list_instances

SSOAdmin.Client.list_instances(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_instances(
    MaxResults=123,
    NextToken='string'
)

Parameters

• MaxResults (integer) -- The maximum number of results to display for the instance.
• NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Return type

dict

Returns

Response Syntax

{
    'Instances': [
        {
            'InstanceArn': 'string',
            'IdentityStoreId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Instances (list) --

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

    • (dict) --

      Provides information about the IAM Identity Center instance.

      • InstanceArn (string) --

        The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

      • IdentityStoreId (string) --

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

  • NextToken (string) --

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

Exceptions

• SSOAdmin.Client.exceptions.InternalServerException
• SSOAdmin.Client.exceptions.ThrottlingException
• SSOAdmin.Client.exceptions.AccessDeniedException
• SSOAdmin.Client.exceptions.ValidationException