QConnect / Paginator / ListContentAssociations

ListContentAssociations

class QConnect.Paginator.ListContentAssociations

paginator = client.get_paginator('list_content_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QConnect.Client.list_content_associations().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• contentId (string) –

  [REQUIRED]

  The identifier of the content.

• knowledgeBaseId (string) –

  [REQUIRED]

  The identifier of the knowledge base.

• 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

{
    'contentAssociationSummaries': [
        {
            'associationData': {
                'amazonConnectGuideAssociation': {
                    'flowId': 'string'
                }
            },
            'associationType': 'AMAZON_CONNECT_GUIDE',
            'contentArn': 'string',
            'contentAssociationArn': 'string',
            'contentAssociationId': 'string',
            'contentId': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • contentAssociationSummaries (list) –

    Summary information about content associations.

    • (dict) –

      Summary information about a content association.

      • associationData (dict) –

        The content association.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: amazonConnectGuideAssociation. 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'}
        

        • amazonConnectGuideAssociation (dict) –

          The data of the step-by-step guide association.

          • flowId (string) –

            The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

      • associationType (string) –

        The type of association.

      • contentArn (string) –

        The Amazon Resource Name (ARN) of the content.

      • contentAssociationArn (string) –

        The Amazon Resource Name (ARN) of the content association.

      • contentAssociationId (string) –

        The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • contentId (string) –

        The identifier of the content.

      • knowledgeBaseArn (string) –

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId (string) –

        The identifier of the knowledge base.

      • tags (dict) –

        The tags used to organize, track, or control access for this resource.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.