Skip to content
AWS for Query.Farm

aws.personalize.describe_campaign

Example SQL Queries

SELECT * FROM
aws.personalize.describe_campaign
WHERE
"campaign_arn" = 'VALUE';

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 CreateCampaign.

Table Definition

Column NameColumn Data Type
campaign_arn Required Input Column

The Amazon Resource Name (ARN) of the campaign.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
campaign

The properties of the campaign.

STRUCT(
    "name" VARCHAR,
    "campaign_arn" VARCHAR,
    "solution_version_arn" VARCHAR,
    "min_provisioned_tps" BIGINT,
    "campaign_config" STRUCT(
        "item_exploration_config" MAP(VARCHAR, VARCHAR),
        "enable_metadata_with_recommendations" BOOLEAN,
        "sync_with_latest_solution_version" BOOLEAN
    ),
    "status" VARCHAR,
    "failure_reason" VARCHAR,
    "creation_date_time" TIMESTAMP_S,
    "last_updated_date_time" TIMESTAMP_S,
    "latest_campaign_update" STRUCT(
        "solution_version_arn" VARCHAR,
        "min_provisioned_tps" BIGINT,
        "campaign_config" STRUCT(
            "item_exploration_config" MAP(VARCHAR, VARCHAR),
            "enable_metadata_with_recommendations" BOOLEAN,
            "sync_with_latest_solution_version" BOOLEAN
        ),
        "status" VARCHAR,
        "failure_reason" VARCHAR,
        "creation_date_time" TIMESTAMP_S,
        "last_updated_date_time" TIMESTAMP_S
    )
)
Show child fields
campaign.campaign_arn

The Amazon Resource Name (ARN) of the campaign.

campaign.campaign_config

The configuration details of a campaign.

Show child fields
campaign.campaign_config.enable_metadata_with_recommendations

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

campaign.campaign_config.item_exploration_config

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

campaign.campaign_config.sync_with_latest_solution_version

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

campaign.creation_date_time

The date and time (in Unix format) that the campaign was created.

campaign.failure_reason

If a campaign fails, the reason behind the failure.

campaign.last_updated_date_time

The date and time (in Unix format) that the campaign was last updated.

campaign.latest_campaign_update

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

Show child fields
campaign.latest_campaign_update.campaign_config

The configuration details of a campaign.

Show child fields
campaign.latest_campaign_update.campaign_config.enable_metadata_with_recommendations

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

campaign.latest_campaign_update.campaign_config.item_exploration_config

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

campaign.latest_campaign_update.campaign_config.sync_with_latest_solution_version

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

campaign.latest_campaign_update.creation_date_time

The date and time (in Unix time) that the campaign update was created.

campaign.latest_campaign_update.failure_reason

If a campaign update fails, the reason behind the failure.

campaign.latest_campaign_update.last_updated_date_time

The date and time (in Unix time) that the campaign update was last updated.

campaign.latest_campaign_update.min_provisioned_tps

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

campaign.latest_campaign_update.solution_version_arn

The Amazon Resource Name (ARN) of the deployed solution version.

campaign.latest_campaign_update.status

The status of the campaign update.

A campaign update can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

campaign.min_provisioned_tps

Specifies the requested minimum provisioned transactions (recommendations) per second. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

campaign.name

The name of the campaign.

campaign.solution_version_arn

The Amazon Resource Name (ARN) of the solution version the campaign uses.

campaign.status

The status of the campaign.

A campaign can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS