Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of your vehicle data models, independent of the in-vehicle communication architecture, and define data collection rules to transfer only high-value data to the cloud.
For more information, see What is Amazon Web Services IoT FleetWise? in the Amazon Web Services IoT FleetWise Developer Guide.
' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: iotfleetwise x-aws-signingName: iotfleetwise x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotfleetwise-2021-06-17.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/iotfleetwise/' servers: - url: 'http://iotfleetwise.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS IoT FleetWise multi-region endpoint - url: 'https://iotfleetwise.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS IoT FleetWise multi-region endpoint - url: 'http://iotfleetwise.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT FleetWise endpoint for China (Beijing) and China (Ningxia) - url: 'https://iotfleetwise.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT FleetWise endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /#X-Amz-Target=IoTAutobahnControlPlane.AssociateVehicleFleet: post: operationId: AssociateVehicleFleet description: ' Adds, or associates, a vehicle with a fleet. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateVehicleFleetResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssociateVehicleFleetRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - IoTAutobahnControlPlane.AssociateVehicleFleet summary: Amazon IoT FleetWise Associate Vehicle Fleet x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=IoTAutobahnControlPlane.BatchCreateVehicle: post: operationId: BatchCreateVehicle description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchCreateVehicleResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchCreateVehicleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - IoTAutobahnControlPlane.BatchCreateVehicle summary: Amazon IoT FleetWise Batch Create Vehicle x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=IoTAutobahnControlPlane.BatchUpdateVehicle: post: operationId: BatchUpdateVehicle description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchUpdateVehicleResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchUpdateVehicleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - IoTAutobahnControlPlane.BatchUpdateVehicle summary: Amazon IoT FleetWise Batch Update Vehicle x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=IoTAutobahnControlPlane.CreateCampaign: post: operationId: CreateCampaign description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateCampaignResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '486': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCampaignRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - IoTAutobahnControlPlane.CreateCampaign summary: Amazon IoT FleetWise Create Campaign x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=IoTAutobahnControlPlane.CreateDecoderManifest: post: operationId: CreateDecoderManifest description: '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.
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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateFleetResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '486': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFleetRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - IoTAutobahnControlPlane.CreateFleet summary: Amazon IoT FleetWise Create Fleet x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=IoTAutobahnControlPlane.CreateModelManifest: post: operationId: CreateModelManifest description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateModelManifestResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '486': description: InvalidSignalsException content: application/json: schema: $ref: '#/components/schemas/InvalidSignalsException' '487': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateModelManifestRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - IoTAutobahnControlPlane.CreateModelManifest summary: Amazon IoT FleetWise Create Model Manifest x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=IoTAutobahnControlPlane.CreateSignalCatalog: post: operationId: CreateSignalCatalog description: ' Creates a collection of standardized signals that can be reused to create vehicle models.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSignalCatalogResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: InvalidNodeException content: application/json: schema: $ref: '#/components/schemas/InvalidNodeException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '486': description: InvalidSignalsException content: application/json: schema: $ref: '#/components/schemas/InvalidSignalsException' '487': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSignalCatalogRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - IoTAutobahnControlPlane.CreateSignalCatalog summary: Amazon IoT FleetWise Create Signal Catalog x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=IoTAutobahnControlPlane.CreateVehicle: post: operationId: CreateVehicle description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateVehicleResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '486': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateVehicleRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - IoTAutobahnControlPlane.CreateVehicle summary: Amazon IoT FleetWise Create Vehicle x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=IoTAutobahnControlPlane.DeleteCampaign: post: operationId: DeleteCampaign description: ' Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteCampaignResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteCampaignRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - IoTAutobahnControlPlane.DeleteCampaign summary: Amazon IoT FleetWise Delete Campaign x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /#X-Amz-Target=IoTAutobahnControlPlane.DeleteDecoderManifest: post: operationId: DeleteDecoderManifest description: 'Deletes a decoder manifest. You can''t delete a decoder manifest if it has vehicles associated with it.
If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
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.
If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Deletes a vehicle model (model manifest).
If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Deletes a signal catalog.
If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Deletes a vehicle and removes it from any campaigns.
If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn''t delete the vehicle.
If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
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.
Lists information about created campaigns.
This API operation uses pagination. Specify the nextToken parameter in the request to return more
results.
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.
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.
Lists decoder manifests.
This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
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.
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.
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.
Retrieves a list of vehicle models (model manifests).
This API operation uses pagination. Specify the nextToken parameter in the request to return
more results.
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.
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.
Retrieves a list of summaries of created vehicles.
This API operation uses pagination. Specify the nextToken parameter in the request to return more
results.
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.
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.
<p>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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html">Setting
up Amazon Web Services IoT FleetWise</a>. </p> <note> <p>An Amazon Web Services account is <b>not</b> the same thing as a "user." An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html#intro-identity-users">Amazon
Web Services user</a> is an identity that you create using Identity and Access Management (IAM) and takes the form of either an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html">IAM
user</a> or an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM role, both with credentials</a>. A single Amazon Web Services account can,
and typically does, contain many users and roles.</p> </note> 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.
Updates the description of an existing fleet.
If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.
A list of information about the batch of updated vehicles.
This list contains only unique IDs for the vehicles that were updated.
(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it''s not specified, 0 is used.
Default: 0
(Optional) 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)
' postTriggerCollectionDuration: allOf: - $ref: '#/components/schemas/uint32' - description: ' (Optional) 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
(Optional) 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
(Optional) 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
(Optional) 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
(Optional) 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
(Optional) 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
' tags: allOf: - $ref: '#/components/schemas/TagList' - description: Metadata that can be used to manage the campaign. dataDestinationConfigs: allOf: - $ref: '#/components/schemas/DataDestinationConfigs' - description: 'The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
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.
' ConflictException: {} CreateDecoderManifestResponse: type: object required: - name - arn properties: name: allOf: - $ref: '#/components/schemas/resourceName' - description: ' The name of the created decoder manifest. ' arn: allOf: - $ref: '#/components/schemas/arn' - description: ' The ARN of the created decoder manifest. ' CreateDecoderManifestRequest: type: object required: - name - modelManifestArn title: CreateDecoderManifestRequest properties: name: allOf: - $ref: '#/components/schemas/resourceName' - description: ' The unique name of the decoder manifest to create.' description: allOf: - $ref: '#/components/schemas/description' - description: ' A brief description of the decoder manifest. ' modelManifestArn: allOf: - $ref: '#/components/schemas/arn' - description: ' The Amazon Resource Name (ARN) of the vehicle model (model manifest). ' signalDecoders: allOf: - $ref: '#/components/schemas/SignalDecoders' - description: ' A list of information about signal decoders. ' networkInterfaces: allOf: - $ref: '#/components/schemas/NetworkInterfaces' - description: ' A list of information about available network interfaces. ' tags: allOf: - $ref: '#/components/schemas/TagList' - description: Metadata that can be used to manage the decoder manifest. DecoderManifestValidationException: {} CreateFleetResponse: type: object required: - id - arn properties: id: allOf: - $ref: '#/components/schemas/fleetId' - description: ' The ID of the created fleet. ' arn: allOf: - $ref: '#/components/schemas/arn' - description: ' The ARN of the created fleet. ' CreateFleetRequest: type: object required: - fleetId - signalCatalogArn title: CreateFleetRequest properties: fleetId: allOf: - $ref: '#/components/schemas/fleetId' - description: ' The unique ID of the fleet to create. ' description: allOf: - $ref: '#/components/schemas/description' - description: ' A brief description of the fleet to create. ' signalCatalogArn: allOf: - $ref: '#/components/schemas/arn' - description: ' The Amazon Resource Name (ARN) of a signal catalog. ' tags: allOf: - $ref: '#/components/schemas/TagList' - description: Metadata that can be used to manage the fleet. CreateModelManifestResponse: type: object required: - name - arn properties: name: allOf: - $ref: '#/components/schemas/resourceName' - description: ' The name of the created vehicle model.' arn: allOf: - $ref: '#/components/schemas/arn' - description: ' The ARN of the created vehicle model.' CreateModelManifestRequest: type: object required: - name - nodes - signalCatalogArn title: CreateModelManifestRequest properties: name: allOf: - $ref: '#/components/schemas/resourceName' - description: ' The name of the vehicle model to create.' description: allOf: - $ref: '#/components/schemas/description' - description: ' A brief description of the vehicle model. ' nodes: allOf: - $ref: '#/components/schemas/listOfStrings' - description: ' A list of nodes, which are a general abstraction of signals. ' signalCatalogArn: allOf: - $ref: '#/components/schemas/arn' - description: ' The Amazon Resource Name (ARN) of a signal catalog. ' tags: allOf: - $ref: '#/components/schemas/TagList' - description: Metadata that can be used to manage the vehicle model. InvalidSignalsException: {} CreateSignalCatalogResponse: type: object required: - name - arn properties: name: allOf: - $ref: '#/components/schemas/resourceName' - description: ' The name of the created signal catalog. ' arn: allOf: - $ref: '#/components/schemas/arn' - description: ' The ARN of the created signal catalog. ' CreateSignalCatalogRequest: type: object required: - name title: CreateSignalCatalogRequest properties: name: allOf: - $ref: '#/components/schemas/resourceName' - description: ' The name of the signal catalog to create. ' description: allOf: - $ref: '#/components/schemas/description' - description: A brief description of the signal catalog. nodes: allOf: - $ref: '#/components/schemas/Nodes' - description: ' A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.' tags: allOf: - $ref: '#/components/schemas/TagList' - description: Metadata that can be used to manage the signal catalog. InvalidNodeException: {} CreateVehicleResponse: type: object properties: vehicleName: allOf: - $ref: '#/components/schemas/vehicleName' - description: The unique ID of the created vehicle. arn: allOf: - $ref: '#/components/schemas/arn' - description: ' The ARN of the created vehicle. ' thingArn: allOf: - $ref: '#/components/schemas/arn' - description: ' The ARN of a created or validated Amazon Web Services IoT thing. ' CreateVehicleRequest: type: object required: - vehicleName - modelManifestArn - decoderManifestArn title: CreateVehicleRequest properties: vehicleName: allOf: - $ref: '#/components/schemas/vehicleName' - description: ' The unique ID of the vehicle to create. ' modelManifestArn: allOf: - $ref: '#/components/schemas/arn' - description: ' The Amazon Resource Name ARN of a vehicle model. ' decoderManifestArn: allOf: - $ref: '#/components/schemas/arn' - description: ' The ARN of a decoder manifest. ' attributes: allOf: - $ref: '#/components/schemas/attributesMap' - description: 'Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
A campaign must include the keys (attribute
names) in dataExtraDimensions for them to display in Amazon Timestream.
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:
The Amazon Resource Name (ARN) of the deleted campaign.
The ARN isn’t returned if a campaign doesn’t exist.
CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED. '
startTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: ' The time, in milliseconds, to deliver a campaign after it was approved.'
expiryTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: ' 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.'
postTriggerCollectionDuration:
allOf:
- $ref: '#/components/schemas/uint32'
- description: ' How long (in seconds) to collect raw data after a triggering event initiates the collection. '
diagnosticsMode:
allOf:
- $ref: '#/components/schemas/DiagnosticsMode'
- description: ' Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. '
spoolingMode:
allOf:
- $ref: '#/components/schemas/SpoolingMode'
- description: ' 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. '
compression:
allOf:
- $ref: '#/components/schemas/Compression'
- description: ' 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. '
priority:
allOf:
- $ref: '#/components/schemas/priority'
- description: ' 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.'
signalsToCollect:
allOf:
- $ref: '#/components/schemas/SignalInformationList'
- description: ' Information about a list of signals to collect data on. '
collectionScheme:
allOf:
- $ref: '#/components/schemas/CollectionScheme'
- description: ' Information about the data collection scheme associated with the campaign. '
dataExtraDimensions:
allOf:
- $ref: '#/components/schemas/DataExtraDimensionNodePathList'
- description: ' A list of vehicle attributes associated with the campaign. '
creationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: ' The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time). '
lastModificationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The last time the campaign was modified.
dataDestinationConfigs:
allOf:
- $ref: '#/components/schemas/DataDestinationConfigs'
- description: 'The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
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.
' GetCampaignRequest: type: object required: - name title: GetCampaignRequest properties: name: allOf: - $ref: '#/components/schemas/campaignName' - description: ' The name of the campaign to retrieve information about. ' GetDecoderManifestResponse: type: object required: - name - arn - creationTime - lastModificationTime properties: name: allOf: - $ref: '#/components/schemas/string' - description: ' The name of the decoder manifest. ' arn: allOf: - $ref: '#/components/schemas/arn' - description: ' The Amazon Resource Name (ARN) of the decoder manifest. ' description: allOf: - $ref: '#/components/schemas/description' - description: ' A brief description of the decoder manifest.' modelManifestArn: allOf: - $ref: '#/components/schemas/arn' - description: ' The ARN of a vehicle model (model manifest) associated with the decoder manifest.' status: allOf: - $ref: '#/components/schemas/ManifestStatus' - description: ' The state of the decoder manifest. If the status isACTIVE, the decoder manifest can''t be edited. If the status is marked DRAFT, you can edit the decoder
manifest.'
creationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: ' The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time). '
lastModificationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: ' The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). '
GetDecoderManifestRequest:
type: object
required:
- name
title: GetDecoderManifestRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the decoder manifest to retrieve information about. '
GetFleetResponse:
type: object
required:
- id
- arn
- signalCatalogArn
- creationTime
- lastModificationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/fleetId'
- description: ' The ID of the fleet.'
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: ' The Amazon Resource Name (ARN) of the fleet. '
description:
allOf:
- $ref: '#/components/schemas/description'
- description: ' A brief description of the fleet. '
signalCatalogArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: ' The ARN of a signal catalog associated with the fleet. '
creationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: ' The time the fleet was created in seconds since epoch (January 1, 1970 at midnight UTC time). '
lastModificationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: ' The time the fleet was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time). '
GetFleetRequest:
type: object
required:
- fleetId
title: GetFleetRequest
properties:
fleetId:
allOf:
- $ref: '#/components/schemas/fleetId'
- description: ' The ID of the fleet to retrieve information about. '
GetLoggingOptionsResponse:
type: object
required:
- cloudWatchLogDelivery
properties:
cloudWatchLogDelivery:
allOf:
- $ref: '#/components/schemas/CloudWatchLogDeliveryOptions'
- description: Returns information about log delivery to Amazon CloudWatch Logs.
GetLoggingOptionsRequest:
type: object
title: GetLoggingOptionsRequest
properties: {}
GetModelManifestResponse:
type: object
required:
- name
- arn
- creationTime
- lastModificationTime
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the vehicle model. '
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: ' The Amazon Resource Name (ARN) of the vehicle model. '
description:
allOf:
- $ref: '#/components/schemas/description'
- description: ' A brief description of the vehicle model. '
signalCatalogArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: ' The ARN of the signal catalog associated with the vehicle model. '
status:
allOf:
- $ref: '#/components/schemas/ManifestStatus'
- description: ' 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.'
creationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: 'The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).'
lastModificationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: The last time the vehicle model was modified.
GetModelManifestRequest:
type: object
required:
- name
title: GetModelManifestRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the vehicle model to retrieve information about. '
GetRegisterAccountStatusResponse:
type: object
required:
- customerAccountId
- accountStatus
- iamRegistrationResponse
- creationTime
- lastModificationTime
properties:
customerAccountId:
allOf:
- $ref: '#/components/schemas/customerAccountId'
- description: ' The unique ID of the Amazon Web Services account, provided at account creation. '
accountStatus:
allOf:
- $ref: '#/components/schemas/RegistrationStatus'
- description: '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.
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
null if there are no more results. '
GetVehicleStatusRequest:
type: object
required:
- vehicleName
title: GetVehicleStatusRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListCampaignsRequest:
type: object
title: ListCampaignsRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
CREATING, WAITING_FOR_APPROVAL,
RUNNING, or SUSPENDED.'
ListDecoderManifestNetworkInterfacesResponse:
type: object
properties:
networkInterfaces:
allOf:
- $ref: '#/components/schemas/NetworkInterfaces'
- description: ' A list of information about network interfaces. '
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: ' The token to retrieve the next set of results, or null if there are no more results. '
ListDecoderManifestNetworkInterfacesRequest:
type: object
required:
- name
title: ListDecoderManifestNetworkInterfacesRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the decoder manifest to list information about. '
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListDecoderManifestSignalsRequest:
type: object
required:
- name
title: ListDecoderManifestSignalsRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the decoder manifest to list information about. '
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListDecoderManifestsRequest:
type: object
title: ListDecoderManifestsRequest
properties:
modelManifestArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: ' The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest. '
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListFleetsRequest:
type: object
title: ListFleetsRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListFleetsForVehicleRequest:
type: object
required:
- vehicleName
title: ListFleetsForVehicleRequest
properties:
vehicleName:
allOf:
- $ref: '#/components/schemas/vehicleName'
- description: ' The ID of the vehicle to retrieve information about. '
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListModelManifestNodesRequest:
type: object
required:
- name
title: ListModelManifestNodesRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the vehicle model to list information about. '
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListModelManifestsRequest:
type: object
title: ListModelManifestsRequest
properties:
signalCatalogArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: ' The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.'
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListSignalCatalogNodesRequest:
type: object
required:
- name
title: ListSignalCatalogNodesRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the signal catalog to list information about. '
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListSignalCatalogsRequest:
type: object
title: ListSignalCatalogsRequest
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListVehiclesRequest:
type: object
title: ListVehiclesRequest
properties:
modelManifestArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: ' 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:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
null if there are no more results. '
ListVehiclesInFleetRequest:
type: object
required:
- fleetId
title: ListVehiclesInFleetRequest
properties:
fleetId:
allOf:
- $ref: '#/components/schemas/fleetId'
- description: ' The ID of a fleet. '
nextToken:
allOf:
- $ref: '#/components/schemas/nextToken'
- description: '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.
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.
A list of vehicle attributes to associate with a signal.
Default: An empty array
' action: allOf: - $ref: '#/components/schemas/UpdateCampaignAction' - description: '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.
ACTIVE, the decoder manifest can''t be edited. If the status is DRAFT, you can edit the decoder manifest. '
UpdateFleetResponse:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/fleetId'
- description: The ID of the updated fleet.
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The Amazon Resource Name (ARN) of the updated fleet.
UpdateFleetRequest:
type: object
required:
- fleetId
title: UpdateFleetRequest
properties:
fleetId:
allOf:
- $ref: '#/components/schemas/fleetId'
- description: ' The ID of the fleet to update. '
description:
allOf:
- $ref: '#/components/schemas/description'
- description: ' An updated description of the fleet. '
UpdateModelManifestResponse:
type: object
required:
- name
- arn
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the updated vehicle model. '
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: ' The Amazon Resource Name (ARN) of the updated vehicle model. '
UpdateModelManifestRequest:
type: object
required:
- name
title: UpdateModelManifestRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the vehicle model to update. '
description:
allOf:
- $ref: '#/components/schemas/description'
- description: ' A brief description of the vehicle model. '
nodesToAdd:
allOf:
- $ref: '#/components/schemas/NodePaths'
- description: ' A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the vehicle model. '
nodesToRemove:
allOf:
- $ref: '#/components/schemas/NodePaths'
- description: ' A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from the vehicle model. '
status:
allOf:
- $ref: '#/components/schemas/ManifestStatus'
- description: ' 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. '
UpdateSignalCatalogResponse:
type: object
required:
- name
- arn
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the updated signal catalog. '
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: ' The ARN of the updated signal catalog. '
UpdateSignalCatalogRequest:
type: object
required:
- name
title: UpdateSignalCatalogRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/resourceName'
- description: ' The name of the signal catalog to update. '
description:
allOf:
- $ref: '#/components/schemas/description'
- description: ' A brief description of the signal catalog to update.'
nodesToAdd:
allOf:
- $ref: '#/components/schemas/Nodes'
- description: ' A list of information about nodes to add to the signal catalog. '
nodesToUpdate:
allOf:
- $ref: '#/components/schemas/Nodes'
- description: ' A list of information about nodes to update in the signal catalog. '
nodesToRemove:
allOf:
- $ref: '#/components/schemas/NodePaths'
- description: ' A list of fullyQualifiedName of nodes to remove from the signal catalog. '
UpdateVehicleResponse:
type: object
properties:
vehicleName:
allOf:
- $ref: '#/components/schemas/vehicleName'
- description: The ID of the updated vehicle.
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The ARN of the updated vehicle.
UpdateVehicleRequest:
type: object
required:
- vehicleName
title: UpdateVehicleRequest
properties:
vehicleName:
allOf:
- $ref: '#/components/schemas/vehicleName'
- description: The unique ID of the vehicle to update.
modelManifestArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The ARN of a vehicle model (model manifest) associated with the vehicle.
decoderManifestArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The ARN of the decoder manifest associated with this vehicle.
attributes:
allOf:
- $ref: '#/components/schemas/attributesMap'
- description: 'Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
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.
string: type: string NodeDataType: type: string enum: - 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 description: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 2048 listOfStrings: type: array items: $ref: '#/components/schemas/string' double: type: number format: double message: type: string pattern: '[^\u0000-\u001F\u007F]+' minLength: 1 maxLength: 2048 Actuator: type: object required: - fullyQualifiedName - dataType properties: fullyQualifiedName: allOf: - $ref: '#/components/schemas/string' - description: 'The fully qualified name of the actuator. For example, the fully qualified name of an actuator might beVehicle.Front.Left.Door.Lock.'
dataType:
allOf:
- $ref: '#/components/schemas/NodeDataType'
- description: 'The specified data type of the actuator. '
description:
allOf:
- $ref: '#/components/schemas/description'
- description: A brief description of the actuator.
unit:
allOf:
- $ref: '#/components/schemas/string'
- description: The scientific unit for the actuator.
allowedValues:
allOf:
- $ref: '#/components/schemas/listOfStrings'
- description: A list of possible values an actuator can take.
min:
allOf:
- $ref: '#/components/schemas/double'
- description: The specified possible minimum value of an actuator.
max:
allOf:
- $ref: '#/components/schemas/double'
- description: The specified possible maximum value of an actuator.
assignedValue:
allOf:
- $ref: '#/components/schemas/string'
- deprecated: true
description: A specified value for the actuator.assignedValue is no longer in use
deprecationMessage:
allOf:
- $ref: '#/components/schemas/message'
- description: The deprecation message for the node or the branch that was moved or deleted.
comment:
allOf:
- $ref: '#/components/schemas/message'
- description: A comment in addition to the description.
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.
Vehicle.Body.Engine.Type.'
dataType:
allOf:
- $ref: '#/components/schemas/NodeDataType'
- description: 'The specified data type of the attribute. '
description:
allOf:
- $ref: '#/components/schemas/description'
- description: A brief description of the attribute.
unit:
allOf:
- $ref: '#/components/schemas/string'
- description: The scientific unit for the attribute.
allowedValues:
allOf:
- $ref: '#/components/schemas/listOfStrings'
- description: A list of possible values an attribute can be assigned.
min:
allOf:
- $ref: '#/components/schemas/double'
- description: The specified possible minimum value of the attribute.
max:
allOf:
- $ref: '#/components/schemas/double'
- description: The specified possible maximum value of the attribute.
assignedValue:
allOf:
- $ref: '#/components/schemas/string'
- deprecated: true
description: A specified value for the attribute.assignedValue is no longer in use
defaultValue:
allOf:
- $ref: '#/components/schemas/string'
- description: The default value of the attribute.
deprecationMessage:
allOf:
- $ref: '#/components/schemas/message'
- description: The deprecation message for the node or the branch that was moved or deleted.
comment:
allOf:
- $ref: '#/components/schemas/message'
- description: A comment in addition to the description.
description: 'A signal that represents static information about the vehicle, such as engine type or manufacturing date.'
createVehicleRequestItems:
type: array
items:
$ref: '#/components/schemas/CreateVehicleRequestItem'
minItems: 1
createVehicleResponses:
type: array
items:
$ref: '#/components/schemas/CreateVehicleResponseItem'
createVehicleErrors:
type: array
items:
$ref: '#/components/schemas/CreateVehicleError'
updateVehicleRequestItems:
type: array
items:
$ref: '#/components/schemas/UpdateVehicleRequestItem'
minItems: 1
updateVehicleResponseItems:
type: array
items:
$ref: '#/components/schemas/UpdateVehicleResponseItem'
updateVehicleErrors:
type: array
items:
$ref: '#/components/schemas/UpdateVehicleError'
Branch:
type: object
required:
- fullyQualifiedName
properties:
fullyQualifiedName:
allOf:
- $ref: '#/components/schemas/string'
- description: 'The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine.'
description:
allOf:
- $ref: '#/components/schemas/description'
- description: A brief description of the branch.
deprecationMessage:
allOf:
- $ref: '#/components/schemas/message'
- description: The deprecation message for the node or the branch that was moved or deleted.
comment:
allOf:
- $ref: '#/components/schemas/message'
- description: A comment in addition to the description.
description: A group of signals that are defined in a hierarchical structure.
CampaignStatus:
type: string
enum:
- CREATING
- WAITING_FOR_APPROVAL
- RUNNING
- SUSPENDED
arn:
type: string
campaignName:
type: string
pattern: '[a-zA-Z\d\-_:]+'
minLength: 1
maxLength: 100
timestamp:
type: string
format: date-time
CampaignSummary:
type: object
required:
- creationTime
- lastModificationTime
properties:
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The Amazon Resource Name (ARN) of a campaign.
name:
allOf:
- $ref: '#/components/schemas/campaignName'
- description: The name of a campaign.
description:
allOf:
- $ref: '#/components/schemas/description'
- description: The description of the campaign.
signalCatalogArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The ARN of the signal catalog associated with the campaign.
targetArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The ARN of a vehicle or fleet to which the campaign is deployed.
status:
allOf:
- $ref: '#/components/schemas/CampaignStatus'
- description: '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.
Information about a campaign.
You can use the API operation to return this information about multiple created campaigns.
InterfaceId: type: string minLength: 1 maxLength: 50 NetworkFilesList: type: array items: $ref: '#/components/schemas/NetworkFileBlob' minItems: 1 maxItems: 5 ModelSignalsMap: type: object additionalProperties: $ref: '#/components/schemas/string' CanDbcDefinition: type: object required: - networkInterface - canDbcFiles properties: networkInterface: allOf: - $ref: '#/components/schemas/InterfaceId' - description: Contains information about a network interface. canDbcFiles: allOf: - $ref: '#/components/schemas/NetworkFilesList' - description: 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. signalsMap: allOf: - $ref: '#/components/schemas/ModelSignalsMap' - description: Pairs every signal specified in your vehicle model with a signal decoder. description: Configurations used to create a decoder manifest. CanInterfaceName: type: string minLength: 1 maxLength: 100 ProtocolName: type: string minLength: 1 maxLength: 50 ProtocolVersion: type: string minLength: 1 maxLength: 50 CanInterface: type: object required: - name properties: name: allOf: - $ref: '#/components/schemas/CanInterfaceName' - description: The unique name of the interface. protocolName: allOf: - $ref: '#/components/schemas/ProtocolName' - description: The name of the communication protocol for the interface. protocolVersion: allOf: - $ref: '#/components/schemas/ProtocolVersion' - description: The version of the communication protocol for the interface. description: A single controller area network (CAN) device interface. nonNegativeInteger: type: integer minimum: 0 boolean: type: boolean CanSignalName: type: string minLength: 1 maxLength: 100 CanSignal: type: object required: - messageId - isBigEndian - isSigned - startBit - offset - factor - length properties: messageId: allOf: - $ref: '#/components/schemas/nonNegativeInteger' - description: The ID of the message. isBigEndian: allOf: - $ref: '#/components/schemas/boolean' - description: Whether the byte ordering of a CAN message is big-endian. isSigned: allOf: - $ref: '#/components/schemas/boolean' - description: Whether the message data is specified as a signed value. startBit: allOf: - $ref: '#/components/schemas/nonNegativeInteger' - description: '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.
value = raw_value * factor + offset.'
factor:
allOf:
- $ref: '#/components/schemas/double'
- description: A multiplier used to decode the CAN message.
length:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: How many bytes of data are in the message.
name:
allOf:
- $ref: '#/components/schemas/CanSignalName'
- description: The name of the signal.
description: Information about a single controller area network (CAN) signal and the messages it receives and transmits.
LogType:
type: string
enum:
- 'OFF'
- ERROR
CloudWatchLogGroupName:
type: string
pattern: '[\.\-_\/#A-Za-z0-9]+'
minLength: 1
maxLength: 512
CloudWatchLogDeliveryOptions:
type: object
required:
- logType
properties:
logType:
allOf:
- $ref: '#/components/schemas/LogType'
- description: The type of log to send data to Amazon CloudWatch Logs.
logGroupName:
allOf:
- $ref: '#/components/schemas/CloudWatchLogGroupName'
- description: The Amazon CloudWatch Logs group the operation sends data to.
description: The log delivery option to send data to Amazon CloudWatch Logs.
TimeBasedCollectionScheme:
type: object
required:
- periodMs
properties:
periodMs:
allOf:
- $ref: '#/components/schemas/collectionPeriodMs'
- description: '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.'
description: Information about a collection scheme that uses a time period to decide how often to collect data.
ConditionBasedCollectionScheme:
type: object
required:
- expression
properties:
expression:
allOf:
- $ref: '#/components/schemas/eventExpression'
- description: 'The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0.'
minimumTriggerIntervalMs:
allOf:
- $ref: '#/components/schemas/uint32'
- description: '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.
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.'
conditionLanguageVersion:
allOf:
- $ref: '#/components/schemas/languageVersion'
- description: Specifies the version of the conditional expression language.
description: Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
CollectionScheme:
type: object
properties:
timeBasedCollectionScheme:
allOf:
- $ref: '#/components/schemas/TimeBasedCollectionScheme'
- description: Information about a collection scheme that uses a time period to decide how often to collect data.
conditionBasedCollectionScheme:
allOf:
- $ref: '#/components/schemas/ConditionBasedCollectionScheme'
- description: Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
description: Specifies what data to collect and how often or when to collect it.
Compression:
type: string
enum:
- 'OFF'
- SNAPPY
eventExpression:
type: string
minLength: 1
maxLength: 2048
uint32:
type: integer
minimum: 0
maximum: 4294967295
TriggerMode:
type: string
enum:
- ALWAYS
- RISING_EDGE
languageVersion:
type: integer
minimum: 1
DiagnosticsMode:
type: string
enum:
- 'OFF'
- SEND_ACTIVE_DTCS
SpoolingMode:
type: string
enum:
- 'OFF'
- TO_DISK
priority:
type: integer
minimum: 0
SignalInformationList:
type: array
items:
$ref: '#/components/schemas/SignalInformation'
minItems: 0
maxItems: 1000
DataExtraDimensionNodePathList:
type: array
items:
$ref: '#/components/schemas/NodePath'
minItems: 0
maxItems: 5
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 0
maxItems: 50
DataDestinationConfigs:
type: array
items:
$ref: '#/components/schemas/DataDestinationConfig'
minItems: 1
maxItems: 1
resourceName:
type: string
pattern: '[a-zA-Z\d\-_:]+'
minLength: 1
maxLength: 100
SignalDecoders:
type: array
items:
$ref: '#/components/schemas/SignalDecoder'
minItems: 1
maxItems: 500
NetworkInterfaces:
type: array
items:
$ref: '#/components/schemas/NetworkInterface'
minItems: 1
maxItems: 500
Nodes:
type: array
items:
$ref: '#/components/schemas/Node'
minItems: 0
maxItems: 500
CreateVehicleError:
type: object
properties:
vehicleName:
allOf:
- $ref: '#/components/schemas/vehicleName'
- description: The ID of the vehicle with the error.
code:
allOf:
- $ref: '#/components/schemas/string'
- description: An HTTP error code.
message:
allOf:
- $ref: '#/components/schemas/string'
- description: A description of the HTTP error.
description: An HTTP error resulting from creating a vehicle.
attributesMap:
type: object
additionalProperties:
$ref: '#/components/schemas/attributeValue'
VehicleAssociationBehavior:
type: string
enum:
- CreateIotThing
- ValidateIotThingExists
CreateVehicleRequestItem:
type: object
required:
- vehicleName
- modelManifestArn
- decoderManifestArn
properties:
vehicleName:
allOf:
- $ref: '#/components/schemas/vehicleName'
- description: The unique ID of the vehicle to create.
modelManifestArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The ARN of the vehicle model (model manifest) to create the vehicle from.
decoderManifestArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: 'The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create. '
attributes:
allOf:
- $ref: '#/components/schemas/attributesMap'
- description: 'Static information about a vehicle in a key-value pair. For example: "engine Type" : "v6" '
associationBehavior:
allOf:
- $ref: '#/components/schemas/VehicleAssociationBehavior'
- description: 'An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.'
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: Metadata which can be used to manage the vehicle.
description: Information about the vehicle to create.
CreateVehicleResponseItem:
type: object
properties:
vehicleName:
allOf:
- $ref: '#/components/schemas/vehicleName'
- description: The unique ID of the vehicle to create.
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The ARN of the created vehicle.
thingArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The ARN of a created or validated Amazon Web Services IoT thing.
description: Information about a created vehicle.
S3Config:
type: object
required:
- bucketArn
properties:
bucketArn:
allOf:
- $ref: '#/components/schemas/S3BucketArn'
- description: The Amazon Resource Name (ARN) of the Amazon S3 bucket.
dataFormat:
allOf:
- $ref: '#/components/schemas/DataFormat'
- description: 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.
(Optional) 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/.
ACTIVE, the decoder manifest can''t be edited. If the status is marked DRAFT, you can edit the decoder
manifest.'
creationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: 'The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).'
lastModificationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: 'The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).'
description: Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.
FleetSummary:
type: object
required:
- id
- arn
- signalCatalogArn
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/fleetId'
- description: The unique ID of the fleet.
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The Amazon Resource Name (ARN) of the fleet.
description:
allOf:
- $ref: '#/components/schemas/description'
- description: A brief description of the fleet.
signalCatalogArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The ARN of the signal catalog associated with the fleet.
creationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: 'The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).'
lastModificationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: 'The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).'
description: Information about a fleet.
You can use the API operation to return this information about multiple fleets.
String: type: string FormattedVss: type: object properties: vssJson: allOf: - $ref: '#/components/schemas/String' - description: Provides the VSS in JSON format. 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.' FullyQualifiedName: type: string minLength: 1 maxLength: 150 Fqns: type: array items: $ref: '#/components/schemas/FullyQualifiedName' minItems: 1 maxItems: 500 customerAccountId: type: string RegistrationStatus: type: string enum: - REGISTRATION_PENDING - REGISTRATION_SUCCESS - REGISTRATION_FAILURE TimestreamRegistrationResponse: type: object required: - timestreamDatabaseName - timestreamTableName - registrationStatus properties: timestreamDatabaseName: allOf: - $ref: '#/components/schemas/TimestreamDatabaseName' - description: The name of the Timestream database. timestreamTableName: allOf: - $ref: '#/components/schemas/TimestreamTableName' - description: The name of the Timestream database table. timestreamDatabaseArn: allOf: - $ref: '#/components/schemas/arn' - description: The Amazon Resource Name (ARN) of the Timestream database. timestreamTableArn: allOf: - $ref: '#/components/schemas/arn' - description: The ARN of the Timestream database table. registrationStatus: allOf: - $ref: '#/components/schemas/RegistrationStatus' - description: 'The status of registering your Amazon Timestream resources. The status can be one ofREGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.'
errorMessage:
allOf:
- $ref: '#/components/schemas/errorMessage'
- description: A message associated with a registration error.
description: 'Information about the registered Amazon Timestream resources or errors, if any.'
IamRegistrationResponse:
type: object
required:
- roleArn
- registrationStatus
properties:
roleArn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The Amazon Resource Name (ARN) of the IAM role to register.
registrationStatus:
allOf:
- $ref: '#/components/schemas/RegistrationStatus'
- description: 'The status of registering your IAM resource. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.'
errorMessage:
allOf:
- $ref: '#/components/schemas/errorMessage'
- description: A message associated with a registration error.
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.
NodeCounts:
type: object
properties:
totalNodes:
allOf:
- $ref: '#/components/schemas/number'
- description: The total number of nodes in a vehicle network.
totalBranches:
allOf:
- $ref: '#/components/schemas/number'
- description: The total number of nodes in a vehicle network that represent branches.
totalSensors:
allOf:
- $ref: '#/components/schemas/number'
- description: The total number of nodes in a vehicle network that represent sensors.
totalAttributes:
allOf:
- $ref: '#/components/schemas/number'
- description: The total number of nodes in a vehicle network that represent attributes.
totalActuators:
allOf:
- $ref: '#/components/schemas/number'
- description: The total number of nodes in a vehicle network that represent actuators.
description: Information about the number of nodes and node types in a vehicle network.
nextToken:
type: string
minLength: 1
maxLength: 4096
maxResults:
type: integer
minimum: 1
maximum: 100
VehicleStatusList:
type: array
items:
$ref: '#/components/schemas/VehicleStatus'
IAMRoleArn:
type: string
pattern: 'arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)'
minLength: 20
maxLength: 2048
errorMessage:
type: string
IamResources:
type: object
required:
- roleArn
properties:
roleArn:
allOf:
- $ref: '#/components/schemas/IAMRoleArn'
- description: '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. '
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.
' NetworkFileDefinitions: type: array items: $ref: '#/components/schemas/NetworkFileDefinition' InterfaceIds: type: array items: $ref: '#/components/schemas/InterfaceId' minItems: 1 maxItems: 500 status: type: string campaignSummaries: type: array items: $ref: '#/components/schemas/CampaignSummary' decoderManifestSummaries: type: array items: $ref: '#/components/schemas/DecoderManifestSummary' fleets: type: array items: $ref: '#/components/schemas/fleetId' fleetSummaries: type: array items: $ref: '#/components/schemas/FleetSummary' modelManifestSummaries: type: array items: $ref: '#/components/schemas/ModelManifestSummary' signalCatalogSummaries: type: array items: $ref: '#/components/schemas/SignalCatalogSummary' vehicles: type: array items: $ref: '#/components/schemas/vehicleName' listVehiclesMaxResults: type: integer minimum: 1 maximum: 100 vehicleSummaries: type: array items: $ref: '#/components/schemas/VehicleSummary' ModelManifestSummary: type: object required: - creationTime - lastModificationTime properties: name: allOf: - $ref: '#/components/schemas/string' - description: The name of the vehicle model. arn: allOf: - $ref: '#/components/schemas/arn' - description: The Amazon Resource Name (ARN) of the vehicle model. signalCatalogArn: allOf: - $ref: '#/components/schemas/arn' - description: The ARN of the signal catalog associated with the vehicle model. description: allOf: - $ref: '#/components/schemas/description' - description: A brief description of the vehicle model. status: allOf: - $ref: '#/components/schemas/ManifestStatus' - description: 'The state of the vehicle model. If the status isACTIVE, the vehicle model can''t be edited. If the status is DRAFT, you can edit the vehicle model.'
creationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: 'The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).'
lastModificationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: 'The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).'
description: Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.
NetworkFileBlob:
type: string
NetworkFileDefinition:
type: object
properties:
canDbc:
allOf:
- $ref: '#/components/schemas/CanDbcDefinition'
- description: 'Information, including CAN DBC files, about the configurations used to create a decoder manifest.'
description: Specifications for defining a vehicle network.
NetworkInterfaceType:
type: string
enum:
- CAN_INTERFACE
- OBD_INTERFACE
ObdInterface:
type: object
required:
- name
- requestMessageId
properties:
name:
allOf:
- $ref: '#/components/schemas/ObdInterfaceName'
- description: The name of the interface.
requestMessageId:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: The ID of the message requesting vehicle data.
obdStandard:
allOf:
- $ref: '#/components/schemas/ObdStandard'
- description: The standard OBD II PID.
pidRequestIntervalSeconds:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: The maximum number message requests per second.
dtcRequestIntervalSeconds:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: The maximum number message requests per diagnostic trouble code per second.
useExtendedIds:
allOf:
- $ref: '#/components/schemas/boolean'
- description: Whether to use extended IDs in the message.
hasTransmissionEcu:
allOf:
- $ref: '#/components/schemas/boolean'
- description: Whether the vehicle has a transmission control module (TCM).
description: A network interface that specifies the On-board diagnostic (OBD) II network protocol.
NetworkInterface:
type: object
required:
- interfaceId
- type
properties:
interfaceId:
allOf:
- $ref: '#/components/schemas/InterfaceId'
- description: The ID of the network interface.
type:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceType'
- description: '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.'
canInterface:
allOf:
- $ref: '#/components/schemas/CanInterface'
- description: Information about a network interface specified by the Controller Area Network (CAN) protocol.
obdInterface:
allOf:
- $ref: '#/components/schemas/ObdInterface'
- description: Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
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.
' Sensor: type: object required: - fullyQualifiedName - dataType properties: fullyQualifiedName: allOf: - $ref: '#/components/schemas/string' - description: 'The fully qualified name of the sensor. For example, the fully qualified name of a sensor might beVehicle.Body.Engine.Battery.'
dataType:
allOf:
- $ref: '#/components/schemas/NodeDataType'
- description: 'The specified data type of the sensor. '
description:
allOf:
- $ref: '#/components/schemas/description'
- description: A brief description of a sensor.
unit:
allOf:
- $ref: '#/components/schemas/string'
- description: The scientific unit of measurement for data collected by the sensor.
allowedValues:
allOf:
- $ref: '#/components/schemas/listOfStrings'
- description: A list of possible values a sensor can take.
min:
allOf:
- $ref: '#/components/schemas/double'
- description: The specified possible minimum value of the sensor.
max:
allOf:
- $ref: '#/components/schemas/double'
- description: The specified possible maximum value of the sensor.
deprecationMessage:
allOf:
- $ref: '#/components/schemas/message'
- description: The deprecation message for the node or the branch that was moved or deleted.
comment:
allOf:
- $ref: '#/components/schemas/message'
- description: A comment in addition to the description.
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.
Information about a node specified as a branch.
A group of signals that are defined in a hierarchical structure.
Information about a node specified as an actuator.
An actuator is a digital representation of a vehicle device.
Information about a node specified as an attribute.
An attribute represents static information about a vehicle.
value = raw_value * scaling + offset.'
startByte:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: Indicates the beginning of the message.
byteLength:
allOf:
- $ref: '#/components/schemas/ObdByteLength'
- description: The length of a message.
bitRightShift:
allOf:
- $ref: '#/components/schemas/nonNegativeInteger'
- description: The number of positions to shift bits in the message.
bitMaskLength:
allOf:
- $ref: '#/components/schemas/ObdBitmaskLength'
- description: The number of bits to mask in a message.
description: Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
Prefix:
type: string
pattern: '[a-zA-Z0-9-_:./!*''()]+'
minLength: 1
maxLength: 512
TimestreamResources:
type: object
required:
- timestreamDatabaseName
- timestreamTableName
properties:
timestreamDatabaseName:
allOf:
- $ref: '#/components/schemas/TimestreamDatabaseName'
- description: The name of the registered Amazon Timestream database.
timestreamTableName:
allOf:
- $ref: '#/components/schemas/TimestreamTableName'
- description: The name of the registered Amazon Timestream database table.
description: The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.
S3BucketArn:
type: string
pattern: 'arn:(aws[a-zA-Z0-9-]*):s3:::.+'
minLength: 16
maxLength: 100
StorageCompressionFormat:
type: string
enum:
- NONE
- GZIP
SignalCatalogSummary:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/string'
- description: The name of the signal catalog.
arn:
allOf:
- $ref: '#/components/schemas/arn'
- description: The Amazon Resource Name (ARN) of the signal catalog.
creationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: 'The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time). '
lastModificationTime:
allOf:
- $ref: '#/components/schemas/timestamp'
- description: 'The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). '
description: 'Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.'
SignalDecoderType:
type: string
enum:
- CAN_SIGNAL
- OBD_SIGNAL
SignalDecoder:
type: object
required:
- fullyQualifiedName
- type
- interfaceId
properties:
fullyQualifiedName:
allOf:
- $ref: '#/components/schemas/FullyQualifiedName'
- description: The fully qualified name of a signal decoder as defined in a vehicle model.
type:
allOf:
- $ref: '#/components/schemas/SignalDecoderType'
- description: '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.'
interfaceId:
allOf:
- $ref: '#/components/schemas/InterfaceId'
- description: The ID of a network interface that specifies what network protocol a vehicle follows.
canSignal:
allOf:
- $ref: '#/components/schemas/CanSignal'
- description: Information about signal decoder using the Controller Area Network (CAN) protocol.
obdSignal:
allOf:
- $ref: '#/components/schemas/ObdSignal'
- description: Information about signal decoder using the On-board diagnostic (OBD) II protocol.
description: Information about a signal decoder.
wildcardSignalName:
type: string
pattern: '[\w|*|-]+(\.[\w|*|-]+)*'
minLength: 1
maxLength: 150
maxSampleCount:
type: integer
minimum: 1
maximum: 4294967295
SignalInformation:
type: object
required:
- name
properties:
name:
allOf:
- $ref: '#/components/schemas/wildcardSignalName'
- description: The name of the signal.
maxSampleCount:
allOf:
- $ref: '#/components/schemas/maxSampleCount'
- description: The maximum number of samples to collect.
minimumSamplingIntervalMs:
allOf:
- $ref: '#/components/schemas/uint32'
- description: '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.
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
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.
description: Information about the vehicle to update. UpdateVehicleResponseItem: type: object properties: vehicleName: allOf: - $ref: '#/components/schemas/vehicleName' - description: The unique ID of the updated vehicle. arn: allOf: - $ref: '#/components/schemas/arn' - description: The Amazon Resource Name (ARN) of the updated vehicle. description: Information about the updated vehicle. VehicleState: type: string enum: - CREATED - READY - HEALTHY - SUSPENDED - DELETING VehicleStatus: type: object properties: campaignName: allOf: - $ref: '#/components/schemas/string' - description: The name of a campaign. vehicleName: allOf: - $ref: '#/components/schemas/vehicleName' - description: The unique ID of the vehicle. status: allOf: - $ref: '#/components/schemas/VehicleState' - description: 'The state of a vehicle, which can be one of the following:
CREATED - Amazon Web Services IoT FleetWise sucessfully created the vehicle.
READY - The vehicle is ready to receive a campaign deployment.
HEALTHY - A campaign deployment was delivered to the vehicle.
SUSPENDED - A campaign associated with the vehicle was suspended and data collection was paused.
DELETING - Amazon Web Services IoT FleetWise
is removing a campaign from the vehicle.
Information about a vehicle.
To return this information about vehicles in your account, you can use the API operation.
' attributeName: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 150 attributeValue: type: string security: - hmac: []