/AWS1/CL_PZZCAMPAIGN¶
An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_name TYPE /AWS1/PZZNAME /AWS1/PZZNAME¶
The name of the campaign.
iv_campaignarn TYPE /AWS1/PZZARN /AWS1/PZZARN¶
The Amazon Resource Name (ARN) of the campaign.
iv_solutionversionarn TYPE /AWS1/PZZARN /AWS1/PZZARN¶
The Amazon Resource Name (ARN) of the solution version the campaign uses.
iv_minprovisionedtps TYPE /AWS1/PZZTRANSACTIONSPERSECOND /AWS1/PZZTRANSACTIONSPERSECOND¶
Specifies the requested minimum provisioned transactions (recommendations) per second. A high
minProvisionedTPSwill increase your bill. We recommend starting with 1 forminProvisionedTPS(the default). Track your usage using Amazon CloudWatch metrics, and increase theminProvisionedTPSas necessary.
io_campaignconfig TYPE REF TO /AWS1/CL_PZZCAMPAIGNCONFIG /AWS1/CL_PZZCAMPAIGNCONFIG¶
The configuration details of a campaign.
iv_status TYPE /AWS1/PZZSTATUS /AWS1/PZZSTATUS¶
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
iv_failurereason TYPE /AWS1/PZZFAILUREREASON /AWS1/PZZFAILUREREASON¶
If a campaign fails, the reason behind the failure.
iv_creationdatetime TYPE /AWS1/PZZDATE /AWS1/PZZDATE¶
The date and time (in Unix format) that the campaign was created.
iv_lastupdateddatetime TYPE /AWS1/PZZDATE /AWS1/PZZDATE¶
The date and time (in Unix format) that the campaign was last updated.
io_latestcampaignupdate TYPE REF TO /AWS1/CL_PZZCAMPAIGNUPDATESUMM /AWS1/CL_PZZCAMPAIGNUPDATESUMM¶
Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.
The
latestCampaignUpdatefield is only returned when the campaign has had at least oneUpdateCampaigncall.
Queryable Attributes¶
name¶
The name of the campaign.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
campaignArn¶
The Amazon Resource Name (ARN) of the campaign.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAMPAIGNARN() |
Getter for CAMPAIGNARN, with configurable default |
ASK_CAMPAIGNARN() |
Getter for CAMPAIGNARN w/ exceptions if field has no value |
HAS_CAMPAIGNARN() |
Determine if CAMPAIGNARN has a value |
solutionVersionArn¶
The Amazon Resource Name (ARN) of the solution version the campaign uses.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOLUTIONVERSIONARN() |
Getter for SOLUTIONVERSIONARN, with configurable default |
ASK_SOLUTIONVERSIONARN() |
Getter for SOLUTIONVERSIONARN w/ exceptions if field has no |
HAS_SOLUTIONVERSIONARN() |
Determine if SOLUTIONVERSIONARN has a value |
minProvisionedTPS¶
Specifies the requested minimum provisioned transactions (recommendations) per second. A high
minProvisionedTPSwill increase your bill. We recommend starting with 1 forminProvisionedTPS(the default). Track your usage using Amazon CloudWatch metrics, and increase theminProvisionedTPSas necessary.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MINPROVISIONEDTPS() |
Getter for MINPROVISIONEDTPS, with configurable default |
ASK_MINPROVISIONEDTPS() |
Getter for MINPROVISIONEDTPS w/ exceptions if field has no v |
HAS_MINPROVISIONEDTPS() |
Determine if MINPROVISIONEDTPS has a value |
campaignConfig¶
The configuration details of a campaign.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAMPAIGNCONFIG() |
Getter for CAMPAIGNCONFIG |
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
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
failureReason¶
If a campaign fails, the reason behind the failure.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREREASON() |
Getter for FAILUREREASON, with configurable default |
ASK_FAILUREREASON() |
Getter for FAILUREREASON w/ exceptions if field has no value |
HAS_FAILUREREASON() |
Determine if FAILUREREASON has a value |
creationDateTime¶
The date and time (in Unix format) that the campaign was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATETIME() |
Getter for CREATIONDATETIME, with configurable default |
ASK_CREATIONDATETIME() |
Getter for CREATIONDATETIME w/ exceptions if field has no va |
HAS_CREATIONDATETIME() |
Determine if CREATIONDATETIME has a value |
lastUpdatedDateTime¶
The date and time (in Unix format) that the campaign was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATEDDATETIME() |
Getter for LASTUPDATEDDATETIME, with configurable default |
ASK_LASTUPDATEDDATETIME() |
Getter for LASTUPDATEDDATETIME w/ exceptions if field has no |
HAS_LASTUPDATEDDATETIME() |
Determine if LASTUPDATEDDATETIME has a value |
latestCampaignUpdate¶
Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.
The
latestCampaignUpdatefield is only returned when the campaign has had at least oneUpdateCampaigncall.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LATESTCAMPAIGNUPDATE() |
Getter for LATESTCAMPAIGNUPDATE |