SDK for PHP 3.x

AWS IoT FleetWise 2021-06-17

Client: Aws\IoTFleetWise\IoTFleetWiseClient
Service ID: iotfleetwise
Version: 2021-06-17

This page describes the parameters and results for the operations of the AWS IoT FleetWise (2021-06-17), and shows how to use the Aws\IoTFleetWise\IoTFleetWiseClient object to call the described operations. This documentation is specific to the 2021-06-17 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateVehicleFleet ( array $params = [] )
Adds, or associates, a vehicle with a fleet.
BatchCreateVehicle ( array $params = [] )
Creates a group, or batch, of vehicles.
BatchUpdateVehicle ( array $params = [] )
Updates a group, or batch, of vehicles.
CreateCampaign ( array $params = [] )
Creates an orchestration of data collection rules.
CreateDecoderManifest ( array $params = [] )
Creates the decoder manifest associated with a model manifest.
CreateFleet ( array $params = [] )
Creates a fleet that represents a group of vehicles.
CreateModelManifest ( array $params = [] )
Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
CreateSignalCatalog ( array $params = [] )
Creates a collection of standardized signals that can be reused to create vehicle models.
CreateStateTemplate ( array $params = [] )
Creates a state template.
CreateVehicle ( array $params = [] )
Creates a vehicle, which is an instance of a vehicle model (model manifest).
DeleteCampaign ( array $params = [] )
Deletes a data collection campaign.
DeleteDecoderManifest ( array $params = [] )
Deletes a decoder manifest.
DeleteFleet ( array $params = [] )
Deletes a fleet.
DeleteModelManifest ( array $params = [] )
Deletes a vehicle model (model manifest).
DeleteSignalCatalog ( array $params = [] )
Deletes a signal catalog.
DeleteStateTemplate ( array $params = [] )
Deletes a state template.
DeleteVehicle ( array $params = [] )
Deletes a vehicle and removes it from any campaigns.
DisassociateVehicleFleet ( array $params = [] )
Removes, or disassociates, a vehicle from a fleet.
GetCampaign ( array $params = [] )
Retrieves information about a campaign.
GetDecoderManifest ( array $params = [] )
Retrieves information about a created decoder manifest.
GetEncryptionConfiguration ( array $params = [] )
Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
GetFleet ( array $params = [] )
Retrieves information about a fleet.
GetLoggingOptions ( array $params = [] )
Retrieves the logging options.
GetModelManifest ( array $params = [] )
Retrieves information about a vehicle model (model manifest).
GetRegisterAccountStatus ( array $params = [] )
Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.
GetSignalCatalog ( array $params = [] )
Retrieves information about a signal catalog.
GetStateTemplate ( array $params = [] )
Retrieves information about a state template.
GetVehicle ( array $params = [] )
Retrieves information about a vehicle.
GetVehicleStatus ( array $params = [] )
Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.
ImportDecoderManifest ( array $params = [] )
Creates a decoder manifest using your existing CAN DBC file from your local device.
ImportSignalCatalog ( array $params = [] )
Creates a signal catalog using your existing VSS formatted content from your local device.
ListCampaigns ( array $params = [] )
Lists information about created campaigns.
ListDecoderManifestNetworkInterfaces ( array $params = [] )
Lists the network interfaces specified in a decoder manifest.
ListDecoderManifestSignals ( array $params = [] )
A list of information about signal decoders specified in a decoder manifest.
ListDecoderManifests ( array $params = [] )
Lists decoder manifests.
ListFleets ( array $params = [] )
Retrieves information for each created fleet in an Amazon Web Services account.
ListFleetsForVehicle ( array $params = [] )
Retrieves a list of IDs for all fleets that the vehicle is associated with.
ListModelManifestNodes ( array $params = [] )
Lists information about nodes specified in a vehicle model (model manifest).
ListModelManifests ( array $params = [] )
Retrieves a list of vehicle models (model manifests).
ListSignalCatalogNodes ( array $params = [] )
Lists of information about the signals (nodes) specified in a signal catalog.
ListSignalCatalogs ( array $params = [] )
Lists all the created signal catalogs in an Amazon Web Services account.
ListStateTemplates ( array $params = [] )
Lists information about created state templates.
ListTagsForResource ( array $params = [] )
Lists the tags (metadata) you have assigned to the resource.
ListVehicles ( array $params = [] )
Retrieves a list of summaries of created vehicles.
ListVehiclesInFleet ( array $params = [] )
Retrieves a list of summaries of all vehicles associated with a fleet.
PutEncryptionConfiguration ( array $params = [] )
Creates or updates the encryption configuration.
PutLoggingOptions ( array $params = [] )
Creates or updates the logging option.
RegisterAccount ( array $params = [] )
This API operation contains deprecated parameters.
TagResource ( array $params = [] )
Adds to or modifies the tags of the given resource.
UntagResource ( array $params = [] )
Removes the given tags (metadata) from the resource.
UpdateCampaign ( array $params = [] )
Updates a campaign.
UpdateDecoderManifest ( array $params = [] )
Updates a decoder manifest.
UpdateFleet ( array $params = [] )
Updates the description of an existing fleet.
UpdateModelManifest ( array $params = [] )
Updates a vehicle model (model manifest).
UpdateSignalCatalog ( array $params = [] )
Updates a signal catalog.
UpdateStateTemplate ( array $params = [] )
Updates a state template.
UpdateVehicle ( array $params = [] )
Updates a vehicle.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetVehicleStatus
ListCampaigns
ListDecoderManifestNetworkInterfaces
ListDecoderManifestSignals
ListDecoderManifests
ListFleets
ListFleetsForVehicle
ListModelManifestNodes
ListModelManifests
ListSignalCatalogNodes
ListSignalCatalogs
ListStateTemplates
ListVehicles
ListVehiclesInFleet

Operations

AssociateVehicleFleet 

$result = $client->associateVehicleFleet([/* ... */]);
$promise = $client->associateVehicleFleetAsync([/* ... */]);

Adds, or associates, a vehicle with a fleet.

Parameter Syntax

