Connect / Paginator / ListExtractionDefinitions

ListExtractionDefinitions

class Connect.Paginator.ListExtractionDefinitions

paginator = client.get_paginator('list_extraction_definitions')

paginate(**kwargs)

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

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 Connect Customer 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

{
    'ExtractionDefinitionSummaryList': [
        {
            'Name': 'string',
            'ExtractionDefinitionId': 'string',
            'ExtractionDefinitionArn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'LastUpdatedBy': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • ExtractionDefinitionSummaryList (list) –

    Information about the extraction definitions.

    • (dict) –

      Summary information about an extraction definition.

      • Name (string) –

        The name of the extraction definition.

      • ExtractionDefinitionId (string) –

        The identifier of the extraction definition.

      • ExtractionDefinitionArn (string) –

        The Amazon Resource Name (ARN) of the extraction definition.

      • CreatedTime (datetime) –

        The timestamp when the extraction definition was created.

      • LastUpdatedTime (datetime) –

        The timestamp when the extraction definition was last updated.

      • LastUpdatedBy (string) –

        The Amazon Resource Name (ARN) of the user who last updated the extraction definition.