Class: Aws::IoTFleetWise::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-iotfleetwise/client.rb,
sig/client.rbs

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.

Defined Under Namespace

Modules: _AssociateVehicleFleetResponseSuccess, _BatchCreateVehicleResponseSuccess, _BatchUpdateVehicleResponseSuccess, _CreateCampaignResponseSuccess, _CreateDecoderManifestResponseSuccess, _CreateFleetResponseSuccess, _CreateModelManifestResponseSuccess, _CreateSignalCatalogResponseSuccess, _CreateStateTemplateResponseSuccess, _CreateVehicleResponseSuccess, _DeleteCampaignResponseSuccess, _DeleteDecoderManifestResponseSuccess, _DeleteFleetResponseSuccess, _DeleteModelManifestResponseSuccess, _DeleteSignalCatalogResponseSuccess, _DeleteStateTemplateResponseSuccess, _DeleteVehicleResponseSuccess, _DisassociateVehicleFleetResponseSuccess, _GetCampaignResponseSuccess, _GetDecoderManifestResponseSuccess, _GetEncryptionConfigurationResponseSuccess, _GetFleetResponseSuccess, _GetLoggingOptionsResponseSuccess, _GetModelManifestResponseSuccess, _GetRegisterAccountStatusResponseSuccess, _GetSignalCatalogResponseSuccess, _GetStateTemplateResponseSuccess, _GetVehicleResponseSuccess, _GetVehicleStatusResponseSuccess, _ImportDecoderManifestResponseSuccess, _ImportSignalCatalogResponseSuccess, _ListCampaignsResponseSuccess, _ListDecoderManifestNetworkInterfacesResponseSuccess, _ListDecoderManifestSignalsResponseSuccess, _ListDecoderManifestsResponseSuccess, _ListFleetsForVehicleResponseSuccess, _ListFleetsResponseSuccess, _ListModelManifestNodesResponseSuccess, _ListModelManifestsResponseSuccess, _ListSignalCatalogNodesResponseSuccess, _ListSignalCatalogsResponseSuccess, _ListStateTemplatesResponseSuccess, _ListTagsForResourceResponseSuccess, _ListVehiclesInFleetResponseSuccess, _ListVehiclesResponseSuccess, _PutEncryptionConfigurationResponseSuccess, _PutLoggingOptionsResponseSuccess, _RegisterAccountResponseSuccess, _TagResourceResponseSuccess, _UntagResourceResponseSuccess, _UpdateCampaignResponseSuccess, _UpdateDecoderManifestResponseSuccess, _UpdateFleetResponseSuccess, _UpdateModelManifestResponseSuccess, _UpdateSignalCatalogResponseSuccess, _UpdateStateTemplateResponseSuccess, _UpdateVehicleResponseSuccess

Constant Summary collapse

Params =

Returns:

  • (:state_template_association) 

      
    

  




  
Class Attribute Summary collapse

  




  
    

      API Operations
      collapse
    


    
    
  
    

      Class Method Summary
      collapse
    


    
    
  
    

      Instance Method Summary
      collapse
    


    
    
  


  
  

  
Constructor Details

  
    

  

  
    #initialize(options)  ⇒ Client 
  

  

  




  

    
Returns a new instance of Client.


  





  
  

  

    

  





  
Parameters:


    
  
    
  • 
      
        options
      
      
        (Hash)
      
      
      
    
    • 
  



  
    
    
    
Options Hash (options):

    
    
      
        
  • 
          :plugins
          (Array<Seahorse::Client::Plugin>)
          
            
              — default:
              []]
            
          
          
            — 
    A list of plugins to apply to the client. Each plugin is either a
class name or an instance of a plugin class.
    
          
        
    • 
      
        
  • 
          :credentials
          (required, Aws::CredentialProvider)
          
            
          
          
            — 
    Your AWS credentials used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or 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, :session_token, and
:account_id options.
      

      • 

    • 

      ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].
      

      • 

    • 

      ~/.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::InstanceProfileCredentials 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)
          
            
          
          
        
    • 
      
        
  • 
          :account_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.
    
          
        
    • 
      
        
  • 
          :auth_scheme_preference
          (Array<String>)
          
            
          
          
            — 
    A list of preferred authentication schemes to use when making a request. Supported values are:
sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in
shared config as auth_scheme_preference, the value should be a comma-separated list.
    
          
        
    • 
      
        
  • 
          :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
            
          
          
            — 
    When true, the SDK will not prepend the modeled host prefix to the endpoint.
    
          
        
    • 
      
        
  • 
          :disable_request_compression
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to 'true' the request body will not be compressed
for supported operations.
    
          
        
    • 
      
        
  • 
          :endpoint
          (String, URI::HTTPS, URI::HTTP)
          
            
          
          
            — 
    Normally you should not configure the :endpoint option
directly. This is normally constructed from the :region
option. Configuring :endpoint is normally reserved for
connecting to test or custom endpoints. The endpoint should
be a URI formatted like:
    

    'http://example.com'
'https://example.com'
'http://example.com:123'
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :ignore_configured_endpoint_urls
          (Boolean)
          
            
          
          
            — 
    Setting to true disables use of endpoint URLs provided via environment
variables and the shared configuration file.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :request_checksum_calculation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when a checksum will be calculated for request payloads. Values are:
    

      

    • when_supported - (default) When set, a checksum will be
calculated for all request payloads of operations modeled with the
httpChecksum trait where requestChecksumRequired is true and/or a
requestAlgorithmMember is modeled.
      • 

    • when_required - When set, a checksum will only be calculated for
request payloads of operations modeled with the  httpChecksum trait where
requestChecksumRequired is true or where a requestAlgorithmMember
is modeled and supplied.
      • 

    
          
        
    • 
      
        
  • 
          :request_min_compression_size_bytes
          (Integer)
          
            
              — default:
              10240
            
          
          
            — 
    The minimum size in bytes that triggers compression for request
bodies. The value must be non-negative integer value between 0
and 10485780 bytes inclusive.
    
          
        
    • 
      
        
  • 
          :response_checksum_validation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when checksum validation will be performed on response payloads. Values are:
    

      

    • when_supported - (default) When set, checksum validation is performed on all
response payloads of operations modeled with the httpChecksum trait where
responseAlgorithms is modeled, except when no modeled checksum algorithms
are supported.
      • 

    • when_required - When set, checksum validation is not performed on
response payloads of operations unless the checksum algorithm is supported and
the requestValidationModeMember member is set to ENABLED.
      • 

    
          
        
    • 
      
        
  • 
          :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 the 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 - A retry mode that includes all the functionality of
standard mode along with automatic client side throttling.
      

      • 

    
          
        
    • 
      
        
  • 
          :sdk_ua_app_id
          (String)
          
            
          
          
            — 
    A unique and opaque application ID that is appended to the
