Connect / Client / list_instances

list_instances#

Connect.Client.list_instances(**kwargs)#

This API is in preview release for Amazon Connect and is subject to change.

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren’t successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

See also: AWS API Documentation

Request Syntax

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

  • NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'IdentityManagementType': 'SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
            'InstanceAlias': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'ServiceRole': 'string',
            'InstanceStatus': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED',
            'InboundCallsEnabled': True|False,
            'OutboundCallsEnabled': True|False,
            'InstanceAccessUrl': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • InstanceSummaryList (list) –

      Information about the instances.

      • (dict) –

        Information about the instance.

        • Id (string) –

          The identifier of the instance.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the instance.

        • IdentityManagementType (string) –

          The identity management type of the instance.

        • InstanceAlias (string) –

          The alias of the instance.

        • CreatedTime (datetime) –

          When the instance was created.

        • ServiceRole (string) –

          The service role of the instance.

        • InstanceStatus (string) –

          The state of the instance.

        • InboundCallsEnabled (boolean) –

          Whether inbound calls are enabled.

        • OutboundCallsEnabled (boolean) –

          Whether outbound calls are enabled.

        • InstanceAccessUrl (string) –

          This URL allows contact center users to access Amazon Connect admin website.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InternalServiceException