List Campaigns

personalize_list_campaigns

R Documentation

Returns a list of campaigns that use the given solution¶

Description¶

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see create_campaign.

Usage¶

personalize_list_campaigns(solutionArn, nextToken, maxResults)

Arguments¶

solutionArn: The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.
nextToken: A token returned from the previous call to list_campaigns for getting the next set of campaigns (if they exist).
maxResults: The maximum number of campaigns to return.

Value¶

A list with the following syntax:

list(
  campaigns = list(
    list(
      name = "string",
      campaignArn = "string",
      status = "string",
      creationDateTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      failureReason = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_campaigns(
  solutionArn = "string",
  nextToken = "string",
  maxResults = 123
)