Skip to content

Instance

Source code in docs_src/capo_supplychain/types/instance.py
class Instance(TypedDict, closed=True):
    instance_id: "capo_supplychain.types.uuid.UUID"
    """<p>The Amazon Web Services Supply Chain instance identifier.</p>"""
    aws_account_id: "capo_supplychain.types.aws_account_id.AwsAccountId"
    """<p>The Amazon Web Services account ID that owns the instance.</p>"""
    state: "capo_supplychain.types.instance_state.InstanceState"
    """<p>The state of the instance.</p>"""
    error_message: NotRequired["str"]
    """<p>The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.</p>"""
    web_app_dns_domain: NotRequired[
        "capo_supplychain.types.instance_web_app_dns_domain.InstanceWebAppDnsDomain"
    ]
    """<p>The WebApp DNS domain name of the instance.</p>"""
    created_time: NotRequired["datetime.datetime"]
    """<p>The instance creation timestamp.</p>"""
    last_modified_time: NotRequired["datetime.datetime"]
    """<p>The instance last modified timestamp.</p>"""
    instance_name: NotRequired["capo_supplychain.types.instance_name.InstanceName"]
    """<p>The Amazon Web Services Supply Chain instance name.</p>"""
    instance_description: NotRequired[
        "capo_supplychain.types.instance_description.InstanceDescription"
    ]
    """<p>The Amazon Web Services Supply Chain instance description.</p>"""
    kms_key_arn: NotRequired["capo_supplychain.types.kms_key_arn.KmsKeyArn"]
    """<p>The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.</p>"""
    version_number: NotRequired["float"]
    """<p>The version number of the instance.</p>"""

aws_account_id instance-attribute

aws_account_id: AwsAccountId

The Amazon Web Services account ID that owns the instance.

created_time instance-attribute

created_time: NotRequired[datetime]

The instance creation timestamp.

error_message instance-attribute

error_message: NotRequired[str]

The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

instance_description instance-attribute

instance_description: NotRequired[InstanceDescription]

The Amazon Web Services Supply Chain instance description.

instance_id instance-attribute

instance_id: UUID

The Amazon Web Services Supply Chain instance identifier.

instance_name instance-attribute

instance_name: NotRequired[InstanceName]

The Amazon Web Services Supply Chain instance name.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

last_modified_time instance-attribute

last_modified_time: NotRequired[datetime]

The instance last modified timestamp.

state instance-attribute

The state of the instance.

version_number instance-attribute

version_number: NotRequired[float]

The version number of the instance.

web_app_dns_domain instance-attribute

web_app_dns_domain: NotRequired[InstanceWebAppDnsDomain]

The WebApp DNS domain name of the instance.