Class: Aws::IoTFleetWise::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::IoTFleetWise::Client

show all

Includes:: ClientStubs

Defined in:: gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb

Overview

An API client for IoTFleetWise. To construct a client, you need to configure a :region and :credentials.

client = Aws::IoTFleetWise::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

#associate_vehicle_fleet(params = {}) ⇒ Struct
Adds, or associates, a vehicle with a fleet.
#batch_create_vehicle(params = {}) ⇒ Types::BatchCreateVehicleResponse
Creates a group, or batch, of vehicles.
#batch_update_vehicle(params = {}) ⇒ Types::BatchUpdateVehicleResponse
Updates a group, or batch, of vehicles.
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates an orchestration of data collection rules.
#create_decoder_manifest(params = {}) ⇒ Types::CreateDecoderManifestResponse
Creates the decoder manifest associated with a model manifest.
#create_fleet(params = {}) ⇒ Types::CreateFleetResponse
Creates a fleet that represents a group of vehicles.
#create_model_manifest(params = {}) ⇒ Types::CreateModelManifestResponse
Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
#create_signal_catalog(params = {}) ⇒ Types::CreateSignalCatalogResponse
Creates a collection of standardized signals that can be reused to create vehicle models.
#create_vehicle(params = {}) ⇒ Types::CreateVehicleResponse
Creates a vehicle, which is an instance of a vehicle model (model manifest).
#delete_campaign(params = {}) ⇒ Types::DeleteCampaignResponse
Deletes a data collection campaign.
#delete_decoder_manifest(params = {}) ⇒ Types::DeleteDecoderManifestResponse
Deletes a decoder manifest.
#delete_fleet(params = {}) ⇒ Types::DeleteFleetResponse
Deletes a fleet.
#delete_model_manifest(params = {}) ⇒ Types::DeleteModelManifestResponse
Deletes a vehicle model (model manifest).
#delete_signal_catalog(params = {}) ⇒ Types::DeleteSignalCatalogResponse
Deletes a signal catalog.
#delete_vehicle(params = {}) ⇒ Types::DeleteVehicleResponse
Deletes a vehicle and removes it from any campaigns.
#disassociate_vehicle_fleet(params = {}) ⇒ Struct
Removes, or disassociates, a vehicle from a fleet.
#get_campaign(params = {}) ⇒ Types::GetCampaignResponse
Retrieves information about a campaign.
#get_decoder_manifest(params = {}) ⇒ Types::GetDecoderManifestResponse
Retrieves information about a created decoder manifest.
#get_fleet(params = {}) ⇒ Types::GetFleetResponse
Retrieves information about a fleet.
#get_logging_options(params = {}) ⇒ Types::GetLoggingOptionsResponse
Retrieves the logging options.
#get_model_manifest(params = {}) ⇒ Types::GetModelManifestResponse
Retrieves information about a vehicle model (model manifest).
#get_register_account_status(params = {}) ⇒ Types::GetRegisterAccountStatusResponse
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.
#get_signal_catalog(params = {}) ⇒ Types::GetSignalCatalogResponse
Retrieves information about a signal catalog.
#get_vehicle(params = {}) ⇒ Types::GetVehicleResponse
Retrieves information about a vehicle.
#get_vehicle_status(params = {}) ⇒ Types::GetVehicleStatusResponse
Retrieves information about the status of a vehicle with any associated campaigns.
#import_decoder_manifest(params = {}) ⇒ Types::ImportDecoderManifestResponse
Creates a decoder manifest using your existing CAN DBC file from your local device.
#import_signal_catalog(params = {}) ⇒ Types::ImportSignalCatalogResponse
Creates a signal catalog using your existing VSS formatted content from your local device.
#list_campaigns(params = {}) ⇒ Types::ListCampaignsResponse
Lists information about created campaigns.
#list_decoder_manifest_network_interfaces(params = {}) ⇒ Types::ListDecoderManifestNetworkInterfacesResponse
Lists the network interfaces specified in a decoder manifest.
#list_decoder_manifest_signals(params = {}) ⇒ Types::ListDecoderManifestSignalsResponse
A list of information about signal decoders specified in a decoder manifest.
#list_decoder_manifests(params = {}) ⇒ Types::ListDecoderManifestsResponse
Lists decoder manifests.
#list_fleets(params = {}) ⇒ Types::ListFleetsResponse
Retrieves information for each created fleet in an Amazon Web Services account.
#list_fleets_for_vehicle(params = {}) ⇒ Types::ListFleetsForVehicleResponse
Retrieves a list of IDs for all fleets that the vehicle is associated with.
#list_model_manifest_nodes(params = {}) ⇒ Types::ListModelManifestNodesResponse
Lists information about nodes specified in a vehicle model (model manifest).
#list_model_manifests(params = {}) ⇒ Types::ListModelManifestsResponse
Retrieves a list of vehicle models (model manifests).
#list_signal_catalog_nodes(params = {}) ⇒ Types::ListSignalCatalogNodesResponse
Lists of information about the signals (nodes) specified in a signal catalog.
#list_signal_catalogs(params = {}) ⇒ Types::ListSignalCatalogsResponse
Lists all the created signal catalogs in an Amazon Web Services account.
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.
#list_vehicles(params = {}) ⇒ Types::ListVehiclesResponse
Retrieves a list of summaries of created vehicles.
#list_vehicles_in_fleet(params = {}) ⇒ Types::ListVehiclesInFleetResponse
Retrieves a list of summaries of all vehicles associated with a fleet.
#put_logging_options(params = {}) ⇒ Struct
Creates or updates the logging option.
#register_account(params = {}) ⇒ Types::RegisterAccountResponse
This API operation contains deprecated parameters.
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource.
#untag_resource(params = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign.
#update_decoder_manifest(params = {}) ⇒ Types::UpdateDecoderManifestResponse
Updates a decoder manifest.
#update_fleet(params = {}) ⇒ Types::UpdateFleetResponse
Updates the description of an existing fleet.
#update_model_manifest(params = {}) ⇒ Types::UpdateModelManifestResponse
Updates a vehicle model (model manifest).
#update_signal_catalog(params = {}) ⇒ Types::UpdateSignalCatalogResponse
Updates a signal catalog.
#update_vehicle(params = {}) ⇒ Types::UpdateVehicleResponse
Updates a vehicle.

Instance Method Summary collapse

#initialize(options) ⇒ Client constructor
A new instance of Client.

Constructor Details

#initialize(options) ⇒ `Client`

Returns a new instance of Client.

Parameters:

options (Hash)

Options Hash (options):

:credentials (required, Aws::CredentialProvider) —
Your AWS credentials. This can be an instance of any one of the following classes:
- Aws::Credentials - Used for configuring static, non-refreshing credentials.
- Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.
- Aws::AssumeRoleCredentials - Used when you need to assume a role.
- Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.
- Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.
- Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.
- Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- Aws::ECSCredentials - Used for loading credentials from instances running in ECS.
- Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.
When :credentials are not configured directly, the following locations will be searched for credentials:
- Aws.config[:credentials]
- The :access_key_id, :secret_access_key, and :session_token options.
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- ~/.aws/credentials
- ~/.aws/config
- EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
:region (required, String) —
The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:
- Aws.config[:region]
- ENV['AWS_REGION']
- ENV['AMAZON_REGION']
- ENV['AWS_DEFAULT_REGION']
- ~/.aws/credentials
- ~/.aws/config
:access_key_id (String)
:active_endpoint_cache (Boolean) — default: false —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.
:adaptive_retry_wait_to_fill (Boolean) — default: true —
Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.
:client_side_monitoring (Boolean) — default: false —
When true, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "127.0.0.1" —
Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_port (Integer) — default: 31000 —
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types.
:correct_clock_skew (Boolean) — default: true —
Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.
:defaults_mode (String) — default: "legacy" —
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
:disable_host_prefix_injection (Boolean) — default: false —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:endpoint (String) —
The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.
:endpoint_cache_max_entries (Integer) — default: 1000 —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —
When set to true, endpoint discovery will be enabled for operations when available.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —
The log formatter.
:log_level (Symbol) — default: :info —
The log level to send messages to the :logger at.
:logger (Logger) —
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:max_attempts (Integer) — default: 3 —
An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.
:profile (String) — default: "default" —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
:retry_backoff (Proc) —
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.
:retry_base_delay (Float) — default: 0.3 —
The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.
:retry_jitter (Symbol) — default: :none —
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