User-Agent header as app/sdk_ua_app_id. It should have a
maximum length of 50. This variable is sourced from environment
variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
    
          
        
    • 
      
        
  • 
          :secret_access_key
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :session_token
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :sigv4a_signing_region_set
          (Array)
          
            
          
          
            — 
    A list of regions that should be signed with SigV4a signing. When
not passed, a default :sigv4a_signing_region_set is searched for
in the following locations:
    

      

    • Aws.config[:sigv4a_signing_region_set]
      • 

    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
      • 

    • ~/.aws/config
      • 

    
          
        
    • 
      
        
  • 
          :simple_json
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    Disables request parameter conversion, validation, and formatting.
Also disables response data type conversions. The request parameters
hash must be formatted exactly as the API expects.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.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :telemetry_provider
          (Aws::Telemetry::TelemetryProviderBase)
          
            
              — default:
              Aws::Telemetry::NoOpTelemetryProvider
            
          
          
            — 
    Allows you to provide a telemetry provider, which is used to
emit telemetry data. By default, uses NoOpTelemetryProvider which
will not record or emit any telemetry data. The SDK supports the
following telemetry providers:
    

      

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the
opentelemetry-sdk gem and then, pass in an instance of a
Aws::Telemetry::OTelProvider for telemetry provider.
      • 

    
          
        
    • 
      
        
  • 
          :token_provider
          (Aws::TokenProvider)
          
            
          
          
            — 
    Your Bearer token used for authentication. This can be any class that includes and implements
Aws::TokenProvider, or 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_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.
    
          
        
    • 
      
        
  • 
          :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_open_timeout
          (Float)
          
            
              — default:
              15
            
          
          
            — 
    The default number of seconds to wait for response data.
This value can safely be set per-request on the session.
    
          
        
    • 
      
        
  • 
          :http_proxy
          (URI::HTTP, String)
          
            
          
          
            — 
    A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
    
          
        
    • 
      
        
  • 
          :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_wire_trace
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true,  HTTP debug output will be sent to the :logger.
    
          
        
    • 
      
        
  • 
          :on_chunk_received
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the response body is received. It provides three arguments: the chunk,
the number of bytes received, and the total number of
bytes in the response (or nil if the server did not send a content-length).
    
          
        
    • 
      
        
  • 
          :on_chunk_sent
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the request body is sent. It provides three arguments: the chunk,
the number of bytes read from the body, and the total number of
bytes in the body.
    
          
        
    • 
      
        
  • 
          :raise_response_errors
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, response errors are raised.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :ssl_ca_store
          (String)
          
            
          
          
            — 
    Sets the X509::Store to verify peer certificate.
    
          
        
    • 
      
        
  • 
          :ssl_cert
          (OpenSSL::X509::Certificate)
          
            
          
          
            — 
    Sets a client certificate when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_key
          (OpenSSL::PKey)
          
            
          
          
            — 
    Sets a client key when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_timeout
          (Float)
          
            
          
          
            — 
    Sets the SSL timeout in seconds
    
          
        
    • 
      
        
  • 
          :ssl_verify_peer
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, SSL peer certificates are verified when establishing a connection.
    
          
        
    • 
      
    

  








  

    
      


478
479
480

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

def initialize(*args)
  super
end

    		
  





  



  

    
Class Attribute Details

    
      
      
      

  

  
    .identifier  ⇒ Object  (readonly)
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


4268
4269
4270

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

def identifier
  @identifier
end

    		
  





    
  



  

    
Class Method Details


    
      

  

  
    .errors_module  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


4271
4272
4273

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

def errors_module
  Errors
end

    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  




  

    
https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTFleetWise/Client.html#initialize-instance_method


  





  



  

    
      


14

    		
    
      
# File 'sig/client.rbs', line 14

def self.new: (

    		
  





    
  


  

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





  

    
      


86

    		
    
      
# File 'sig/client.rbs', line 86

def associate_vehicle_fleet: (

    		
  





    
      

  

  
    #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
        },
      ],
      state_templates: [
        {
          identifier: "ResourceIdentifier", # required
          state_template_update_strategy: { # required
            periodic: {
              state_template_update_rate: { # required
                unit: "MILLISECOND", # required, accepts MILLISECOND, SECOND, MINUTE, HOUR
                value: 1, # required
              },
            },
            on_change: {
            },
          },
        },
      ],
    },
  ],
})

    
      
        
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:





  

    
      


98

    		
    
      
# File 'sig/client.rbs', line 98

def batch_create_vehicle: (

    		
  





    
      

  

  
    #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
      state_templates_to_add: [
        {
          identifier: "ResourceIdentifier", # required
          state_template_update_strategy: { # required
            periodic: {
              state_template_update_rate: { # required
                unit: "MILLISECOND", # required, accepts MILLISECOND, SECOND, MINUTE, HOUR
                value: 1, # required
              },
            },
            on_change: {
            },
          },
        },
      ],
      state_templates_to_remove: ["ResourceIdentifier"],
      state_templates_to_update: [
        {
          identifier: "ResourceIdentifier", # required
          state_template_update_strategy: { # required
            periodic: {
              state_template_update_rate: { # required
                unit: "MILLISECOND", # required, accepts MILLISECOND, SECOND, MINUTE, HOUR
                value: 1, # required
              },
            },
            on_change: {
            },
          },
        },
      ],
    },
  ],
})

    
      
        
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:





  

    
      


126

    		
    
      
# File 'sig/client.rbs', line 126

def batch_update_vehicle: (

    		
  





    
      

  

  
    #build_request(operation_name, params = {})  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  
Parameters:


    
  
    
  • 
      
        params
      
      
        ({})
      
      
        (defaults to: {})
      
      
    
    • 
  






  

    
      


4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257

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

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::IoTFleetWise')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-iotfleetwise'
  context[:gem_version] = '1.68.0'
  Seahorse::Client::Request.new(handlers, context)
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.


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


  





  
  

    
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,
      data_partition_id: "DataPartitionId",
    },
  ],
  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
      },
      mqtt_topic_config: {
        mqtt_topic_arn: "MqttTopicArn", # required
        execution_role_arn: "IAMRoleArn", # required
      },
    },
  ],
  data_partitions: [
    {
      id: "DataPartitionId", # required
      storage_options: { # required
        maximum_size: { # required
          unit: "MB", # required, accepts MB, GB, TB
          value: 1, # required
        },
        storage_location: "StorageLocation", # required
        minimum_time_to_live: { # required
          unit: "HOURS", # required, accepts HOURS, DAYS, WEEKS
          value: 1, # required
        },
      },
      upload_options: {
        expression: "eventExpression", # required
        condition_language_version: 1,
      },
    },
  ],
  signals_to_fetch: [
    {
      fully_qualified_name: "NodePath", # required
      signal_fetch_config: { # required
        time_based: {
          execution_frequency_ms: 1, # required
        },
        condition_based: {
          condition_expression: "fetchConfigEventExpression", # required
          trigger_mode: "ALWAYS", # required, accepts ALWAYS, RISING_EDGE
        },
      },
      condition_language_version: 1,
      actions: ["actionEventExpression"], # 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)
          
            
          
          
            — 
    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)
          
            
          
          
            — 
    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)
          
            
          
          
            — 
    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)
          
            
          
          
            — 
    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)
          
            
          
          
            — 
    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)
          
            
          
          
            — 
    Determines whether to store collected data after a vehicle lost a
