SSOAdmin / Client / describe_instance

describe_instance#

SSOAdmin.Client.describe_instance(**kwargs)#

Returns the details of an instance of IAM Identity Center. The status can be one of the following:

  • CREATE_IN_PROGRESS - The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status of ACTIVE. While the instance is in the CREATE_IN_PROGRESS state, you can call only DescribeInstance and DeleteInstance operations.

  • DELETE_IN_PROGRESS - The instance is being deleted. Returns AccessDeniedException after the delete operation completes.

  • ACTIVE - The instance is active.

See also: AWS API Documentation

Request Syntax

response = client.describe_instance(
    InstanceArn='string'
)
Parameters:

InstanceArn (string) –

[REQUIRED]

The ARN of the instance of IAM Identity Center under which the operation will run.

Return type:

dict

Returns:

Response Syntax

{
    'CreatedDate': datetime(2015, 1, 1),
    'IdentityStoreId': 'string',
    'InstanceArn': 'string',
    'Name': 'string',
    'OwnerAccountId': 'string',
    'Status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'ACTIVE'
}

Response Structure

  • (dict) –

    • CreatedDate (datetime) –

      The date the instance was created.

    • IdentityStoreId (string) –

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

    • InstanceArn (string) –

      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 (string) –

      Specifies the instance name.

    • OwnerAccountId (string) –

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

    • Status (string) –

      The status of the instance.

Exceptions