SAMCustomDomain
SAM model of the CustomDomain kind, generated from the Smarter platform’s JSON Schema.
Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.
- class smarter.models.sam.customdomain.SAMCustomDomainMetadata(*, annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]] = None, description: str | None, name: str, tags: list[str] | None = None, version: str | None, **extra_data: Any)[source]
Bases:
SAMModelSmarter API CustomDomain Manifest - Metadata class.
- annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]]
The manifest annotations.
- Used for storing arbitrary metadata as
key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.
- tags: list[str] | None
The tags of the manifest.
Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]
- model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}
Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].
- class smarter.models.sam.customdomain.SAMCustomDomainSpecConfig(*, domainName: str, **extra_data: Any)[source]
Bases:
SAMModelSmarter API CustomDomain Manifest - CustomDomain.spec.config.
- domainName: str
CustomDomain.spec.config.domainName[str].
Required. The domain name, e.g. ‘llmclients.example.com’. It cannot be changed once the domain has been registered.
- model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}
Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].
- class smarter.models.sam.customdomain.SAMDependency(*, kind: str, name: str, **extra_data: Any)[source]
Bases:
SAMModelA resource that depends on the resource that a manifest describes.
- kind: str
Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.
Read only.
- model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}
Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].
- class smarter.models.sam.customdomain.SAMCustomDomainSpec(*, config: SAMCustomDomainSpecConfig, **extra_data: Any)[source]
Bases:
SAMModelSmarter API CustomDomain Manifest - CustomDomain.spec.
- config: SAMCustomDomainSpecConfig
CustomDomain.spec.config[object].
Required. The configuration of the CustomDomain.
- model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}
Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].
- class smarter.models.sam.customdomain.SAMCustomDomainStatus(*, accountNumber: str, awsHostedZoneId: str | None = None, created: datetime, dependencies: list[SAMDependency] | None = None, dnsRecords: list[str] | None = None, modified: datetime, recordLocator: str, username: str, verificationMessage: str | None = None, verificationStatus: str | None = 'Not Verified', verifiedAt: datetime | None = None, **extra_data: Any)[source]
Bases:
SAMModelSmarter API CustomDomain Manifest - Status class.
Read only. Besides ownership, it reports the domain’s AWS Route53 hosted zone, whether the domain is verified, and its DNS records. The LLMClient that uses it is reported in
dependencies.- accountNumber: str
CustomDomain.status.accountNumber: The account owner of this CustomDomain.
Read only.
- awsHostedZoneId: str | None
CustomDomain.status.awsHostedZoneId: The AWS Route53 hosted zone of this CustomDomain, once it is registered with smarter deploy.
Read only.
- created: datetime
The date in which this resource was created.
Read only.
- dependencies: list[SAMDependency] | None
Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.
Lists only the resources that you can read. Read only.
- model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}
Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].
- dnsRecords: list[str] | None
CustomDomain.status.dnsRecords: The DNS records of this CustomDomain.
Read only.
- modified: datetime
The date in which this resource was most recently changed.
Read only.
- recordLocator: str
RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.
Read only.
- username: str
CustomDomain.status.username: The Smarter user who created this CustomDomain.
Read only.
- verificationMessage: str | None
CustomDomain.status.verificationMessage: Why the domain is not verified yet, or why its verification failed.
Read only.
- class smarter.models.sam.customdomain.SAMCustomDomain(*, apiVersion: str, kind: str, metadata: SAMCustomDomainMetadata, spec: SAMCustomDomainSpec, status: SAMCustomDomainStatus | None = None, **extra_data: Any)[source]
Bases:
SAMModelSmarter API Manifest - CustomDomain.
- model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}
Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].
- metadata: SAMCustomDomainMetadata
CustomDomain.metadata[obj]: Required, the CustomDomain metadata.
- spec: SAMCustomDomainSpec
CustomDomain.spec[obj]: Required, the CustomDomain specification.
- status: SAMCustomDomainStatus | None
CustomDomain.status[obj]: Optional, Read-only.
Stateful status information about the CustomDomain.