Skip to content

DescribeInstanceResponse

Source code in docs_src/capo_sso_admin/types/describe_instance_response.py
class DescribeInstanceResponse(TypedDict, closed=True):
    instance_arn: NotRequired["capo_sso_admin.types.instance_arn.InstanceArn"]
    """<p>The ARN of the instance of IAM Identity Center under which the operation will run. 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 instance of IAM Identity Center.</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 instance of IAM Identity Center.</p>"""
    owner_account_id: NotRequired["capo_sso_admin.types.account_id.AccountId"]
    """<p>The identifier of the Amazon Web Services account for which the instance was created.</p>"""
    name: NotRequired["capo_sso_admin.types.name_type.NameType"]
    """<p>Specifies the instance name.</p>"""
    created_date: NotRequired["capo_sso_admin.types.date.Date"]
    """<p>The date the instance was created.</p>"""
    status: NotRequired["capo_sso_admin.types.instance_status.InstanceStatus"]
    """<p>The status of the 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 fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors. </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>"""
    encryption_configuration_details: NotRequired[
        "capo_sso_admin.types.encryption_configuration_details.EncryptionConfigurationDetails"
    ]
    """<p>Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.</p>"""
    permission_sets_enabled: NotRequired["bool"]
    """<p>Indicates whether permission sets are enabled for this Identity Center instance.</p>"""

created_date instance-attribute

created_date: NotRequired[Date]

The date the instance was created.

encryption_configuration_details instance-attribute

encryption_configuration_details: NotRequired[EncryptionConfigurationDetails]

Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.

identity_store_arn instance-attribute

identity_store_arn: NotRequired[InstanceIdentityStoreArn]

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

identity_store_id instance-attribute

identity_store_id: NotRequired[Id]

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

instance_arn instance-attribute

instance_arn: NotRequired[InstanceArn]

The ARN of the instance of IAM Identity Center under which the operation will run. 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]

Specifies the instance name.

owner_account_id instance-attribute

owner_account_id: NotRequired[AccountId]

The identifier of the Amazon Web Services account for which the instance was created.

permission_sets_enabled instance-attribute

permission_sets_enabled: NotRequired[bool]

Indicates whether permission sets are enabled for this 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 status of the 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 fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.