Connect / Paginator / ListSecurityKeys

ListSecurityKeys

class Connect.Paginator.ListSecurityKeys

paginator = client.get_paginator('list_security_keys')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• 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:

dict

Returns:

Response Syntax

{
    'SecurityKeys': [
        {
            'AssociationId': 'string',
            'Key': 'string',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • SecurityKeys (list) –

    The security keys.

    • (dict) –

      Configuration information of the security key.

      • AssociationId (string) –

        The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

      • Key (string) –

        The key of the security key.

      • CreationTime (datetime) –

        When the security key was created.