connection with the cloud. After a connection is re-established, the
data is automatically forwarded to Amazon Web Services IoT FleetWise.
If you want to store collected data when a vehicle loses connection
with the cloud, use TO_DISK. If it's not specified, OFF is used.
    

    Default: OFF
    
          
        
    • 
      
        
  • 
          :compression
          (String)
          
            
          
          
            — 
    Determines whether to compress signals before transmitting data to
Amazon Web Services IoT FleetWise. If you don't want to compress the
signals, use OFF. If it's not specified, SNAPPY is used.
    

    Default: SNAPPY
    
          
        
    • 
      
        
  • 
          :priority
          (Integer)
          
            
          
          
            — 
    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>)
          
            
          
          
            — 
    A list of information about signals to collect.
    

     If you upload a signal as a condition in a data partition for a
campaign, then those same signals must be included in
signalsToCollect.
    
 
    
          
        
    • 
      
        
  • 
          :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>)
          
            
          
          
            — 
    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 send data to an
MQTT topic, or store it in Amazon S3 or Amazon Timestream.
    

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

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

    You can use Amazon Timestream to access and analyze time series data,
and Timestream to query vehicle data so that you can identify trends
and patterns.
    
          
        
    • 
      
        
  • 
          :data_partitions
          (Array<Types::DataPartition>)
          
            
          
          
            — 
    The data partitions associated with the signals collected from the
vehicle.
    
          
        
    • 
      
        
  • 
          :signals_to_fetch
          (Array<Types::SignalFetchInformation>)
          
            
          
          
            — 
    A list of information about signals to fetch.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


152

    		
    
      
# File 'sig/client.rbs', line 152

def create_campaign: (

    		
  





    
      

  

  
    #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: "CreateDecoderManifestRequestModelManifestArnString", # required
  signal_decoders: [
    {
      fully_qualified_name: "FullyQualifiedName", # required
      type: "CAN_SIGNAL", # required, accepts CAN_SIGNAL, OBD_SIGNAL, MESSAGE_SIGNAL, CUSTOM_DECODING_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",
        signal_value_type: "INTEGER", # accepts INTEGER, FLOATING_POINT
      },
      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,
        is_signed: false,
        signal_value_type: "INTEGER", # accepts INTEGER, FLOATING_POINT
      },
      message_signal: {
        topic_name: "TopicName", # required
        structured_message: { # required
          primitive_message_definition: {
            ros2_primitive_message_definition: {
              primitive_type: "BOOL", # required, accepts BOOL, BYTE, CHAR, FLOAT32, FLOAT64, INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, STRING, WSTRING
              offset: 1.0,
              scaling: 1.0,
              upper_bound: 1,
            },
          },
          structured_message_list_definition: {
            name: "StructureMessageName", # required
            member_type: { # required
              # recursive StructuredMessage
            },
            list_type: "FIXED_CAPACITY", # required, accepts FIXED_CAPACITY, DYNAMIC_UNBOUNDED_CAPACITY, DYNAMIC_BOUNDED_CAPACITY
            capacity: 1,
          },
          structured_message_definition: [
            {
              field_name: "StructureMessageName", # required
              data_type: { # required
                # recursive StructuredMessage
              },
            },
          ],
        },
      },
      custom_decoding_signal: {
        id: "CustomDecodingId", # required
      },
    },
  ],
  network_interfaces: [
    {
      interface_id: "InterfaceId", # required
      type: "CAN_INTERFACE", # required, accepts CAN_INTERFACE, OBD_INTERFACE, VEHICLE_MIDDLEWARE, CUSTOM_DECODING_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,
      },
      vehicle_middleware: {
        name: "VehicleMiddlewareName", # required
        protocol_name: "ROS_2", # required, accepts ROS_2
      },
      custom_decoding_interface: {
        name: "CustomDecodingSignalInterfaceName", # required
      },
    },
  ],
  default_for_unmapped_signals: "CUSTOM_DECODING", # accepts CUSTOM_DECODING
  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.
    
          
        
    • 
      
        
  • 
          :default_for_unmapped_signals
          (String)
          
            
          
          
            — 
    Use default decoders for all unmapped signals in the model. You don't
need to provide any detailed decoding information.
    

    Access to certain Amazon Web Services IoT FleetWise features is
currently gated. For more information, see Amazon Web Services Region
and feature availability in the Amazon Web Services IoT FleetWise
Developer Guide.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Metadata that can be used to manage the decoder manifest.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


253

    		
    
      
# File 'sig/client.rbs', line 253

def create_decoder_manifest: (

    		
  





    
      

  

  
    #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:





  

    
      


279

    		
    
      
# File 'sig/client.rbs', line 279

def create_fleet: (

    		
  





    
      

  

  
    #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:





  

    
      


298

    		
    
      
# File 'sig/client.rbs', line 298

def create_model_manifest: (

    		
  





    
      

  

  
    #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: "BranchFullyQualifiedNameString", # required
        description: "description",
        deprecation_message: "message",
        comment: "message",
      },
      sensor: {
        fully_qualified_name: "SensorFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        description: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        deprecation_message: "message",
        comment: "message",
        struct_fully_qualified_name: "NodePath",
      },
      actuator: {
        fully_qualified_name: "ActuatorFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        description: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        deprecation_message: "message",
        comment: "message",
        struct_fully_qualified_name: "NodePath",
      },
      attribute: {
        fully_qualified_name: "AttributeFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        description: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        default_value: "string",
        deprecation_message: "message",
        comment: "message",
      },
      struct: {
        fully_qualified_name: "CustomStructFullyQualifiedNameString", # required
        description: "description",
        deprecation_message: "message",
        comment: "message",
      },
      property: {
        fully_qualified_name: "CustomPropertyFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        data_encoding: "BINARY", # accepts BINARY, TYPED
        description: "description",
        deprecation_message: "message",
        comment: "message",
        struct_fully_qualified_name: "NodePath",
      },
    },
  ],
  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:





  

    
      


318

    		
    
      
# File 'sig/client.rbs', line 318

