Struct Client

pub struct Client { /* private fields */ }

Client for AWS IoT RoboRunner

Client for invoking operations on AWS IoT RoboRunner. Each operation on AWS IoT RoboRunner 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_iotroborunner::Client::new(&config);

Occasionally, SDKs may have additional service-specific values 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_iotroborunner::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 CreateWorker operation has a Client::create_worker, 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.create_worker()
    .client_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 create_destination(&self) -> CreateDestinationFluentBuilder

Constructs a fluent builder for the CreateDestination operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    Human friendly name of the resource.
    
  • site(impl Into<String>) / set_site(Option<String>):
    required: true
    Site ARN.
    
  • state(DestinationState) / set_state(Option<DestinationState>):
    required: false
    The state of the destination. Default used if not specified.
    
  • additional_fixed_properties(impl Into<String>) / set_additional_fixed_properties(Option<String>):
    required: false
    JSON document containing additional fixed properties regarding the destination
    
• On success, responds with CreateDestinationOutput with field(s):
  • arn(String): Destination ARN.
  • id(String): Filters access by the destination’s identifier
  • created_at(DateTime): Timestamp at which the resource was created.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
  • state(DestinationState): State of the destination.
• On failure, responds with SdkError<CreateDestinationError>

impl Client

pub fn create_site(&self) -> CreateSiteFluentBuilder

Constructs a fluent builder for the CreateSite operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    Human friendly name of the resource.
    
  • country_code(impl Into<String>) / set_country_code(Option<String>):
    required: true
    A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    A high-level description of the site.
    
• On success, responds with CreateSiteOutput with field(s):
  • arn(String): Site ARN.
  • id(String): Filters access by the site’s identifier
  • created_at(DateTime): Timestamp at which the resource was created.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
• On failure, responds with SdkError<CreateSiteError>

impl Client

pub fn create_worker(&self) -> CreateWorkerFluentBuilder

Constructs a fluent builder for the CreateWorker operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    Human friendly name of the resource.
    
  • fleet(impl Into<String>) / set_fleet(Option<String>):
    required: true
    Full ARN of the worker fleet.
    
  • additional_transient_properties(impl Into<String>) / set_additional_transient_properties(Option<String>):
    required: false
    JSON blob containing unstructured worker properties that are transient and may change during regular operation.
    
  • additional_fixed_properties(impl Into<String>) / set_additional_fixed_properties(Option<String>):
    required: false
    JSON blob containing unstructured worker properties that are fixed and won’t change during regular operation.
    
  • vendor_properties(VendorProperties) / set_vendor_properties(Option<VendorProperties>):
    required: false
    Properties of the worker that are provided by the vendor FMS.
    
  • position(PositionCoordinates) / set_position(Option<PositionCoordinates>):
    required: false
    Supported coordinates for worker position.
    
  • orientation(Orientation) / set_orientation(Option<Orientation>):
    required: false
    Worker orientation measured in units clockwise from north.
    
• On success, responds with CreateWorkerOutput with field(s):
  • arn(String): Full ARN of the worker.
  • id(String): Filters access by the workers identifier
  • created_at(DateTime): Timestamp at which the resource was created.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
  • site(String): Site ARN.
• On failure, responds with SdkError<CreateWorkerError>

impl Client

pub fn create_worker_fleet(&self) -> CreateWorkerFleetFluentBuilder

Constructs a fluent builder for the CreateWorkerFleet operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    Human friendly name of the resource.
    
  • site(impl Into<String>) / set_site(Option<String>):
    required: true
    Site ARN.
    
  • additional_fixed_properties(impl Into<String>) / set_additional_fixed_properties(Option<String>):
    required: false
    JSON blob containing additional fixed properties regarding the worker fleet
    
• On success, responds with CreateWorkerFleetOutput with field(s):
  • arn(String): Full ARN of the worker fleet.
  • id(String): Filters access by the worker fleet’s identifier
  • created_at(DateTime): Timestamp at which the resource was created.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
• On failure, responds with SdkError<CreateWorkerFleetError>

impl Client

pub fn delete_destination(&self) -> DeleteDestinationFluentBuilder

Constructs a fluent builder for the DeleteDestination operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Destination ARN.
    
• On success, responds with DeleteDestinationOutput
• On failure, responds with SdkError<DeleteDestinationError>

impl Client

pub fn delete_site(&self) -> DeleteSiteFluentBuilder

Constructs a fluent builder for the DeleteSite operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Site ARN.
    
• On success, responds with DeleteSiteOutput
• On failure, responds with SdkError<DeleteSiteError>

impl Client

pub fn delete_worker(&self) -> DeleteWorkerFluentBuilder

Constructs a fluent builder for the DeleteWorker operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Full ARN of the worker.
    
• On success, responds with DeleteWorkerOutput
• On failure, responds with SdkError<DeleteWorkerError>

