update_campaign

IoTFleetWise.Client.update_campaign(**kwargs)

Updates a campaign.

See also: AWS API Documentation

Request Syntax

response = client.update_campaign(
    name='string',
    description='string',
    dataExtraDimensions=[
        'string',
    ],
    action='APPROVE'|'SUSPEND'|'RESUME'|'UPDATE'
)

Parameters

• name (string) --

  [REQUIRED]

  The name of the campaign to update.

• description (string) -- The description of the campaign.
• dataExtraDimensions (list) --

  A list of vehicle attributes to associate with a signal.

  Default: An empty array

  • (string) --
• action (string) --

  [REQUIRED]

  Specifies how to update a campaign. The action can be one of the following:

  • APPROVE - To approve delivering a data collection scheme to vehicles.
  • SUSPEND - To suspend collecting signal data.
  • RESUME - To resume collecting signal data.
  • UPDATE - To update a campaign.

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'name': 'string',
    'status': 'CREATING'|'WAITING_FOR_APPROVAL'|'RUNNING'|'SUSPENDED'
}

Response Structure

• (dict) --

  • arn (string) --

    The Amazon Resource Name (ARN) of the campaign.

  • name (string) --

    The name of the updated campaign.

  • status (string) --

    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 the WAITING_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.

Exceptions

• IoTFleetWise.Client.exceptions.ResourceNotFoundException
• IoTFleetWise.Client.exceptions.InternalServerException
• IoTFleetWise.Client.exceptions.ConflictException
• IoTFleetWise.Client.exceptions.ThrottlingException
• IoTFleetWise.Client.exceptions.ValidationException
• IoTFleetWise.Client.exceptions.AccessDeniedException