Skip to content

InstanceMetadata

Source code in docs_src/capo_sso_admin/types/instance_metadata.py
class InstanceMetadata(TypedDict, closed=True):
    instance_arn: NotRequired["capo_sso_admin.types.instance_arn.InstanceArn"]
    """<p>The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"""
    identity_store_id: NotRequired["capo_sso_admin.types.id.Id"]
    """<p>The identifier of the identity store that is connected to the Identity Center instance.</p>"""
    identity_store_arn: NotRequired[
        "capo_sso_admin.types.instance_identity_store_arn.InstanceIdentityStoreArn"
    ]
    """<p>The ARN of the identity store that is connected to the Identity Center instance.</p>"""
    owner_account_id: NotRequired["capo_sso_admin.types.account_id.AccountId"]
    """<p>The Amazon Web Services account ID number of the owner of the Identity Center instance.</p>"""
    name: NotRequired["capo_sso_admin.types.name_type.NameType"]
    """<p>The name of the Identity Center instance.</p>"""
    created_date: NotRequired["capo_sso_admin.types.date.Date"]
    """<p>The date and time that the Identity Center instance was created.</p>"""
    status: NotRequired["capo_sso_admin.types.instance_status.InstanceStatus"]
    """<p>The current status of this Identity Center instance.</p>"""
    status_reason: NotRequired["capo_sso_admin.types.reason.Reason"]
    """<p>Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance creation fails, this field contains information about the cause, which may include issues with KMS key configuration or insufficient permissions. </p>"""
    primary_region: NotRequired["capo_sso_admin.types.region_name.RegionName"]
    """<p>The primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.</p>"""
    regions: NotRequired["capo_sso_admin.types.region_metadata_list.RegionMetadataList"]
    """<p>The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.</p>"""

created_date instance-attribute

created_date: NotRequired[Date]

The date and time that the Identity Center instance was created.

identity_store_arn instance-attribute

identity_store_arn: NotRequired[InstanceIdentityStoreArn]

The ARN of the identity store that is connected to the Identity Center instance.

identity_store_id instance-attribute

identity_store_id: NotRequired[Id]

The identifier of the identity store that is connected to the Identity Center instance.

instance_arn instance-attribute

instance_arn: NotRequired[InstanceArn]

The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

name instance-attribute

name: NotRequired[NameType]

The name of the Identity Center instance.

owner_account_id instance-attribute

owner_account_id: NotRequired[AccountId]

The Amazon Web Services account ID number of the owner of the Identity Center instance.

primary_region instance-attribute

primary_region: NotRequired[RegionName]

The primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.

regions instance-attribute

regions: NotRequired[RegionMetadataList]

The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.

status instance-attribute

status: NotRequired[InstanceStatus]

The current status of this Identity Center instance.

status_reason instance-attribute

status_reason: NotRequired[Reason]

Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance creation fails, this field contains information about the cause, which may include issues with KMS key configuration or insufficient permissions.