Struct aws_sdk_elasticinference::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon Elastic Inference
Client for invoking operations on Amazon Elastic Inference. Each operation on Amazon Elastic Inference 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_elasticinference::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_elasticinference::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 DescribeAcceleratorOfferings
operation has
a Client::describe_accelerator_offerings
, 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.describe_accelerator_offerings()
.location_type("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§
source§impl Client
impl Client
sourcepub fn describe_accelerator_offerings(
&self
) -> DescribeAcceleratorOfferingsFluentBuilder
pub fn describe_accelerator_offerings( &self ) -> DescribeAcceleratorOfferingsFluentBuilder
Constructs a fluent builder for the DescribeAcceleratorOfferings
operation.
- The fluent builder is configurable:
location_type(LocationType)
/set_location_type(Option<LocationType>)
:
required: trueThe location type that you want to describe accelerator type offerings for. It can assume the following values: region: will return the accelerator type offering at the regional level. availability-zone: will return the accelerator type offering at the availability zone level. availability-zone-id: will return the accelerator type offering at the availability zone level returning the availability zone id.
accelerator_types(impl Into<String>)
/set_accelerator_types(Option<Vec::<String>>)
:
required: falseThe list of accelerator types to describe.
- On success, responds with
DescribeAcceleratorOfferingsOutput
with field(s):accelerator_type_offerings(Option<Vec::<AcceleratorTypeOffering>>)
:The list of accelerator type offerings for a specific location.
- On failure, responds with
SdkError<DescribeAcceleratorOfferingsError>
source§impl Client
impl Client
sourcepub fn describe_accelerator_types(
&self
) -> DescribeAcceleratorTypesFluentBuilder
pub fn describe_accelerator_types( &self ) -> DescribeAcceleratorTypesFluentBuilder
Constructs a fluent builder for the DescribeAcceleratorTypes
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DescribeAcceleratorTypesOutput
with field(s):accelerator_types(Option<Vec::<AcceleratorType>>)
:The available accelerator types.
- On failure, responds with
SdkError<DescribeAcceleratorTypesError>
source§impl Client
impl Client
sourcepub fn describe_accelerators(&self) -> DescribeAcceleratorsFluentBuilder
pub fn describe_accelerators(&self) -> DescribeAcceleratorsFluentBuilder
Constructs a fluent builder for the DescribeAccelerators
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
accelerator_ids(impl Into<String>)
/set_accelerator_ids(Option<Vec::<String>>)
:
required: falseThe IDs of the accelerators to describe.
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOne or more filters. Filter names and values are case-sensitive. Valid filter names are: accelerator-types: can provide a list of accelerator type names to filter for. instance-id: can provide a list of EC2 instance ids to filter for.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token to specify where to start paginating. This is the NextToken from a previously truncated response.
- On success, responds with
DescribeAcceleratorsOutput
with field(s):accelerator_set(Option<Vec::<ElasticInferenceAccelerator>>)
:The details of the Elastic Inference Accelerators.
next_token(Option<String>)
:A token to specify where to start paginating. This is the NextToken from a previously truncated response.
- On failure, responds with
SdkError<DescribeAcceleratorsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the Elastic Inference Accelerator to list the tags for.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The tags of the Elastic Inference Accelerator.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
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: trueThe ARN of the Elastic Inference Accelerator to tag.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe tags to add to the Elastic Inference Accelerator.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
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: trueThe ARN of the Elastic Inference Accelerator to untag.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe list of tags to remove from the Elastic Inference Accelerator.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
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
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more