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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

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' => [
        [
            's3Config' => [
                'bucketArn' => '<string>',
                'dataFormat' => 'JSON|PARQUET',
                'prefix' => '<string>',
                'storageCompressionFormat' => 'NONE|GZIP',
            ],
            'timestreamConfig' => [
                'executionRoleArn' => '<string>',
                'timestreamTableArn' => '<string>',
            ],
        ],
        // ...
    ],
    'dataExtraDimensions' => ['<string>', ...],
    'description' => '<string>',
    'diagnosticsMode' => 'OFF|SEND_ACTIVE_DTCS',
    'expiryTime' => <DateTime>,
    'lastModificationTime' => <DateTime>,
    'name' => '<string>',
    'postTriggerCollectionDuration' => <integer>,
    'priority' => <integer>,
    'signalCatalogArn' => '<string>',
    'signalsToCollect' => [
        [
            'maxSampleCount' => <integer>,
            'minimumSamplingIntervalMs' => <integer>,
            'name' => '<string>',
        ],
        // ...
    ],
    'spoolingMode' => 'OFF|TO_DISK',
    'startTime' => <DateTime>,
    'status' => 'CREATING|WAITING_FOR_APPROVAL|RUNNING|SUSPENDED',
    'targetArn' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

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

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

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

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

Result Syntax

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

Result Details

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 a vehicle with any associated campaigns.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'networkInterfaces' => [
        [
            'canInterface' => [
                'name' => '<string>',
                'protocolName' => '<string>',
                'protocolVersion' => '<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',
            'vehicleMiddleware' => [
                'name' => '<string>',
                'protocolName' => 'ROS_2',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'signalDecoders' => [
        [
            'canSignal' => [
                'factor' => <float>,
                'isBigEndian' => true || false,
                'isSigned' => true || false,
                'length' => <integer>,
                'messageId' => <integer>,
                'name' => '<string>',
                'offset' => <float>,
                'startBit' => <integer>,
            ],
            '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',
        ],
        // ...
    ],
]

Result Details

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.

Parameter Syntax

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

Parameter Details

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Parameter Syntax

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

Parameter Details

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'networkInterfacesToAdd' => [
        [
            'canInterface' => [
                'name' => '<string>', // REQUIRED
                'protocolName' => '<string>',
                'protocolVersion' => '<string>',
            ],
            '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', // REQUIRED
            'vehicleMiddleware' => [
                'name' => '<string>', // REQUIRED
                'protocolName' => 'ROS_2', // REQUIRED
            ],
        ],
        // ...
    ],
    'networkInterfacesToRemove' => ['<string>', ...],
    'networkInterfacesToUpdate' => [
        [
            'canInterface' => [
                'name' => '<string>', // REQUIRED
                'protocolName' => '<string>',
                'protocolVersion' => '<string>',
            ],
            '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', // 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
            ],
            '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', // 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
            ],
            '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', // REQUIRED
        ],
        // ...
    ],
    'status' => 'ACTIVE|DRAFT|INVALID|VALIDATING',
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

UpdateVehicle

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

Updates a vehicle.

Parameter Syntax

$result = $client->updateVehicle([
    'attributeUpdateMode' => 'Overwrite|Merge',
    'attributes' => ['<string>', ...],
    'decoderManifestArn' => '<string>',
    'modelManifestArn' => '<string>',
    'vehicleName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.