ConnectCampaignServiceV2 / Client / list_campaigns

list_campaigns#

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

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token for the next set of results.

  • filters (dict) –

    Filter model by type

    • instanceIdFilter (dict) –

      Connect instance identifier filter

      • value (string) – [REQUIRED]

        Amazon Connect Instance Id

      • operator (string) – [REQUIRED]

        Operators for Connect instance identifier filter

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'campaignSummaryList': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'connectInstanceId': 'string',
            'channelSubtypes': [
                'TELEPHONY'|'SMS'|'EMAIL',
            ],
            'schedule': {
                'startTime': datetime(2015, 1, 1),
                'endTime': datetime(2015, 1, 1),
                'refreshFrequency': 'string'
            },
            'connectCampaignFlowArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    The response for ListCampaigns API.

    • nextToken (string) –

      The token for the next set of results.

    • campaignSummaryList (list) –

      A list of Amazon Connect campaigns.

      • (dict) –

        An Amazon Connect campaign summary.

        • id (string) –

          Identifier representing a Campaign

        • arn (string) –

          The resource name of an Amazon Connect campaign.

        • name (string) –

          The name of an Amazon Connect Campaign name.

        • connectInstanceId (string) –

          Amazon Connect Instance Id

        • channelSubtypes (list) –

          Channel subtype list

          • (string) –

            The type of campaign channel subtype.

        • schedule (dict) –

          Campaign schedule

          • startTime (datetime) –

            Timestamp with no UTC offset or timezone

          • endTime (datetime) –

            Timestamp with no UTC offset or timezone

          • refreshFrequency (string) –

            Time duration in ISO 8601 format

        • connectCampaignFlowArn (string) –

          Amazon Resource Names(ARN)

Exceptions