Struct aws_sdk_iotfleethub::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description
Client for AWS IoT Fleet Hub
Client for invoking operations on AWS IoT Fleet Hub. Each operation on AWS IoT Fleet Hub is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_iotfleethub::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_iotfleethub::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_iotfleethub::Client::from_conf(config);
Implementations
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
Constructs a fluent builder for the CreateApplication
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of the web application.
application_description(impl Into<String>)
/set_application_description(Option<String>)
:An optional description of the web application.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The ARN of the role that the web application assumes when it interacts with AWS IoT Core.
The name of the role must be in the form
AWSIotFleetHub_random_string
.tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A set of key/value pairs that you can use to manage the web application resource.
- On success, responds with
CreateApplicationOutput
with field(s):application_id(Option<String>)
:The unique Id of the web application.
application_arn(Option<String>)
:The ARN of the web application.
- On failure, responds with
SdkError<CreateApplicationError>
Constructs a fluent builder for the DeleteApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:The unique Id of the web application.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.
- On success, responds with
DeleteApplicationOutput
- On failure, responds with
SdkError<DeleteApplicationError>
Constructs a fluent builder for the DescribeApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:The unique Id of the web application.
- On success, responds with
DescribeApplicationOutput
with field(s):application_id(Option<String>)
:The unique Id of the web application.
application_arn(Option<String>)
:The ARN of the web application.
application_name(Option<String>)
:The name of the web application.
application_description(Option<String>)
:An optional description of the web application.
application_url(Option<String>)
:The URL of the web application.
application_state(Option<ApplicationState>)
:The current state of the web application.
application_creation_date(i64)
:The date (in Unix epoch time) when the application was created.
application_last_update_date(i64)
:The date (in Unix epoch time) when the application was last updated.
role_arn(Option<String>)
:The ARN of the role that the web application assumes when it interacts with AWS IoT Core.
sso_client_id(Option<String>)
:The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
error_message(Option<String>)
:A message indicating why the
DescribeApplication
API failed.tags(Option<HashMap<String, String>>)
:A set of key/value pairs that you can use to manage the web application resource.
- On failure, responds with
SdkError<DescribeApplicationError>
Constructs a fluent builder for the ListApplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token used to get the next set of results.
- On success, responds with
ListApplicationsOutput
with field(s):application_summaries(Option<Vec<ApplicationSummary>>)
:An array of objects that provide summaries of information about the web applications in the list.
next_token(Option<String>)
:A token used to get the next set of results.
- On failure, responds with
SdkError<ListApplicationsError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap<String, String>>)
:The list of tags assigned to the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The new or modified tags for the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
: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>
Constructs a fluent builder for the UpdateApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:The unique Id of the web application.
application_name(impl Into<String>)
/set_application_name(Option<String>)
:The name of the web application.
application_description(impl Into<String>)
/set_application_description(Option<String>)
:An optional description of the web application.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.
- On success, responds with
UpdateApplicationOutput
- On failure, responds with
SdkError<UpdateApplicationError>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more