List Campaigns

connectcampaignservicev2_list_campaigns

R Documentation

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

Description¶

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

Usage¶

connectcampaignservicev2_list_campaigns(maxResults, nextToken, filters)

Arguments¶

maxResults

The maximum number of results to return per page.

nextToken

The token for the next set of results.

filters

Filter model by type

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  campaignSummaryList = list(
    list(
      id = "string",
      arn = "string",
      name = "string",
      connectInstanceId = "string",
      channelSubtypes = list(
        "TELEPHONY"|"SMS"|"EMAIL"|"WHATSAPP"
      ),
      type = "MANAGED"|"JOURNEY",
      schedule = list(
        startTime = as.POSIXct(
          "2015-01-01"
        ),
        endTime = as.POSIXct(
          "2015-01-01"
        ),
        refreshFrequency = "string"
      ),
      entryLimitsConfig = list(
        maxEntryCount = 123,
        minEntryInterval = "string"
      ),
      connectCampaignFlowArn = "string"
    )
  )
)

Request syntax¶

svc$list_campaigns(
  maxResults = 123,
  nextToken = "string",
  filters = list(
    instanceIdFilter = list(
      value = "string",
      operator = "Eq"
    )
  )
)