@see https://www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.
:retry_max_delay (Integer) — default: 0 —
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.
:retry_mode (String) — default: "legacy" —
Specifies which retry algorithm to use. Values are:
- legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.
- standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.
- adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
:sdk_ua_app_id (String) —
A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.
:secret_access_key (String)
:session_token (String)
:simple_json (Boolean) — default: false —
Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
:token_provider (Aws::TokenProvider) —
A Bearer Token Provider. This can be an instance of any one of the following classes:
- Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.
- Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.
When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.
:use_dualstack_endpoint (Boolean) —
When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.
:use_fips_endpoint (Boolean) —
When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request.
:endpoint_provider (Aws::IoTFleetWise::EndpointProvider) —
The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::IoTFleetWise::EndpointParameters
:http_proxy (URI::HTTP, String) —
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
:http_open_timeout (Float) — default: 15 —
The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.
:http_read_timeout (Float) — default: 60 —
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_idle_timeout (Float) — default: 5 —
The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
:http_continue_timeout (Float) — default: 1 —
The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.
:ssl_timeout (Float) — default: nil —
Sets the SSL timeout in seconds.
:http_wire_trace (Boolean) — default: false —
When true, HTTP debug output will be sent to the :logger.
:ssl_verify_peer (Boolean) — default: true —
When true, SSL peer certificates are verified when establishing a connection.
:ssl_ca_bundle (String) —
Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.
:ssl_ca_directory (String) —
Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



380
381
382

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 380

def initialize(*args)
  super
end

Instance Method Details

#associate_vehicle_fleet(params = {}) ⇒ `Struct`

Adds, or associates, a vehicle with a fleet.

Examples:

Request syntax with placeholder values


resp = client.associate_vehicle_fleet({
  vehicle_name: "vehicleName", # required
  fleet_id: "fleetId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:vehicle_name (required, String) —
The unique ID of the vehicle to associate with the fleet.
:fleet_id (required, String) —
The ID of a fleet.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 405

def associate_vehicle_fleet(params = {}, options = {})
  req = build_request(:associate_vehicle_fleet, params)
  req.send_request(options)
end

#batch_create_vehicle(params = {}) ⇒ `Types::BatchCreateVehicleResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.batch_create_vehicle({
  vehicles: [ # required
    {
      vehicle_name: "vehicleName", # required
      model_manifest_arn: "arn", # required
      decoder_manifest_arn: "arn", # required
      attributes: {
        "attributeName" => "attributeValue",
      },
      association_behavior: "CreateIotThing", # accepts CreateIotThing, ValidateIotThingExists
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
    },
  ],
})

Response structure


resp.vehicles #=> Array
resp.vehicles[0].vehicle_name #=> String
resp.vehicles[0].arn #=> String
resp.vehicles[0].thing_arn #=> String
resp.errors #=> Array
resp.errors[0].vehicle_name #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:vehicles (required, Array<Types::CreateVehicleRequestItem>) —
A list of information about each vehicle to create. For more information, see the API data type.

Returns:

(Types::BatchCreateVehicleResponse) —
Returns a response object which responds to the following methods:
- #vehicles => Array<Types::CreateVehicleResponseItem>
- #errors => Array<Types::CreateVehicleError>

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 468

def batch_create_vehicle(params = {}, options = {})
  req = build_request(:batch_create_vehicle, params)
  req.send_request(options)
end

#batch_update_vehicle(params = {}) ⇒ `Types::BatchUpdateVehicleResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.batch_update_vehicle({
  vehicles: [ # required
    {
      vehicle_name: "vehicleName", # required
      model_manifest_arn: "arn",
      decoder_manifest_arn: "arn",
      attributes: {
        "attributeName" => "attributeValue",
      },
      attribute_update_mode: "Overwrite", # accepts Overwrite, Merge
    },
  ],
})

Response structure


resp.vehicles #=> Array
resp.vehicles[0].vehicle_name #=> String
resp.vehicles[0].arn #=> String
resp.errors #=> Array
resp.errors[0].vehicle_name #=> String
resp.errors[0].code #=> Integer
resp.errors[0].message #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:vehicles (required, Array<Types::UpdateVehicleRequestItem>) —
A list of information about the vehicles to update. For more information, see the API data type.

Returns:

(Types::BatchUpdateVehicleResponse) —
Returns a response object which responds to the following methods:
- #vehicles => Array<Types::UpdateVehicleResponseItem>
- #errors => Array<Types::UpdateVehicleError>

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 524

def batch_update_vehicle(params = {}, options = {})
  req = build_request(:batch_update_vehicle, params)
  req.send_request(options)
end

#create_campaign(params = {}) ⇒ `Types::CreateCampaignResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.create_campaign({
  name: "campaignName", # required
  description: "description",
  signal_catalog_arn: "arn", # required
  target_arn: "arn", # required
  start_time: Time.now,
  expiry_time: Time.now,
  post_trigger_collection_duration: 1,
  diagnostics_mode: "OFF", # accepts OFF, SEND_ACTIVE_DTCS
  spooling_mode: "OFF", # accepts OFF, TO_DISK
  compression: "OFF", # accepts OFF, SNAPPY
  priority: 1,
  signals_to_collect: [
    {
      name: "wildcardSignalName", # required
      max_sample_count: 1,
      minimum_sampling_interval_ms: 1,
    },
  ],
  collection_scheme: { # required
    time_based_collection_scheme: {
      period_ms: 1, # required
    },
    condition_based_collection_scheme: {
      expression: "eventExpression", # required
      minimum_trigger_interval_ms: 1,
      trigger_mode: "ALWAYS", # accepts ALWAYS, RISING_EDGE
      condition_language_version: 1,
    },
  },
  data_extra_dimensions: ["NodePath"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  data_destination_configs: [
    {
      s3_config: {
        bucket_arn: "S3BucketArn", # required
        data_format: "JSON", # accepts JSON, PARQUET
        storage_compression_format: "NONE", # accepts NONE, GZIP
        prefix: "Prefix",
      },
      timestream_config: {
        timestream_table_arn: "TimestreamTableArn", # required
        execution_role_arn: "IAMRoleArn", # required
      },
    },
  ],
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the campaign to create.
:description (String) —
An optional description of the campaign to help identify its purpose.
:signal_catalog_arn (required, String) — default: Optional —
The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
:target_arn (required, String) —
The ARN of the vehicle or fleet to deploy a campaign to.
:start_time (Time, DateTime, Date, Integer, String) — default: Optional —
The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0
:expiry_time (Time, DateTime, Date, Integer, String) — default: 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)
:post_trigger_collection_duration (Integer) — default: 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
:diagnostics_mode (String) — default: 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
:spooling_mode (String) — default: 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
:compression (String) — default: 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
:priority (Integer) — default: 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
:signals_to_collect (Array<Types::SignalInformation>) — default: Optional —
A list of information about signals to collect.
:collection_scheme (required, Types::CollectionScheme) —
The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
:data_extra_dimensions (Array<String>) — default: 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 (Array<Types::Tag>) —
Metadata that can be used to manage the campaign.
:data_destination_configs (Array<Types::DataDestinationConfig>) —
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.

Returns:

