Connect / Paginator / ListInstances


class Connect.Paginator.ListInstances#
paginator = client.get_paginator('list_instances')

Creates an iterator that will paginate through responses from Connect.Client.list_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



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'


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 the Amazon Connect admin website.