Struct aws_sdk_iotfleethub::Client
source · [−]pub struct Client { /* 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
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn create_application(&self) -> CreateApplication
pub fn create_application(&self) -> CreateApplication
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>
sourcepub fn delete_application(&self) -> DeleteApplication
pub fn delete_application(&self) -> DeleteApplication
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>
sourcepub fn describe_application(&self) -> DescribeApplication
pub fn describe_application(&self) -> DescribeApplication
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>
sourcepub fn list_applications(&self) -> ListApplications
pub fn list_applications(&self) -> ListApplications
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>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
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>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
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>
sourcepub fn update_application(&self) -> UpdateApplication
pub fn update_application(&self) -> UpdateApplication
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>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more