list_campaigns

ConnectCampaignService.Client.list_campaigns(**kwargs)

Provides summary information about the campaigns under the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

response = client.list_campaigns(
    filters={
        'instanceIdFilter': {
            'operator': 'Eq',
            'value': 'string'
        }
    },
    maxResults=123,
    nextToken='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

• maxResults (integer) -- The maximum number of results to return per page.
• nextToken (string) -- The token for the next set of results.

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) --

    The token for the next set of results.

Exceptions

• ConnectCampaignService.Client.exceptions.InternalServerException
• ConnectCampaignService.Client.exceptions.ValidationException
• ConnectCampaignService.Client.exceptions.AccessDeniedException