/AWS1/CL_IOIUPDATECAMPAIGNRSP¶
UpdateCampaignResponse
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
IV_ARN
TYPE /AWS1/IOIARN
/AWS1/IOIARN
¶
The Amazon Resource Name (ARN) of the campaign.
IV_NAME
TYPE /AWS1/IOICAMPAIGNNAME
/AWS1/IOICAMPAIGNNAME
¶
The name of the updated campaign.
IV_STATUS
TYPE /AWS1/IOICAMPAIGNSTATUS
/AWS1/IOICAMPAIGNSTATUS
¶
The state of a campaign. The status can be one of:
CREATING
- Amazon Web Services IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL
- After a campaign is created, it enters theWAITING_FOR_APPROVAL
state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
RUNNING
- The campaign is active.
SUSPENDED
- The campaign is suspended. To resume the campaign, use the API operation.
Queryable Attributes¶
arn¶
The Amazon Resource Name (ARN) of the campaign.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
name¶
The name of the updated 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 |
status¶
The state of a campaign. The status can be one of:
CREATING
- Amazon Web Services IoT FleetWise is processing your request to create the campaign.
WAITING_FOR_APPROVAL
- After a campaign is created, it enters theWAITING_FOR_APPROVAL
state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.
RUNNING
- The campaign is active.
SUSPENDED
- The campaign is suspended. To resume the campaign, use the API operation.
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 |