def create_signal_catalog: (

    		
  





    
      

  

  
    #create_state_template(params = {})  ⇒ Types::CreateStateTemplateResponse 
  

  

  




  

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


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_state_template({
  name: "resourceName", # required
  description: "description",
  signal_catalog_arn: "arn", # required
  state_template_properties: ["NodePath"], # required
  data_extra_dimensions: ["NodePath"],
  metadata_extra_dimensions: ["NodePath"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

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

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    The name of the state template.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A brief description of the state template.
    
          
        
    • 
      
        
  • 
          :signal_catalog_arn
          (required, String)
          
            
          
          
            — 
    The ARN of the signal catalog associated with the state template.
    
          
        
    • 
      
        
  • 
          :state_template_properties
          (required, Array<String>)
          
            
          
          
            — 
    A list of signals from which data is collected. The state template
properties contain the fully qualified names of the signals.
    
          
        
    • 
      
        
  • 
          :data_extra_dimensions
          (Array<String>)
          
            
          
          
            — 
    A list of vehicle attributes to associate with the payload published
on the state template's MQTT topic. (See  Processing last known
state vehicle data using MQTT messaging). For example, if you add
Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes,
Amazon Web Services IoT FleetWise will enrich the protobuf encoded
payload with those attributes in the extraDimensions field.
    
          
        
    • 
      
        
  • 
          :metadata_extra_dimensions
          (Array<String>)
          
            
          
          
            — 
    A list of vehicle attributes to associate with user properties of the
messages published on the state template's MQTT topic. (See 
Processing last known state vehicle data using MQTT messaging).
For example, if you add Vehicle.Attributes.Make and
Vehicle.Attributes.Model attributes, Amazon Web Services IoT
FleetWise will include these attributes as User Properties with the
MQTT message.
    

    Default: An empty array
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Metadata that can be used to manage the state template.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


340

    		
    
      
# File 'sig/client.rbs', line 340

def create_state_template: (

    		
  





    
      

  

  
    #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
    },
  ],
  state_templates: [
    {
      identifier: "ResourceIdentifier", # required
      state_template_update_strategy: { # required
        periodic: {
          state_template_update_rate: { # required
            unit: "MILLISECOND", # required, accepts MILLISECOND, SECOND, MINUTE, HOUR
            value: 1, # required
          },
        },
        on_change: {
        },
      },
    },
  ],
})

    
      
        
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"
    

    To use attributes with Campaigns or State Templates, you must include
them using the request parameters dataExtraDimensions and/or
metadataExtraDimensions (for state templates only) when creating
your campaign/state template.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :state_templates
          (Array<Types::StateTemplateAssociation>)
          
            
          
          
            — 
    Associate state templates with the vehicle. You can monitor the last
known state of the vehicle in near real time.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


363

    		
    
      
# File 'sig/client.rbs', line 363

