Describe Campaign

personalize_describe_campaign

R Documentation

Describes the given campaign, including its status

Description

Describes the given campaign, including its status.

A campaign can be in one of the following states:

• CREATE PENDING \ CREATE IN_PROGRESS \ ACTIVE -or- CREATE FAILED

• DELETE PENDING \ DELETE IN_PROGRESS

When the status is ⁠CREATE FAILED⁠, the response includes the failureReason key, which describes why.

For more information on campaigns, see create_campaign.

Usage

personalize_describe_campaign(campaignArn)

Arguments

campaignArn

[required] The Amazon Resource Name (ARN) of the campaign.

Value

A list with the following syntax:

list(
  campaign = list(
    name = "string",
    campaignArn = "string",
    solutionVersionArn = "string",
    minProvisionedTPS = 123,
    campaignConfig = list(
      itemExplorationConfig = list(
        "string"
      ),
      enableMetadataWithRecommendations = TRUE|FALSE,
      syncWithLatestSolutionVersion = TRUE|FALSE
    ),
    status = "string",
    failureReason = "string",
    creationDateTime = as.POSIXct(
      "2015-01-01"
    ),
    lastUpdatedDateTime = as.POSIXct(
      "2015-01-01"
    ),
    latestCampaignUpdate = list(
      solutionVersionArn = "string",
      minProvisionedTPS = 123,
      campaignConfig = list(
        itemExplorationConfig = list(
          "string"
        ),
        enableMetadataWithRecommendations = TRUE|FALSE,
        syncWithLatestSolutionVersion = TRUE|FALSE
      ),
      status = "string",
      failureReason = "string",
      creationDateTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$describe_campaign(
  campaignArn = "string"
)