impl Client

pub fn delete_worker_fleet(&self) -> DeleteWorkerFleetFluentBuilder

Constructs a fluent builder for the DeleteWorkerFleet operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Full ARN of the worker fleet.
    
• On success, responds with DeleteWorkerFleetOutput
• On failure, responds with SdkError<DeleteWorkerFleetError>

impl Client

pub fn get_destination(&self) -> GetDestinationFluentBuilder

Constructs a fluent builder for the GetDestination operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Destination ARN.
    
• On success, responds with GetDestinationOutput with field(s):
  • arn(String): Destination ARN.
  • id(String): Filters access by the destination’s identifier
  • name(String): Human friendly name of the resource.
  • site(String): Site ARN.
  • created_at(DateTime): Timestamp at which the resource was created.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
  • state(DestinationState): State of the destination.
  • additional_fixed_properties(Option<String>): JSON document containing additional fixed properties regarding the destination
• On failure, responds with SdkError<GetDestinationError>

impl Client

pub fn get_site(&self) -> GetSiteFluentBuilder

Constructs a fluent builder for the GetSite operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Site ARN.
    
• On success, responds with GetSiteOutput with field(s):
  • arn(String): Site ARN.
  • id(String): Filters access by the site’s identifier
  • name(String): Human friendly name of the resource.
  • country_code(String): A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
  • description(Option<String>): A high-level description of the site.
  • created_at(DateTime): Timestamp at which the resource was created.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
• On failure, responds with SdkError<GetSiteError>

impl Client

pub fn get_worker(&self) -> GetWorkerFluentBuilder

Constructs a fluent builder for the GetWorker operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Full ARN of the worker.
    
• On success, responds with GetWorkerOutput with field(s):
  • arn(String): Full ARN of the worker.
  • id(String): Filters access by the workers identifier
  • fleet(String): Full ARN of the worker fleet.
  • site(String): Site ARN.
  • created_at(DateTime): Timestamp at which the resource was created.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
  • name(String): Human friendly name of the resource.
  • additional_transient_properties(Option<String>): JSON blob containing unstructured worker properties that are transient and may change during regular operation.
  • additional_fixed_properties(Option<String>): JSON blob containing unstructured worker properties that are fixed and won’t change during regular operation.
  • vendor_properties(Option<VendorProperties>): Properties of the worker that are provided by the vendor FMS.
  • position(Option<PositionCoordinates>): Supported coordinates for worker position.
  • orientation(Option<Orientation>): Worker orientation measured in units clockwise from north.
• On failure, responds with SdkError<GetWorkerError>

impl Client

pub fn get_worker_fleet(&self) -> GetWorkerFleetFluentBuilder

Constructs a fluent builder for the GetWorkerFleet operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Full ARN of the worker fleet.
    
• On success, responds with GetWorkerFleetOutput with field(s):
  • id(String): Filters access by the worker fleet’s identifier
  • arn(String): Full ARN of the worker fleet.
  • name(String): Human friendly name of the resource.
  • site(String): Site ARN.
  • created_at(DateTime): Timestamp at which the resource was created.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
  • additional_fixed_properties(Option<String>): JSON blob containing additional fixed properties regarding the worker fleet
• On failure, responds with SdkError<GetWorkerFleetError>

impl Client

pub fn list_destinations(&self) -> ListDestinationsFluentBuilder

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

• The fluent builder is configurable:
  • site(impl Into<String>) / set_site(Option<String>):
    required: true
    Site ARN.
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Maximum number of results to retrieve in a single call.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
    
  • state(DestinationState) / set_state(Option<DestinationState>):
    required: false
    State of the destination.
    
• On success, responds with ListDestinationsOutput with field(s):
  • next_token(Option<String>): Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
  • destinations(Option<Vec::<Destination>>): List of destinations.
• On failure, responds with SdkError<ListDestinationsError>

impl Client

pub fn list_sites(&self) -> ListSitesFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Maximum number of results to retrieve in a single ListSites call.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
    
• On success, responds with ListSitesOutput with field(s):
  • next_token(Option<String>): Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
  • sites(Option<Vec::<Site>>): List of facilities.
• On failure, responds with SdkError<ListSitesError>

impl Client

pub fn list_worker_fleets(&self) -> ListWorkerFleetsFluentBuilder

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

• The fluent builder is configurable:
  • site(impl Into<String>) / set_site(Option<String>):
    required: true
    Site ARN.
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Maximum number of results to retrieve in a single ListWorkerFleets call.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
    
• On success, responds with ListWorkerFleetsOutput with field(s):
  • next_token(Option<String>): Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
  • worker_fleets(Option<Vec::<WorkerFleet>>): List of worker fleets.
• On failure, responds with SdkError<ListWorkerFleetsError>

impl Client

pub fn list_workers(&self) -> ListWorkersFluentBuilder

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

