CampaignSummary
Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.
Contents
- campaignArn
-
The Amazon Resource Name (ARN) of the campaign.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):personalize:.*:.*:.+Required: No
- creationDateTime
-
The date and time (in Unix time) that the campaign was created.
Type: Timestamp
Required: No
- failureReason
-
If a campaign fails, the reason behind the failure.
Type: String
Required: No
- lastUpdatedDateTime
-
The date and time (in Unix time) that the campaign was last updated.
Type: Timestamp
Required: No
- name
-
The name of the campaign.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9\-_]*Required: No
- 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
Type: String
Length Constraints: Maximum length of 256.
Required: No
-
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: