Connect / Paginator / ListContactReferences

ListContactReferences

class Connect.Paginator.ListContactReferences

paginator = client.get_paginator('list_contact_references')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    ContactId='string',
    ReferenceTypes=[
        'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL',
    ],
    PaginationConfig={
        'MaxItems': 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.

• ContactId (string) –

  [REQUIRED]

  The identifier of the initial contact.

• ReferenceTypes (list) –

  [REQUIRED]

  The type of reference.

  • (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.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'ReferenceSummaryList': [
        {
            'Url': {
                'Name': 'string',
                'Value': 'string'
            },
            'Attachment': {
                'Name': 'string',
                'Value': 'string',
                'Status': 'APPROVED'|'REJECTED'
            },
            'String': {
                'Name': 'string',
                'Value': 'string'
            },
            'Number': {
                'Name': 'string',
                'Value': 'string'
            },
            'Date': {
                'Name': 'string',
                'Value': 'string'
            },
            'Email': {
                'Name': 'string',
                'Value': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • ReferenceSummaryList (list) –

    Information about the flows.

    • (dict) –

      Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: Url, Attachment, String, Number, Date, Email. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • Url (dict) –

        Information about the reference when the referenceType is URL . Otherwise, null.

        • Name (string) –

          Identifier of the URL reference.

        • Value (string) –

          A valid URL.

      • Attachment (dict) –

        Information about the reference when the referenceType is ATTACHMENT . Otherwise, null.

        • Name (string) –

          Identifier of the attachment reference.

        • Value (string) –

          The location path of the attachment reference.

        • Status (string) –

          Status of the attachment reference type.

      • String (dict) –

        Information about a reference when the referenceType is STRING . Otherwise, null.

        • Name (string) –

          Identifier of the string reference.

        • Value (string) –

          A valid string.

      • Number (dict) –

        Information about a reference when the referenceType is NUMBER . Otherwise, null.

        • Name (string) –

          Identifier of the number reference.

        • Value (string) –

          A valid number.

      • Date (dict) –

        Information about a reference when the referenceType is DATE . Otherwise, null.

        • Name (string) –

          Identifier of the date reference.

        • Value (string) –

          A valid date.

      • Email (dict) –

        Information about a reference when the referenceType is EMAIL . Otherwise, null.

        • Name (string) –

          Identifier of the email reference.

        • Value (string) –

          A valid email address.