Struct aws_sdk_iotfleetwise::Client

pub struct Client { /* private fields */ }

Client for AWS IoT FleetWise

Client for invoking operations on AWS IoT FleetWise. Each operation on AWS IoT FleetWise is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_iotfleetwise::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_iotfleetwise::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the GetVehicleStatus operation has a Client::get_vehicle_status, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.get_vehicle_status()
    .next_token("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_vehicle_fleet(&self) -> AssociateVehicleFleetFluentBuilder

Constructs a fluent builder for the AssociateVehicleFleet operation.

• The fluent builder is configurable:
  • vehicle_name(impl Into<String>) / set_vehicle_name(Option<String>):
    required: true
    

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

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The ID of a fleet.

    
    
• On success, responds with AssociateVehicleFleetOutput
• On failure, responds with SdkError<AssociateVehicleFleetError>

impl Client

pub fn batch_create_vehicle(&self) -> BatchCreateVehicleFluentBuilder

Constructs a fluent builder for the BatchCreateVehicle operation.

• The fluent builder is configurable:
  • vehicles(CreateVehicleRequestItem) / set_vehicles(Option<Vec::<CreateVehicleRequestItem>>):
    required: true
    

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

    
    
• On success, responds with BatchCreateVehicleOutput with field(s):
  • vehicles(Option<Vec::<CreateVehicleResponseItem>>):

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

  • errors(Option<Vec::<CreateVehicleError>>):

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

• On failure, responds with SdkError<BatchCreateVehicleError>

impl Client

pub fn batch_update_vehicle(&self) -> BatchUpdateVehicleFluentBuilder

Constructs a fluent builder for the BatchUpdateVehicle operation.

• The fluent builder is configurable:
  • vehicles(UpdateVehicleRequestItem) / set_vehicles(Option<Vec::<UpdateVehicleRequestItem>>):
    required: true
    

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

    
    
• On success, responds with BatchUpdateVehicleOutput with field(s):
  • vehicles(Option<Vec::<UpdateVehicleResponseItem>>):

    A list of information about the batch of updated vehicles.

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

  • errors(Option<Vec::<UpdateVehicleError>>):

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

• On failure, responds with SdkError<BatchUpdateVehicleError>

impl Client

pub fn create_campaign(&self) -> CreateCampaignFluentBuilder

Constructs a fluent builder for the CreateCampaign operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the campaign to create.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

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

    
    
  • signal_catalog_arn(impl Into<String>) / set_signal_catalog_arn(Option<String>):
    required: true
    

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

    
    
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

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

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

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

    Default: 0

    
    
  • expiry_time(DateTime) / set_expiry_time(Option<DateTime>):
    required: false
    

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

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

    
    
  • post_trigger_collection_duration(i64) / set_post_trigger_collection_duration(Option<i64>):
    required: false
    

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

    Default: 0

    
    
  • diagnostics_mode(DiagnosticsMode) / set_diagnostics_mode(Option<DiagnosticsMode>):
    required: false
    

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

    Default: OFF

    
    
  • spooling_mode(SpoolingMode) / set_spooling_mode(Option<SpoolingMode>):
    required: false
    

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

    Default: OFF

    
    
  • compression(Compression) / set_compression(Option<Compression>):
    required: false
    

    (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don’t want to compress the signals, use OFF. If it’s not specified, SNAPPY is used.

    Default: SNAPPY

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

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

    Default: 0

    
    
  • signals_to_collect(SignalInformation) / set_signals_to_collect(Option<Vec::<SignalInformation>>):
    required: false
    

    (Optional) A list of information about signals to collect.

    
    
  • collection_scheme(CollectionScheme) / set_collection_scheme(Option<CollectionScheme>):
    required: true
    

    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(impl Into<String>) / set_data_extra_dimensions(Option<Vec::<String>>):
    required: false
    

    (Optional) A list of vehicle attributes to associate with a campaign.

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

    Default: An empty array

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the campaign.

    
    
  • data_destination_configs(DataDestinationConfig) / set_data_destination_configs(Option<Vec::<DataDestinationConfig>>):
    required: false
    

    The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

    Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. 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.

    
    
• On success, responds with CreateCampaignOutput with field(s):
  • name(Option<String>):

    The name of the created campaign.

  • arn(Option<String>):

    The ARN of the created campaign.

• On failure, responds with SdkError<CreateCampaignError>

impl Client

pub fn create_decoder_manifest(&self) -> CreateDecoderManifestFluentBuilder

Constructs a fluent builder for the CreateDecoderManifest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The unique name of the decoder manifest to create.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of the decoder manifest.

    
    
  • model_manifest_arn(impl Into<String>) / set_model_manifest_arn(Option<String>):
    required: true
    

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

    
    
  • signal_decoders(SignalDecoder) / set_signal_decoders(Option<Vec::<SignalDecoder>>):
    required: false
    

    A list of information about signal decoders.

    
    
  • network_interfaces(NetworkInterface) / set_network_interfaces(Option<Vec::<NetworkInterface>>):
    required: false
    

    A list of information about available network interfaces.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the decoder manifest.

    
    
• On success, responds with CreateDecoderManifestOutput with field(s):
  • name(String):

    The name of the created decoder manifest.

  • arn(String):

    The ARN of the created decoder manifest.

• On failure, responds with SdkError<CreateDecoderManifestError>

impl Client

pub fn create_fleet(&self) -> CreateFleetFluentBuilder

Constructs a fluent builder for the CreateFleet operation.

• The fluent builder is configurable:
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The unique ID of the fleet to create.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of the fleet to create.

    
    
  • signal_catalog_arn(impl Into<String>) / set_signal_catalog_arn(Option<String>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the fleet.

    
    
• On success, responds with CreateFleetOutput with field(s):
  • id(String):

    The ID of the created fleet.

  • arn(String):

    The ARN of the created fleet.

• On failure, responds with SdkError<CreateFleetError>

impl Client

pub fn create_model_manifest(&self) -> CreateModelManifestFluentBuilder

Constructs a fluent builder for the CreateModelManifest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the vehicle model to create.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of the vehicle model.

    
    
  • nodes(impl Into<String>) / set_nodes(Option<Vec::<String>>):
    required: true
    

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

    
    
  • signal_catalog_arn(impl Into<String>) / set_signal_catalog_arn(Option<String>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the vehicle model.

    
    
• On success, responds with CreateModelManifestOutput with field(s):
  • name(String):

    The name of the created vehicle model.

  • arn(String):

    The ARN of the created vehicle model.

• On failure, responds with SdkError<CreateModelManifestError>

impl Client

pub fn create_signal_catalog(&self) -> CreateSignalCatalogFluentBuilder

Constructs a fluent builder for the CreateSignalCatalog operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the signal catalog to create.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of the signal catalog.

    
    
  • nodes(Node) / set_nodes(Option<Vec::<Node>>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the signal catalog.

    
    
• On success, responds with CreateSignalCatalogOutput with field(s):
  • name(String):

    The name of the created signal catalog.

  • arn(String):

    The ARN of the created signal catalog.

• On failure, responds with SdkError<CreateSignalCatalogError>

impl Client

pub fn create_vehicle(&self) -> CreateVehicleFluentBuilder

Constructs a fluent builder for the CreateVehicle operation.

• The fluent builder is configurable:
  • vehicle_name(impl Into<String>) / set_vehicle_name(Option<String>):
    required: true
    

    The unique ID of the vehicle to create.

    
    
  • model_manifest_arn(impl Into<String>) / set_model_manifest_arn(Option<String>):
    required: true
    

    The Amazon Resource Name ARN of a vehicle model.

    
    
  • decoder_manifest_arn(impl Into<String>) / set_decoder_manifest_arn(Option<String>):
    required: true
    

    The ARN of a decoder manifest.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

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

    A campaign must include the keys (attribute names) in dataExtraDimensions for them to display in Amazon Timestream.

    
    
  • association_behavior(VehicleAssociationBehavior) / set_association_behavior(Option<VehicleAssociationBehavior>):
    required: false
    

    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(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the vehicle.

    
    
• On success, responds with CreateVehicleOutput with field(s):
  • vehicle_name(Option<String>):

    The unique ID of the created vehicle.

  • arn(Option<String>):

    The ARN of the created vehicle.

  • thing_arn(Option<String>):

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

• On failure, responds with SdkError<CreateVehicleError>

impl Client

pub fn delete_campaign(&self) -> DeleteCampaignFluentBuilder

Constructs a fluent builder for the DeleteCampaign operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the campaign to delete.

    
    
• On success, responds with DeleteCampaignOutput with field(s):
  • name(Option<String>):

    The name of the deleted campaign.

  • arn(Option<String>):

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

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

• On failure, responds with SdkError<DeleteCampaignError>

impl Client

pub fn delete_decoder_manifest(&self) -> DeleteDecoderManifestFluentBuilder

Constructs a fluent builder for the DeleteDecoderManifest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the decoder manifest to delete.

    
    
• On success, responds with DeleteDecoderManifestOutput with field(s):
  • name(String):

    The name of the deleted decoder manifest.

  • arn(String):

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

• On failure, responds with SdkError<DeleteDecoderManifestError>

impl Client

pub fn delete_fleet(&self) -> DeleteFleetFluentBuilder

Constructs a fluent builder for the DeleteFleet operation.

• The fluent builder is configurable:
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The ID of the fleet to delete.

    
    
• On success, responds with DeleteFleetOutput with field(s):
  • id(Option<String>):

    The ID of the deleted fleet.

  • arn(Option<String>):

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

• On failure, responds with SdkError<DeleteFleetError>

impl Client

pub fn delete_model_manifest(&self) -> DeleteModelManifestFluentBuilder

Constructs a fluent builder for the DeleteModelManifest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the model manifest to delete.

    
    
• On success, responds with DeleteModelManifestOutput with field(s):
  • name(String):

    The name of the deleted model manifest.

  • arn(String):

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

• On failure, responds with SdkError<DeleteModelManifestError>

impl Client

pub fn delete_signal_catalog(&self) -> DeleteSignalCatalogFluentBuilder

Constructs a fluent builder for the DeleteSignalCatalog operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the signal catalog to delete.

    
    
• On success, responds with DeleteSignalCatalogOutput with field(s):
  • name(String):

    The name of the deleted signal catalog.

  • arn(String):

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

• On failure, responds with SdkError<DeleteSignalCatalogError>

impl Client

pub fn delete_vehicle(&self) -> DeleteVehicleFluentBuilder

Constructs a fluent builder for the DeleteVehicle operation.

• The fluent builder is configurable:
  • vehicle_name(impl Into<String>) / set_vehicle_name(Option<String>):
    required: true
    

    The ID of the vehicle to delete.

    
    
• On success, responds with DeleteVehicleOutput with field(s):
  • vehicle_name(String):

    The ID of the deleted vehicle.

  • arn(String):

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

• On failure, responds with SdkError<DeleteVehicleError>

impl Client

pub fn disassociate_vehicle_fleet( &self ) -> DisassociateVehicleFleetFluentBuilder

Constructs a fluent builder for the DisassociateVehicleFleet operation.

• The fluent builder is configurable:
  • vehicle_name(impl Into<String>) / set_vehicle_name(Option<String>):
    required: true
    

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

    
    
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The unique ID of a fleet.

    
    
• On success, responds with DisassociateVehicleFleetOutput
• On failure, responds with SdkError<DisassociateVehicleFleetError>

impl Client

pub fn get_campaign(&self) -> GetCampaignFluentBuilder

Constructs a fluent builder for the GetCampaign operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the campaign to retrieve information about.

    
    
• On success, responds with GetCampaignOutput with field(s):
  • name(Option<String>):

    The name of the campaign.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the campaign.

  • description(Option<String>):

    The description of the campaign.

  • signal_catalog_arn(Option<String>):

    The ARN of a signal catalog.

  • target_arn(Option<String>):

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

  • status(Option<CampaignStatus>):

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

  • start_time(Option<DateTime>):

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

  • expiry_time(Option<DateTime>):

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

  • post_trigger_collection_duration(Option<i64>):

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

  • diagnostics_mode(Option<DiagnosticsMode>):

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

  • spooling_mode(Option<SpoolingMode>):

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

  • compression(Option<Compression>):

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

  • priority(Option<i32>):

    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.

  • signals_to_collect(Option<Vec::<SignalInformation>>):

    Information about a list of signals to collect data on.

  • collection_scheme(Option<CollectionScheme>):

    Information about the data collection scheme associated with the campaign.

  • data_extra_dimensions(Option<Vec::<String>>):

    A list of vehicle attributes associated with the campaign.

  • creation_time(Option<DateTime>):

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

  • last_modification_time(Option<DateTime>):

    The last time the campaign was modified.

  • data_destination_configs(Option<Vec::<DataDestinationConfig>>):

    The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

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

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

• On failure, responds with SdkError<GetCampaignError>

impl Client

pub fn get_decoder_manifest(&self) -> GetDecoderManifestFluentBuilder

Constructs a fluent builder for the GetDecoderManifest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the decoder manifest to retrieve information about.

    
    
• On success, responds with GetDecoderManifestOutput with field(s):
  • name(String):

    The name of the decoder manifest.

  • arn(String):

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

  • description(Option<String>):

    A brief description of the decoder manifest.

  • model_manifest_arn(Option<String>):

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

  • status(Option<ManifestStatus>):

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

  • creation_time(DateTime):

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

  • last_modification_time(DateTime):

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

  • message(Option<String>):

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

• On failure, responds with SdkError<GetDecoderManifestError>

impl Client

pub fn get_encryption_configuration( &self ) -> GetEncryptionConfigurationFluentBuilder

Constructs a fluent builder for the GetEncryptionConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetEncryptionConfigurationOutput with field(s):
  • kms_key_id(Option<String>):

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

  • encryption_status(EncryptionStatus):

    The encryption status.

  • encryption_type(EncryptionType):

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

  • error_message(Option<String>):

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

  • creation_time(Option<DateTime>):

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

  • last_modification_time(Option<DateTime>):

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

• On failure, responds with SdkError<GetEncryptionConfigurationError>

impl Client

pub fn get_fleet(&self) -> GetFleetFluentBuilder

Constructs a fluent builder for the GetFleet operation.

• The fluent builder is configurable:
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The ID of the fleet to retrieve information about.

    
    
• On success, responds with GetFleetOutput with field(s):
  • id(String):

    The ID of the fleet.

  • arn(String):

    The Amazon Resource Name (ARN) of the fleet.

  • description(Option<String>):

    A brief description of the fleet.

  • signal_catalog_arn(String):

    The ARN of a signal catalog associated with the fleet.

  • creation_time(DateTime):

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

  • last_modification_time(DateTime):

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

• On failure, responds with SdkError<GetFleetError>

impl Client

pub fn get_logging_options(&self) -> GetLoggingOptionsFluentBuilder

Constructs a fluent builder for the GetLoggingOptions operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetLoggingOptionsOutput with field(s):
  • cloud_watch_log_delivery(Option<CloudWatchLogDeliveryOptions>):

    Returns information about log delivery to Amazon CloudWatch Logs.

• On failure, responds with SdkError<GetLoggingOptionsError>

impl Client

pub fn get_model_manifest(&self) -> GetModelManifestFluentBuilder

Constructs a fluent builder for the GetModelManifest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the vehicle model to retrieve information about.

    
    
• On success, responds with GetModelManifestOutput with field(s):
  • name(String):

    The name of the vehicle model.

  • arn(String):

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

  • description(Option<String>):

    A brief description of the vehicle model.

  • signal_catalog_arn(Option<String>):

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

  • status(Option<ManifestStatus>):

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

  • creation_time(DateTime):

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

  • last_modification_time(DateTime):

    The last time the vehicle model was modified.

• On failure, responds with SdkError<GetModelManifestError>

impl Client

pub fn get_register_account_status( &self ) -> GetRegisterAccountStatusFluentBuilder

Constructs a fluent builder for the GetRegisterAccountStatus operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetRegisterAccountStatusOutput with field(s):
  • customer_account_id(String):

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

  • account_status(RegistrationStatus):

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

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

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

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

  • timestream_registration_response(Option<TimestreamRegistrationResponse>):

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

  • iam_registration_response(Option<IamRegistrationResponse>):

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

  • creation_time(DateTime):

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

  • last_modification_time(DateTime):

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

• On failure, responds with SdkError<GetRegisterAccountStatusError>

impl Client

pub fn get_signal_catalog(&self) -> GetSignalCatalogFluentBuilder

Constructs a fluent builder for the GetSignalCatalog operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the signal catalog to retrieve information about.

    
    
• On success, responds with GetSignalCatalogOutput with field(s):
  • name(String):

    The name of the signal catalog.

  • arn(String):

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

  • description(Option<String>):

    A brief description of the signal catalog.

  • node_counts(Option<NodeCounts>):

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

  • creation_time(DateTime):

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

  • last_modification_time(DateTime):

    The last time the signal catalog was modified.

• On failure, responds with SdkError<GetSignalCatalogError>

impl Client

pub fn get_vehicle(&self) -> GetVehicleFluentBuilder

Constructs a fluent builder for the GetVehicle operation.

• The fluent builder is configurable:
  • vehicle_name(impl Into<String>) / set_vehicle_name(Option<String>):
    required: true
    

    The ID of the vehicle to retrieve information about.

    
    
• On success, responds with GetVehicleOutput with field(s):
  • vehicle_name(Option<String>):

    The ID of the vehicle.

  • arn(Option<String>):

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

  • model_manifest_arn(Option<String>):

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

  • decoder_manifest_arn(Option<String>):

    The ARN of a decoder manifest associated with the vehicle.

  • attributes(Option<HashMap::<String, String>>):

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

    “engineType” : “1.3 L R2”

  • creation_time(Option<DateTime>):

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

  • last_modification_time(Option<DateTime>):

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

• On failure, responds with SdkError<GetVehicleError>

impl Client

pub fn get_vehicle_status(&self) -> GetVehicleStatusFluentBuilder

Constructs a fluent builder for the GetVehicleStatus operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • vehicle_name(impl Into<String>) / set_vehicle_name(Option<String>):
    required: true
    

    The ID of the vehicle to retrieve information about.

    
    
• On success, responds with GetVehicleStatusOutput with field(s):
  • campaigns(Option<Vec::<VehicleStatus>>):

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

  • next_token(Option<String>):

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

• On failure, responds with SdkError<GetVehicleStatusError>

impl Client

pub fn import_decoder_manifest(&self) -> ImportDecoderManifestFluentBuilder

Constructs a fluent builder for the ImportDecoderManifest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the decoder manifest to import.

    
    
  • network_file_definitions(NetworkFileDefinition) / set_network_file_definitions(Option<Vec::<NetworkFileDefinition>>):
    required: true
    

    The file to load into an Amazon Web Services account.

    
    
• On success, responds with ImportDecoderManifestOutput with field(s):
  • name(String):

    The name of the imported decoder manifest.

  • arn(String):

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

• On failure, responds with SdkError<ImportDecoderManifestError>

impl Client

pub fn import_signal_catalog(&self) -> ImportSignalCatalogFluentBuilder

Constructs a fluent builder for the ImportSignalCatalog operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the signal catalog to import.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of the signal catalog.

    
    
  • vss(FormattedVss) / set_vss(Option<FormattedVss>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the signal catalog.

    
    
• On success, responds with ImportSignalCatalogOutput with field(s):
  • name(String):

    The name of the imported signal catalog.

  • arn(String):

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

• On failure, responds with SdkError<ImportSignalCatalogError>

impl Client

pub fn list_campaigns(&self) -> ListCampaignsFluentBuilder

Constructs a fluent builder for the ListCampaigns operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
  • status(impl Into<String>) / set_status(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListCampaignsOutput with field(s):
  • campaign_summaries(Option<Vec::<CampaignSummary>>):

    A summary of information about each campaign.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListCampaignsError>

impl Client

pub fn list_decoder_manifest_network_interfaces( &self ) -> ListDecoderManifestNetworkInterfacesFluentBuilder

Constructs a fluent builder for the ListDecoderManifestNetworkInterfaces operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the decoder manifest to list information about.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListDecoderManifestNetworkInterfacesOutput with field(s):
  • network_interfaces(Option<Vec::<NetworkInterface>>):

    A list of information about network interfaces.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListDecoderManifestNetworkInterfacesError>

impl Client

pub fn list_decoder_manifest_signals( &self ) -> ListDecoderManifestSignalsFluentBuilder

Constructs a fluent builder for the ListDecoderManifestSignals operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the decoder manifest to list information about.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListDecoderManifestSignalsOutput with field(s):
  • signal_decoders(Option<Vec::<SignalDecoder>>):

    Information about a list of signals to decode.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListDecoderManifestSignalsError>

impl Client

pub fn list_decoder_manifests(&self) -> ListDecoderManifestsFluentBuilder

Constructs a fluent builder for the ListDecoderManifests operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • model_manifest_arn(impl Into<String>) / set_model_manifest_arn(Option<String>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListDecoderManifestsOutput with field(s):
  • summaries(Option<Vec::<DecoderManifestSummary>>):

    A list of information about each decoder manifest.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListDecoderManifestsError>

impl Client

pub fn list_fleets(&self) -> ListFleetsFluentBuilder

Constructs a fluent builder for the ListFleets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListFleetsOutput with field(s):
  • fleet_summaries(Option<Vec::<FleetSummary>>):

    A list of information for each fleet.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListFleetsError>

impl Client

pub fn list_fleets_for_vehicle(&self) -> ListFleetsForVehicleFluentBuilder

Constructs a fluent builder for the ListFleetsForVehicle operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • vehicle_name(impl Into<String>) / set_vehicle_name(Option<String>):
    required: true
    

    The ID of the vehicle to retrieve information about.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListFleetsForVehicleOutput with field(s):
  • fleets(Option<Vec::<String>>):

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

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListFleetsForVehicleError>

impl Client

pub fn list_model_manifest_nodes(&self) -> ListModelManifestNodesFluentBuilder

Constructs a fluent builder for the ListModelManifestNodes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the vehicle model to list information about.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListModelManifestNodesOutput with field(s):
  • nodes(Option<Vec::<Node>>):

    A list of information about nodes.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListModelManifestNodesError>

impl Client

pub fn list_model_manifests(&self) -> ListModelManifestsFluentBuilder

Constructs a fluent builder for the ListModelManifests operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • signal_catalog_arn(impl Into<String>) / set_signal_catalog_arn(Option<String>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListModelManifestsOutput with field(s):
  • summaries(Option<Vec::<ModelManifestSummary>>):

    A list of information about vehicle models.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListModelManifestsError>

impl Client

pub fn list_signal_catalog_nodes(&self) -> ListSignalCatalogNodesFluentBuilder

Constructs a fluent builder for the ListSignalCatalogNodes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the signal catalog to list information about.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListSignalCatalogNodesOutput with field(s):
  • nodes(Option<Vec::<Node>>):

    A list of information about nodes.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListSignalCatalogNodesError>

impl Client

pub fn list_signal_catalogs(&self) -> ListSignalCatalogsFluentBuilder

Constructs a fluent builder for the ListSignalCatalogs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListSignalCatalogsOutput with field(s):
  • summaries(Option<Vec::<SignalCatalogSummary>>):

    A list of information about each signal catalog.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListSignalCatalogsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The list of tags assigned to the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_vehicles(&self) -> ListVehiclesFluentBuilder

Constructs a fluent builder for the ListVehicles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • model_manifest_arn(impl Into<String>) / set_model_manifest_arn(Option<String>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListVehiclesOutput with field(s):
  • vehicle_summaries(Option<Vec::<VehicleSummary>>):

    A list of vehicles and information about them.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListVehiclesError>

impl Client

pub fn list_vehicles_in_fleet(&self) -> ListVehiclesInFleetFluentBuilder

Constructs a fluent builder for the ListVehiclesInFleet operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The ID of a fleet.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListVehiclesInFleetOutput with field(s):
  • vehicles(Option<Vec::<String>>):

    A list of vehicles associated with the fleet.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListVehiclesInFleetError>

impl Client

pub fn put_encryption_configuration( &self ) -> PutEncryptionConfigurationFluentBuilder

Constructs a fluent builder for the PutEncryptionConfiguration operation.

• The fluent builder is configurable:
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

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

    
    
  • encryption_type(EncryptionType) / set_encryption_type(Option<EncryptionType>):
    required: true
    

    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.

    
    
• On success, responds with PutEncryptionConfigurationOutput with field(s):
  • kms_key_id(Option<String>):

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

  • encryption_status(EncryptionStatus):

    The encryption status.

  • encryption_type(EncryptionType):

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

• On failure, responds with SdkError<PutEncryptionConfigurationError>

impl Client

pub fn put_logging_options(&self) -> PutLoggingOptionsFluentBuilder

Constructs a fluent builder for the PutLoggingOptions operation.

• The fluent builder is configurable:
  • cloud_watch_log_delivery(CloudWatchLogDeliveryOptions) / set_cloud_watch_log_delivery(Option<CloudWatchLogDeliveryOptions>):
    required: true
    

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

    
    
• On success, responds with PutLoggingOptionsOutput
• On failure, responds with SdkError<PutLoggingOptionsError>

impl Client

pub fn register_account(&self) -> RegisterAccountFluentBuilder

Constructs a fluent builder for the RegisterAccount operation.

• The fluent builder is configurable:
  • timestream_resources(TimestreamResources) / set_timestream_resources(Option<TimestreamResources>):
    required: false
    

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

    
    
  • iam_resources(IamResources) / set_iam_resources(Option<IamResources>):
    required: false
    

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

    
    
• On success, responds with RegisterAccountOutput with field(s):
  • register_account_status(RegistrationStatus):

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

  • timestream_resources(Option<TimestreamResources>):

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

  • iam_resources(Option<IamResources>):

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

  • creation_time(DateTime):

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

  • last_modification_time(DateTime):

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

• On failure, responds with SdkError<RegisterAccountError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The new or modified tags for the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

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

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_campaign(&self) -> UpdateCampaignFluentBuilder

Constructs a fluent builder for the UpdateCampaign operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the campaign to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the campaign.

    
    
  • data_extra_dimensions(impl Into<String>) / set_data_extra_dimensions(Option<Vec::<String>>):
    required: false
    

    A list of vehicle attributes to associate with a signal.

    Default: An empty array

    
    
  • action(UpdateCampaignAction) / set_action(Option<UpdateCampaignAction>):
    required: true
    

    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.

    
    
• On success, responds with UpdateCampaignOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the campaign.

  • name(Option<String>):

    The name of the updated campaign.

  • status(Option<CampaignStatus>):

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

    • CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

    • WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

    • RUNNING - The campaign is active.

    • SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

• On failure, responds with SdkError<UpdateCampaignError>

impl Client

pub fn update_decoder_manifest(&self) -> UpdateDecoderManifestFluentBuilder

Constructs a fluent builder for the UpdateDecoderManifest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the decoder manifest to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of the decoder manifest to update.

    
    
  • signal_decoders_to_add(SignalDecoder) / set_signal_decoders_to_add(Option<Vec::<SignalDecoder>>):
    required: false
    

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

    
    
  • signal_decoders_to_update(SignalDecoder) / set_signal_decoders_to_update(Option<Vec::<SignalDecoder>>):
    required: false
    

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

    
    
  • signal_decoders_to_remove(impl Into<String>) / set_signal_decoders_to_remove(Option<Vec::<String>>):
    required: false
    

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

    
    
  • network_interfaces_to_add(NetworkInterface) / set_network_interfaces_to_add(Option<Vec::<NetworkInterface>>):
    required: false
    

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

    
    
  • network_interfaces_to_update(NetworkInterface) / set_network_interfaces_to_update(Option<Vec::<NetworkInterface>>):
    required: false
    

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

    
    
  • network_interfaces_to_remove(impl Into<String>) / set_network_interfaces_to_remove(Option<Vec::<String>>):
    required: false
    

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

    
    
  • status(ManifestStatus) / set_status(Option<ManifestStatus>):
    required: false
    

    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.

    
    
• On success, responds with UpdateDecoderManifestOutput with field(s):
  • name(String):

    The name of the updated decoder manifest.

  • arn(String):

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

• On failure, responds with SdkError<UpdateDecoderManifestError>

impl Client

pub fn update_fleet(&self) -> UpdateFleetFluentBuilder

Constructs a fluent builder for the UpdateFleet operation.

• The fluent builder is configurable:
  • fleet_id(impl Into<String>) / set_fleet_id(Option<String>):
    required: true
    

    The ID of the fleet to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An updated description of the fleet.

    
    
• On success, responds with UpdateFleetOutput with field(s):
  • id(Option<String>):

    The ID of the updated fleet.

  • arn(Option<String>):

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

• On failure, responds with SdkError<UpdateFleetError>

impl Client

pub fn update_model_manifest(&self) -> UpdateModelManifestFluentBuilder

Constructs a fluent builder for the UpdateModelManifest operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the vehicle model to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of the vehicle model.

    
    
  • nodes_to_add(impl Into<String>) / set_nodes_to_add(Option<Vec::<String>>):
    required: false
    

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

    
    
  • nodes_to_remove(impl Into<String>) / set_nodes_to_remove(Option<Vec::<String>>):
    required: false
    

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

    
    
  • status(ManifestStatus) / set_status(Option<ManifestStatus>):
    required: false
    

    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.

    
    
• On success, responds with UpdateModelManifestOutput with field(s):
  • name(String):

    The name of the updated vehicle model.

  • arn(String):

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

• On failure, responds with SdkError<UpdateModelManifestError>

impl Client

pub fn update_signal_catalog(&self) -> UpdateSignalCatalogFluentBuilder

Constructs a fluent builder for the UpdateSignalCatalog operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the signal catalog to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of the signal catalog to update.

    
    
  • nodes_to_add(Node) / set_nodes_to_add(Option<Vec::<Node>>):
    required: false
    

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

    
    
  • nodes_to_update(Node) / set_nodes_to_update(Option<Vec::<Node>>):
    required: false
    

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

    
    
  • nodes_to_remove(impl Into<String>) / set_nodes_to_remove(Option<Vec::<String>>):
    required: false
    

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

    
    
• On success, responds with UpdateSignalCatalogOutput with field(s):
  • name(String):

    The name of the updated signal catalog.

  • arn(String):

    The ARN of the updated signal catalog.

• On failure, responds with SdkError<UpdateSignalCatalogError>

impl Client

pub fn update_vehicle(&self) -> UpdateVehicleFluentBuilder

Constructs a fluent builder for the UpdateVehicle operation.

• The fluent builder is configurable:
  • vehicle_name(impl Into<String>) / set_vehicle_name(Option<String>):
    required: true
    

    The unique ID of the vehicle to update.

    
    
  • model_manifest_arn(impl Into<String>) / set_model_manifest_arn(Option<String>):
    required: false
    

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

    
    
  • decoder_manifest_arn(impl Into<String>) / set_decoder_manifest_arn(Option<String>):
    required: false
    

    The ARN of the decoder manifest associated with this vehicle.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

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

    “engineType” : “1.3 L R2”

    
    
  • attribute_update_mode(UpdateMode) / set_attribute_update_mode(Option<UpdateMode>):
    required: false
    

    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.

    
    
• On success, responds with UpdateVehicleOutput with field(s):
  • vehicle_name(Option<String>):

    The ID of the updated vehicle.

  • arn(Option<String>):

    The ARN of the updated vehicle.

• On failure, responds with SdkError<UpdateVehicleError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.