IdentityStore / Client / list_identity_stores

list_identity_stores

IdentityStore.Client.list_identity_stores(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_identity_stores(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – 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.

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

Return type:

dict

Returns:

Response Syntax

{
    'IdentityStores': [
        {
            'IdentityStoreId': 'string',
            'IdentityStoreArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • IdentityStores (list) –

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

      • (dict) –

        A structure that contains the identifiers for an identity store: its globally unique identifier (ID) and Amazon Resource Name (ARN).

        • IdentityStoreId (string) –

          The globally unique identifier for the identity store.

        • IdentityStoreArn (string) –

          The Amazon Resource Name (ARN) of the identity store. For example, arn:aws:identitystore::111122223333:identitystore/d-1234567890.

    • NextToken (string) –

      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.

Exceptions

  • IdentityStore.Client.exceptions.ThrottlingException

  • IdentityStore.Client.exceptions.AccessDeniedException

  • IdentityStore.Client.exceptions.InternalServerException

  • IdentityStore.Client.exceptions.ValidationException