Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListIdentityStores

Lists the identity stores that you have access to. This operation returns only the identity store ID and Amazon Resource Name (ARN) of each identity store. To obtain additional information about an identity store, call DescribeIdentityStore.

This operation returns results in paginated form. Use the NextToken parameter to retrieve additional pages of results.

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 return per request. This parameter is used in all List operations to specify how many results to return on one page. If you don't specify a value, the operation uses a default page size.

Type: Integer

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

Required: No

NextToken

The pagination token used for the ListIdentityStores API operation. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.

Type: String

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

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

Required: No

Response Syntax


{
   "IdentityStores": [ 
      { 
         "IdentityStoreArn": "string",
         "IdentityStoreId": "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.

IdentityStores

A list of IdentityStore objects, each of which contains the identifiers for an identity store that you have access to.

Type: Array of IdentityStore objects

NextToken

Type: String

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

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

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

Reason: Indicates the reason for an access denial when returned by KMS while accessing a Customer Managed KMS key. For non-KMS access-denied errors, this field is not included.
RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

InternalServerException

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

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
RetryAfterSeconds: The number of seconds to wait before retrying the next request.

HTTP Status Code: 500

ThrottlingException

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

Reason: Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
RetryAfterSeconds: The number of seconds to wait before retrying the next request.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

Reason: Indicates the reason for the validation error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

Examples

Example

This example lists the identity stores that you have access to.

Sample Request


{
    "MaxResults": 10,
    "NextToken": ""
}

Sample Response


{
    "IdentityStores": [
        {
            "IdentityStoreId": "d-1234567890",
            "IdentityStoreArn": "arn:aws:identitystore::111122223333:identitystore/d-1234567890"
        }
    ],
    "NextToken": "EXAMPLE-TOKEN"
}