(Types::CreateCampaignResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 709

def create_campaign(params = {}, options = {})
  req = build_request(:create_campaign, params)
  req.send_request(options)
end

#create_decoder_manifest(params = {}) ⇒ `Types::CreateDecoderManifestResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.create_decoder_manifest({
  name: "resourceName", # required
  description: "description",
  model_manifest_arn: "arn", # required
  signal_decoders: [
    {
      fully_qualified_name: "FullyQualifiedName", # required
      type: "CAN_SIGNAL", # required, accepts CAN_SIGNAL, OBD_SIGNAL
      interface_id: "InterfaceId", # required
      can_signal: {
        message_id: 1, # required
        is_big_endian: false, # required
        is_signed: false, # required
        start_bit: 1, # required
        offset: 1.0, # required
        factor: 1.0, # required
        length: 1, # required
        name: "CanSignalName",
      },
      obd_signal: {
        pid_response_length: 1, # required
        service_mode: 1, # required
        pid: 1, # required
        scaling: 1.0, # required
        offset: 1.0, # required
        start_byte: 1, # required
        byte_length: 1, # required
        bit_right_shift: 1,
        bit_mask_length: 1,
      },
    },
  ],
  network_interfaces: [
    {
      interface_id: "InterfaceId", # required
      type: "CAN_INTERFACE", # required, accepts CAN_INTERFACE, OBD_INTERFACE
      can_interface: {
        name: "CanInterfaceName", # required
        protocol_name: "ProtocolName",
        protocol_version: "ProtocolVersion",
      },
      obd_interface: {
        name: "ObdInterfaceName", # required
        request_message_id: 1, # required
        obd_standard: "ObdStandard",
        pid_request_interval_seconds: 1,
        dtc_request_interval_seconds: 1,
        use_extended_ids: false,
        has_transmission_ecu: false,
      },
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The unique name of the decoder manifest to create.
:description (String) —
A brief description of the decoder manifest.
:model_manifest_arn (required, String) —
The Amazon Resource Name (ARN) of the vehicle model (model manifest).
:signal_decoders (Array<Types::SignalDecoder>) —
A list of information about signal decoders.
:network_interfaces (Array<Types::NetworkInterface>) —
A list of information about available network interfaces.
:tags (Array<Types::Tag>) —
Metadata that can be used to manage the decoder manifest.

Returns:

(Types::CreateDecoderManifestResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 817

def create_decoder_manifest(params = {}, options = {})
  req = build_request(:create_decoder_manifest, params)
  req.send_request(options)
end

#create_fleet(params = {}) ⇒ `Types::CreateFleetResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.create_fleet({
  fleet_id: "fleetId", # required
  description: "description",
  signal_catalog_arn: "arn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
The unique ID of the fleet to create.
:description (String) —
A brief description of the fleet to create.
:signal_catalog_arn (required, String) —
The Amazon Resource Name (ARN) of a signal catalog.
:tags (Array<Types::Tag>) —
Metadata that can be used to manage the fleet.

Returns:

(Types::CreateFleetResponse) —
Returns a response object which responds to the following methods:
- #id => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 874

def create_fleet(params = {}, options = {})
  req = build_request(:create_fleet, params)
  req.send_request(options)
end

#create_model_manifest(params = {}) ⇒ `Types::CreateModelManifestResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.create_model_manifest({
  name: "resourceName", # required
  description: "description",
  nodes: ["string"], # required
  signal_catalog_arn: "arn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the vehicle model to create.
:description (String) —
A brief description of the vehicle model.
:nodes (required, Array<String>) —
A list of nodes, which are a general abstraction of signals.
:signal_catalog_arn (required, String) —
The Amazon Resource Name (ARN) of a signal catalog.
:tags (Array<Types::Tag>) —
Metadata that can be used to manage the vehicle model.

Returns:

(Types::CreateModelManifestResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 931

def create_model_manifest(params = {}, options = {})
  req = build_request(:create_model_manifest, params)
  req.send_request(options)
end

#create_signal_catalog(params = {}) ⇒ `Types::CreateSignalCatalogResponse`

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

Examples:

Request syntax with placeholder values


resp = client.create_signal_catalog({
  name: "resourceName", # required
  description: "description",
  nodes: [
    {
      branch: {
        fully_qualified_name: "string", # required
        description: "description",
        deprecation_message: "message",
        comment: "message",
      },
      sensor: {
        fully_qualified_name: "string", # required
        data_type: "INT8", # required, accepts 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: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        deprecation_message: "message",
        comment: "message",
      },
      actuator: {
        fully_qualified_name: "string", # required
        data_type: "INT8", # required, accepts 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: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        deprecation_message: "message",
        comment: "message",
      },
      attribute: {
        fully_qualified_name: "string", # required
        data_type: "INT8", # required, accepts 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: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        default_value: "string",
        deprecation_message: "message",
        comment: "message",
      },
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the signal catalog to create.
:description (String) —
A brief description of the signal catalog.
:nodes (Array<Types::Node>) —
A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.
:tags (Array<Types::Tag>) —
Metadata that can be used to manage the signal catalog.

Returns:

(Types::CreateSignalCatalogResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1023

def create_signal_catalog(params = {}, options = {})
  req = build_request(:create_signal_catalog, params)
  req.send_request(options)
end

#create_vehicle(params = {}) ⇒ `Types::CreateVehicleResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.create_vehicle({
  vehicle_name: "vehicleName", # required
  model_manifest_arn: "arn", # required
  decoder_manifest_arn: "arn", # required
  attributes: {
    "attributeName" => "attributeValue",
  },
  association_behavior: "CreateIotThing", # accepts CreateIotThing, ValidateIotThingExists
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.vehicle_name #=> String
resp.arn #=> String
resp.thing_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:vehicle_name (required, String) —
The unique ID of the vehicle to create.
:model_manifest_arn (required, String) —
The Amazon Resource Name ARN of a vehicle model.
:decoder_manifest_arn (required, String) —
The ARN of a decoder manifest.
:attributes (Hash<String,String>) —
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.
:association_behavior (String) —
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.

Default: ``
:tags (Array<Types::Tag>) —
Metadata that can be used to manage the vehicle.

Returns:

(Types::CreateVehicleResponse) —
Returns a response object which responds to the following methods:
- #vehicle_name => String
- #arn => String
- #thing_arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1103

def create_vehicle(params = {}, options = {})
  req = build_request(:create_vehicle, params)
  req.send_request(options)
end

#delete_campaign(params = {}) ⇒ `Types::DeleteCampaignResponse`

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

Examples:

Request syntax with placeholder values


resp = client.delete_campaign({
  name: "campaignName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the campaign to delete.

Returns:

(Types::DeleteCampaignResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1132

def delete_campaign(params = {}, options = {})
  req = build_request(:delete_campaign, params)
  req.send_request(options)
end

#delete_decoder_manifest(params = {}) ⇒ `Types::DeleteDecoderManifestResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.delete_decoder_manifest({
  name: "resourceName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the decoder manifest to delete.

Returns:

(Types::DeleteDecoderManifestResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1166

def delete_decoder_manifest(params = {}, options = {})
  req = build_request(:delete_decoder_manifest, params)
  req.send_request(options)
end

#delete_fleet(params = {}) ⇒ `Types::DeleteFleetResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.delete_fleet({
  fleet_id: "fleetId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
The ID of the fleet to delete.

Returns:

(Types::DeleteFleetResponse) —
Returns a response object which responds to the following methods:
- #id => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1206

def delete_fleet(params = {}, options = {})
  req = build_request(:delete_fleet, params)
  req.send_request(options)
end

#delete_model_manifest(params = {}) ⇒ `Types::DeleteModelManifestResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.delete_model_manifest({
  name: "resourceName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the model manifest to delete.

Returns:

(Types::DeleteModelManifestResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1239

def delete_model_manifest(params = {}, options = {})
  req = build_request(:delete_model_manifest, params)
  req.send_request(options)
end

#delete_signal_catalog(params = {}) ⇒ `Types::DeleteSignalCatalogResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.delete_signal_catalog({
  name: "resourceName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the signal catalog to delete.

Returns:

(Types::DeleteSignalCatalogResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1272

def delete_signal_catalog(params = {}, options = {})
  req = build_request(:delete_signal_catalog, params)
  req.send_request(options)
end

#delete_vehicle(params = {}) ⇒ `Types::DeleteVehicleResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.delete_vehicle({
  vehicle_name: "vehicleName", # required
})

Response structure


resp.vehicle_name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:vehicle_name (required, String) —
The ID of the vehicle to delete.

Returns:

(Types::DeleteVehicleResponse) —
Returns a response object which responds to the following methods:
- #vehicle_name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1305

def delete_vehicle(params = {}, options = {})
  req = build_request(:delete_vehicle, params)
  req.send_request(options)
end

#disassociate_vehicle_fleet(params = {}) ⇒ `Struct`

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.

Examples:

Request syntax with placeholder values


resp = client.disassociate_vehicle_fleet({
  vehicle_name: "vehicleName", # required
  fleet_id: "fleetId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:vehicle_name (required, String) —
The unique ID of the vehicle to disassociate from the fleet.
:fleet_id (required, String) —
The unique ID of a fleet.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1336

def disassociate_vehicle_fleet(params = {}, options = {})
  req = build_request(:disassociate_vehicle_fleet, params)
  req.send_request(options)
end

#get_campaign(params = {}) ⇒ `Types::GetCampaignResponse`

Retrieves information about a campaign.

Examples:

Request syntax with placeholder values


resp = client.get_campaign({
  name: "campaignName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.description #=> String
resp.signal_catalog_arn #=> String
resp.target_arn #=> String
resp.status #=> String, one of "CREATING", "WAITING_FOR_APPROVAL", "RUNNING", "SUSPENDED"
resp.start_time #=> Time
resp.expiry_time #=> Time
resp.post_trigger_collection_duration #=> Integer
resp.diagnostics_mode #=> String, one of "OFF", "SEND_ACTIVE_DTCS"
resp.spooling_mode #=> String, one of "OFF", "TO_DISK"
resp.compression #=> String, one of "OFF", "SNAPPY"
resp.priority #=> Integer
resp.signals_to_collect #=> Array
resp.signals_to_collect[0].name #=> String
resp.signals_to_collect[0].max_sample_count #=> Integer
resp.signals_to_collect[0].minimum_sampling_interval_ms #=> Integer
resp.collection_scheme.time_based_collection_scheme.period_ms #=> Integer
resp.collection_scheme.condition_based_collection_scheme.expression #=> String
resp.collection_scheme.condition_based_collection_scheme.minimum_trigger_interval_ms #=> Integer
resp.collection_scheme.condition_based_collection_scheme.trigger_mode #=> String, one of "ALWAYS", "RISING_EDGE"
resp.collection_scheme.condition_based_collection_scheme.condition_language_version #=> Integer
resp.data_extra_dimensions #=> Array
resp.data_extra_dimensions[0] #=> String
resp.creation_time #=> Time
resp.last_modification_time #=> Time
resp.data_destination_configs #=> Array
resp.data_destination_configs[0].s3_config.bucket_arn #=> String
resp.data_destination_configs[0].s3_config.data_format #=> String, one of "JSON", "PARQUET"
resp.data_destination_configs[0].s3_config.storage_compression_format #=> String, one of "NONE", "GZIP"
resp.data_destination_configs[0].s3_config.prefix #=> String
resp.data_destination_configs[0].timestream_config.timestream_table_arn #=> String
resp.data_destination_configs[0].timestream_config.execution_role_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the campaign to retrieve information about.

Returns:

(Types::GetCampaignResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String
- #description => String
- #signal_catalog_arn => String
- #target_arn => String
- #status => String
- #start_time => Time
- #expiry_time => Time
- #post_trigger_collection_duration => Integer
- #diagnostics_mode => String
- #spooling_mode => String
- #compression => String
- #priority => Integer
- #signals_to_collect => Array<Types::SignalInformation>
- #collection_scheme => Types::CollectionScheme
- #data_extra_dimensions => Array<String>
- #creation_time => Time
- #last_modification_time => Time
- #data_destination_configs => Array<Types::DataDestinationConfig>

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1412

def get_campaign(params = {}, options = {})
  req = build_request(:get_campaign, params)
  req.send_request(options)
end

#get_decoder_manifest(params = {}) ⇒ `Types::GetDecoderManifestResponse`

Retrieves information about a created decoder manifest.

Examples:

Request syntax with placeholder values


resp = client.get_decoder_manifest({
  name: "resourceName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.description #=> String
resp.model_manifest_arn #=> String
resp.status #=> String, one of "ACTIVE", "DRAFT"
resp.creation_time #=> Time
resp.last_modification_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the decoder manifest to retrieve information about.

Returns:

(Types::GetDecoderManifestResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String
- #description => String
- #model_manifest_arn => String
- #status => String
- #creation_time => Time
- #last_modification_time => Time

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1450

def get_decoder_manifest(params = {}, options = {})
  req = build_request(:get_decoder_manifest, params)
  req.send_request(options)
end

#get_fleet(params = {}) ⇒ `Types::GetFleetResponse`

Retrieves information about a fleet.

Examples:

Request syntax with placeholder values


resp = client.get_fleet({
  fleet_id: "fleetId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.description #=> String
resp.signal_catalog_arn #=> String
resp.creation_time #=> Time
resp.last_modification_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
The ID of the fleet to retrieve information about.

Returns:

(Types::GetFleetResponse) —
Returns a response object which responds to the following methods:
- #id => String
- #arn => String
- #description => String
- #signal_catalog_arn => String
- #creation_time => Time
- #last_modification_time => Time

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1486

def get_fleet(params = {}, options = {})
  req = build_request(:get_fleet, params)
  req.send_request(options)
end

#get_logging_options(params = {}) ⇒ `Types::GetLoggingOptionsResponse`

Retrieves the logging options.

Examples:

Response structure


resp.cloud_watch_log_delivery.log_type #=> String, one of "OFF", "ERROR"
resp.cloud_watch_log_delivery.log_group_name #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Types::GetLoggingOptionsResponse) —
Returns a response object which responds to the following methods:
- #cloud_watch_log_delivery => Types::CloudWatchLogDeliveryOptions

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1504

def get_logging_options(params = {}, options = {})
  req = build_request(:get_logging_options, params)
  req.send_request(options)
end

#get_model_manifest(params = {}) ⇒ `Types::GetModelManifestResponse`

Retrieves information about a vehicle model (model manifest).

Examples:

Request syntax with placeholder values


resp = client.get_model_manifest({
  name: "resourceName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.description #=> String
resp.signal_catalog_arn #=> String
resp.status #=> String, one of "ACTIVE", "DRAFT"
resp.creation_time #=> Time
resp.last_modification_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the vehicle model to retrieve information about.

Returns:

(Types::GetModelManifestResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String
- #description => String
- #signal_catalog_arn => String
- #status => String
- #creation_time => Time
- #last_modification_time => Time

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1542

def get_model_manifest(params = {}, options = {})
  req = build_request(:get_model_manifest, params)
  req.send_request(options)
end

#get_register_account_status(params = {}) ⇒ `Types::GetRegisterAccountStatusResponse`

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.

Examples:

Response structure


resp.customer_account_id #=> String
resp.account_status #=> String, one of "REGISTRATION_PENDING", "REGISTRATION_SUCCESS", "REGISTRATION_FAILURE"
resp.timestream_registration_response.timestream_database_name #=> String
resp.timestream_registration_response.timestream_table_name #=> String
resp.timestream_registration_response.timestream_database_arn #=> String
resp.timestream_registration_response.timestream_table_arn #=> String
resp.timestream_registration_response.registration_status #=> String, one of "REGISTRATION_PENDING", "REGISTRATION_SUCCESS", "REGISTRATION_FAILURE"
resp.timestream_registration_response.error_message #=> String
resp.iam_registration_response.role_arn #=> String
resp.iam_registration_response.registration_status #=> String, one of "REGISTRATION_PENDING", "REGISTRATION_SUCCESS", "REGISTRATION_FAILURE"
resp.iam_registration_response.error_message #=> String
resp.creation_time #=> Time
resp.last_modification_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Types::GetRegisterAccountStatusResponse) —
Returns a response object which responds to the following methods:
- #customer_account_id => String
- #account_status => String
- #timestream_registration_response => Types::TimestreamRegistrationResponse
- #iam_registration_response => Types::IamRegistrationResponse
- #creation_time => Time
- #last_modification_time => Time

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1590

def get_register_account_status(params = {}, options = {})
  req = build_request(:get_register_account_status, params)
  req.send_request(options)
end

#get_signal_catalog(params = {}) ⇒ `Types::GetSignalCatalogResponse`

Retrieves information about a signal catalog.

Examples:

Request syntax with placeholder values


resp = client.get_signal_catalog({
  name: "resourceName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.description #=> String
resp.node_counts.total_nodes #=> Integer
resp.node_counts.total_branches #=> Integer
resp.node_counts.total_sensors #=> Integer
resp.node_counts.total_attributes #=> Integer
resp.node_counts.total_actuators #=> Integer
resp.creation_time #=> Time
resp.last_modification_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the signal catalog to retrieve information about.

Returns:

(Types::GetSignalCatalogResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String
- #description => String
- #node_counts => Types::NodeCounts
- #creation_time => Time
- #last_modification_time => Time

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1630

def get_signal_catalog(params = {}, options = {})
  req = build_request(:get_signal_catalog, params)
  req.send_request(options)
end

#get_vehicle(params = {}) ⇒ `Types::GetVehicleResponse`

Retrieves information about a vehicle.

Examples:

Request syntax with placeholder values


resp = client.get_vehicle({
  vehicle_name: "vehicleName", # required
})

Response structure


resp.vehicle_name #=> String
resp.arn #=> String
resp.model_manifest_arn #=> String
resp.decoder_manifest_arn #=> String
resp.attributes #=> Hash
resp.attributes["attributeName"] #=> String
resp.creation_time #=> Time
resp.last_modification_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:vehicle_name (required, String) —
The ID of the vehicle to retrieve information about.

Returns:

(Types::GetVehicleResponse) —
Returns a response object which responds to the following methods:
- #vehicle_name => String
- #arn => String
- #model_manifest_arn => String
- #decoder_manifest_arn => String
- #attributes => Hash<String,String>
- #creation_time => Time
- #last_modification_time => Time

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1669

def get_vehicle(params = {}, options = {})
  req = build_request(:get_vehicle, params)
  req.send_request(options)
end

#get_vehicle_status(params = {}) ⇒ `Types::GetVehicleStatusResponse`

Retrieves information about the status of a vehicle with any associated campaigns.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_vehicle_status({
  next_token: "nextToken",
  max_results: 1,
  vehicle_name: "vehicleName", # required
})

Response structure


resp.campaigns #=> Array
resp.campaigns[0].campaign_name #=> String
resp.campaigns[0].vehicle_name #=> String
resp.campaigns[0].status #=> String, one of "CREATED", "READY", "HEALTHY", "SUSPENDED", "DELETING"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.
:vehicle_name (required, String) —
The ID of the vehicle to retrieve information about.

Returns:

(Types::GetVehicleStatusResponse) —
Returns a response object which responds to the following methods:
- #campaigns => Array<Types::VehicleStatus>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1717

def get_vehicle_status(params = {}, options = {})
  req = build_request(:get_vehicle_status, params)
  req.send_request(options)
end

#import_decoder_manifest(params = {}) ⇒ `Types::ImportDecoderManifestResponse`

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

Examples:

Request syntax with placeholder values


resp = client.import_decoder_manifest({
  name: "resourceName", # required
  network_file_definitions: [ # required
    {
      can_dbc: {
        network_interface: "InterfaceId", # required
        can_dbc_files: ["data"], # required
        signals_map: {
          "string" => "string",
        },
      },
    },
  ],
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the decoder manifest to import.
:network_file_definitions (required, Array<Types::NetworkFileDefinition>) —
The file to load into an Amazon Web Services account.

Returns:

(Types::ImportDecoderManifestResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1760

def import_decoder_manifest(params = {}, options = {})
  req = build_request(:import_decoder_manifest, params)
  req.send_request(options)
end

#import_signal_catalog(params = {}) ⇒ `Types::ImportSignalCatalogResponse`

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

Examples:

Request syntax with placeholder values


resp = client.import_signal_catalog({
  name: "resourceName", # required
  description: "description",
  vss: {
    vss_json: "String",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the signal catalog to import.
:description (String) —
A brief description of the signal catalog.
:vss (Types::FormattedVss) —
The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.
:tags (Array<Types::Tag>) —
Metadata that can be used to manage the signal catalog.

Returns:

(Types::ImportSignalCatalogResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1810

def import_signal_catalog(params = {}, options = {})
  req = build_request(:import_signal_catalog, params)
  req.send_request(options)
end

#list_campaigns(params = {}) ⇒ `Types::ListCampaignsResponse`

Lists information about created campaigns.

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_campaigns({
  next_token: "nextToken",
  max_results: 1,
  status: "status",
})

Response structure


resp.campaign_summaries #=> Array
resp.campaign_summaries[0].arn #=> String
resp.campaign_summaries[0].name #=> String
resp.campaign_summaries[0].description #=> String
resp.campaign_summaries[0].signal_catalog_arn #=> String
resp.campaign_summaries[0].target_arn #=> String
resp.campaign_summaries[0].status #=> String, one of "CREATING", "WAITING_FOR_APPROVAL", "RUNNING", "SUSPENDED"
resp.campaign_summaries[0].creation_time #=> Time
resp.campaign_summaries[0].last_modification_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.
:status (String) —
Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.

Returns:

(Types::ListCampaignsResponse) —
Returns a response object which responds to the following methods:
- #campaign_summaries => Array<Types::CampaignSummary>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1869

def list_campaigns(params = {}, options = {})
  req = build_request(:list_campaigns, params)
  req.send_request(options)
end

#list_decoder_manifest_network_interfaces(params = {}) ⇒ `Types::ListDecoderManifestNetworkInterfacesResponse`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_decoder_manifest_network_interfaces({
  name: "resourceName", # required
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.network_interfaces #=> Array
resp.network_interfaces[0].interface_id #=> String
resp.network_interfaces[0].type #=> String, one of "CAN_INTERFACE", "OBD_INTERFACE"
resp.network_interfaces[0].can_interface.name #=> String
resp.network_interfaces[0].can_interface.protocol_name #=> String
resp.network_interfaces[0].can_interface.protocol_version #=> String
resp.network_interfaces[0].obd_interface.name #=> String
resp.network_interfaces[0].obd_interface.request_message_id #=> Integer
resp.network_interfaces[0].obd_interface.obd_standard #=> String
resp.network_interfaces[0].obd_interface.pid_request_interval_seconds #=> Integer
resp.network_interfaces[0].obd_interface.dtc_request_interval_seconds #=> Integer
resp.network_interfaces[0].obd_interface.use_extended_ids #=> Boolean
resp.network_interfaces[0].obd_interface.has_transmission_ecu #=> Boolean
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the decoder manifest to list information about.
:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListDecoderManifestNetworkInterfacesResponse) —
Returns a response object which responds to the following methods:
- #network_interfaces => Array<Types::NetworkInterface>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 1930

def list_decoder_manifest_network_interfaces(params = {}, options = {})
  req = build_request(:list_decoder_manifest_network_interfaces, params)
  req.send_request(options)
end

#list_decoder_manifest_signals(params = {}) ⇒ `Types::ListDecoderManifestSignalsResponse`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_decoder_manifest_signals({
  name: "resourceName", # required
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.signal_decoders #=> Array
resp.signal_decoders[0].fully_qualified_name #=> String
resp.signal_decoders[0].type #=> String, one of "CAN_SIGNAL", "OBD_SIGNAL"
resp.signal_decoders[0].interface_id #=> String
resp.signal_decoders[0].can_signal.message_id #=> Integer
resp.signal_decoders[0].can_signal.is_big_endian #=> Boolean
resp.signal_decoders[0].can_signal.is_signed #=> Boolean
resp.signal_decoders[0].can_signal.start_bit #=> Integer
resp.signal_decoders[0].can_signal.offset #=> Float
resp.signal_decoders[0].can_signal.factor #=> Float
resp.signal_decoders[0].can_signal.length #=> Integer
resp.signal_decoders[0].can_signal.name #=> String
resp.signal_decoders[0].obd_signal.pid_response_length #=> Integer
resp.signal_decoders[0].obd_signal.service_mode #=> Integer
resp.signal_decoders[0].obd_signal.pid #=> Integer
resp.signal_decoders[0].obd_signal.scaling #=> Float
resp.signal_decoders[0].obd_signal.offset #=> Float
resp.signal_decoders[0].obd_signal.start_byte #=> Integer
resp.signal_decoders[0].obd_signal.byte_length #=> Integer
resp.signal_decoders[0].obd_signal.bit_right_shift #=> Integer
resp.signal_decoders[0].obd_signal.bit_mask_length #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the decoder manifest to list information about.
:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListDecoderManifestSignalsResponse) —
Returns a response object which responds to the following methods:
- #signal_decoders => Array<Types::SignalDecoder>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2000

def list_decoder_manifest_signals(params = {}, options = {})
  req = build_request(:list_decoder_manifest_signals, params)
  req.send_request(options)
end

#list_decoder_manifests(params = {}) ⇒ `Types::ListDecoderManifestsResponse`

Lists decoder manifests.

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_decoder_manifests({
  model_manifest_arn: "arn",
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.summaries #=> Array
resp.summaries[0].name #=> String
resp.summaries[0].arn #=> String
resp.summaries[0].model_manifest_arn #=> String
resp.summaries[0].description #=> String
resp.summaries[0].status #=> String, one of "ACTIVE", "DRAFT"
resp.summaries[0].creation_time #=> Time
resp.summaries[0].last_modification_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:model_manifest_arn (String) —
The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListDecoderManifestsResponse) —
Returns a response object which responds to the following methods:
- #summaries => Array<Types::DecoderManifestSummary>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2057

def list_decoder_manifests(params = {}, options = {})
  req = build_request(:list_decoder_manifests, params)
  req.send_request(options)
end

#list_fleets(params = {}) ⇒ `Types::ListFleetsResponse`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_fleets({
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.fleet_summaries #=> Array
resp.fleet_summaries[0].id #=> String
resp.fleet_summaries[0].arn #=> String
resp.fleet_summaries[0].description #=> String
resp.fleet_summaries[0].signal_catalog_arn #=> String
resp.fleet_summaries[0].creation_time #=> Time
resp.fleet_summaries[0].last_modification_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListFleetsResponse) —
Returns a response object which responds to the following methods:
- #fleet_summaries => Array<Types::FleetSummary>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2109

def list_fleets(params = {}, options = {})
  req = build_request(:list_fleets, params)
  req.send_request(options)
end

#list_fleets_for_vehicle(params = {}) ⇒ `Types::ListFleetsForVehicleResponse`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_fleets_for_vehicle({
  vehicle_name: "vehicleName", # required
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.fleets #=> Array
resp.fleets[0] #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:vehicle_name (required, String) —
The ID of the vehicle to retrieve information about.
:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListFleetsForVehicleResponse) —
Returns a response object which responds to the following methods:
- #fleets => Array<String>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2160

def list_fleets_for_vehicle(params = {}, options = {})
  req = build_request(:list_fleets_for_vehicle, params)
  req.send_request(options)
end

#list_model_manifest_nodes(params = {}) ⇒ `Types::ListModelManifestNodesResponse`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_model_manifest_nodes({
  name: "resourceName", # required
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.nodes #=> Array
resp.nodes[0].branch.fully_qualified_name #=> String
resp.nodes[0].branch.description #=> String
resp.nodes[0].branch.deprecation_message #=> String
resp.nodes[0].branch.comment #=> String
resp.nodes[0].sensor.fully_qualified_name #=> String
resp.nodes[0].sensor.data_type #=> String, one of "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"
resp.nodes[0].sensor.description #=> String
resp.nodes[0].sensor.unit #=> String
resp.nodes[0].sensor.allowed_values #=> Array
resp.nodes[0].sensor.allowed_values[0] #=> String
resp.nodes[0].sensor.min #=> Float
resp.nodes[0].sensor.max #=> Float
resp.nodes[0].sensor.deprecation_message #=> String
resp.nodes[0].sensor.comment #=> String
resp.nodes[0].actuator.fully_qualified_name #=> String
resp.nodes[0].actuator.data_type #=> String, one of "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"
resp.nodes[0].actuator.description #=> String
resp.nodes[0].actuator.unit #=> String
resp.nodes[0].actuator.allowed_values #=> Array
resp.nodes[0].actuator.allowed_values[0] #=> String
resp.nodes[0].actuator.min #=> Float
resp.nodes[0].actuator.max #=> Float
resp.nodes[0].actuator.assigned_value #=> String
resp.nodes[0].actuator.deprecation_message #=> String
resp.nodes[0].actuator.comment #=> String
resp.nodes[0].attribute.fully_qualified_name #=> String
resp.nodes[0].attribute.data_type #=> String, one of "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"
resp.nodes[0].attribute.description #=> String
resp.nodes[0].attribute.unit #=> String
resp.nodes[0].attribute.allowed_values #=> Array
resp.nodes[0].attribute.allowed_values[0] #=> String
resp.nodes[0].attribute.min #=> Float
resp.nodes[0].attribute.max #=> Float
resp.nodes[0].attribute.assigned_value #=> String
resp.nodes[0].attribute.default_value #=> String
resp.nodes[0].attribute.deprecation_message #=> String
resp.nodes[0].attribute.comment #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the vehicle model to list information about.
:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListModelManifestNodesResponse) —
Returns a response object which responds to the following methods:
- #nodes => Array<Types::Node>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2247

def list_model_manifest_nodes(params = {}, options = {})
  req = build_request(:list_model_manifest_nodes, params)
  req.send_request(options)
end

#list_model_manifests(params = {}) ⇒ `Types::ListModelManifestsResponse`

Retrieves a list of vehicle models (model manifests).

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_model_manifests({
  signal_catalog_arn: "arn",
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.summaries #=> Array
resp.summaries[0].name #=> String
resp.summaries[0].arn #=> String
resp.summaries[0].signal_catalog_arn #=> String
resp.summaries[0].description #=> String
resp.summaries[0].status #=> String, one of "ACTIVE", "DRAFT"
resp.summaries[0].creation_time #=> Time
resp.summaries[0].last_modification_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:signal_catalog_arn (String) —
The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.
:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListModelManifestsResponse) —
Returns a response object which responds to the following methods:
- #summaries => Array<Types::ModelManifestSummary>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2304

def list_model_manifests(params = {}, options = {})
  req = build_request(:list_model_manifests, params)
  req.send_request(options)
end

#list_signal_catalog_nodes(params = {}) ⇒ `Types::ListSignalCatalogNodesResponse`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_signal_catalog_nodes({
  name: "resourceName", # required
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.nodes #=> Array
resp.nodes[0].branch.fully_qualified_name #=> String
resp.nodes[0].branch.description #=> String
resp.nodes[0].branch.deprecation_message #=> String
resp.nodes[0].branch.comment #=> String
resp.nodes[0].sensor.fully_qualified_name #=> String
resp.nodes[0].sensor.data_type #=> String, one of "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"
resp.nodes[0].sensor.description #=> String
resp.nodes[0].sensor.unit #=> String
resp.nodes[0].sensor.allowed_values #=> Array
resp.nodes[0].sensor.allowed_values[0] #=> String
resp.nodes[0].sensor.min #=> Float
resp.nodes[0].sensor.max #=> Float
resp.nodes[0].sensor.deprecation_message #=> String
resp.nodes[0].sensor.comment #=> String
resp.nodes[0].actuator.fully_qualified_name #=> String
resp.nodes[0].actuator.data_type #=> String, one of "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"
resp.nodes[0].actuator.description #=> String
resp.nodes[0].actuator.unit #=> String
resp.nodes[0].actuator.allowed_values #=> Array
resp.nodes[0].actuator.allowed_values[0] #=> String
resp.nodes[0].actuator.min #=> Float
resp.nodes[0].actuator.max #=> Float
resp.nodes[0].actuator.assigned_value #=> String
resp.nodes[0].actuator.deprecation_message #=> String
resp.nodes[0].actuator.comment #=> String
resp.nodes[0].attribute.fully_qualified_name #=> String
resp.nodes[0].attribute.data_type #=> String, one of "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"
resp.nodes[0].attribute.description #=> String
resp.nodes[0].attribute.unit #=> String
resp.nodes[0].attribute.allowed_values #=> Array
resp.nodes[0].attribute.allowed_values[0] #=> String
resp.nodes[0].attribute.min #=> Float
resp.nodes[0].attribute.max #=> Float
resp.nodes[0].attribute.assigned_value #=> String
resp.nodes[0].attribute.default_value #=> String
resp.nodes[0].attribute.deprecation_message #=> String
resp.nodes[0].attribute.comment #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the signal catalog to list information about.
:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListSignalCatalogNodesResponse) —
Returns a response object which responds to the following methods:
- #nodes => Array<Types::Node>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2391

def list_signal_catalog_nodes(params = {}, options = {})
  req = build_request(:list_signal_catalog_nodes, params)
  req.send_request(options)
end

#list_signal_catalogs(params = {}) ⇒ `Types::ListSignalCatalogsResponse`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_signal_catalogs({
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.summaries #=> Array
resp.summaries[0].name #=> String
resp.summaries[0].arn #=> String
resp.summaries[0].creation_time #=> Time
resp.summaries[0].last_modification_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListSignalCatalogsResponse) —
Returns a response object which responds to the following methods:
- #summaries => Array<Types::SignalCatalogSummary>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2444

def list_signal_catalogs(params = {}, options = {})
  req = build_request(:list_signal_catalogs, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The ARN of the resource.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Array<Types::Tag>

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2472

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_vehicles(params = {}) ⇒ `Types::ListVehiclesResponse`

Retrieves a list of summaries of created vehicles.

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_vehicles({
  model_manifest_arn: "arn",
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.vehicle_summaries #=> Array
resp.vehicle_summaries[0].vehicle_name #=> String
resp.vehicle_summaries[0].arn #=> String
resp.vehicle_summaries[0].model_manifest_arn #=> String
resp.vehicle_summaries[0].decoder_manifest_arn #=> String
resp.vehicle_summaries[0].creation_time #=> Time
resp.vehicle_summaries[0].last_modification_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:model_manifest_arn (String) —
The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.
:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListVehiclesResponse) —
Returns a response object which responds to the following methods:
- #vehicle_summaries => Array<Types::VehicleSummary>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2529

def list_vehicles(params = {}, options = {})
  req = build_request(:list_vehicles, params)
  req.send_request(options)
end

#list_vehicles_in_fleet(params = {}) ⇒ `Types::ListVehiclesInFleetResponse`

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_vehicles_in_fleet({
  fleet_id: "fleetId", # required
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.vehicles #=> Array
resp.vehicles[0] #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
The ID of a fleet.
:next_token (String) —
A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
:max_results (Integer) —
The maximum number of items to return, between 1 and 100, inclusive.

Returns:

(Types::ListVehiclesInFleetResponse) —
Returns a response object which responds to the following methods:
- #vehicles => Array<String>
- #next_token => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2579

def list_vehicles_in_fleet(params = {}, options = {})
  req = build_request(:list_vehicles_in_fleet, params)
  req.send_request(options)
end

#put_logging_options(params = {}) ⇒ `Struct`

Creates or updates the logging option.

Examples:

Request syntax with placeholder values


resp = client.put_logging_options({
  cloud_watch_log_delivery: { # required
    log_type: "OFF", # required, accepts OFF, ERROR
    log_group_name: "CloudWatchLogGroupName",
  },
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:cloud_watch_log_delivery (required, Types::CloudWatchLogDeliveryOptions) —
Creates or updates the log delivery option to Amazon CloudWatch Logs.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2602

def put_logging_options(params = {}, options = {})
  req = build_request(:put_logging_options, params)
  req.send_request(options)
end

#register_account(params = {}) ⇒ `Types::RegisterAccountResponse`

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>

Examples:

Request syntax with placeholder values


resp = client.register_account({
  timestream_resources: {
    timestream_database_name: "TimestreamDatabaseName", # required
    timestream_table_name: "TimestreamTableName", # required
  },
  iam_resources: {
    role_arn: "IAMRoleArn", # required
  },
})

Response structure


resp.register_account_status #=> String, one of "REGISTRATION_PENDING", "REGISTRATION_SUCCESS", "REGISTRATION_FAILURE"
resp.timestream_resources.timestream_database_name #=> String
resp.timestream_resources.timestream_table_name #=> String
resp.iam_resources.role_arn #=> String
resp.creation_time #=> Time
resp.last_modification_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:timestream_resources (Types::TimestreamResources) —
The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.
:iam_resources (Types::IamResources) —
The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.

Returns:

(Types::RegisterAccountResponse) —
Returns a response object which responds to the following methods:
- #register_account_status => String
- #timestream_resources => Types::TimestreamResources
- #iam_resources => Types::IamResources
- #creation_time => Time
- #last_modification_time => Time

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2672

def register_account(params = {}, options = {})
  req = build_request(:register_account, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ `Struct`

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

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The ARN of the resource.
:tags (required, Array<Types::Tag>) —
The new or modified tags for the resource.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2702

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ `Struct`

Removes the given tags (metadata) from the resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The ARN of the resource.
:tag_keys (required, Array<String>) —
A list of the keys of the tags to be removed from the resource.

Returns:

(Struct) —
Returns an empty response.

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2726

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_campaign(params = {}) ⇒ `Types::UpdateCampaignResponse`

Updates a campaign.

Examples:

Request syntax with placeholder values


resp = client.update_campaign({
  name: "campaignName", # required
  description: "description",
  data_extra_dimensions: ["NodePath"],
  action: "APPROVE", # required, accepts APPROVE, SUSPEND, RESUME, UPDATE
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.status #=> String, one of "CREATING", "WAITING_FOR_APPROVAL", "RUNNING", "SUSPENDED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the campaign to update.
:description (String) —
The description of the campaign.
:data_extra_dimensions (Array<String>) —
A list of vehicle attributes to associate with a signal.

Default: An empty array
:action (required, String) —
Specifies how to update a campaign. The action can be one of the following:
- APPROVE - To approve delivering a data collection scheme to vehicles.
- SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.
- RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.
- UPDATE - To update a campaign.

Returns:

(Types::UpdateCampaignResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #name => String
- #status => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2784

def update_campaign(params = {}, options = {})
  req = build_request(:update_campaign, params)
  req.send_request(options)
end

#update_decoder_manifest(params = {}) ⇒ `Types::UpdateDecoderManifestResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.update_decoder_manifest({
  name: "resourceName", # required
  description: "description",
  signal_decoders_to_add: [
    {
      fully_qualified_name: "FullyQualifiedName", # required
      type: "CAN_SIGNAL", # required, accepts CAN_SIGNAL, OBD_SIGNAL
      interface_id: "InterfaceId", # required
      can_signal: {
        message_id: 1, # required
        is_big_endian: false, # required
        is_signed: false, # required
        start_bit: 1, # required
        offset: 1.0, # required
        factor: 1.0, # required
        length: 1, # required
        name: "CanSignalName",
      },
      obd_signal: {
        pid_response_length: 1, # required
        service_mode: 1, # required
        pid: 1, # required
        scaling: 1.0, # required
        offset: 1.0, # required
        start_byte: 1, # required
        byte_length: 1, # required
        bit_right_shift: 1,
        bit_mask_length: 1,
      },
    },
  ],
  signal_decoders_to_update: [
    {
      fully_qualified_name: "FullyQualifiedName", # required
      type: "CAN_SIGNAL", # required, accepts CAN_SIGNAL, OBD_SIGNAL
      interface_id: "InterfaceId", # required
      can_signal: {
        message_id: 1, # required
        is_big_endian: false, # required
        is_signed: false, # required
        start_bit: 1, # required
        offset: 1.0, # required
        factor: 1.0, # required
        length: 1, # required
        name: "CanSignalName",
      },
      obd_signal: {
        pid_response_length: 1, # required
        service_mode: 1, # required
        pid: 1, # required
        scaling: 1.0, # required
        offset: 1.0, # required
        start_byte: 1, # required
        byte_length: 1, # required
        bit_right_shift: 1,
        bit_mask_length: 1,
      },
    },
  ],
  signal_decoders_to_remove: ["FullyQualifiedName"],
  network_interfaces_to_add: [
    {
      interface_id: "InterfaceId", # required
      type: "CAN_INTERFACE", # required, accepts CAN_INTERFACE, OBD_INTERFACE
      can_interface: {
        name: "CanInterfaceName", # required
        protocol_name: "ProtocolName",
        protocol_version: "ProtocolVersion",
      },
      obd_interface: {
        name: "ObdInterfaceName", # required
        request_message_id: 1, # required
        obd_standard: "ObdStandard",
        pid_request_interval_seconds: 1,
        dtc_request_interval_seconds: 1,
        use_extended_ids: false,
        has_transmission_ecu: false,
      },
    },
  ],
  network_interfaces_to_update: [
    {
      interface_id: "InterfaceId", # required
      type: "CAN_INTERFACE", # required, accepts CAN_INTERFACE, OBD_INTERFACE
      can_interface: {
        name: "CanInterfaceName", # required
        protocol_name: "ProtocolName",
        protocol_version: "ProtocolVersion",
      },
      obd_interface: {
        name: "ObdInterfaceName", # required
        request_message_id: 1, # required
        obd_standard: "ObdStandard",
        pid_request_interval_seconds: 1,
        dtc_request_interval_seconds: 1,
        use_extended_ids: false,
        has_transmission_ecu: false,
      },
    },
  ],
  network_interfaces_to_remove: ["InterfaceId"],
  status: "ACTIVE", # accepts ACTIVE, DRAFT
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the decoder manifest to update.
:description (String) —
A brief description of the decoder manifest to update.
:signal_decoders_to_add (Array<Types::SignalDecoder>) —
A list of information about decoding additional signals to add to the decoder manifest.
:signal_decoders_to_update (Array<Types::SignalDecoder>) —
A list of updated information about decoding signals to update in the decoder manifest.
:signal_decoders_to_remove (Array<String>) —
A list of signal decoders to remove from the decoder manifest.
:network_interfaces_to_add (Array<Types::NetworkInterface>) —
A list of information about the network interfaces to add to the decoder manifest.
:network_interfaces_to_update (Array<Types::NetworkInterface>) —
A list of information about the network interfaces to update in the decoder manifest.
:network_interfaces_to_remove (Array<String>) —
A list of network interfaces to remove from the decoder manifest.
:status (String) —
The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.

Returns:

(Types::UpdateDecoderManifestResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2945

def update_decoder_manifest(params = {}, options = {})
  req = build_request(:update_decoder_manifest, params)
  req.send_request(options)
end

#update_fleet(params = {}) ⇒ `Types::UpdateFleetResponse`

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.

Examples:

Request syntax with placeholder values


resp = client.update_fleet({
  fleet_id: "fleetId", # required
  description: "description",
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
The ID of the fleet to update.
:description (String) —
An updated description of the fleet.

Returns:

(Types::UpdateFleetResponse) —
Returns a response object which responds to the following methods:
- #id => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 2982

def update_fleet(params = {}, options = {})
  req = build_request(:update_fleet, params)
  req.send_request(options)
end

#update_model_manifest(params = {}) ⇒ `Types::UpdateModelManifestResponse`

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

Examples:

Request syntax with placeholder values


resp = client.update_model_manifest({
  name: "resourceName", # required
  description: "description",
  nodes_to_add: ["NodePath"],
  nodes_to_remove: ["NodePath"],
  status: "ACTIVE", # accepts ACTIVE, DRAFT
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the vehicle model to update.
:description (String) —
A brief description of the vehicle model.
:nodes_to_add (Array<String>) —
A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the vehicle model.
:nodes_to_remove (Array<String>) —
A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from the vehicle model.
:status (String) —
The state of the vehicle model. If the status is ACTIVE, the vehicle model can't be edited. If the status is DRAFT, you can edit the vehicle model.

Returns:

(Types::UpdateModelManifestResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3031

def update_model_manifest(params = {}, options = {})
  req = build_request(:update_model_manifest, params)
  req.send_request(options)
end

#update_signal_catalog(params = {}) ⇒ `Types::UpdateSignalCatalogResponse`

Updates a signal catalog.

Examples:

Request syntax with placeholder values


resp = client.update_signal_catalog({
  name: "resourceName", # required
  description: "description",
  nodes_to_add: [
    {
      branch: {
        fully_qualified_name: "string", # required
        description: "description",
        deprecation_message: "message",
        comment: "message",
      },
      sensor: {
        fully_qualified_name: "string", # required
        data_type: "INT8", # required, accepts 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: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        deprecation_message: "message",
        comment: "message",
      },
      actuator: {
        fully_qualified_name: "string", # required
        data_type: "INT8", # required, accepts 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: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        deprecation_message: "message",
        comment: "message",
      },
      attribute: {
        fully_qualified_name: "string", # required
        data_type: "INT8", # required, accepts 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: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        default_value: "string",
        deprecation_message: "message",
        comment: "message",
      },
    },
  ],
  nodes_to_update: [
    {
      branch: {
        fully_qualified_name: "string", # required
        description: "description",
        deprecation_message: "message",
        comment: "message",
      },
      sensor: {
        fully_qualified_name: "string", # required
        data_type: "INT8", # required, accepts 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: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        deprecation_message: "message",
        comment: "message",
      },
      actuator: {
        fully_qualified_name: "string", # required
        data_type: "INT8", # required, accepts 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: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        deprecation_message: "message",
        comment: "message",
      },
      attribute: {
        fully_qualified_name: "string", # required
        data_type: "INT8", # required, accepts 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: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        default_value: "string",
        deprecation_message: "message",
        comment: "message",
      },
    },
  ],
  nodes_to_remove: ["NodePath"],
})

Response structure


resp.name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the signal catalog to update.
:description (String) —
A brief description of the signal catalog to update.
:nodes_to_add (Array<Types::Node>) —
A list of information about nodes to add to the signal catalog.
:nodes_to_update (Array<Types::Node>) —
A list of information about nodes to update in the signal catalog.
:nodes_to_remove (Array<String>) —
A list of fullyQualifiedName of nodes to remove from the signal catalog.

Returns:

(Types::UpdateSignalCatalogResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3166

def update_signal_catalog(params = {}, options = {})
  req = build_request(:update_signal_catalog, params)
  req.send_request(options)
end

#update_vehicle(params = {}) ⇒ `Types::UpdateVehicleResponse`

Updates a vehicle.

Examples:

Request syntax with placeholder values


resp = client.update_vehicle({
  vehicle_name: "vehicleName", # required
  model_manifest_arn: "arn",
  decoder_manifest_arn: "arn",
  attributes: {
    "attributeName" => "attributeValue",
  },
  attribute_update_mode: "Overwrite", # accepts Overwrite, Merge
})

Response structure


resp.vehicle_name #=> String
resp.arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:vehicle_name (required, String) —
The unique ID of the vehicle to update.
:model_manifest_arn (String) —
The ARN of a vehicle model (model manifest) associated with the vehicle.
:decoder_manifest_arn (String) —
The ARN of the decoder manifest associated with this vehicle.
:attributes (Hash<String,String>) —
Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"
:attribute_update_mode (String) —
The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.

This is required if attributes are present in the input.

Returns:

(Types::UpdateVehicleResponse) —
Returns a response object which responds to the following methods:
- #vehicle_name => String
- #arn => String

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/client.rb', line 3220

def update_vehicle(params = {}, options = {})
  req = build_request(:update_vehicle, params)
  req.send_request(options)
end

Class: Aws::IoTFleetWise::Client

Overview

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options) ⇒ Client

Instance Method Details

#associate_vehicle_fleet(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#batch_create_vehicle(params = {}) ⇒ Types::BatchCreateVehicleResponse

Examples:

Request syntax with placeholder values

Response structure

#batch_update_vehicle(params = {}) ⇒ Types::BatchUpdateVehicleResponse

Examples:

Request syntax with placeholder values

Response structure

#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse

Examples:

Request syntax with placeholder values

Response structure

#create_decoder_manifest(params = {}) ⇒ Types::CreateDecoderManifestResponse

Examples:

Request syntax with placeholder values

Response structure

#create_fleet(params = {}) ⇒ Types::CreateFleetResponse

Examples:

Request syntax with placeholder values

Response structure

#create_model_manifest(params = {}) ⇒ Types::CreateModelManifestResponse

Examples:

Request syntax with placeholder values

Response structure

#create_signal_catalog(params = {}) ⇒ Types::CreateSignalCatalogResponse

Examples:

Request syntax with placeholder values

Response structure

#create_vehicle(params = {}) ⇒ Types::CreateVehicleResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_campaign(params = {}) ⇒ Types::DeleteCampaignResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_decoder_manifest(params = {}) ⇒ Types::DeleteDecoderManifestResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_fleet(params = {}) ⇒ Types::DeleteFleetResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_model_manifest(params = {}) ⇒ Types::DeleteModelManifestResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_signal_catalog(params = {}) ⇒ Types::DeleteSignalCatalogResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_vehicle(params = {}) ⇒ Types::DeleteVehicleResponse

Examples:

Request syntax with placeholder values

Response structure

#disassociate_vehicle_fleet(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#get_campaign(params = {}) ⇒ Types::GetCampaignResponse

Examples:

Request syntax with placeholder values

Response structure

#get_decoder_manifest(params = {}) ⇒ Types::GetDecoderManifestResponse

Examples:

#initialize(options) ⇒ `Client`

#associate_vehicle_fleet(params = {}) ⇒ `Struct`

#batch_create_vehicle(params = {}) ⇒ `Types::BatchCreateVehicleResponse`

#batch_update_vehicle(params = {}) ⇒ `Types::BatchUpdateVehicleResponse`

#create_campaign(params = {}) ⇒ `Types::CreateCampaignResponse`

#create_decoder_manifest(params = {}) ⇒ `Types::CreateDecoderManifestResponse`

#create_fleet(params = {}) ⇒ `Types::CreateFleetResponse`

#create_model_manifest(params = {}) ⇒ `Types::CreateModelManifestResponse`

#create_signal_catalog(params = {}) ⇒ `Types::CreateSignalCatalogResponse`

#create_vehicle(params = {}) ⇒ `Types::CreateVehicleResponse`

#delete_campaign(params = {}) ⇒ `Types::DeleteCampaignResponse`

#delete_decoder_manifest(params = {}) ⇒ `Types::DeleteDecoderManifestResponse`

#delete_fleet(params = {}) ⇒ `Types::DeleteFleetResponse`

#delete_model_manifest(params = {}) ⇒ `Types::DeleteModelManifestResponse`

#delete_signal_catalog(params = {}) ⇒ `Types::DeleteSignalCatalogResponse`

#delete_vehicle(params = {}) ⇒ `Types::DeleteVehicleResponse`

#disassociate_vehicle_fleet(params = {}) ⇒ `Struct`

#get_campaign(params = {}) ⇒ `Types::GetCampaignResponse`

#get_decoder_manifest(params = {}) ⇒ `Types::GetDecoderManifestResponse`

#get_fleet(params = {}) ⇒ `Types::GetFleetResponse`

#get_logging_options(params = {}) ⇒ `Types::GetLoggingOptionsResponse`

#get_model_manifest(params = {}) ⇒ `Types::GetModelManifestResponse`

#get_register_account_status(params = {}) ⇒ `Types::GetRegisterAccountStatusResponse`

#get_signal_catalog(params = {}) ⇒ `Types::GetSignalCatalogResponse`

#get_vehicle(params = {}) ⇒ `Types::GetVehicleResponse`

#get_vehicle_status(params = {}) ⇒ `Types::GetVehicleStatusResponse`

#import_decoder_manifest(params = {}) ⇒ `Types::ImportDecoderManifestResponse`

#import_signal_catalog(params = {}) ⇒ `Types::ImportSignalCatalogResponse`

#list_campaigns(params = {}) ⇒ `Types::ListCampaignsResponse`

#list_decoder_manifest_network_interfaces(params = {}) ⇒ `Types::ListDecoderManifestNetworkInterfacesResponse`

#list_decoder_manifest_signals(params = {}) ⇒ `Types::ListDecoderManifestSignalsResponse`

#list_decoder_manifests(params = {}) ⇒ `Types::ListDecoderManifestsResponse`

#list_fleets(params = {}) ⇒ `Types::ListFleetsResponse`

#list_fleets_for_vehicle(params = {}) ⇒ `Types::ListFleetsForVehicleResponse`

#list_model_manifest_nodes(params = {}) ⇒ `Types::ListModelManifestNodesResponse`

#list_model_manifests(params = {}) ⇒ `Types::ListModelManifestsResponse`

#list_signal_catalog_nodes(params = {}) ⇒ `Types::ListSignalCatalogNodesResponse`