• The fluent builder is configurable:
  • site(impl Into<String>) / set_site(Option<String>):
    required: true
    Site ARN.
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Maximum number of results to retrieve in a single ListWorkers call.
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
    
  • fleet(impl Into<String>) / set_fleet(Option<String>):
    required: false
    Full ARN of the worker fleet.
    
• On success, responds with ListWorkersOutput with field(s):
  • next_token(Option<String>): Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
  • workers(Option<Vec::<Worker>>): List of workers.
• On failure, responds with SdkError<ListWorkersError>

impl Client

pub fn update_destination(&self) -> UpdateDestinationFluentBuilder

Constructs a fluent builder for the UpdateDestination operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Destination ARN.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    Human friendly name of the resource.
    
  • state(DestinationState) / set_state(Option<DestinationState>):
    required: false
    State of the destination.
    
  • additional_fixed_properties(impl Into<String>) / set_additional_fixed_properties(Option<String>):
    required: false
    JSON document containing additional fixed properties regarding the destination
    
• On success, responds with UpdateDestinationOutput with field(s):
  • arn(String): Destination ARN.
  • id(String): Filters access by the destination’s identifier
  • name(String): Human friendly name of the resource.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
  • state(DestinationState): State of the destination.
  • additional_fixed_properties(Option<String>): JSON document containing additional fixed properties regarding the destination
• On failure, responds with SdkError<UpdateDestinationError>

impl Client

pub fn update_site(&self) -> UpdateSiteFluentBuilder

Constructs a fluent builder for the UpdateSite operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Site ARN.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    Human friendly name of the resource.
    
  • country_code(impl Into<String>) / set_country_code(Option<String>):
    required: false
    A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    A high-level description of the site.
    
• On success, responds with UpdateSiteOutput with field(s):
  • arn(String): Site ARN.
  • id(String): Filters access by the site’s identifier
  • name(String): Human friendly name of the resource.
  • country_code(Option<String>): A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
  • description(Option<String>): A high-level description of the site.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
• On failure, responds with SdkError<UpdateSiteError>

impl Client

pub fn update_worker(&self) -> UpdateWorkerFluentBuilder

Constructs a fluent builder for the UpdateWorker operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Full ARN of the worker.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    Human friendly name of the resource.
    
  • additional_transient_properties(impl Into<String>) / set_additional_transient_properties(Option<String>):
    required: false
    JSON blob containing unstructured worker properties that are transient and may change during regular operation.
    
  • additional_fixed_properties(impl Into<String>) / set_additional_fixed_properties(Option<String>):
    required: false
    JSON blob containing unstructured worker properties that are fixed and won’t change during regular operation.
    
  • vendor_properties(VendorProperties) / set_vendor_properties(Option<VendorProperties>):
    required: false
    Properties of the worker that are provided by the vendor FMS.
    
  • position(PositionCoordinates) / set_position(Option<PositionCoordinates>):
    required: false
    Supported coordinates for worker position.
    
  • orientation(Orientation) / set_orientation(Option<Orientation>):
    required: false
    Worker orientation measured in units clockwise from north.
    
• On success, responds with UpdateWorkerOutput with field(s):
  • arn(String): Full ARN of the worker.
  • id(String): Filters access by the workers identifier
  • fleet(String): Full ARN of the worker fleet.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
  • name(String): Human friendly name of the resource.
  • additional_transient_properties(Option<String>): JSON blob containing unstructured worker properties that are transient and may change during regular operation.
  • additional_fixed_properties(Option<String>): JSON blob containing unstructured worker properties that are fixed and won’t change during regular operation.
  • orientation(Option<Orientation>): Worker orientation measured in units clockwise from north.
  • vendor_properties(Option<VendorProperties>): Properties of the worker that are provided by the vendor FMS.
  • position(Option<PositionCoordinates>): Supported coordinates for worker position.
• On failure, responds with SdkError<UpdateWorkerError>

impl Client

pub fn update_worker_fleet(&self) -> UpdateWorkerFleetFluentBuilder

Constructs a fluent builder for the UpdateWorkerFleet operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    Full ARN of the worker fleet.
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    Human friendly name of the resource.
    
  • additional_fixed_properties(impl Into<String>) / set_additional_fixed_properties(Option<String>):
    required: false
    JSON blob containing additional fixed properties regarding the worker fleet
    
• On success, responds with UpdateWorkerFleetOutput with field(s):
  • arn(String): Full ARN of the worker fleet.
  • id(String): Filters access by the worker fleet’s identifier
  • name(String): Human friendly name of the resource.
  • updated_at(DateTime): Timestamp at which the resource was last updated.
  • additional_fixed_properties(Option<String>): JSON blob containing additional fixed properties regarding the worker fleet
• On failure, responds with SdkError<UpdateWorkerFleetError>

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.