def create_vehicle: (

    		
  





    
      

  

  
    #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:





  

    
      


387

    		
    
      
# File 'sig/client.rbs', line 387

def delete_campaign: (

    		
  





    
      

  

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

  

  




  

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


  





  
  

    
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:





  

    
      


398

    		
    
      
# File 'sig/client.rbs', line 398

def delete_decoder_manifest: (

    		
  





    
      

  

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


  





  
  

    
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:





  

    
      


409

    		
    
      
# File 'sig/client.rbs', line 409

def delete_fleet: (

    		
  





    
      

  

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

  

  




  

    
Deletes a vehicle model (model manifest).


  





  
  

    
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:





  

    
      


420

    		
    
      
# File 'sig/client.rbs', line 420

def delete_model_manifest: (

    		
  





    
      

  

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

  

  




  

    
Deletes a signal catalog.


  





  
  

    
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:





  

    
      


431

    		
    
      
# File 'sig/client.rbs', line 431

def delete_signal_catalog: (

    		
  





    
      

  

  
    #delete_state_template(params = {})  ⇒ Types::DeleteStateTemplateResponse 
  

  

  




  

    
Deletes a state template.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_state_template({
  identifier: "ResourceIdentifier", # required
})

    
      
        
Response structure

      
      

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

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :identifier
          (required, String)
          
            
          
          
            — 
    The unique ID of the state template.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


443

    		
    
      
# File 'sig/client.rbs', line 443

def delete_state_template: (

    		
  





    
      

  

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

  

  




  

    
Deletes a vehicle and removes it from any campaigns.


  





  
  

    
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:





  

    
      


454

    		
    
      
# File 'sig/client.rbs', line 454

def delete_vehicle: (

    		
  





    
      

  

  
    #disassociate_vehicle_fleet(params = {})  ⇒ Struct 
  

  

  




  

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


  





  
  

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





  

    
      


463

    		
    
      
# File 'sig/client.rbs', line 463

def disassociate_vehicle_fleet: (

    		
  





    
      

  

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

  

  




  

    
Retrieves information about a campaign.


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


  





  
  

    
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.signals_to_collect[0].data_partition_id #=> String
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
resp.data_destination_configs[0].mqtt_topic_config.mqtt_topic_arn #=> String
resp.data_destination_configs[0].mqtt_topic_config.execution_role_arn #=> String
resp.data_partitions #=> Array
resp.data_partitions[0].id #=> String
resp.data_partitions[0].storage_options.maximum_size.unit #=> String, one of "MB", "GB", "TB"
resp.data_partitions[0].storage_options.maximum_size.value #=> Integer
resp.data_partitions[0].storage_options.storage_location #=> String
resp.data_partitions[0].storage_options.minimum_time_to_live.unit #=> String, one of "HOURS", "DAYS", "WEEKS"
resp.data_partitions[0].storage_options.minimum_time_to_live.value #=> Integer
resp.data_partitions[0].upload_options.expression #=> String
resp.data_partitions[0].upload_options.condition_language_version #=> Integer
resp.signals_to_fetch #=> Array
resp.signals_to_fetch[0].fully_qualified_name #=> String
resp.signals_to_fetch[0].signal_fetch_config.time_based.execution_frequency_ms #=> Integer
resp.signals_to_fetch[0].signal_fetch_config.condition_based.condition_expression #=> String
resp.signals_to_fetch[0].signal_fetch_config.condition_based.trigger_mode #=> String, one of "ALWAYS", "RISING_EDGE"
resp.signals_to_fetch[0].condition_language_version #=> Integer
resp.signals_to_fetch[0].actions #=> Array
resp.signals_to_fetch[0].actions[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

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

  
    
    


Returns:





  

    
      


494

    		
    
      
# File 'sig/client.rbs', line 494

def get_campaign: (

    		
  





    
      

  

  
    #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", "INVALID", "VALIDATING"
resp.creation_time #=> Time
resp.last_modification_time #=> Time
resp.message #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

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

  
    
    


Returns:





  

    
      


511

    		
    
      
# File 'sig/client.rbs', line 511

def get_decoder_manifest: (

    		
  





    
      

  

  
    #get_encryption_configuration(params = {})  ⇒ Types::GetEncryptionConfigurationResponse 
  

  

  




  

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


  





  
  

    
Examples:

    
      
        
Response structure

      
      

resp.kms_key_id #=> String
resp.encryption_status #=> String, one of "PENDING", "SUCCESS", "FAILURE"
resp.encryption_type #=> String, one of "KMS_BASED_ENCRYPTION", "FLEETWISE_DEFAULT_ENCRYPTION"
resp.error_message #=> String
resp.creation_time #=> Time
resp.last_modification_time #=> Time

    
  


  

Parameters:


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




Returns:





  

    
      


526

    		
    
      
# File 'sig/client.rbs', line 526

def get_encryption_configuration: (

    		
  





    
      

  

  
    #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:





  

    
      


540

    		
    
      
# File 'sig/client.rbs', line 540

def get_fleet: (

    		
  





    
      

  

  
    #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:





  

    
      


550

    		
    
      
# File 'sig/client.rbs', line 550

def get_logging_options: (

    		
  





    
      

  

  
    #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", "INVALID", "VALIDATING"
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:





  

    
      


565

    		
    
      
# File 'sig/client.rbs', line 565

def get_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.


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. #=> String
resp. #=> 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:





  

    
      


580

    		
    
      
# File 'sig/client.rbs', line 580

def get_register_account_status: (

    		
  





    
      

  

  
    #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.node_counts.total_structs #=> Integer
resp.node_counts.total_properties #=> 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:





  

    
      


594

    		
    
      
# File 'sig/client.rbs', line 594

def get_signal_catalog: (

    		
  





    
      

  

  
    #get_state_template(params = {})  ⇒ Types::GetStateTemplateResponse 
  

  

  




  

    
Retrieves information about a state template.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_state_template({
  identifier: "ResourceIdentifier", # required
})

    
      
        
Response structure

      
      

resp.name #=> String
resp.arn #=> String
resp.description #=> String
resp.signal_catalog_arn #=> String
resp.state_template_properties #=> Array
resp.state_template_properties[0] #=> String
resp.data_extra_dimensions #=> Array
resp.data_extra_dimensions[0] #=> String
resp.metadata_extra_dimensions #=> Array
resp.metadata_extra_dimensions[0] #=> String
resp.creation_time #=> Time
resp.last_modification_time #=> Time
resp.id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :identifier
          (required, String)
          
            
          
          
            — 
    The unique ID of the state template.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


613

    		
    
      
# File 'sig/client.rbs', line 613

def get_state_template: (

    		
  





    
      

  

  
    #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.state_templates #=> Array
resp.state_templates[0].identifier #=> String
resp.state_templates[0].state_template_update_strategy.periodic.state_template_update_rate.unit #=> String, one of "MILLISECOND", "SECOND", "MINUTE", "HOUR"
resp.state_templates[0].state_template_update_strategy.periodic.state_template_update_rate.value #=> Integer
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:





  

    
      


630

    		
    
      
# File 'sig/client.rbs', line 630

def get_vehicle: (

    		
  





    
      

  

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

  

  




  

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


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", "READY_FOR_CHECKIN"
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. This
parameter is only supported for resources of type CAMPAIGN.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return, between 1 and 100, inclusive.
This parameter is only supported for resources of type CAMPAIGN.
    
          
        
    • 
      
        
  • 
          :vehicle_name
          (required, String)
          
            
          
          
            — 
    The ID of the vehicle to retrieve information about.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


641

    		
    
      
# File 'sig/client.rbs', line 641

def get_vehicle_status: (

    		
  





    
      

  

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

  

  




  

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


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


  





  
  

    
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:





  

    
      


654

    		
    
      
# File 'sig/client.rbs', line 654

def import_decoder_manifest: (

    		
  





    
      

  

  
    #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:





  

    
      


674

    		
    
      
# File 'sig/client.rbs', line 674

def import_signal_catalog: (

    		
  





    
      

  

  
    #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: "statusStr",
  list_response_scope: "METADATA_ONLY", # accepts METADATA_ONLY
})

    
      
        
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)
          
            
          
          
            — 
    An optional parameter to filter the results by the status of each
created campaign in your account. The status can be one of:
CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.
    
          
        
    • 
      
        
  • 
          :list_response_scope
          (String)
          
            
          
          
            — 
    When you set the listResponseScope parameter to METADATA_ONLY, the
list response includes: campaign name, Amazon Resource Name (ARN),
creation time, and last modification time.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


695

    		
    
      
# File 'sig/client.rbs', line 695

def list_campaigns: (

    		
  





    
      

  

  
    #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", "VEHICLE_MIDDLEWARE", "CUSTOM_DECODING_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.network_interfaces[0].vehicle_middleware.name #=> String
resp.network_interfaces[0].vehicle_middleware.protocol_name #=> String, one of "ROS_2"
resp.network_interfaces[0].custom_decoding_interface.name #=> String
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:





  

    
      


709

    		
    
      
# File 'sig/client.rbs', line 709

def list_decoder_manifest_network_interfaces: (

    		
  





    
      

  

  
    #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", "MESSAGE_SIGNAL", "CUSTOM_DECODING_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].can_signal.signal_value_type #=> String, one of "INTEGER", "FLOATING_POINT"
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.signal_decoders[0].obd_signal.is_signed #=> Boolean
resp.signal_decoders[0].obd_signal.signal_value_type #=> String, one of "INTEGER", "FLOATING_POINT"
resp.signal_decoders[0].message_signal.topic_name #=> String
resp.signal_decoders[0].message_signal.structured_message.primitive_message_definition.ros2_primitive_message_definition.primitive_type #=> String, one of "BOOL", "BYTE", "CHAR", "FLOAT32", "FLOAT64", "INT8", "UINT8", "INT16", "UINT16", "INT32", "UINT32", "INT64", "UINT64", "STRING", "WSTRING"
resp.signal_decoders[0].message_signal.structured_message.primitive_message_definition.ros2_primitive_message_definition.offset #=> Float
resp.signal_decoders[0].message_signal.structured_message.primitive_message_definition.ros2_primitive_message_definition.scaling #=> Float
resp.signal_decoders[0].message_signal.structured_message.primitive_message_definition.ros2_primitive_message_definition.upper_bound #=> Integer
resp.signal_decoders[0].message_signal.structured_message.structured_message_list_definition.name #=> String
resp.signal_decoders[0].message_signal.structured_message.structured_message_list_definition.member_type #=> Types::StructuredMessage
resp.signal_decoders[0].message_signal.structured_message.structured_message_list_definition.list_type #=> String, one of "FIXED_CAPACITY", "DYNAMIC_UNBOUNDED_CAPACITY", "DYNAMIC_BOUNDED_CAPACITY"
resp.signal_decoders[0].message_signal.structured_message.structured_message_list_definition.capacity #=> Integer
resp.signal_decoders[0].message_signal.structured_message.structured_message_definition #=> Array
resp.signal_decoders[0].message_signal.structured_message.structured_message_definition[0].field_name #=> String
resp.signal_decoders[0].message_signal.structured_message.structured_message_definition[0].data_type #=> Types::StructuredMessage
resp.signal_decoders[0].custom_decoding_signal.id #=> String
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:





  

    
      


722

    		
    
      
# File 'sig/client.rbs', line 722

def list_decoder_manifest_signals: (

    		
  





    
      

  

  
    #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,
  list_response_scope: "METADATA_ONLY", # accepts METADATA_ONLY
})

    
      
        
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", "INVALID", "VALIDATING"
resp.summaries[0].creation_time #=> Time
resp.summaries[0].last_modification_time #=> Time
resp.summaries[0].message #=> String
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.
    
          
        
    • 
      
        
  • 
          :list_response_scope
          (String)
          
            
          
          
            — 
    When you set the listResponseScope parameter to METADATA_ONLY, the
list response includes: decoder manifest name, Amazon Resource Name
(ARN), creation time, and last modification time.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


735

    		
    
      
# File 'sig/client.rbs', line 735

def list_decoder_manifests: (

    		
  





    
      

  

  
    #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,
  list_response_scope: "METADATA_ONLY", # accepts METADATA_ONLY
})

    
      
        
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.
    
          
        
    • 
      
        
  • 
          :list_response_scope
          (String)
          
            
          
          
            — 
    When you set the listResponseScope parameter to METADATA_ONLY, the
list response includes: fleet ID, Amazon Resource Name (ARN), creation
time, and last modification time.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


749

    		
    
      
# File 'sig/client.rbs', line 749

def list_fleets: (

    		
  





    
      

  

  
    #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:





  

    
      


762

    		
    
      
# File 'sig/client.rbs', line 762

def list_fleets_for_vehicle: (

    		
  





    
      

  

  
    #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", "STRUCT", "STRUCT_ARRAY"
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].sensor.struct_fully_qualified_name #=> 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", "STRUCT", "STRUCT_ARRAY"
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].actuator.struct_fully_qualified_name #=> 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", "STRUCT", "STRUCT_ARRAY"
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.nodes[0].struct.fully_qualified_name #=> String
resp.nodes[0].struct.description #=> String
resp.nodes[0].struct.deprecation_message #=> String
resp.nodes[0].struct.comment #=> String
resp.nodes[0].property.fully_qualified_name #=> String
resp.nodes[0].property.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", "STRUCT", "STRUCT_ARRAY"
resp.nodes[0].property.data_encoding #=> String, one of "BINARY", "TYPED"
resp.nodes[0].property.description #=> String
resp.nodes[0].property.deprecation_message #=> String
resp.nodes[0].property.comment #=> String
resp.nodes[0].property.struct_fully_qualified_name #=> 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:





  

    
      


775

    		
    
      
# File 'sig/client.rbs', line 775

def list_model_manifest_nodes: (

    		
  





    
      

  

  
    #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,
  list_response_scope: "METADATA_ONLY", # accepts METADATA_ONLY
})

    
      
        
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", "INVALID", "VALIDATING"
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.
    
          
        
    • 
      
        
  • 
          :list_response_scope
          (String)
          
            
          
          
            — 
    When you set the listResponseScope parameter to METADATA_ONLY, the
list response includes: model manifest name, Amazon Resource Name
(ARN), creation time, and last modification time.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


788

    		
    
      
# File 'sig/client.rbs', line 788

def list_model_manifests: (

    		
  





    
      

  

  
    #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,
  signal_node_type: "SENSOR", # accepts SENSOR, ACTUATOR, ATTRIBUTE, BRANCH, CUSTOM_STRUCT, CUSTOM_PROPERTY
})

    
      
        
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", "STRUCT", "STRUCT_ARRAY"
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].sensor.struct_fully_qualified_name #=> 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", "STRUCT", "STRUCT_ARRAY"
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].actuator.struct_fully_qualified_name #=> 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", "STRUCT", "STRUCT_ARRAY"
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.nodes[0].struct.fully_qualified_name #=> String
resp.nodes[0].struct.description #=> String
resp.nodes[0].struct.deprecation_message #=> String
resp.nodes[0].struct.comment #=> String
resp.nodes[0].property.fully_qualified_name #=> String
resp.nodes[0].property.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", "STRUCT", "STRUCT_ARRAY"
resp.nodes[0].property.data_encoding #=> String, one of "BINARY", "TYPED"
resp.nodes[0].property.description #=> String
resp.nodes[0].property.deprecation_message #=> String
resp.nodes[0].property.comment #=> String
resp.nodes[0].property.struct_fully_qualified_name #=> 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.
    
          
        
    • 
      
        
  • 
          :signal_node_type
          (String)
          
            
          
          
            — 
    The type of node in the signal catalog.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


802

    		
    
      
# File 'sig/client.rbs', line 802

def list_signal_catalog_nodes: (

    		
  





    
      

  

  
    #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:





  

    
      


816

    		
    
      
# File 'sig/client.rbs', line 816

def list_signal_catalogs: (

    		
  





    
      

  

  
    #list_state_templates(params = {})  ⇒ Types::ListStateTemplatesResponse 
  

  

  




  

    
Lists information about created state templates.


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


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_state_templates({
  next_token: "nextToken",
  max_results: 1,
  list_response_scope: "METADATA_ONLY", # accepts METADATA_ONLY
})

    
      
        
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].creation_time #=> Time
resp.summaries[0].last_modification_time #=> Time
resp.summaries[0].id #=> String
resp.next_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    The token to retrieve the next set of results, or null if there are
no more results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return, between 1 and 100, inclusive.
    
          
        
    • 
      
        
  • 
          :list_response_scope
          (String)
          
            
          
          
            — 
    When you set the listResponseScope parameter to METADATA_ONLY, the
list response includes: state template ID, Amazon Resource Name (ARN),
creation time, and last modification time.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


828

    		
    
      
# File 'sig/client.rbs', line 828

def list_state_templates: (

    		
  





    
      

  

  
    #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:





  

    
      


840

    		
    
      
# File 'sig/client.rbs', line 840

def list_tags_for_resource: (

    		
  





    
      

  

  
    #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",
  attribute_names: ["attributeName"],
  attribute_values: ["attributeValue"],
  next_token: "nextToken",
  max_results: 1,
  list_response_scope: "METADATA_ONLY", # accepts METADATA_ONLY
})

    
      
        
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.vehicle_summaries[0].attributes #=> Hash
resp.vehicle_summaries[0].attributes["attributeName"] #=> String
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.
    
          
        
    • 
      
        
  • 
          :attribute_names
          (Array<String>)
          
            
          
          
            — 
    The fully qualified names of the attributes. You can use this optional
parameter to list the vehicles containing all the attributes in the
request. For example, attributeNames could be
"Vehicle.Body.Engine.Type, Vehicle.Color" and the corresponding
attributeValues could be "1.3 L R2, Blue" . In this case, the
API will filter vehicles with an attribute name
Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an
attribute name Vehicle.Color that contains a value of "Blue". A
request must contain unique values for the attributeNames filter and
the matching number of attributeValues filters to return the subset
of vehicles that match the attributes filter condition.
    
          
        
    • 
      
        
  • 
          :attribute_values
          (Array<String>)
          
            
          
          
            — 
    Static information about a vehicle attribute value in string format.
You can use this optional parameter in conjunction with
attributeNames to list the vehicles containing all the
attributeValues corresponding to the attributeNames filter. For
example, attributeValues could be "1.3 L R2, Blue" and the
corresponding attributeNames filter could be
"Vehicle.Body.Engine.Type, Vehicle.Color". In this case, the API
will filter vehicles with attribute name Vehicle.Body.Engine.Type
that contains a value of 1.3 L R2 AND an attribute name
Vehicle.Color that contains a value of "Blue". A request must
contain unique values for the attributeNames filter and the matching
number of attributeValues filter to return the subset of vehicles
that match the attributes filter condition.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :list_response_scope
          (String)
          
            
          
          
            — 
    When you set the listResponseScope parameter to METADATA_ONLY, the
list response includes: vehicle name, Amazon Resource Name (ARN),
creation time, and last modification time.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


851

    		
    
      
# File 'sig/client.rbs', line 851

def list_vehicles: (

    		
  





    
      

  

  
    #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:





  

    
      


867

    		
    
      
# File 'sig/client.rbs', line 867

def list_vehicles_in_fleet: (

    		
  





    
      

  

  
    #put_encryption_configuration(params = {})  ⇒ Types::PutEncryptionConfigurationResponse 
  

  

  




  

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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.put_encryption_configuration({
  kms_key_id: "PutEncryptionConfigurationRequestKmsKeyIdString",
  encryption_type: "KMS_BASED_ENCRYPTION", # required, accepts KMS_BASED_ENCRYPTION, FLEETWISE_DEFAULT_ENCRYPTION
})

    
      
        
Response structure

      
      

resp.kms_key_id #=> String
resp.encryption_status #=> String, one of "PENDING", "SUCCESS", "FAILURE"
resp.encryption_type #=> String, one of "KMS_BASED_ENCRYPTION", "FLEETWISE_DEFAULT_ENCRYPTION"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :kms_key_id
          (String)
          
            
          
          
            — 
    The ID of the KMS key that is used for encryption.
    
          
        
    • 
      
        
  • 
          :encryption_type
          (required, String)
          
            
          
          
            — 
    The type of encryption. Choose KMS_BASED_ENCRYPTION to use a KMS key
or FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services
managed key.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


881

    		
    
      
# File 'sig/client.rbs', line 881

def put_encryption_configuration: (

    		
  





    
      

  

  
    #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):

    
  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  





  

    
      


891

    		
    
      
# File 'sig/client.rbs', line 891

def put_logging_options: (

    		
  





    
      

  

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


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


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

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp. #=> 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:





  

    
      


908

    		
    
      
# File 'sig/client.rbs', line 908

def register_account: (

    		
  





    
      

  

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





  

    
      


923

    		
    
      
# File 'sig/client.rbs', line 923

def tag_resource: (

    		
  





    
      

  

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





  

    
      


938

    		
    
      
# File 'sig/client.rbs', line 938

def untag_resource: (

    		
  





    
      

  

  
    #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:





  

    
      


951

    		
    
      
# File 'sig/client.rbs', line 951

def update_campaign: (

    		
  





    
      

  

  
    #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, MESSAGE_SIGNAL, CUSTOM_DECODING_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",
        signal_value_type: "INTEGER", # accepts INTEGER, FLOATING_POINT
      },
      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,
        is_signed: false,
        signal_value_type: "INTEGER", # accepts INTEGER, FLOATING_POINT
      },
      message_signal: {
        topic_name: "TopicName", # required
        structured_message: { # required
          primitive_message_definition: {
            ros2_primitive_message_definition: {
              primitive_type: "BOOL", # required, accepts BOOL, BYTE, CHAR, FLOAT32, FLOAT64, INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, STRING, WSTRING
              offset: 1.0,
              scaling: 1.0,
              upper_bound: 1,
            },
          },
          structured_message_list_definition: {
            name: "StructureMessageName", # required
            member_type: { # required
              # recursive StructuredMessage
            },
            list_type: "FIXED_CAPACITY", # required, accepts FIXED_CAPACITY, DYNAMIC_UNBOUNDED_CAPACITY, DYNAMIC_BOUNDED_CAPACITY
            capacity: 1,
          },
          structured_message_definition: [
            {
              field_name: "StructureMessageName", # required
              data_type: { # required
                # recursive StructuredMessage
              },
            },
          ],
        },
      },
      custom_decoding_signal: {
        id: "CustomDecodingId", # required
      },
    },
  ],
  signal_decoders_to_update: [
    {
      fully_qualified_name: "FullyQualifiedName", # required
      type: "CAN_SIGNAL", # required, accepts CAN_SIGNAL, OBD_SIGNAL, MESSAGE_SIGNAL, CUSTOM_DECODING_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",
        signal_value_type: "INTEGER", # accepts INTEGER, FLOATING_POINT
      },
      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,
        is_signed: false,
        signal_value_type: "INTEGER", # accepts INTEGER, FLOATING_POINT
      },
      message_signal: {
        topic_name: "TopicName", # required
        structured_message: { # required
          primitive_message_definition: {
            ros2_primitive_message_definition: {
              primitive_type: "BOOL", # required, accepts BOOL, BYTE, CHAR, FLOAT32, FLOAT64, INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64, UINT64, STRING, WSTRING
              offset: 1.0,
              scaling: 1.0,
              upper_bound: 1,
            },
          },
          structured_message_list_definition: {
            name: "StructureMessageName", # required
            member_type: { # required
              # recursive StructuredMessage
            },
            list_type: "FIXED_CAPACITY", # required, accepts FIXED_CAPACITY, DYNAMIC_UNBOUNDED_CAPACITY, DYNAMIC_BOUNDED_CAPACITY
            capacity: 1,
          },
          structured_message_definition: [
            {
              field_name: "StructureMessageName", # required
              data_type: { # required
                # recursive StructuredMessage
              },
            },
          ],
        },
      },
      custom_decoding_signal: {
        id: "CustomDecodingId", # required
      },
    },
  ],
  signal_decoders_to_remove: ["FullyQualifiedName"],
  network_interfaces_to_add: [
    {
      interface_id: "InterfaceId", # required
      type: "CAN_INTERFACE", # required, accepts CAN_INTERFACE, OBD_INTERFACE, VEHICLE_MIDDLEWARE, CUSTOM_DECODING_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,
      },
      vehicle_middleware: {
        name: "VehicleMiddlewareName", # required
        protocol_name: "ROS_2", # required, accepts ROS_2
      },
      custom_decoding_interface: {
        name: "CustomDecodingSignalInterfaceName", # required
      },
    },
  ],
  network_interfaces_to_update: [
    {
      interface_id: "InterfaceId", # required
      type: "CAN_INTERFACE", # required, accepts CAN_INTERFACE, OBD_INTERFACE, VEHICLE_MIDDLEWARE, CUSTOM_DECODING_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,
      },
      vehicle_middleware: {
        name: "VehicleMiddlewareName", # required
        protocol_name: "ROS_2", # required, accepts ROS_2
      },
      custom_decoding_interface: {
        name: "CustomDecodingSignalInterfaceName", # required
      },
    },
  ],
  network_interfaces_to_remove: ["InterfaceId"],
  status: "ACTIVE", # accepts ACTIVE, DRAFT, INVALID, VALIDATING
  default_for_unmapped_signals: "CUSTOM_DECODING", # accepts CUSTOM_DECODING
})

    
      
        
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.
    
          
        
    • 
      
        
  • 
          :default_for_unmapped_signals
          (String)
          
            
          
          
            — 
    Use default decoders for all unmapped signals in the model. You don't
need to provide any detailed decoding information.
    

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

  
    
    


Returns:





  

    
      


965

    		
    
      
# File 'sig/client.rbs', line 965

def update_decoder_manifest: (

    		
  





    
      

  

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

  

  




  

    
Updates the description of an existing fleet.


  





  
  

    
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:





  

    
      


993

    		
    
      
# File 'sig/client.rbs', line 993

def update_fleet: (

    		
  





    
      

  

  
    #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, INVALID, VALIDATING
})

    
      
        
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:





  

    
      


1005

    		
    
      
# File 'sig/client.rbs', line 1005

def update_model_manifest: (

    		
  





    
      

  

  
    #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: "BranchFullyQualifiedNameString", # required
        description: "description",
        deprecation_message: "message",
        comment: "message",
      },
      sensor: {
        fully_qualified_name: "SensorFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        description: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        deprecation_message: "message",
        comment: "message",
        struct_fully_qualified_name: "NodePath",
      },
      actuator: {
        fully_qualified_name: "ActuatorFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        description: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        deprecation_message: "message",
        comment: "message",
        struct_fully_qualified_name: "NodePath",
      },
      attribute: {
        fully_qualified_name: "AttributeFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        description: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        default_value: "string",
        deprecation_message: "message",
        comment: "message",
      },
      struct: {
        fully_qualified_name: "CustomStructFullyQualifiedNameString", # required
        description: "description",
        deprecation_message: "message",
        comment: "message",
      },
      property: {
        fully_qualified_name: "CustomPropertyFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        data_encoding: "BINARY", # accepts BINARY, TYPED
        description: "description",
        deprecation_message: "message",
        comment: "message",
        struct_fully_qualified_name: "NodePath",
      },
    },
  ],
  nodes_to_update: [
    {
      branch: {
        fully_qualified_name: "BranchFullyQualifiedNameString", # required
        description: "description",
        deprecation_message: "message",
        comment: "message",
      },
      sensor: {
        fully_qualified_name: "SensorFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        description: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        deprecation_message: "message",
        comment: "message",
        struct_fully_qualified_name: "NodePath",
      },
      actuator: {
        fully_qualified_name: "ActuatorFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        description: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        deprecation_message: "message",
        comment: "message",
        struct_fully_qualified_name: "NodePath",
      },
      attribute: {
        fully_qualified_name: "AttributeFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        description: "description",
        unit: "string",
        allowed_values: ["string"],
        min: 1.0,
        max: 1.0,
        assigned_value: "string",
        default_value: "string",
        deprecation_message: "message",
        comment: "message",
      },
      struct: {
        fully_qualified_name: "CustomStructFullyQualifiedNameString", # required
        description: "description",
        deprecation_message: "message",
        comment: "message",
      },
      property: {
        fully_qualified_name: "CustomPropertyFullyQualifiedNameString", # 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, STRUCT, STRUCT_ARRAY
        data_encoding: "BINARY", # accepts BINARY, TYPED
        description: "description",
        deprecation_message: "message",
        comment: "message",
        struct_fully_qualified_name: "NodePath",
      },
    },
  ],
  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:





  

    
      


1020

    		
    
      
# File 'sig/client.rbs', line 1020

def update_signal_catalog: (

    		
  





    
      

  

  
    #update_state_template(params = {})  ⇒ Types::UpdateStateTemplateResponse 
  

  

  




  

    
Updates a state template.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_state_template({
  identifier: "ResourceIdentifier", # required
  description: "description",
  state_template_properties_to_add: ["NodePath"],
  state_template_properties_to_remove: ["NodePath"],
  data_extra_dimensions: ["NodePath"],
  metadata_extra_dimensions: ["NodePath"],
})

    
      
        
Response structure

      
      

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

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :identifier
          (required, String)
          
            
          
          
            — 
    The unique ID of the state template.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A brief description of the state template.
    
          
        
    • 
      
        
  • 
          :state_template_properties_to_add
          (Array<String>)
          
            
          
          
            — 
    Add signals from which data is collected as part of the state
template.
    
          
        
    • 
      
        
  • 
          :state_template_properties_to_remove
          (Array<String>)
          
            
          
          
            — 
    Remove signals from which data is collected as part of the state
template.
    
          
        
    • 
      
        
  • 
          :data_extra_dimensions
          (Array<String>)
          
            
          
          
            — 
    A list of vehicle attributes to associate with the payload published
on the state template's MQTT topic. (See  Processing last known
state vehicle data using MQTT messaging). For example, if you add
Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes,
Amazon Web Services IoT FleetWise will enrich the protobuf encoded
payload with those attributes in the extraDimensions field.
    

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

  
    
    


Returns:





  

    
      


1040

    		
    
      
# File 'sig/client.rbs', line 1040

def update_state_template: (

    		
  





    
      

  

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

  

  




  

    
Updates a vehicle.


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


  





  
  

    
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
  state_templates_to_add: [
    {
      identifier: "ResourceIdentifier", # required
      state_template_update_strategy: { # required
        periodic: {
          state_template_update_rate: { # required
            unit: "MILLISECOND", # required, accepts MILLISECOND, SECOND, MINUTE, HOUR
            value: 1, # required
          },
        },
        on_change: {
        },
      },
    },
  ],
  state_templates_to_remove: ["ResourceIdentifier"],
  state_templates_to_update: [
    {
      identifier: "ResourceIdentifier", # required
      state_template_update_strategy: { # required
        periodic: {
          state_template_update_rate: { # required
            unit: "MILLISECOND", # required, accepts MILLISECOND, SECOND, MINUTE, HOUR
            value: 1, # required
          },
        },
        on_change: {
        },
      },
    },
  ],
})

    
      
        
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.
    
          
        
    • 
      
        
  • 
          :state_templates_to_add
          (Array<Types::StateTemplateAssociation>)
          
            
          
          
            — 
    Associate state templates with the vehicle.
    
          
        
    • 
      
        
  • 
          :state_templates_to_remove
          (Array<String>)
          
            
          
          
            — 
    Remove state templates from the vehicle.
    
          
        
    • 
      
        
  • 
          :state_templates_to_update
          (Array<Types::StateTemplateAssociation>)
          
            
          
          
            — 
    Change the stateTemplateUpdateStrategy of state templates already
associated with the vehicle.
    
          
        
    • 
      
    

  
    
    


Returns:





  

    
      


1056

    		
    
      
# File 'sig/client.rbs', line 1056

def update_vehicle: (

    		
  





    
      

  

  
    #waiter_names  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.



Deprecated. 



  





  



  

    
      


4261
4262
4263

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

def waiter_names
  []
end