Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

ListCampaigns

class ConnectCampaignService.Paginator.ListCampaigns
paginator = client.get_paginator('list_campaigns')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectCampaignService.Client.list_campaigns().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters={
        'instanceIdFilter': {
            'operator': 'Eq',
            'value': 'string'
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (dict) --

    Filter model by type

    • instanceIdFilter (dict) --

      Connect instance identifier filter

      • operator (string) -- [REQUIRED]

        Operators for Connect instance identifier filter

      • value (string) -- [REQUIRED]

        Amazon Connect Instance Id

  • 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

{
    'campaignSummaryList': [
        {
            'arn': 'string',
            'connectInstanceId': 'string',
            'id': 'string',
            'name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    ListCampaignsResponse

    • campaignSummaryList (list) --

      A list of Amazon Connect campaigns.

      • (dict) --

        An Amazon Connect campaign summary.

        • arn (string) --

          The resource name of an Amazon Connect campaign.

        • connectInstanceId (string) --

          Amazon Connect Instance Id

        • id (string) --

          Identifier representing a Campaign

        • name (string) --

          The name of an Amazon Connect Campaign name.

    • NextToken (string) --

      A token to resume pagination.