$result = $client->associateVehicleFleet([
    'fleetId' => '<string>', // REQUIRED
    'vehicleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
fleetId
Required: Yes
Type: string

The ID of a fleet.

vehicleName
Required: Yes
Type: string

The unique ID of the vehicle to associate with the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

BatchCreateVehicle 

$result = $client->batchCreateVehicle([/* ... */]);
$promise = $client->batchCreateVehicleAsync([/* ... */]);

Creates a group, or batch, of vehicles.

You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.

For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->batchCreateVehicle([
    'vehicles' => [ // REQUIRED
        [
            'associationBehavior' => 'CreateIotThing|ValidateIotThingExists',
            'attributes' => ['<string>', ...],
            'decoderManifestArn' => '<string>', // REQUIRED
            'modelManifestArn' => '<string>', // REQUIRED
            'stateTemplates' => [
                [
                    'identifier' => '<string>', // REQUIRED
                    'stateTemplateUpdateStrategy' => [ // REQUIRED
                        'onChange' => [
                        ],
                        'periodic' => [
                            'stateTemplateUpdateRate' => [ // REQUIRED
                                'unit' => 'MILLISECOND|SECOND|MINUTE|HOUR', // REQUIRED
                                'value' => <integer>, // REQUIRED
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'tags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'vehicleName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
vehicles
Required: Yes
Type: Array of CreateVehicleRequestItem structures

A list of information about each vehicle to create. For more information, see the API data type.

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'message' => '<string>',
            'vehicleName' => '<string>',
        ],
        // ...
    ],
    'vehicles' => [
        [
            'arn' => '<string>',
            'thingArn' => '<string>',
            'vehicleName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
errors
Type: Array of CreateVehicleError structures

A list of information about creation errors, or an empty list if there aren't any errors.

vehicles
Type: Array of CreateVehicleResponseItem structures

A list of information about a batch of created vehicles. For more information, see the API data type.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

BatchUpdateVehicle 

$result = $client->batchUpdateVehicle([/* ... */]);
$promise = $client->batchUpdateVehicleAsync([/* ... */]);

Updates a group, or batch, of vehicles.

You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.

For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->batchUpdateVehicle([
    'vehicles' => [ // REQUIRED
        [
            'attributeUpdateMode' => 'Overwrite|Merge',
            'attributes' => ['<string>', ...],
            'decoderManifestArn' => '<string>',
            'modelManifestArn' => '<string>',
            'stateTemplatesToAdd' => [
                [
                    'identifier' => '<string>', // REQUIRED
                    'stateTemplateUpdateStrategy' => [ // REQUIRED
                        'onChange' => [
                        ],
                        'periodic' => [
                            'stateTemplateUpdateRate' => [ // REQUIRED
                                'unit' => 'MILLISECOND|SECOND|MINUTE|HOUR', // REQUIRED
                                'value' => <integer>, // REQUIRED
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'stateTemplatesToRemove' => ['<string>', ...],
            'vehicleName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
vehicles
Required: Yes
Type: Array of UpdateVehicleRequestItem structures

A list of information about the vehicles to update. For more information, see the API data type.

Result Syntax

[
    'errors' => [
        [
            'code' => <integer>,
            'message' => '<string>',
            'vehicleName' => '<string>',
        ],
        // ...
    ],
    'vehicles' => [
        [
            'arn' => '<string>',
            'vehicleName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
errors
Type: Array of UpdateVehicleError structures

A list of information about errors returned while updating a batch of vehicles, or, if there aren't any errors, an empty list.

vehicles
Type: Array of UpdateVehicleResponseItem structures

A list of information about the batch of updated vehicles.

This list contains only unique IDs for the vehicles that were updated.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

CreateCampaign 

$result = $client->createCampaign([/* ... */]);
$promise = $client->createCampaignAsync([/* ... */]);

Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles.

For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->createCampaign([
    'collectionScheme' => [ // REQUIRED
        'conditionBasedCollectionScheme' => [
            'conditionLanguageVersion' => <integer>,
            'expression' => '<string>', // REQUIRED
            'minimumTriggerIntervalMs' => <integer>,
            'triggerMode' => 'ALWAYS|RISING_EDGE',
        ],
        'timeBasedCollectionScheme' => [
            'periodMs' => <integer>, // REQUIRED
        ],
    ],
    'compression' => 'OFF|SNAPPY',
    'dataDestinationConfigs' => [
        [
            'mqttTopicConfig' => [
                'executionRoleArn' => '<string>', // REQUIRED
                'mqttTopicArn' => '<string>', // REQUIRED
            ],
            's3Config' => [
                'bucketArn' => '<string>', // REQUIRED
                'dataFormat' => 'JSON|PARQUET',
                'prefix' => '<string>',
                'storageCompressionFormat' => 'NONE|GZIP',
            ],
            'timestreamConfig' => [
                'executionRoleArn' => '<string>', // REQUIRED
                'timestreamTableArn' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'dataExtraDimensions' => ['<string>', ...],
    'dataPartitions' => [
        [
            'id' => '<string>', // REQUIRED
            'storageOptions' => [ // REQUIRED
                'maximumSize' => [ // REQUIRED
                    'unit' => 'MB|GB|TB', // REQUIRED
                    'value' => <integer>, // REQUIRED
                ],
                'minimumTimeToLive' => [ // REQUIRED
                    'unit' => 'HOURS|DAYS|WEEKS', // REQUIRED
                    'value' => <integer>, // REQUIRED
                ],
                'storageLocation' => '<string>', // REQUIRED
            ],
            'uploadOptions' => [
                'conditionLanguageVersion' => <integer>,
                'expression' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'description' => '<string>',
    'diagnosticsMode' => 'OFF|SEND_ACTIVE_DTCS',
    'expiryTime' => <integer || string || DateTime>,
    'name' => '<string>', // REQUIRED
    'postTriggerCollectionDuration' => <integer>,
    'priority' => <integer>,
    'signalCatalogArn' => '<string>', // REQUIRED
    'signalsToCollect' => [
        [
            'dataPartitionId' => '<string>',
            'maxSampleCount' => <integer>,
            'minimumSamplingIntervalMs' => <integer>,
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'signalsToFetch' => [
        [
            'actions' => ['<string>', ...], // REQUIRED
            'conditionLanguageVersion' => <integer>,
            'fullyQualifiedName' => '<string>', // REQUIRED
            'signalFetchConfig' => [ // REQUIRED
                'conditionBased' => [
                    'conditionExpression' => '<string>', // REQUIRED
                    'triggerMode' => 'ALWAYS|RISING_EDGE', // REQUIRED
                ],
                'timeBased' => [
                    'executionFrequencyMs' => <integer>, // REQUIRED
                ],
            ],
        ],
        // ...
    ],
    'spoolingMode' => 'OFF|TO_DISK',
    'startTime' => <integer || string || DateTime>,
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'targetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
collectionScheme
Required: Yes
Type: CollectionScheme structure

The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

compression
Type: string

Determines whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.

Default: SNAPPY

dataDestinationConfigs
Type: Array of DataDestinationConfig structures

The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.

MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.

Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.

You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

dataExtraDimensions
Type: Array of strings

A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.

Default: An empty array

dataPartitions
Type: Array of DataPartition structures

The data partitions associated with the signals collected from the vehicle.

description
Type: string

An optional description of the campaign to help identify its purpose.

diagnosticsMode
Type: string

Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.

Default: OFF

expiryTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.

Default: 253402214400 (December 31, 9999, 00:00:00 UTC)

name
Required: Yes
Type: string

The name of the campaign to create.

postTriggerCollectionDuration
Type: long (int|float)

How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.

Default: 0

priority
Type: int

A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.

Default: 0

signalCatalogArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

signalsToCollect
Type: Array of SignalInformation structures

A list of information about signals to collect.

If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in signalsToCollect.

signalsToFetch
Type: Array of SignalFetchInformation structures

A list of information about signals to fetch.

spoolingMode
Type: string

Determines whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.

Default: OFF

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

tags
Type: Array of Tag structures

Metadata that can be used to manage the campaign.

targetArn
Required: Yes
Type: string

The ARN of the vehicle or fleet to deploy a campaign to.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Type: string

The ARN of the created campaign.

name
Type: string

The name of the created campaign.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

CreateDecoderManifest 

$result = $client->createDecoderManifest([/* ... */]);
$promise = $client->createDecoderManifestAsync([/* ... */]);

Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:

  • Every signal decoder has a unique name.

  • Each signal decoder is associated with a network interface.

  • Each network interface has a unique ID.

  • The signal decoders are specified in the model manifest.

Parameter Syntax

$result = $client->createDecoderManifest([
    'defaultForUnmappedSignals' => 'CUSTOM_DECODING',
    'description' => '<string>',
    'modelManifestArn' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'networkInterfaces' => [
        [
            'canInterface' => [
                'name' => '<string>', // REQUIRED
                'protocolName' => '<string>',
                'protocolVersion' => '<string>',
            ],
            'customDecodingInterface' => [
                'name' => '<string>', // REQUIRED
            ],
            'interfaceId' => '<string>', // REQUIRED
            'obdInterface' => [
                'dtcRequestIntervalSeconds' => <integer>,
                'hasTransmissionEcu' => true || false,
                'name' => '<string>', // REQUIRED
                'obdStandard' => '<string>',
                'pidRequestIntervalSeconds' => <integer>,
                'requestMessageId' => <integer>, // REQUIRED
                'useExtendedIds' => true || false,
            ],
            'type' => 'CAN_INTERFACE|OBD_INTERFACE|VEHICLE_MIDDLEWARE|CUSTOM_DECODING_INTERFACE', // REQUIRED
            'vehicleMiddleware' => [
                'name' => '<string>', // REQUIRED
                'protocolName' => 'ROS_2', // REQUIRED
            ],
        ],
        // ...
    ],
    'signalDecoders' => [
        [
            'canSignal' => [
                'factor' => <float>, // REQUIRED
                'isBigEndian' => true || false, // REQUIRED
                'isSigned' => true || false, // REQUIRED
                'length' => <integer>, // REQUIRED
                'messageId' => <integer>, // REQUIRED
                'name' => '<string>',
                'offset' => <float>, // REQUIRED
                'startBit' => <integer>, // REQUIRED
            ],
            'customDecodingSignal' => [
                'id' => '<string>', // REQUIRED
            ],
            'fullyQualifiedName' => '<string>', // REQUIRED
            'interfaceId' => '<string>', // REQUIRED
            'messageSignal' => [
                'structuredMessage' => [ // REQUIRED
                    'primitiveMessageDefinition' => [
                        'ros2PrimitiveMessageDefinition' => [
                            'offset' => <float>,
                            'primitiveType' => 'BOOL|BYTE|CHAR|FLOAT32|FLOAT64|INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|STRING|WSTRING', // REQUIRED
                            'scaling' => <float>,
                            'upperBound' => <integer>,
                        ],
                    ],
                    'structuredMessageDefinition' => [
                        [
                            'dataType' => [...], // REQUIRED, RECURSIVE
                            'fieldName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'structuredMessageListDefinition' => [
                        'capacity' => <integer>,
                        'listType' => 'FIXED_CAPACITY|DYNAMIC_UNBOUNDED_CAPACITY|DYNAMIC_BOUNDED_CAPACITY', // REQUIRED
                        'memberType' => [...], // REQUIRED, RECURSIVE
                        'name' => '<string>', // REQUIRED
                    ],
                ],
                'topicName' => '<string>', // REQUIRED
            ],
            'obdSignal' => [
                'bitMaskLength' => <integer>,
                'bitRightShift' => <integer>,
                'byteLength' => <integer>, // REQUIRED
                'offset' => <float>, // REQUIRED
                'pid' => <integer>, // REQUIRED
                'pidResponseLength' => <integer>, // REQUIRED
                'scaling' => <float>, // REQUIRED
                'serviceMode' => <integer>, // REQUIRED
                'startByte' => <integer>, // REQUIRED
            ],
            'type' => 'CAN_SIGNAL|OBD_SIGNAL|MESSAGE_SIGNAL|CUSTOM_DECODING_SIGNAL', // REQUIRED
        ],
        // ...
    ],
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
defaultForUnmappedSignals
Type: string

Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

description
Type: string

A brief description of the decoder manifest.

modelManifestArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the vehicle model (model manifest).

name
Required: Yes
Type: string

The unique name of the decoder manifest to create.

networkInterfaces
Type: Array of NetworkInterface structures

A list of information about available network interfaces.

signalDecoders
Type: Array of SignalDecoder structures

A list of information about signal decoders.

tags
Type: Array of Tag structures

Metadata that can be used to manage the decoder manifest.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the created decoder manifest.

name
Required: Yes
Type: string

The name of the created decoder manifest.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

DecoderManifestValidationException:

The request couldn't be completed because it contains signal decoders with one or more validation errors.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

CreateFleet 

$result = $client->createFleet([/* ... */]);
$promise = $client->createFleetAsync([/* ... */]);

Creates a fleet that represents a group of vehicles.

You must create both a signal catalog and vehicles before you can create a fleet.

For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->createFleet([
    'description' => '<string>',
    'fleetId' => '<string>', // REQUIRED
    'signalCatalogArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
Type: string

A brief description of the fleet to create.

fleetId
Required: Yes
Type: string

The unique ID of the fleet to create.

signalCatalogArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of a signal catalog.

tags
Type: Array of Tag structures

Metadata that can be used to manage the fleet.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the created fleet.

id
Required: Yes
Type: string

The ID of the created fleet.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

CreateModelManifest 

$result = $client->createModelManifest([/* ... */]);
$promise = $client->createModelManifestAsync([/* ... */]);

Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).

For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->createModelManifest([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'nodes' => ['<string>', ...], // REQUIRED
    'signalCatalogArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
Type: string

A brief description of the vehicle model.

name
Required: Yes
Type: string

The name of the vehicle model to create.

nodes
Required: Yes
Type: Array of strings

A list of nodes, which are a general abstraction of signals.

signalCatalogArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of a signal catalog.

tags
Type: Array of Tag structures

Metadata that can be used to manage the vehicle model.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the created vehicle model.

name
Required: Yes
Type: string

The name of the created vehicle model.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InvalidSignalsException:

The request couldn't be completed because it contains signals that aren't valid.

AccessDeniedException:

You don't have sufficient permission to perform this action.

CreateSignalCatalog 

$result = $client->createSignalCatalog([/* ... */]);
$promise = $client->createSignalCatalogAsync([/* ... */]);

Creates a collection of standardized signals that can be reused to create vehicle models.

Parameter Syntax

$result = $client->createSignalCatalog([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'nodes' => [
        [
            'actuator' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'attribute' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'defaultValue' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'max' => <float>,
                'min' => <float>,
                'unit' => '<string>',
            ],
            'branch' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
            ],
            'property' => [
                'comment' => '<string>',
                'dataEncoding' => 'BINARY|TYPED',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'structFullyQualifiedName' => '<string>',
            ],
            'sensor' => [
                'allowedValues' => ['<string>', ...],
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'struct' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
Type: string

A brief description of the signal catalog.

name
Required: Yes
Type: string

The name of the signal catalog to create.

nodes
Type: Array of Node structures

A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.

tags
Type: Array of Tag structures

Metadata that can be used to manage the signal catalog.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the created signal catalog.

name
Required: Yes
Type: string

The name of the created signal catalog.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

InvalidNodeException:

The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InvalidSignalsException:

The request couldn't be completed because it contains signals that aren't valid.

AccessDeniedException:

You don't have sufficient permission to perform this action.

CreateStateTemplate 

$result = $client->createStateTemplate([/* ... */]);
$promise = $client->createStateTemplateAsync([/* ... */]);

Creates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->createStateTemplate([
    'dataExtraDimensions' => ['<string>', ...],
    'description' => '<string>',
    'metadataExtraDimensions' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
    'signalCatalogArn' => '<string>', // REQUIRED
    'stateTemplateProperties' => ['<string>', ...], // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
dataExtraDimensions
Type: Array of strings

A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field.

description
Type: string

A brief description of the state template.

metadataExtraDimensions
Type: Array of strings

A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.

Default: An empty array

name
Required: Yes
Type: string

The name of the state template.

signalCatalogArn
Required: Yes
Type: string

The ARN of the signal catalog associated with the state template.

stateTemplateProperties
Required: Yes
Type: Array of strings

A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.

tags
Type: Array of Tag structures

Metadata that can be used to manage the state template.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the state template.

id
Type: string

The unique ID of the state template.

name
Type: string

The name of the state template.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InvalidSignalsException:

The request couldn't be completed because it contains signals that aren't valid.

AccessDeniedException:

You don't have sufficient permission to perform this action.

CreateVehicle 

$result = $client->createVehicle([/* ... */]);
$promise = $client->createVehicleAsync([/* ... */]);

Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.

If you have an existing Amazon Web Services IoT thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.

For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->createVehicle([
    'associationBehavior' => 'CreateIotThing|ValidateIotThingExists',
    'attributes' => ['<string>', ...],
    'decoderManifestArn' => '<string>', // REQUIRED
    'modelManifestArn' => '<string>', // REQUIRED
    'stateTemplates' => [
        [
            'identifier' => '<string>', // REQUIRED
            'stateTemplateUpdateStrategy' => [ // REQUIRED
                'onChange' => [
                ],
                'periodic' => [
                    'stateTemplateUpdateRate' => [ // REQUIRED
                        'unit' => 'MILLISECOND|SECOND|MINUTE|HOUR', // REQUIRED
                        'value' => <integer>, // REQUIRED
                    ],
                ],
            ],
        ],
        // ...
    ],
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'vehicleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
associationBehavior
Type: string

An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.

Default:

attributes
Type: Associative array of custom strings keys (attributeName) to strings

Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"

To use attributes with Campaigns or State Templates, you must include them using the request parameters dataExtraDimensions and/or metadataExtraDimensions (for state templates only) when creating your campaign/state template.

decoderManifestArn
Required: Yes
Type: string

The ARN of a decoder manifest.

modelManifestArn
Required: Yes
Type: string

The Amazon Resource Name ARN of a vehicle model.

stateTemplates
Type: Array of StateTemplateAssociation structures

Associate state templates with the vehicle. You can monitor the last known state of the vehicle in near real time.

tags
Type: Array of Tag structures

Metadata that can be used to manage the vehicle.

vehicleName
Required: Yes
Type: string

The unique ID of the vehicle to create.

Result Syntax

[
    'arn' => '<string>',
    'thingArn' => '<string>',
    'vehicleName' => '<string>',
]

Result Details

Members
arn
Type: string

The ARN of the created vehicle.

thingArn
Type: string

The ARN of a created or validated Amazon Web Services IoT thing.

vehicleName
Type: string

The unique ID of the created vehicle.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

DeleteCampaign 

$result = $client->deleteCampaign([/* ... */]);
$promise = $client->deleteCampaignAsync([/* ... */]);

Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.

Parameter Syntax

$result = $client->deleteCampaign([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the campaign to delete.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the deleted campaign.

The ARN isn’t returned if a campaign doesn’t exist.

name
Type: string

The name of the deleted campaign.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

DeleteDecoderManifest 

$result = $client->deleteDecoderManifest([/* ... */]);
$promise = $client->deleteDecoderManifestAsync([/* ... */]);

Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.

Parameter Syntax

$result = $client->deleteDecoderManifest([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the decoder manifest to delete.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the deleted decoder manifest.

name
Required: Yes
Type: string

The name of the deleted decoder manifest.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

DeleteFleet 

$result = $client->deleteFleet([/* ... */]);
$promise = $client->deleteFleetAsync([/* ... */]);

Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->deleteFleet([
    'fleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
fleetId
Required: Yes
Type: string

The ID of the fleet to delete.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the deleted fleet.

id
Type: string

The ID of the deleted fleet.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

DeleteModelManifest 

$result = $client->deleteModelManifest([/* ... */]);
$promise = $client->deleteModelManifestAsync([/* ... */]);

Deletes a vehicle model (model manifest).

Parameter Syntax

$result = $client->deleteModelManifest([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the model manifest to delete.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the deleted model manifest.

name
Required: Yes
Type: string

The name of the deleted model manifest.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

DeleteSignalCatalog 

$result = $client->deleteSignalCatalog([/* ... */]);
$promise = $client->deleteSignalCatalogAsync([/* ... */]);

Deletes a signal catalog.

Parameter Syntax

$result = $client->deleteSignalCatalog([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the signal catalog to delete.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the deleted signal catalog.

name
Required: Yes
Type: string

The name of the deleted signal catalog.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

DeleteStateTemplate 

$result = $client->deleteStateTemplate([/* ... */]);
$promise = $client->deleteStateTemplateAsync([/* ... */]);

Deletes a state template.

Parameter Syntax

$result = $client->deleteStateTemplate([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
identifier
Required: Yes
Type: string

A unique, service-generated identifier.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the state template.

id
Type: string

The unique ID of the state template.

name
Type: string

The name of the state template.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

DeleteVehicle 

$result = $client->deleteVehicle([/* ... */]);
$promise = $client->deleteVehicleAsync([/* ... */]);

Deletes a vehicle and removes it from any campaigns.

Parameter Syntax

$result = $client->deleteVehicle([
    'vehicleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
vehicleName
Required: Yes
Type: string

The ID of the vehicle to delete.

Result Syntax

[
    'arn' => '<string>',
    'vehicleName' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the deleted vehicle.

vehicleName
Required: Yes
Type: string

The ID of the deleted vehicle.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

DisassociateVehicleFleet 

$result = $client->disassociateVehicleFleet([/* ... */]);
$promise = $client->disassociateVehicleFleetAsync([/* ... */]);

Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.

Parameter Syntax

$result = $client->disassociateVehicleFleet([
    'fleetId' => '<string>', // REQUIRED
    'vehicleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
fleetId
Required: Yes
Type: string

The unique ID of a fleet.

vehicleName
Required: Yes
Type: string

The unique ID of the vehicle to disassociate from the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetCampaign 

$result = $client->getCampaign([/* ... */]);
$promise = $client->getCampaignAsync([/* ... */]);

Retrieves information about a campaign.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->getCampaign([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the campaign to retrieve information about.

Result Syntax

[
    'arn' => '<string>',
    'collectionScheme' => [
        'conditionBasedCollectionScheme' => [
            'conditionLanguageVersion' => <integer>,
            'expression' => '<string>',
            'minimumTriggerIntervalMs' => <integer>,
            'triggerMode' => 'ALWAYS|RISING_EDGE',
        ],
        'timeBasedCollectionScheme' => [
            'periodMs' => <integer>,
        ],
    ],
    'compression' => 'OFF|SNAPPY',
    'creationTime' => <DateTime>,
    'dataDestinationConfigs' => [
        [
            'mqttTopicConfig' => [
                'executionRoleArn' => '<string>',
                'mqttTopicArn' => '<string>',
            ],
            's3Config' => [
                'bucketArn' => '<string>',
                'dataFormat' => 'JSON|PARQUET',
                'prefix' => '<string>',
                'storageCompressionFormat' => 'NONE|GZIP',
            ],
            'timestreamConfig' => [
                'executionRoleArn' => '<string>',
                'timestreamTableArn' => '<string>',
            ],
        ],
        // ...
    ],
    'dataExtraDimensions' => ['<string>', ...],
    'dataPartitions' => [
        [
            'id' => '<string>',
            'storageOptions' => [
                'maximumSize' => [
                    'unit' => 'MB|GB|TB',
                    'value' => <integer>,
                ],
                'minimumTimeToLive' => [
                    'unit' => 'HOURS|DAYS|WEEKS',
                    'value' => <integer>,
                ],
                'storageLocation' => '<string>',
            ],
            'uploadOptions' => [
                'conditionLanguageVersion' => <integer>,
                'expression' => '<string>',
            ],
        ],
        // ...
    ],
    'description' => '<string>',
    'diagnosticsMode' => 'OFF|SEND_ACTIVE_DTCS',
    'expiryTime' => <DateTime>,
    'lastModificationTime' => <DateTime>,
    'name' => '<string>',
    'postTriggerCollectionDuration' => <integer>,
    'priority' => <integer>,
    'signalCatalogArn' => '<string>',
    'signalsToCollect' => [
        [
            'dataPartitionId' => '<string>',
            'maxSampleCount' => <integer>,
            'minimumSamplingIntervalMs' => <integer>,
            'name' => '<string>',
        ],
        // ...
    ],
    'signalsToFetch' => [
        [
            'actions' => ['<string>', ...],
            'conditionLanguageVersion' => <integer>,
            'fullyQualifiedName' => '<string>',
            'signalFetchConfig' => [
                'conditionBased' => [
                    'conditionExpression' => '<string>',
                    'triggerMode' => 'ALWAYS|RISING_EDGE',
                ],
                'timeBased' => [
                    'executionFrequencyMs' => <integer>,
                ],
            ],
        ],
        // ...
    ],
    'spoolingMode' => 'OFF|TO_DISK',
    'startTime' => <DateTime>,
    'status' => 'CREATING|WAITING_FOR_APPROVAL|RUNNING|SUSPENDED',
    'targetArn' => '<string>',
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the campaign.

collectionScheme
Type: CollectionScheme structure

Information about the data collection scheme associated with the campaign.

compression
Type: string

Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

dataDestinationConfigs
Type: Array of DataDestinationConfig structures

The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.

MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.

Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.

You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

dataExtraDimensions
Type: Array of strings

A list of vehicle attributes associated with the campaign.

dataPartitions
Type: Array of DataPartition structures

The data partitions associated with the signals collected from the vehicle.

description
Type: string

The description of the campaign.

diagnosticsMode
Type: string

Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

expiryTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.

lastModificationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time the campaign was modified.

name
Type: string

The name of the campaign.

postTriggerCollectionDuration
Type: long (int|float)

How long (in seconds) to collect raw data after a triggering event initiates the collection.

priority
Type: int

A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.

signalCatalogArn
Type: string

The ARN of a signal catalog.

signalsToCollect
Type: Array of SignalInformation structures

Information about a list of signals to collect data on.

signalsToFetch
Type: Array of SignalFetchInformation structures

Information about a list of signals to fetch data from.

spoolingMode
Type: string

Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time, in milliseconds, to deliver a campaign after it was approved.

status
Type: string

The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

targetArn
Type: string

The ARN of the vehicle or the fleet targeted by the campaign.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetDecoderManifest 

$result = $client->getDecoderManifest([/* ... */]);
$promise = $client->getDecoderManifestAsync([/* ... */]);

Retrieves information about a created decoder manifest.

Parameter Syntax

$result = $client->getDecoderManifest([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the decoder manifest to retrieve information about.

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'lastModificationTime' => <DateTime>,
    'message' => '<string>',
    'modelManifestArn' => '<string>',
    'name' => '<string>',
    'status' => 'ACTIVE|DRAFT|INVALID|VALIDATING',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the decoder manifest.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).

description
Type: string

A brief description of the decoder manifest.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

message
Type: string

The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.

modelManifestArn
Type: string

The ARN of a vehicle model (model manifest) associated with the decoder manifest.

name
Required: Yes
Type: string

The name of the decoder manifest.

status
Type: string

The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetEncryptionConfiguration 

$result = $client->getEncryptionConfiguration([/* ... */]);
$promise = $client->getEncryptionConfigurationAsync([/* ... */]);

Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.

Parameter Syntax

$result = $client->getEncryptionConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'creationTime' => <DateTime>,
    'encryptionStatus' => 'PENDING|SUCCESS|FAILURE',
    'encryptionType' => 'KMS_BASED_ENCRYPTION|FLEETWISE_DEFAULT_ENCRYPTION',
    'errorMessage' => '<string>',
    'kmsKeyId' => '<string>',
    'lastModificationTime' => <DateTime>,
]

Result Details

Members
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).

encryptionStatus
Required: Yes
Type: string

The encryption status.

encryptionType
Required: Yes
Type: string

The type of encryption. Set to KMS_BASED_ENCRYPTION to use a KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.

errorMessage
Type: string

The error message that describes why encryption settings couldn't be configured, if applicable.

kmsKeyId
Type: string

The ID of the KMS key that is used for encryption.

lastModificationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetFleet 

$result = $client->getFleet([/* ... */]);
$promise = $client->getFleetAsync([/* ... */]);

Retrieves information about a fleet.

Parameter Syntax

$result = $client->getFleet([
    'fleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
fleetId
Required: Yes
Type: string

The ID of the fleet to retrieve information about.

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'lastModificationTime' => <DateTime>,
    'signalCatalogArn' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the fleet.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the fleet was created in seconds since epoch (January 1, 1970 at midnight UTC time).

description
Type: string

A brief description of the fleet.

id
Required: Yes
Type: string

The ID of the fleet.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the fleet was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

signalCatalogArn
Required: Yes
Type: string

The ARN of a signal catalog associated with the fleet.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetLoggingOptions 

$result = $client->getLoggingOptions([/* ... */]);
$promise = $client->getLoggingOptionsAsync([/* ... */]);

Retrieves the logging options.

Parameter Syntax

$result = $client->getLoggingOptions([
]);

Parameter Details

Members

Result Syntax

[
    'cloudWatchLogDelivery' => [
        'logGroupName' => '<string>',
        'logType' => 'OFF|ERROR',
    ],
]

Result Details

Members
cloudWatchLogDelivery
Required: Yes
Type: CloudWatchLogDeliveryOptions structure

Returns information about log delivery to Amazon CloudWatch Logs.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetModelManifest 

$result = $client->getModelManifest([/* ... */]);
$promise = $client->getModelManifestAsync([/* ... */]);

Retrieves information about a vehicle model (model manifest).

Parameter Syntax

$result = $client->getModelManifest([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the vehicle model to retrieve information about.

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'lastModificationTime' => <DateTime>,
    'name' => '<string>',
    'signalCatalogArn' => '<string>',
    'status' => 'ACTIVE|DRAFT|INVALID|VALIDATING',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the vehicle model.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).

description
Type: string

A brief description of the vehicle model.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time the vehicle model was modified.

name
Required: Yes
Type: string

The name of the vehicle model.

signalCatalogArn
Type: string

The ARN of the signal catalog associated with the vehicle model.

status
Type: string

The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. You can edit the vehicle model if the status is marked DRAFT.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetRegisterAccountStatus 

$result = $client->getRegisterAccountStatus([/* ... */]);
$promise = $client->getRegisterAccountStatusAsync([/* ... */]);

Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.

For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.

This API operation doesn't require input parameters.

Parameter Syntax

$result = $client->getRegisterAccountStatus([
]);

Parameter Details

Members

Result Syntax

[
    'accountStatus' => 'REGISTRATION_PENDING|REGISTRATION_SUCCESS|REGISTRATION_FAILURE',
    'creationTime' => <DateTime>,
    'customerAccountId' => '<string>',
    'iamRegistrationResponse' => [
        'errorMessage' => '<string>',
        'registrationStatus' => 'REGISTRATION_PENDING|REGISTRATION_SUCCESS|REGISTRATION_FAILURE',
        'roleArn' => '<string>',
    ],
    'lastModificationTime' => <DateTime>,
    'timestreamRegistrationResponse' => [
        'errorMessage' => '<string>',
        'registrationStatus' => 'REGISTRATION_PENDING|REGISTRATION_SUCCESS|REGISTRATION_FAILURE',
        'timestreamDatabaseArn' => '<string>',
        'timestreamDatabaseName' => '<string>',
        'timestreamTableArn' => '<string>',
        'timestreamTableName' => '<string>',
    ],
]

Result Details

Members
accountStatus
Required: Yes
Type: string

The status of registering your account and resources. The status can be one of:

  • REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully registered.

  • REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is processing the registration request. This process takes approximately five minutes to complete.

  • REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise can't register the AWS resource. Try again later.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).

customerAccountId
Required: Yes
Type: string

The unique ID of the Amazon Web Services account, provided at account creation.

iamRegistrationResponse
Required: Yes
Type: IamRegistrationResponse structure

Information about the registered IAM resources or errors, if any.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

timestreamRegistrationResponse
Type: TimestreamRegistrationResponse structure

Information about the registered Amazon Timestream resources or errors, if any.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetSignalCatalog 

$result = $client->getSignalCatalog([/* ... */]);
$promise = $client->getSignalCatalogAsync([/* ... */]);

Retrieves information about a signal catalog.

Parameter Syntax

$result = $client->getSignalCatalog([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the signal catalog to retrieve information about.

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'lastModificationTime' => <DateTime>,
    'name' => '<string>',
    'nodeCounts' => [
        'totalActuators' => <integer>,
        'totalAttributes' => <integer>,
        'totalBranches' => <integer>,
        'totalNodes' => <integer>,
        'totalProperties' => <integer>,
        'totalSensors' => <integer>,
        'totalStructs' => <integer>,
    ],
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the signal catalog.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).

description
Type: string

A brief description of the signal catalog.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time the signal catalog was modified.

name
Required: Yes
Type: string

The name of the signal catalog.

nodeCounts
Type: NodeCounts structure

The total number of network nodes specified in a signal catalog.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetStateTemplate 

$result = $client->getStateTemplate([/* ... */]);
$promise = $client->getStateTemplateAsync([/* ... */]);

Retrieves information about a state template.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->getStateTemplate([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
identifier
Required: Yes
Type: string

A unique, service-generated identifier.

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'dataExtraDimensions' => ['<string>', ...],
    'description' => '<string>',
    'id' => '<string>',
    'lastModificationTime' => <DateTime>,
    'metadataExtraDimensions' => ['<string>', ...],
    'name' => '<string>',
    'signalCatalogArn' => '<string>',
    'stateTemplateProperties' => ['<string>', ...],
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the state template.

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).

dataExtraDimensions
Type: Array of strings

A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

Default: An empty array

description
Type: string

A brief description of the state template.

id
Type: string

The unique ID of the state template.

lastModificationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

metadataExtraDimensions
Type: Array of strings

A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.

Default: An empty array

name
Type: string

The name of the state template.

signalCatalogArn
Type: string

The ARN of the signal catalog associated with the state template.

stateTemplateProperties
Type: Array of strings

A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetVehicle 

$result = $client->getVehicle([/* ... */]);
$promise = $client->getVehicleAsync([/* ... */]);

Retrieves information about a vehicle.

Parameter Syntax

$result = $client->getVehicle([
    'vehicleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
vehicleName
Required: Yes
Type: string

The ID of the vehicle to retrieve information about.

Result Syntax

[
    'arn' => '<string>',
    'attributes' => ['<string>', ...],
    'creationTime' => <DateTime>,
    'decoderManifestArn' => '<string>',
    'lastModificationTime' => <DateTime>,
    'modelManifestArn' => '<string>',
    'stateTemplates' => [
        [
            'identifier' => '<string>',
            'stateTemplateUpdateStrategy' => [
                'onChange' => [
                ],
                'periodic' => [
                    'stateTemplateUpdateRate' => [
                        'unit' => 'MILLISECOND|SECOND|MINUTE|HOUR',
                        'value' => <integer>,
                    ],
                ],
            ],
        ],
        // ...
    ],
    'vehicleName' => '<string>',
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the vehicle to retrieve information about.

attributes
Type: Associative array of custom strings keys (attributeName) to strings

Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).

decoderManifestArn
Type: string

The ARN of a decoder manifest associated with the vehicle.

lastModificationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

modelManifestArn
Type: string

The ARN of a vehicle model (model manifest) associated with the vehicle.

stateTemplates
Type: Array of StateTemplateAssociation structures

State templates associated with the vehicle.

vehicleName
Type: string

The ID of the vehicle.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

GetVehicleStatus 

$result = $client->getVehicleStatus([/* ... */]);
$promise = $client->getVehicleStatusAsync([/* ... */]);

Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.

Parameter Syntax

$result = $client->getVehicleStatus([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'vehicleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive. This parameter is only supported for resources of type CAMPAIGN.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. This parameter is only supported for resources of type CAMPAIGN.

vehicleName
Required: Yes
Type: string

The ID of the vehicle to retrieve information about.

Result Syntax

[
    'campaigns' => [
        [
            'campaignName' => '<string>',
            'status' => 'CREATED|READY|HEALTHY|SUSPENDED|DELETING',
            'vehicleName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
campaigns
Type: Array of VehicleStatus structures

Lists information about the state of the vehicle with deployed campaigns.

nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ImportDecoderManifest 

$result = $client->importDecoderManifest([/* ... */]);
$promise = $client->importDecoderManifestAsync([/* ... */]);

Creates a decoder manifest using your existing CAN DBC file from your local device.

The CAN signal name must be unique and not repeated across CAN message definitions in a .dbc file.

Parameter Syntax

$result = $client->importDecoderManifest([
    'name' => '<string>', // REQUIRED
    'networkFileDefinitions' => [ // REQUIRED
        [
            'canDbc' => [
                'canDbcFiles' => [<string || resource || Psr\Http\Message\StreamInterface>, ...], // REQUIRED
                'networkInterface' => '<string>', // REQUIRED
                'signalsMap' => ['<string>', ...],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the decoder manifest to import.

networkFileDefinitions
Required: Yes
Type: Array of NetworkFileDefinition structures

The file to load into an Amazon Web Services account.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the decoder manifest that was imported.

name
Required: Yes
Type: string

The name of the imported decoder manifest.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

DecoderManifestValidationException:

The request couldn't be completed because it contains signal decoders with one or more validation errors.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InvalidSignalsException:

The request couldn't be completed because it contains signals that aren't valid.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ImportSignalCatalog 

$result = $client->importSignalCatalog([/* ... */]);
$promise = $client->importSignalCatalogAsync([/* ... */]);

Creates a signal catalog using your existing VSS formatted content from your local device.

Parameter Syntax

$result = $client->importSignalCatalog([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'vss' => [
        'vssJson' => '<string>',
    ],
]);

Parameter Details

Members
description
Type: string

A brief description of the signal catalog.

name
Required: Yes
Type: string

The name of the signal catalog to import.

tags
Type: Array of Tag structures

Metadata that can be used to manage the signal catalog.

vss
Type: FormattedVss structure

The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the imported signal catalog.

name
Required: Yes
Type: string

The name of the imported signal catalog.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InvalidSignalsException:

The request couldn't be completed because it contains signals that aren't valid.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListCampaigns 

$result = $client->listCampaigns([/* ... */]);
$promise = $client->listCampaignsAsync([/* ... */]);

Lists information about created campaigns.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listCampaigns([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

status
Type: string

An optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

Result Syntax

[
    'campaignSummaries' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'lastModificationTime' => <DateTime>,
            'name' => '<string>',
            'signalCatalogArn' => '<string>',
            'status' => 'CREATING|WAITING_FOR_APPROVAL|RUNNING|SUSPENDED',
            'targetArn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
campaignSummaries
Type: Array of CampaignSummary structures

A summary of information about each campaign.

nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListDecoderManifestNetworkInterfaces 

$result = $client->listDecoderManifestNetworkInterfaces([/* ... */]);
$promise = $client->listDecoderManifestNetworkInterfacesAsync([/* ... */]);

Lists the network interfaces specified in a decoder manifest.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listDecoderManifestNetworkInterfaces([
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

name
Required: Yes
Type: string

The name of the decoder manifest to list information about.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Result Syntax

[
    'networkInterfaces' => [
        [
            'canInterface' => [
                'name' => '<string>',
                'protocolName' => '<string>',
                'protocolVersion' => '<string>',
            ],
            'customDecodingInterface' => [
                'name' => '<string>',
            ],
            'interfaceId' => '<string>',
            'obdInterface' => [
                'dtcRequestIntervalSeconds' => <integer>,
                'hasTransmissionEcu' => true || false,
                'name' => '<string>',
                'obdStandard' => '<string>',
                'pidRequestIntervalSeconds' => <integer>,
                'requestMessageId' => <integer>,
                'useExtendedIds' => true || false,
            ],
            'type' => 'CAN_INTERFACE|OBD_INTERFACE|VEHICLE_MIDDLEWARE|CUSTOM_DECODING_INTERFACE',
            'vehicleMiddleware' => [
                'name' => '<string>',
                'protocolName' => 'ROS_2',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
networkInterfaces
Type: Array of NetworkInterface structures

A list of information about network interfaces.

nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListDecoderManifestSignals 

$result = $client->listDecoderManifestSignals([/* ... */]);
$promise = $client->listDecoderManifestSignalsAsync([/* ... */]);

A list of information about signal decoders specified in a decoder manifest.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listDecoderManifestSignals([
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

name
Required: Yes
Type: string

The name of the decoder manifest to list information about.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Result Syntax

[
    'nextToken' => '<string>',
    'signalDecoders' => [
        [
            'canSignal' => [
                'factor' => <float>,
                'isBigEndian' => true || false,
                'isSigned' => true || false,
                'length' => <integer>,
                'messageId' => <integer>,
                'name' => '<string>',
                'offset' => <float>,
                'startBit' => <integer>,
            ],
            'customDecodingSignal' => [
                'id' => '<string>',
            ],
            'fullyQualifiedName' => '<string>',
            'interfaceId' => '<string>',
            'messageSignal' => [
                'structuredMessage' => [
                    'primitiveMessageDefinition' => [
                        'ros2PrimitiveMessageDefinition' => [
                            'offset' => <float>,
                            'primitiveType' => 'BOOL|BYTE|CHAR|FLOAT32|FLOAT64|INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|STRING|WSTRING',
                            'scaling' => <float>,
                            'upperBound' => <integer>,
                        ],
                    ],
                    'structuredMessageDefinition' => [
                        [
                            'dataType' => [...], // RECURSIVE
                            'fieldName' => '<string>',
                        ],
                        // ...
                    ],
                    'structuredMessageListDefinition' => [
                        'capacity' => <integer>,
                        'listType' => 'FIXED_CAPACITY|DYNAMIC_UNBOUNDED_CAPACITY|DYNAMIC_BOUNDED_CAPACITY',
                        'memberType' => [...], // RECURSIVE
                        'name' => '<string>',
                    ],
                ],
                'topicName' => '<string>',
            ],
            'obdSignal' => [
                'bitMaskLength' => <integer>,
                'bitRightShift' => <integer>,
                'byteLength' => <integer>,
                'offset' => <float>,
                'pid' => <integer>,
                'pidResponseLength' => <integer>,
                'scaling' => <float>,
                'serviceMode' => <integer>,
                'startByte' => <integer>,
            ],
            'type' => 'CAN_SIGNAL|OBD_SIGNAL|MESSAGE_SIGNAL|CUSTOM_DECODING_SIGNAL',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

signalDecoders
Type: Array of SignalDecoder structures

Information about a list of signals to decode.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListDecoderManifests 

$result = $client->listDecoderManifests([/* ... */]);
$promise = $client->listDecoderManifestsAsync([/* ... */]);

Lists decoder manifests.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listDecoderManifests([
    'maxResults' => <integer>,
    'modelManifestArn' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

modelManifestArn
Type: string

The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'lastModificationTime' => <DateTime>,
            'message' => '<string>',
            'modelManifestArn' => '<string>',
            'name' => '<string>',
            'status' => 'ACTIVE|DRAFT|INVALID|VALIDATING',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

summaries
Type: Array of DecoderManifestSummary structures

A list of information about each decoder manifest.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListFleets 

$result = $client->listFleets([/* ... */]);
$promise = $client->listFleetsAsync([/* ... */]);

Retrieves information for each created fleet in an Amazon Web Services account.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listFleets([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Result Syntax

[
    'fleetSummaries' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'lastModificationTime' => <DateTime>,
            'signalCatalogArn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
fleetSummaries
Type: Array of FleetSummary structures

A list of information for each fleet.

nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListFleetsForVehicle 

$result = $client->listFleetsForVehicle([/* ... */]);
$promise = $client->listFleetsForVehicleAsync([/* ... */]);

Retrieves a list of IDs for all fleets that the vehicle is associated with.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listFleetsForVehicle([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'vehicleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

vehicleName
Required: Yes
Type: string

The ID of the vehicle to retrieve information about.

Result Syntax

[
    'fleets' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Members
fleets
Type: Array of strings

A list of fleet IDs that the vehicle is associated with.

nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListModelManifestNodes 

$result = $client->listModelManifestNodes([/* ... */]);
$promise = $client->listModelManifestNodesAsync([/* ... */]);

Lists information about nodes specified in a vehicle model (model manifest).

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listModelManifestNodes([
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

name
Required: Yes
Type: string

The name of the vehicle model to list information about.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Result Syntax

[
    'nextToken' => '<string>',
    'nodes' => [
        [
            'actuator' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'attribute' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY',
                'defaultValue' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
                'max' => <float>,
                'min' => <float>,
                'unit' => '<string>',
            ],
            'branch' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
            ],
            'property' => [
                'comment' => '<string>',
                'dataEncoding' => 'BINARY|TYPED',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
                'structFullyQualifiedName' => '<string>',
            ],
            'sensor' => [
                'allowedValues' => ['<string>', ...],
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'struct' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

nodes
Type: Array of Node structures

A list of information about nodes.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListModelManifests 

$result = $client->listModelManifests([/* ... */]);
$promise = $client->listModelManifestsAsync([/* ... */]);

Retrieves a list of vehicle models (model manifests).

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listModelManifests([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'signalCatalogArn' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

signalCatalogArn
Type: string

The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'lastModificationTime' => <DateTime>,
            'name' => '<string>',
            'signalCatalogArn' => '<string>',
            'status' => 'ACTIVE|DRAFT|INVALID|VALIDATING',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

summaries
Type: Array of ModelManifestSummary structures

A list of information about vehicle models.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListSignalCatalogNodes 

$result = $client->listSignalCatalogNodes([/* ... */]);
$promise = $client->listSignalCatalogNodesAsync([/* ... */]);

Lists of information about the signals (nodes) specified in a signal catalog.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listSignalCatalogNodes([
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'signalNodeType' => 'SENSOR|ACTUATOR|ATTRIBUTE|BRANCH|CUSTOM_STRUCT|CUSTOM_PROPERTY',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

name
Required: Yes
Type: string

The name of the signal catalog to list information about.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

signalNodeType
Type: string

The type of node in the signal catalog.

Result Syntax

[
    'nextToken' => '<string>',
    'nodes' => [
        [
            'actuator' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'attribute' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY',
                'defaultValue' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
                'max' => <float>,
                'min' => <float>,
                'unit' => '<string>',
            ],
            'branch' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
            ],
            'property' => [
                'comment' => '<string>',
                'dataEncoding' => 'BINARY|TYPED',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
                'structFullyQualifiedName' => '<string>',
            ],
            'sensor' => [
                'allowedValues' => ['<string>', ...],
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'struct' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

nodes
Type: Array of Node structures

A list of information about nodes.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListSignalCatalogs 

$result = $client->listSignalCatalogs([/* ... */]);
$promise = $client->listSignalCatalogsAsync([/* ... */]);

Lists all the created signal catalogs in an Amazon Web Services account.

You can use to list information about each signal (node) specified in a signal catalog.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listSignalCatalogs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'lastModificationTime' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

summaries
Type: Array of SignalCatalogSummary structures

A list of information about each signal catalog.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListStateTemplates 

$result = $client->listStateTemplates([/* ... */]);
$promise = $client->listStateTemplatesAsync([/* ... */]);

Lists information about created state templates.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->listStateTemplates([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'lastModificationTime' => <DateTime>,
            'name' => '<string>',
            'signalCatalogArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

summaries
Type: Array of StateTemplateSummary structures

A list of information about each state template.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags (metadata) you have assigned to the resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the resource.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

The list of tags assigned to the resource.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListVehicles 

$result = $client->listVehicles([/* ... */]);
$promise = $client->listVehiclesAsync([/* ... */]);

Retrieves a list of summaries of created vehicles.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listVehicles([
    'attributeNames' => ['<string>', ...],
    'attributeValues' => ['<string>', ...],
    'maxResults' => <integer>,
    'modelManifestArn' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members
attributeNames
Type: Array of strings

The fully qualified names of the attributes. You can use this optional parameter to list the vehicles containing all the attributes in the request. For example, attributeNames could be "Vehicle.Body.Engine.Type, Vehicle.Color" and the corresponding attributeValues could be "1.3 L R2, Blue" . In this case, the API will filter vehicles with an attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of "Blue". A request must contain unique values for the attributeNames filter and the matching number of attributeValues filters to return the subset of vehicles that match the attributes filter condition.

attributeValues
Type: Array of strings

Static information about a vehicle attribute value in string format. You can use this optional parameter in conjunction with attributeNames to list the vehicles containing all the attributeValues corresponding to the attributeNames filter. For example, attributeValues could be "1.3 L R2, Blue" and the corresponding attributeNames filter could be "Vehicle.Body.Engine.Type, Vehicle.Color". In this case, the API will filter vehicles with attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of "Blue". A request must contain unique values for the attributeNames filter and the matching number of attributeValues filter to return the subset of vehicles that match the attributes filter condition.

maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

modelManifestArn
Type: string

The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Result Syntax

[
    'nextToken' => '<string>',
    'vehicleSummaries' => [
        [
            'arn' => '<string>',
            'attributes' => ['<string>', ...],
            'creationTime' => <DateTime>,
            'decoderManifestArn' => '<string>',
            'lastModificationTime' => <DateTime>,
            'modelManifestArn' => '<string>',
            'vehicleName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

vehicleSummaries
Type: Array of VehicleSummary structures

A list of vehicles and information about them.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

ListVehiclesInFleet 

$result = $client->listVehiclesInFleet([/* ... */]);
$promise = $client->listVehiclesInFleetAsync([/* ... */]);

Retrieves a list of summaries of all vehicles associated with a fleet.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Parameter Syntax

$result = $client->listVehiclesInFleet([
    'fleetId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
fleetId
Required: Yes
Type: string

The ID of a fleet.

maxResults
Type: int

The maximum number of items to return, between 1 and 100, inclusive.

nextToken
Type: string

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Result Syntax

[
    'nextToken' => '<string>',
    'vehicles' => ['<string>', ...],
]

Result Details

Members
nextToken
Type: string

The token to retrieve the next set of results, or null if there are no more results.

vehicles
Type: Array of strings

A list of vehicles associated with the fleet.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

PutEncryptionConfiguration 

$result = $client->putEncryptionConfiguration([/* ... */]);
$promise = $client->putEncryptionConfigurationAsync([/* ... */]);

Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->putEncryptionConfiguration([
    'encryptionType' => 'KMS_BASED_ENCRYPTION|FLEETWISE_DEFAULT_ENCRYPTION', // REQUIRED
    'kmsKeyId' => '<string>',
]);

Parameter Details

Members
encryptionType
Required: Yes
Type: string

The type of encryption. Choose KMS_BASED_ENCRYPTION to use a KMS key or FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key.

kmsKeyId
Type: string

The ID of the KMS key that is used for encryption.

Result Syntax

[
    'encryptionStatus' => 'PENDING|SUCCESS|FAILURE',
    'encryptionType' => 'KMS_BASED_ENCRYPTION|FLEETWISE_DEFAULT_ENCRYPTION',
    'kmsKeyId' => '<string>',
]

Result Details

Members
encryptionStatus
Required: Yes
Type: string

The encryption status.

encryptionType
Required: Yes
Type: string

The type of encryption. Set to KMS_BASED_ENCRYPTION to use an KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.

kmsKeyId
Type: string

The ID of the KMS key that is used for encryption.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

PutLoggingOptions 

$result = $client->putLoggingOptions([/* ... */]);
$promise = $client->putLoggingOptionsAsync([/* ... */]);

Creates or updates the logging option.

Parameter Syntax

$result = $client->putLoggingOptions([
    'cloudWatchLogDelivery' => [ // REQUIRED
        'logGroupName' => '<string>',
        'logType' => 'OFF|ERROR', // REQUIRED
    ],
]);

Parameter Details

Members
cloudWatchLogDelivery
Required: Yes
Type: CloudWatchLogDeliveryOptions structure

Creates or updates the log delivery option to Amazon CloudWatch Logs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

RegisterAccount 

$result = $client->registerAccount([/* ... */]);
$promise = $client->registerAccountAsync([/* ... */]);

This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation.

You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation.

If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the Identity and Access Management API Reference.

Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.

An Amazon Web Services account is not the same thing as a "user." An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.

Parameter Syntax

$result = $client->registerAccount([
    'iamResources' => [
        'roleArn' => '<string>', // REQUIRED
    ],
    'timestreamResources' => [
        'timestreamDatabaseName' => '<string>', // REQUIRED
        'timestreamTableName' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
iamResources
Type: IamResources structure

The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.

timestreamResources
Type: TimestreamResources structure

The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

Result Syntax

[
    'creationTime' => <DateTime>,
    'iamResources' => [
        'roleArn' => '<string>',
    ],
    'lastModificationTime' => <DateTime>,
    'registerAccountStatus' => 'REGISTRATION_PENDING|REGISTRATION_SUCCESS|REGISTRATION_FAILURE',
    'timestreamResources' => [
        'timestreamDatabaseName' => '<string>',
        'timestreamTableName' => '<string>',
    ],
]

Result Details

Members
creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).

iamResources
Required: Yes
Type: IamResources structure

The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

registerAccountStatus
Required: Yes
Type: string

The status of registering your Amazon Web Services account, IAM role, and Timestream resources.

timestreamResources
Type: TimestreamResources structure

The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the resource.

Tags
Required: Yes
Type: Array of Tag structures

The new or modified tags for the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the given tags (metadata) from the resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the resource.

TagKeys
Required: Yes
Type: Array of strings

A list of the keys of the tags to be removed from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

UpdateCampaign 

$result = $client->updateCampaign([/* ... */]);
$promise = $client->updateCampaignAsync([/* ... */]);

Updates a campaign.

Parameter Syntax

$result = $client->updateCampaign([
    'action' => 'APPROVE|SUSPEND|RESUME|UPDATE', // REQUIRED
    'dataExtraDimensions' => ['<string>', ...],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
action
Required: Yes
Type: string

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. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.

  • RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.

  • UPDATE - To update a campaign.

dataExtraDimensions
Type: Array of strings

A list of vehicle attributes to associate with a signal.

Default: An empty array

description
Type: string

The description of the campaign.

name
Required: Yes
Type: string

The name of the campaign to update.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
    'status' => 'CREATING|WAITING_FOR_APPROVAL|RUNNING|SUSPENDED',
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the campaign.

name
Type: string

The name of the updated campaign.

status
Type: 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.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

UpdateDecoderManifest 

$result = $client->updateDecoderManifest([/* ... */]);
$promise = $client->updateDecoderManifestAsync([/* ... */]);

Updates a decoder manifest.

A decoder manifest can only be updated when the status is DRAFT. Only ACTIVE decoder manifests can be associated with vehicles.

Parameter Syntax

$result = $client->updateDecoderManifest([
    'defaultForUnmappedSignals' => 'CUSTOM_DECODING',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'networkInterfacesToAdd' => [
        [
            'canInterface' => [
                'name' => '<string>', // REQUIRED
                'protocolName' => '<string>',
                'protocolVersion' => '<string>',
            ],
            'customDecodingInterface' => [
                'name' => '<string>', // REQUIRED
            ],
            'interfaceId' => '<string>', // REQUIRED
            'obdInterface' => [
                'dtcRequestIntervalSeconds' => <integer>,
                'hasTransmissionEcu' => true || false,
                'name' => '<string>', // REQUIRED
                'obdStandard' => '<string>',
                'pidRequestIntervalSeconds' => <integer>,
                'requestMessageId' => <integer>, // REQUIRED
                'useExtendedIds' => true || false,
            ],
            'type' => 'CAN_INTERFACE|OBD_INTERFACE|VEHICLE_MIDDLEWARE|CUSTOM_DECODING_INTERFACE', // REQUIRED
            'vehicleMiddleware' => [
                'name' => '<string>', // REQUIRED
                'protocolName' => 'ROS_2', // REQUIRED
            ],
        ],
        // ...
    ],
    'networkInterfacesToRemove' => ['<string>', ...],
    'networkInterfacesToUpdate' => [
        [
            'canInterface' => [
                'name' => '<string>', // REQUIRED
                'protocolName' => '<string>',
                'protocolVersion' => '<string>',
            ],
            'customDecodingInterface' => [
                'name' => '<string>', // REQUIRED
            ],
            'interfaceId' => '<string>', // REQUIRED
            'obdInterface' => [
                'dtcRequestIntervalSeconds' => <integer>,
                'hasTransmissionEcu' => true || false,
                'name' => '<string>', // REQUIRED
                'obdStandard' => '<string>',
                'pidRequestIntervalSeconds' => <integer>,
                'requestMessageId' => <integer>, // REQUIRED
                'useExtendedIds' => true || false,
            ],
            'type' => 'CAN_INTERFACE|OBD_INTERFACE|VEHICLE_MIDDLEWARE|CUSTOM_DECODING_INTERFACE', // REQUIRED
            'vehicleMiddleware' => [
                'name' => '<string>', // REQUIRED
                'protocolName' => 'ROS_2', // REQUIRED
            ],
        ],
        // ...
    ],
    'signalDecodersToAdd' => [
        [
            'canSignal' => [
                'factor' => <float>, // REQUIRED
                'isBigEndian' => true || false, // REQUIRED
                'isSigned' => true || false, // REQUIRED
                'length' => <integer>, // REQUIRED
                'messageId' => <integer>, // REQUIRED
                'name' => '<string>',
                'offset' => <float>, // REQUIRED
                'startBit' => <integer>, // REQUIRED
            ],
            'customDecodingSignal' => [
                'id' => '<string>', // REQUIRED
            ],
            'fullyQualifiedName' => '<string>', // REQUIRED
            'interfaceId' => '<string>', // REQUIRED
            'messageSignal' => [
                'structuredMessage' => [ // REQUIRED
                    'primitiveMessageDefinition' => [
                        'ros2PrimitiveMessageDefinition' => [
                            'offset' => <float>,
                            'primitiveType' => 'BOOL|BYTE|CHAR|FLOAT32|FLOAT64|INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|STRING|WSTRING', // REQUIRED
                            'scaling' => <float>,
                            'upperBound' => <integer>,
                        ],
                    ],
                    'structuredMessageDefinition' => [
                        [
                            'dataType' => [...], // REQUIRED, RECURSIVE
                            'fieldName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'structuredMessageListDefinition' => [
                        'capacity' => <integer>,
                        'listType' => 'FIXED_CAPACITY|DYNAMIC_UNBOUNDED_CAPACITY|DYNAMIC_BOUNDED_CAPACITY', // REQUIRED
                        'memberType' => [...], // REQUIRED, RECURSIVE
                        'name' => '<string>', // REQUIRED
                    ],
                ],
                'topicName' => '<string>', // REQUIRED
            ],
            'obdSignal' => [
                'bitMaskLength' => <integer>,
                'bitRightShift' => <integer>,
                'byteLength' => <integer>, // REQUIRED
                'offset' => <float>, // REQUIRED
                'pid' => <integer>, // REQUIRED
                'pidResponseLength' => <integer>, // REQUIRED
                'scaling' => <float>, // REQUIRED
                'serviceMode' => <integer>, // REQUIRED
                'startByte' => <integer>, // REQUIRED
            ],
            'type' => 'CAN_SIGNAL|OBD_SIGNAL|MESSAGE_SIGNAL|CUSTOM_DECODING_SIGNAL', // REQUIRED
        ],
        // ...
    ],
    'signalDecodersToRemove' => ['<string>', ...],
    'signalDecodersToUpdate' => [
        [
            'canSignal' => [
                'factor' => <float>, // REQUIRED
                'isBigEndian' => true || false, // REQUIRED
                'isSigned' => true || false, // REQUIRED
                'length' => <integer>, // REQUIRED
                'messageId' => <integer>, // REQUIRED
                'name' => '<string>',
                'offset' => <float>, // REQUIRED
                'startBit' => <integer>, // REQUIRED
            ],
            'customDecodingSignal' => [
                'id' => '<string>', // REQUIRED
            ],
            'fullyQualifiedName' => '<string>', // REQUIRED
            'interfaceId' => '<string>', // REQUIRED
            'messageSignal' => [
                'structuredMessage' => [ // REQUIRED
                    'primitiveMessageDefinition' => [
                        'ros2PrimitiveMessageDefinition' => [
                            'offset' => <float>,
                            'primitiveType' => 'BOOL|BYTE|CHAR|FLOAT32|FLOAT64|INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|STRING|WSTRING', // REQUIRED
                            'scaling' => <float>,
                            'upperBound' => <integer>,
                        ],
                    ],
                    'structuredMessageDefinition' => [
                        [
                            'dataType' => [...], // REQUIRED, RECURSIVE
                            'fieldName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'structuredMessageListDefinition' => [
                        'capacity' => <integer>,
                        'listType' => 'FIXED_CAPACITY|DYNAMIC_UNBOUNDED_CAPACITY|DYNAMIC_BOUNDED_CAPACITY', // REQUIRED
                        'memberType' => [...], // REQUIRED, RECURSIVE
                        'name' => '<string>', // REQUIRED
                    ],
                ],
                'topicName' => '<string>', // REQUIRED
            ],
            'obdSignal' => [
                'bitMaskLength' => <integer>,
                'bitRightShift' => <integer>,
                'byteLength' => <integer>, // REQUIRED
                'offset' => <float>, // REQUIRED
                'pid' => <integer>, // REQUIRED
                'pidResponseLength' => <integer>, // REQUIRED
                'scaling' => <float>, // REQUIRED
                'serviceMode' => <integer>, // REQUIRED
                'startByte' => <integer>, // REQUIRED
            ],
            'type' => 'CAN_SIGNAL|OBD_SIGNAL|MESSAGE_SIGNAL|CUSTOM_DECODING_SIGNAL', // REQUIRED
        ],
        // ...
    ],
    'status' => 'ACTIVE|DRAFT|INVALID|VALIDATING',
]);

Parameter Details

Members
defaultForUnmappedSignals
Type: string

Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

description
Type: string

A brief description of the decoder manifest to update.

name
Required: Yes
Type: string

The name of the decoder manifest to update.

networkInterfacesToAdd
Type: Array of NetworkInterface structures

A list of information about the network interfaces to add to the decoder manifest.

networkInterfacesToRemove
Type: Array of strings

A list of network interfaces to remove from the decoder manifest.

networkInterfacesToUpdate
Type: Array of NetworkInterface structures

A list of information about the network interfaces to update in the decoder manifest.

signalDecodersToAdd
Type: Array of SignalDecoder structures

A list of information about decoding additional signals to add to the decoder manifest.

signalDecodersToRemove
Type: Array of strings

A list of signal decoders to remove from the decoder manifest.

signalDecodersToUpdate
Type: Array of SignalDecoder structures

A list of updated information about decoding signals to update in the decoder manifest.

status
Type: string

The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the updated decoder manifest.

name
Required: Yes
Type: string

The name of the updated decoder manifest.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

DecoderManifestValidationException:

The request couldn't be completed because it contains signal decoders with one or more validation errors.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

UpdateFleet 

$result = $client->updateFleet([/* ... */]);
$promise = $client->updateFleetAsync([/* ... */]);

Updates the description of an existing fleet.

Parameter Syntax

$result = $client->updateFleet([
    'description' => '<string>',
    'fleetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: string

An updated description of the fleet.

fleetId
Required: Yes
Type: string

The ID of the fleet to update.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the updated fleet.

id
Type: string

The ID of the updated fleet.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

UpdateModelManifest 

$result = $client->updateModelManifest([/* ... */]);
$promise = $client->updateModelManifestAsync([/* ... */]);

Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.

Parameter Syntax

$result = $client->updateModelManifest([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'nodesToAdd' => ['<string>', ...],
    'nodesToRemove' => ['<string>', ...],
    'status' => 'ACTIVE|DRAFT|INVALID|VALIDATING',
]);

Parameter Details

Members
description
Type: string

A brief description of the vehicle model.

name
Required: Yes
Type: string

The name of the vehicle model to update.

nodesToAdd
Type: Array of strings

A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the vehicle model.

nodesToRemove
Type: Array of strings

A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from the vehicle model.

status
Type: string

The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the updated vehicle model.

name
Required: Yes
Type: string

The name of the updated vehicle model.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InvalidSignalsException:

The request couldn't be completed because it contains signals that aren't valid.

AccessDeniedException:

You don't have sufficient permission to perform this action.

UpdateSignalCatalog 

$result = $client->updateSignalCatalog([/* ... */]);
$promise = $client->updateSignalCatalogAsync([/* ... */]);

Updates a signal catalog.

Parameter Syntax

$result = $client->updateSignalCatalog([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'nodesToAdd' => [
        [
            'actuator' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'attribute' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'defaultValue' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'max' => <float>,
                'min' => <float>,
                'unit' => '<string>',
            ],
            'branch' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
            ],
            'property' => [
                'comment' => '<string>',
                'dataEncoding' => 'BINARY|TYPED',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'structFullyQualifiedName' => '<string>',
            ],
            'sensor' => [
                'allowedValues' => ['<string>', ...],
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'struct' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'nodesToRemove' => ['<string>', ...],
    'nodesToUpdate' => [
        [
            'actuator' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'attribute' => [
                'allowedValues' => ['<string>', ...],
                'assignedValue' => '<string>',
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'defaultValue' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'max' => <float>,
                'min' => <float>,
                'unit' => '<string>',
            ],
            'branch' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
            ],
            'property' => [
                'comment' => '<string>',
                'dataEncoding' => 'BINARY|TYPED',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'structFullyQualifiedName' => '<string>',
            ],
            'sensor' => [
                'allowedValues' => ['<string>', ...],
                'comment' => '<string>',
                'dataType' => 'INT8|UINT8|INT16|UINT16|INT32|UINT32|INT64|UINT64|BOOLEAN|FLOAT|DOUBLE|STRING|UNIX_TIMESTAMP|INT8_ARRAY|UINT8_ARRAY|INT16_ARRAY|UINT16_ARRAY|INT32_ARRAY|UINT32_ARRAY|INT64_ARRAY|UINT64_ARRAY|BOOLEAN_ARRAY|FLOAT_ARRAY|DOUBLE_ARRAY|STRING_ARRAY|UNIX_TIMESTAMP_ARRAY|UNKNOWN|STRUCT|STRUCT_ARRAY', // REQUIRED
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
                'max' => <float>,
                'min' => <float>,
                'structFullyQualifiedName' => '<string>',
                'unit' => '<string>',
            ],
            'struct' => [
                'comment' => '<string>',
                'deprecationMessage' => '<string>',
                'description' => '<string>',
                'fullyQualifiedName' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members
description
Type: string

A brief description of the signal catalog to update.

name
Required: Yes
Type: string

The name of the signal catalog to update.

nodesToAdd
Type: Array of Node structures

A list of information about nodes to add to the signal catalog.

nodesToRemove
Type: Array of strings

A list of fullyQualifiedName of nodes to remove from the signal catalog.

nodesToUpdate
Type: Array of Node structures

A list of information about nodes to update in the signal catalog.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the updated signal catalog.

name
Required: Yes
Type: string

The name of the updated signal catalog.

Errors

ResourceNotFoundException:

The resource wasn't found.

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

InvalidNodeException:

The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InvalidSignalsException:

The request couldn't be completed because it contains signals that aren't valid.

AccessDeniedException:

You don't have sufficient permission to perform this action.

UpdateStateTemplate 

$result = $client->updateStateTemplate([/* ... */]);
$promise = $client->updateStateTemplateAsync([/* ... */]);

Updates a state template.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Parameter Syntax

$result = $client->updateStateTemplate([
    'dataExtraDimensions' => ['<string>', ...],
    'description' => '<string>',
    'identifier' => '<string>', // REQUIRED
    'metadataExtraDimensions' => ['<string>', ...],
    'stateTemplatePropertiesToAdd' => ['<string>', ...],
    'stateTemplatePropertiesToRemove' => ['<string>', ...],
]);

Parameter Details

Members
dataExtraDimensions
Type: Array of strings

A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field.

Default: An empty array

description
Type: string

A brief description of the state template.

identifier
Required: Yes
Type: string

A unique, service-generated identifier.

metadataExtraDimensions
Type: Array of strings

A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.

stateTemplatePropertiesToAdd
Type: Array of strings

Add signals from which data is collected as part of the state template.

stateTemplatePropertiesToRemove
Type: Array of strings

Remove signals from which data is collected as part of the state template.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Type: string

The Amazon Resource Name (ARN) of the state template.

id
Type: string

The unique ID of the state template.

name
Type: string

The name of the state template.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InvalidSignalsException:

The request couldn't be completed because it contains signals that aren't valid.

AccessDeniedException:

You don't have sufficient permission to perform this action.

UpdateVehicle 

$result = $client->updateVehicle([/* ... */]);
$promise = $client->updateVehicleAsync([/* ... */]);

Updates a vehicle.

Parameter Syntax

$result = $client->updateVehicle([
    'attributeUpdateMode' => 'Overwrite|Merge',
    'attributes' => ['<string>', ...],
    'decoderManifestArn' => '<string>',
    'modelManifestArn' => '<string>',
    'stateTemplatesToAdd' => [
        [
            'identifier' => '<string>', // REQUIRED
            'stateTemplateUpdateStrategy' => [ // REQUIRED
                'onChange' => [
                ],
                'periodic' => [
                    'stateTemplateUpdateRate' => [ // REQUIRED
                        'unit' => 'MILLISECOND|SECOND|MINUTE|HOUR', // REQUIRED
                        'value' => <integer>, // REQUIRED
                    ],
                ],
            ],
        ],
        // ...
    ],
    'stateTemplatesToRemove' => ['<string>', ...],
    'vehicleName' => '<string>', // REQUIRED
]);

Parameter Details

Members
attributeUpdateMode
Type: string

The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.

This is required if attributes are present in the input.

attributes
Type: Associative array of custom strings keys (attributeName) to strings

Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"

decoderManifestArn
Type: string

The ARN of the decoder manifest associated with this vehicle.

modelManifestArn
Type: string

The ARN of a vehicle model (model manifest) associated with the vehicle.

stateTemplatesToAdd
Type: Array of StateTemplateAssociation structures

Associate state templates with the vehicle.

stateTemplatesToRemove
Type: Array of strings

Remove state templates from the vehicle.

vehicleName
Required: Yes
Type: string

The unique ID of the vehicle to update.

Result Syntax

[
    'arn' => '<string>',
    'vehicleName' => '<string>',
]

Result Details

Members
arn
Type: string

The ARN of the updated vehicle.

vehicleName
Type: string

The ID of the updated vehicle.

Errors

InternalServerException:

The request couldn't be completed because the server temporarily failed.

ResourceNotFoundException:

The resource wasn't found.

ConflictException:

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

LimitExceededException:

A service quota was exceeded.

ThrottlingException:

The request couldn't be completed due to throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You don't have sufficient permission to perform this action.

Shapes

AccessDeniedException

Description

You don't have sufficient permission to perform this action.

Members
message
Required: Yes
Type: string

Actuator

Description

A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.

Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.

Members
allowedValues
Type: Array of strings

A list of possible values an actuator can take.

assignedValue
Type: string

A specified value for the actuator.

comment
Type: string

A comment in addition to the description.

dataType
Required: Yes
Type: string

The specified data type of the actuator.

deprecationMessage
Type: string

The deprecation message for the node or the branch that was moved or deleted.

description
Type: string

A brief description of the actuator.

fullyQualifiedName
Required: Yes
Type: string

The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

max
Type: double

The specified possible maximum value of an actuator.

min
Type: double

The specified possible minimum value of an actuator.

structFullyQualifiedName
Type: string

The fully qualified name of the struct node for the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.

unit
Type: string

The scientific unit for the actuator.

Attribute

Description

A signal that represents static information about the vehicle, such as engine type or manufacturing date.

Members
allowedValues
Type: Array of strings

A list of possible values an attribute can be assigned.

assignedValue
Type: string

A specified value for the attribute.

comment
Type: string

A comment in addition to the description.

dataType
Required: Yes
Type: string

The specified data type of the attribute.

defaultValue
Type: string

The default value of the attribute.

deprecationMessage
Type: string

The deprecation message for the node or the branch that was moved or deleted.

description
Type: string

A brief description of the attribute.

fullyQualifiedName
Required: Yes
Type: string

The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.

max
Type: double

The specified possible maximum value of the attribute.

min
Type: double

The specified possible minimum value of the attribute.

unit
Type: string

The scientific unit for the attribute.

Branch

Description

A group of signals that are defined in a hierarchical structure.

Members
comment
Type: string

A comment in addition to the description.

deprecationMessage
Type: string

The deprecation message for the node or the branch that was moved or deleted.

description
Type: string

A brief description of the branch.

fullyQualifiedName
Required: Yes
Type: string

The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine.

CampaignSummary

Description

Information about a campaign.

You can use the API operation to return this information about multiple created campaigns.

Members
arn
Type: string

The Amazon Resource Name (ARN) of a campaign.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the campaign was created.

description
Type: string

The description of the campaign.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last time the campaign was modified.

name
Type: string

The name of a campaign.

signalCatalogArn
Type: string

The ARN of the signal catalog associated with the campaign.

status
Type: string

The state of a campaign. The status can be one of the following:

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

targetArn
Type: string

The ARN of a vehicle or fleet to which the campaign is deployed.

CanDbcDefinition

Description

Configurations used to create a decoder manifest.

Members
canDbcFiles
Required: Yes
Type: Array of blob (string|resource|Psr\Http\Message\StreamInterface)s

A list of DBC files. You can upload only one DBC file for each network interface and specify up to five (inclusive) files in the list. The DBC file can be a maximum size of 200 MB.

networkInterface
Required: Yes
Type: string

Contains information about a network interface.

signalsMap
Type: Associative array of custom strings keys (string) to strings

Pairs every signal specified in your vehicle model with a signal decoder.

CanInterface

Description

A single controller area network (CAN) device interface.

Members
name
Required: Yes
Type: string

The unique name of the interface.

protocolName
Type: string

The name of the communication protocol for the interface.

protocolVersion
Type: string

The version of the communication protocol for the interface.

CanSignal

Description

Information about a single controller area network (CAN) signal and the messages it receives and transmits.

Members
factor
Required: Yes
Type: double

A multiplier used to decode the CAN message.

isBigEndian
Required: Yes
Type: boolean

Whether the byte ordering of a CAN message is big-endian.

isSigned
Required: Yes
Type: boolean

Whether the message data is specified as a signed value.

length
Required: Yes
Type: int

How many bytes of data are in the message.

messageId
Required: Yes
Type: int

The ID of the message.

name
Type: string

The name of the signal.

offset
Required: Yes
Type: double

The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.

startBit
Required: Yes
Type: int

Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).

This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.

CloudWatchLogDeliveryOptions

Description

The log delivery option to send data to Amazon CloudWatch Logs.

Members
logGroupName
Type: string

The Amazon CloudWatch Logs group the operation sends data to.

logType
Required: Yes
Type: string

The type of log to send data to Amazon CloudWatch Logs.

CollectionScheme

Description

Specifies what data to collect and how often or when to collect it.

Members
conditionBasedCollectionScheme
Type: ConditionBasedCollectionScheme structure

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

timeBasedCollectionScheme
Type: TimeBasedCollectionScheme structure

Information about a collection scheme that uses a time period to decide how often to collect data.

ConditionBasedCollectionScheme

Description

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

Members
conditionLanguageVersion
Type: int

Specifies the version of the conditional expression language.

expression
Required: Yes
Type: string

The logical expression used to recognize what data to collect. For example, $variable.`Vehicle.OutsideAirTemperature` >= 105.0.

minimumTriggerIntervalMs
Type: long (int|float)

The minimum duration of time between two triggering events to collect data, in milliseconds.

If a signal changes often, you might want to collect data at a slower rate.

triggerMode
Type: string

Whether to collect data for all triggering events (ALWAYS). Specify (RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.

ConditionBasedSignalFetchConfig

Description

Specifies the condition under which a signal fetch occurs.

Members
conditionExpression
Required: Yes
Type: string

The condition that must be satisfied to trigger a signal fetch.

triggerMode
Required: Yes
Type: string

Indicates the mode in which the signal fetch is triggered.

ConflictException

Description

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

Members
message
Required: Yes
Type: string
resource
Required: Yes
Type: string

The resource on which there are conflicting operations.

resourceType
Required: Yes
Type: string

The type of resource on which there are conflicting operations..

CreateVehicleError

Description

An HTTP error resulting from creating a vehicle.

Members
code
Type: string

An HTTP error code.

message
Type: string

A description of the HTTP error.

vehicleName
Type: string

The ID of the vehicle with the error.

CreateVehicleRequestItem

Description

Information about the vehicle to create.

Members
associationBehavior
Type: string

An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.

attributes
Type: Associative array of custom strings keys (attributeName) to strings

Static information about a vehicle in a key-value pair. For example: "engine Type" : "v6"

decoderManifestArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.

modelManifestArn
Required: Yes
Type: string

The ARN of the vehicle model (model manifest) to create the vehicle from.

stateTemplates
Type: Array of StateTemplateAssociation structures

Associate state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud.

tags
Type: Array of Tag structures

Metadata which can be used to manage the vehicle.

vehicleName
Required: Yes
Type: string

The unique ID of the vehicle to create.

CreateVehicleResponseItem

Description

Information about a created vehicle.

Members
arn
Type: string

The ARN of the created vehicle.

thingArn
Type: string

The ARN of a created or validated Amazon Web Services IoT thing.

vehicleName
Type: string

The unique ID of the vehicle to create.

CustomDecodingInterface

Description

Represents a custom network interface as defined by the customer.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
name
Required: Yes
Type: string

The name of the interface.

CustomDecodingSignal

Description

Information about signals using a custom decoding protocol as defined by the customer.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
id
Required: Yes
Type: string

The ID of the signal.

CustomProperty

Description

Represents a member of the complex data structure. The data type of the property can be either primitive or another struct.

Members
comment
Type: string

A comment in addition to the description.

dataEncoding
Type: string

Indicates whether the property is binary data.

dataType
Required: Yes
Type: string

The data type for the custom property.

deprecationMessage
Type: string

The deprecation message for the node or the branch that was moved or deleted.

description
Type: string

A brief description of the custom property.

fullyQualifiedName
Required: Yes
Type: string

The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

structFullyQualifiedName
Type: string

The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.

CustomStruct

Description

The custom structure represents a complex or higher-order data structure.

Members
comment
Type: string

A comment in addition to the description.

deprecationMessage
Type: string

The deprecation message for the node or the branch that was moved or deleted.

description
Type: string

A brief description of the custom structure.

fullyQualifiedName
Required: Yes
Type: string

The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera.

DataDestinationConfig

Description

The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.

Members
mqttTopicConfig
Type: MqttTopicConfig structure

The MQTT topic to which the Amazon Web Services IoT FleetWise campaign routes data.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

s3Config
Type: S3Config structure

The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.

timestreamConfig
Type: TimestreamConfig structure

The Amazon Timestream table where the campaign sends data.

DataPartition

Description

The configuration for signal data storage and upload options. You can only specify these options when the campaign's spooling mode is TO_DISK.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
id
Required: Yes
Type: string

The ID of the data partition. The data partition ID must be unique within a campaign. You can establish a data partition as the default partition for a campaign by using default as the ID.

storageOptions
Required: Yes
Type: DataPartitionStorageOptions structure

The storage options for a data partition.

uploadOptions
Type: DataPartitionUploadOptions structure

The upload options for the data partition.

DataPartitionStorageOptions

Description

Size, time, and location options for the data partition.

Members
maximumSize
Required: Yes
Type: StorageMaximumSize structure

The maximum storage size of the data stored in the data partition.

Newer data overwrites older data when the partition reaches the maximum size.

minimumTimeToLive
Required: Yes
Type: StorageMinimumTimeToLive structure

The amount of time that data in this partition will be kept on disk.

  • After the designated amount of time passes, the data can be removed, but it's not guaranteed to be removed.

  • Before the time expires, data in this partition can still be deleted if the partition reaches its configured maximum size.

  • Newer data will overwrite older data when the partition reaches the maximum size.

storageLocation
Required: Yes
Type: string

The folder name for the data partition under the campaign storage folder.

DataPartitionUploadOptions

Description

The upload options for the data partition. If upload options are specified, you must also specify storage options. See DataPartitionStorageOptions.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
conditionLanguageVersion
Type: int

The version of the condition language. Defaults to the most recent condition language version.

expression
Required: Yes
Type: string

The logical expression used to recognize what data to collect. For example, $variable.`Vehicle.OutsideAirTemperature` >= 105.0.

DecoderManifestSummary

Description

Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.

Members
arn
Type: string

The ARN of a vehicle model (model manifest) associated with the decoder manifest.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).

description
Type: string

A brief description of the decoder manifest.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

message
Type: string

The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.

modelManifestArn
Type: string

The ARN of a vehicle model (model manifest) associated with the decoder manifest.

name
Type: string

The name of the decoder manifest.

status
Type: string

The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is marked DRAFT, you can edit the decoder manifest.

DecoderManifestValidationException

Description

The request couldn't be completed because it contains signal decoders with one or more validation errors.

Members
invalidNetworkInterfaces
Type: Array of InvalidNetworkInterface structures

The request couldn't be completed because of invalid network interfaces in the request.

invalidSignals
Type: Array of InvalidSignalDecoder structures

The request couldn't be completed because of invalid signals in the request.

message
Type: string

FleetSummary

Description

Information about a fleet.

You can use the API operation to return this information about multiple fleets.

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the fleet.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).

description
Type: string

A brief description of the fleet.

id
Required: Yes
Type: string

The unique ID of the fleet.

lastModificationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

signalCatalogArn
Required: Yes
Type: string

The ARN of the signal catalog associated with the fleet.

FormattedVss

Description

Vehicle Signal Specification (VSS) is a precise language used to describe and model signals in vehicle networks. The JSON file collects signal specificiations in a VSS format.

Members
vssJson
Type: string

Provides the VSS in JSON format.

IamRegistrationResponse

Description

Information about registering an Identity and Access Management (IAM) resource so Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to Amazon Timestream.

Members
errorMessage
Type: string

A message associated with a registration error.

registrationStatus
Required: Yes
Type: string

The status of registering your IAM resource. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.

roleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM role to register.

IamResources

Description

The IAM resource that enables Amazon Web Services IoT FleetWise edge agent software to send data to Amazon Timestream.

For more information, see IAM roles in the Identity and Access Management User Guide.

Members
roleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. For example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN.

InternalServerException

Description

The request couldn't be completed because the server temporarily failed.

Members
message
Required: Yes
Type: string
retryAfterSeconds
Type: int

The number of seconds to wait before retrying the command.

InvalidNetworkInterface

Description

A reason a vehicle network interface isn't valid.

Members
interfaceId
Type: string

The ID of the interface that isn't valid.

reason
Type: string

A message about why the interface isn't valid.

InvalidNodeException

Description

The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.

Members
invalidNodes
Type: Array of Node structures

The specified node type isn't valid.

message
Type: string
reason
Type: string

The reason the node validation failed.

InvalidSignal

Description

A reason that a signal isn't valid.

Members
name
Type: string

The name of the signal that isn't valid.

reason
Type: string

A message about why the signal isn't valid.

InvalidSignalDecoder

Description

A reason that a signal decoder isn't valid.

Members
hint
Type: string

The possible cause for the invalid signal decoder.

name
Type: string

The name of a signal decoder that isn't valid.

reason
Type: string

A message about why the signal decoder isn't valid.

InvalidSignalsException

Description

The request couldn't be completed because it contains signals that aren't valid.

Members
invalidSignals
Type: Array of InvalidSignal structures

The signals which caused the exception.

message
Type: string

LimitExceededException

Description

A service quota was exceeded.

Members
message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

The identifier of the resource that was exceeded.

resourceType
Required: Yes
Type: string

The type of resource that was exceeded.

MessageSignal

Description

The decoding information for a specific message which support higher order data types.

Members
structuredMessage
Required: Yes
Type: StructuredMessage structure

The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.

topicName
Required: Yes
Type: string

The topic name for the message signal. It corresponds to topics in ROS 2.

ModelManifestSummary

Description

Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.

Members
arn
Type: string

The Amazon Resource Name (ARN) of the vehicle model.

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).

description
Type: string

A brief description of the vehicle model.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

name
Type: string

The name of the vehicle model.

signalCatalogArn
Type: string

The ARN of the signal catalog associated with the vehicle model.

status
Type: string

The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.

MqttTopicConfig

Description

The MQTT topic to which the Amazon Web Services IoT FleetWise campaign routes data. For more information, see Device communication protocols in the Amazon Web Services IoT Core Developer Guide.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
executionRoleArn
Required: Yes
Type: string

The ARN of the role that grants Amazon Web Services IoT FleetWise permission to access and act on messages sent to the MQTT topic.

mqttTopicArn
Required: Yes
Type: string

The ARN of the MQTT topic.

NetworkFileDefinition

Description

Specifications for defining a vehicle network.

Members
canDbc
Type: CanDbcDefinition structure

Information, including CAN DBC files, about the configurations used to create a decoder manifest.

NetworkInterface

Description

Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.

To return this information about all the network interfaces specified in a decoder manifest, use the API operation.

Members
canInterface
Type: CanInterface structure

Information about a network interface specified by the Controller Area Network (CAN) protocol.

customDecodingInterface
Type: CustomDecodingInterface structure

Information about a custom network interface.

interfaceId
Required: Yes
Type: string

The ID of the network interface.

obdInterface
Type: ObdInterface structure

Information about a network interface specified by the on-board diagnostic (OBD) II protocol.

type
Required: Yes
Type: string

The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

vehicleMiddleware
Type: VehicleMiddleware structure

The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.

Node

Description

A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.

Members
actuator
Type: Actuator structure

Information about a node specified as an actuator.

An actuator is a digital representation of a vehicle device.

attribute
Type: Attribute structure

Information about a node specified as an attribute.

An attribute represents static information about a vehicle.

branch
Type: Branch structure

Information about a node specified as a branch.

A group of signals that are defined in a hierarchical structure.

property
Type: CustomProperty structure

Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct.

sensor
Type: Sensor structure

An input component that reports the environmental condition of a vehicle.

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

struct
Type: CustomStruct structure

Represents a complex or higher-order data structure.

NodeCounts

Description

Information about the number of nodes and node types in a vehicle network.

Members
totalActuators
Type: int

The total number of nodes in a vehicle network that represent actuators.

totalAttributes
Type: int

The total number of nodes in a vehicle network that represent attributes.

totalBranches
Type: int

The total number of nodes in a vehicle network that represent branches.

totalNodes
Type: int

The total number of nodes in a vehicle network.

totalProperties
Type: int

The total properties for the node.

totalSensors
Type: int

The total number of nodes in a vehicle network that represent sensors.

totalStructs
Type: int

The total structure for the node.

ObdInterface

Description

A network interface that specifies the on-board diagnostic (OBD) II network protocol.

Members
dtcRequestIntervalSeconds
Type: int

The maximum number message requests per diagnostic trouble code per second.

hasTransmissionEcu
Type: boolean

Whether the vehicle has a transmission control module (TCM).

name
Required: Yes
Type: string

The name of the interface.

obdStandard
Type: string

The standard OBD II PID.

pidRequestIntervalSeconds
Type: int

The maximum number message requests per second.

requestMessageId
Required: Yes
Type: int

The ID of the message requesting vehicle data.

useExtendedIds
Type: boolean

Whether to use extended IDs in the message.

ObdSignal

Description

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

Members
bitMaskLength
Type: int

The number of bits to mask in a message.

bitRightShift
Type: int

The number of positions to shift bits in the message.

byteLength
Required: Yes
Type: int

The length of a message.

offset
Required: Yes
Type: double

The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

pid
Required: Yes
Type: int

The diagnostic code used to request data from a vehicle for this signal.

pidResponseLength
Required: Yes
Type: int

The length of the requested data.

scaling
Required: Yes
Type: double

A multiplier used to decode the message.

serviceMode
Required: Yes
Type: int

The mode of operation (diagnostic service) in a message.

startByte
Required: Yes
Type: int

Indicates the beginning of the message.

OnChangeStateTemplateUpdateStrategy

Description

Vehicles associated with the state template will stream telemetry data when there is a change.

Members

PeriodicStateTemplateUpdateStrategy

Description

Vehicles associated with the state template will stream telemetry data during a specified time period.

Members
stateTemplateUpdateRate
Required: Yes
Type: TimePeriod structure

The length of time between state template updates.

PrimitiveMessageDefinition

Description

Represents a primitive type node of the complex data structure.

Members
ros2PrimitiveMessageDefinition
Type: ROS2PrimitiveMessageDefinition structure

Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.

ROS2PrimitiveMessageDefinition

Description

Represents a ROS 2 compliant primitive type message of the complex data structure.

Members
offset
Type: double

The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

primitiveType
Required: Yes
Type: string

The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.

scaling
Type: double

A multiplier used to decode the message.

upperBound
Type: long (int|float)

An optional attribute specifying the upper bound for STRING and WSTRING.

ResourceNotFoundException

Description

The resource wasn't found.

Members
message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

The identifier of the resource that wasn't found.

resourceType
Required: Yes
Type: string

The type of resource that wasn't found.

S3Config

Description

The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

Members
bucketArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

dataFormat
Type: string

Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.

  • Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.

  • JSON - Store data in a standard text-based JSON file format.

prefix
Type: string

Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.

By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.

storageCompressionFormat
Type: string

By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.

Sensor

Description

An input component that reports the environmental condition of a vehicle.

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

Members
allowedValues
Type: Array of strings

A list of possible values a sensor can take.

comment
Type: string

A comment in addition to the description.

dataType
Required: Yes
Type: string

The specified data type of the sensor.

deprecationMessage
Type: string

The deprecation message for the node or the branch that was moved or deleted.

description
Type: string

A brief description of a sensor.

fullyQualifiedName
Required: Yes
Type: string

The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.

max
Type: double

The specified possible maximum value of the sensor.

min
Type: double

The specified possible minimum value of the sensor.

structFullyQualifiedName
Type: string

The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.

unit
Type: string

The scientific unit of measurement for data collected by the sensor.

SignalCatalogSummary

Description

Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.

Members
arn
Type: string

The Amazon Resource Name (ARN) of the signal catalog.

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).

lastModificationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

name
Type: string

The name of the signal catalog.

SignalDecoder

Description

Information about a signal decoder.

Members
canSignal
Type: CanSignal structure

Information about signal decoder using the Controller Area Network (CAN) protocol.

customDecodingSignal
Type: CustomDecodingSignal structure

Information about a custom signal decoder.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

fullyQualifiedName
Required: Yes
Type: string

The fully qualified name of a signal decoder as defined in a vehicle model.

interfaceId
Required: Yes
Type: string

The ID of a network interface that specifies what network protocol a vehicle follows.

messageSignal
Type: MessageSignal structure

The decoding information for a specific message which supports higher order data types.

obdSignal
Type: ObdSignal structure

Information about signal decoder using the on-board diagnostic (OBD) II protocol.

type
Required: Yes
Type: string

The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

SignalFetchConfig

Description

The configuration of the signal fetch operation.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
conditionBased
Type: ConditionBasedSignalFetchConfig structure

The configuration of a condition-based signal fetch operation.

timeBased
Type: TimeBasedSignalFetchConfig structure

The configuration of a time-based signal fetch operation.

SignalFetchInformation

Description

Information about the signal to be fetched.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
actions
Required: Yes
Type: Array of strings

The actions to be performed by the signal fetch.

conditionLanguageVersion
Type: int

The version of the condition language used.

fullyQualifiedName
Required: Yes
Type: string

The fully qualified name of the signal to be fetched.

signalFetchConfig
Required: Yes
Type: SignalFetchConfig structure

The configuration of the signal fetch operation.

SignalInformation

Description

Information about a signal.

Members
dataPartitionId
Type: string

The ID of the data partition this signal is associated with.

The ID must match one of the IDs provided in dataPartitions. This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type.

If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signalsToCollect.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

maxSampleCount
Type: long (int|float)

The maximum number of samples to collect.

minimumSamplingIntervalMs
Type: long (int|float)

The minimum duration of time (in milliseconds) between two triggering events to collect data.

If a signal changes often, you might want to collect data at a slower rate.

name
Required: Yes
Type: string

The name of the signal.

StateTemplateAssociation

Description

The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
identifier
Required: Yes
Type: string

A unique, service-generated identifier.

stateTemplateUpdateStrategy
Required: Yes
Type: StateTemplateUpdateStrategy structure

The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

StateTemplateSummary

Description

Information about a state template.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
arn
Type: string

The Amazon Resource Name (ARN) of the state template.

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time).

description
Type: string

A brief description of the state template.

id
Type: string

The unique ID of the state template.

lastModificationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

name
Type: string

The name of the state template.

signalCatalogArn
Type: string

The Amazon Resource Name (ARN) of the signal catalog associated with the state template.

StateTemplateUpdateStrategy

Description

The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
onChange
Type: OnChangeStateTemplateUpdateStrategy structure

Vehicles associated with the state template will stream telemetry data when there is a change.

periodic
Type: PeriodicStateTemplateUpdateStrategy structure

Vehicles associated with the state template will stream telemetry data during a specified time period.

StorageMaximumSize

Description

The maximum storage size for the data partition.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
unit
Required: Yes
Type: string

The data type of the data to store.

value
Required: Yes
Type: int

The maximum amount of time to store data.

StorageMinimumTimeToLive

Description

Information about the minimum amount of time that data will be kept.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

Members
unit
Required: Yes
Type: string

The time increment type.

value
Required: Yes
Type: int

The minimum amount of time to store the data.

StructuredMessage

Description

The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.

Members
primitiveMessageDefinition
Type: PrimitiveMessageDefinition structure

Represents a primitive type node of the complex data structure.

structuredMessageDefinition
Type: Array of StructuredMessageFieldNameAndDataTypePair structures

Represents a struct type node of the complex data structure.

structuredMessageListDefinition
Type: StructuredMessageListDefinition structure

Represents a list type node of the complex data structure.

StructuredMessageFieldNameAndDataTypePair

Description

Represents a StructureMessageName to DataType map element.

Members
dataType
Required: Yes
Type: StructuredMessage structure

The data type.

fieldName
Required: Yes
Type: string

The field name of the structured message. It determines how a data value is referenced in the target language.

StructuredMessageListDefinition

Description

Represents a list type node of the complex data structure.

Members
capacity
Type: int

The capacity of the structured message list definition when the list type is FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY.

listType
Required: Yes
Type: string

The type of list of the structured message list definition.

memberType
Required: Yes
Type: StructuredMessage structure

The member type of the structured message list definition.

name
Required: Yes
Type: string

The name of the structured message list definition.

Tag

Description

A set of key/value pairs that are used to manage the resource.

Members
Key
Required: Yes
Type: string

The tag's key.

Value
Required: Yes
Type: string

The tag's value.

ThrottlingException

Description

The request couldn't be completed due to throttling.

Members
message
Required: Yes
Type: string
quotaCode
Type: string

The quota identifier of the applied throttling rules for this request.

retryAfterSeconds
Type: int

The number of seconds to wait before retrying the command.

serviceCode
Type: string

The code for the service that couldn't be completed due to throttling.

TimeBasedCollectionScheme

Description

Information about a collection scheme that uses a time period to decide how often to collect data.

Members
periodMs
Required: Yes
Type: long (int|float)

The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000, the Edge Agent software collects data once every minute.

TimeBasedSignalFetchConfig

Description

Used to configure a frequency-based vehicle signal fetch.

Members
executionFrequencyMs
Required: Yes
Type: long (int|float)

The frequency with which the signal fetch will be executed.

TimePeriod

Description

The length of time between state template updates.

Members
unit
Required: Yes
Type: string

A unit of time.

value
Required: Yes
Type: int

A number of time units.

TimestreamConfig

Description

The Amazon Timestream table where the Amazon Web Services IoT FleetWise campaign sends data. Timestream stores and organizes data to optimize query processing time and to reduce storage costs. For more information, see Data modeling in the Amazon Timestream Developer Guide.

Members
executionRoleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.

timestreamTableArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon Timestream table.

TimestreamRegistrationResponse

Description

Information about the registered Amazon Timestream resources or errors, if any.

Members
errorMessage
Type: string

A message associated with a registration error.

registrationStatus
Required: Yes
Type: string

The status of registering your Amazon Timestream resources. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.

timestreamDatabaseArn
Type: string

The Amazon Resource Name (ARN) of the Timestream database.

timestreamDatabaseName
Required: Yes
Type: string

The name of the Timestream database.

timestreamTableArn
Type: string

The ARN of the Timestream database table.

timestreamTableName
Required: Yes
Type: string

The name of the Timestream database table.

TimestreamResources

Description

The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

Members
timestreamDatabaseName
Required: Yes
Type: string

The name of the registered Amazon Timestream database.

timestreamTableName
Required: Yes
Type: string

The name of the registered Amazon Timestream database table.

UpdateVehicleError

Description

An HTTP error resulting from updating the description for a vehicle.

Members
code
Type: int

The relevant HTTP error code (400+).

message
Type: string

A message associated with the error.

vehicleName
Type: string

The ID of the vehicle with the error.

UpdateVehicleRequestItem

Description

Information about the vehicle to update.

Members
attributeUpdateMode
Type: string

The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.

This is required if attributes are present in the input.

attributes
Type: Associative array of custom strings keys (attributeName) to strings

Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"

decoderManifestArn
Type: string

The ARN of the signal decoder manifest associated with the vehicle to update.

modelManifestArn
Type: string

The ARN of the vehicle model (model manifest) associated with the vehicle to update.

stateTemplatesToAdd
Type: Array of StateTemplateAssociation structures

Associate additional state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud.

stateTemplatesToRemove
Type: Array of strings

Remove existing state template associations from the vehicle.

vehicleName
Required: Yes
Type: string

The unique ID of the vehicle to update.

UpdateVehicleResponseItem

Description

Information about the updated vehicle.

Members
arn
Type: string

The Amazon Resource Name (ARN) of the updated vehicle.

vehicleName
Type: string

The unique ID of the updated vehicle.

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members
fieldList
Type: Array of ValidationExceptionField structures

The list of fields that fail to satisfy the constraints specified by an Amazon Web Services service.

message
Required: Yes
Type: string
reason
Type: string

The reason the input failed to satisfy the constraints specified by an Amazon Web Services service.

ValidationExceptionField

Description

A validation error due to mismatch between the expected data type, length, or pattern of the parameter and the input.

Members
message
Required: Yes
Type: string

A message about the validation error.

name
Required: Yes
Type: string

The name of the parameter field with the validation error.

VehicleMiddleware

Description

The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.

Members
name
Required: Yes
Type: string

The name of the vehicle middleware.

protocolName
Required: Yes
Type: string

The protocol name of the vehicle middleware.

VehicleStatus

Description

Information about a campaign associated with a vehicle.

Members
campaignName
Type: string

The name of a campaign.

status
Type: string

The status of a campaign, which can be one of the following:

  • CREATED - The campaign has been created successfully but has not been approved.

  • READY - The campaign has been approved but has not been deployed to the vehicle.

  • HEALTHY - The campaign has been deployed to the vehicle.

  • SUSPENDED - The campaign has been suspended and data collection is paused.

  • DELETING - The campaign is being removed from the vehicle.

vehicleName
Type: string

The unique ID of the vehicle.

VehicleSummary

Description

Information about a vehicle.

To return this information about vehicles in your account, you can use the API operation.

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the vehicle.

attributes
Type: Associative array of custom strings keys (attributeName) to strings

Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).

decoderManifestArn
Required: Yes
Type: string

The ARN of a decoder manifest associated with the vehicle.

lastModificationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

modelManifestArn
Required: Yes
Type: string

The ARN of a vehicle model (model manifest) associated with the vehicle.

vehicleName
Required: Yes
Type: string

The unique ID of the vehicle.