Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListInstances

Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "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.

MaxResults

The maximum number of results to display for the instance.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Type: String

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

Pattern: ^[-a-zA-Z0-9+=/_]*$

Required: No

Response Syntax


{
   "Instances": [ 
      { 
         "CreatedDate": number,
         "IdentityStoreId": "string",
         "InstanceArn": "string",
         "Name": "string",
         "OwnerAccountId": "string",
         "Status": "string"
      }
   ],
   "NextToken": "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.

Instances

Lists the IAM Identity Center instances that the caller has access to.

Type: Array of InstanceMetadata objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

NextToken

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Type: String

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

Pattern: ^[-a-zA-Z0-9+=/_]*$

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