Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeInstance

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.

Request Syntax


{
   "InstanceArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

InstanceArn

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Required: Yes

Response Syntax


{
   "CreatedDate": number,
   "EncryptionConfigurationDetails": { 
      "EncryptionStatus": "string",
      "EncryptionStatusReason": "string",
      "KeyType": "string",
      "KmsKeyArn": "string"
   },
   "IdentityStoreId": "string",
   "InstanceArn": "string",
   "Name": "string",
   "OwnerAccountId": "string",
   "Status": "string",
   "StatusReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedDate

The date the instance was created.

Type: Timestamp

EncryptionConfigurationDetails

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

Note

Customer managed KMS keys for Amazon IAM Identity Center are currently available in select Amazon Regions.

Type: EncryptionConfigurationDetails object

IdentityStoreId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]*

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 Service Namespaces in the Amazon General Reference.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Name

Specifies the instance name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\w+=,.@-]+

OwnerAccountId

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

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Status

The status of the instance.

Type: String

Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | DELETE_IN_PROGRESS | ACTIVE

StatusReason

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.

Type: String

Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception, or failure with an internal server.

HTTP Status Code: 500

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

HTTP Status Code: 400