Struct aws_sdk_launchwizard::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Launch Wizard
Client for invoking operations on AWS Launch Wizard. Each operation on AWS Launch Wizard 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_launchwizard::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_launchwizard::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.
Implementations§
source§impl Client
impl Client
sourcepub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
pub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
Constructs a fluent builder for the CreateDeployment
operation.
- The fluent builder is configurable:
workload_name(impl Into<String>)
/set_workload_name(Option<String>)
:
required: trueThe name of the workload. You can use the
ListWorkloadDeploymentPatterns
operation to discover supported values for this parameter.deployment_pattern_name(impl Into<String>)
/set_deployment_pattern_name(Option<String>)
:
required: trueThe name of the deployment pattern supported by a given workload. You can use the
ListWorkloadDeploymentPatterns
operation to discover supported values for this parameter.name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the deployment.
specifications(impl Into<String>, impl Into<String>)
/set_specifications(Option<HashMap::<String, String>>)
:
required: trueThe settings specified for the deployment. For more information on the specifications required for creating a deployment, see Workload specifications.
dry_run(bool)
/set_dry_run(Option<bool>)
:
required: falseChecks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
- On success, responds with
CreateDeploymentOutput
with field(s):deployment_id(Option<String>)
:The ID of the deployment.
- On failure, responds with
SdkError<CreateDeploymentError>
source§impl Client
impl Client
sourcepub fn delete_deployment(&self) -> DeleteDeploymentFluentBuilder
pub fn delete_deployment(&self) -> DeleteDeploymentFluentBuilder
Constructs a fluent builder for the DeleteDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe ID of the deployment.
- On success, responds with
DeleteDeploymentOutput
with field(s):status(Option<DeploymentStatus>)
:The status of the deployment.
status_reason(Option<String>)
:The reason for the deployment status.
- On failure, responds with
SdkError<DeleteDeploymentError>
source§impl Client
impl Client
sourcepub fn get_deployment(&self) -> GetDeploymentFluentBuilder
pub fn get_deployment(&self) -> GetDeploymentFluentBuilder
Constructs a fluent builder for the GetDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe ID of the deployment.
- On success, responds with
GetDeploymentOutput
with field(s):deployment(Option<DeploymentData>)
:An object that details the deployment.
- On failure, responds with
SdkError<GetDeploymentError>
source§impl Client
impl Client
sourcepub fn get_workload(&self) -> GetWorkloadFluentBuilder
pub fn get_workload(&self) -> GetWorkloadFluentBuilder
Constructs a fluent builder for the GetWorkload
operation.
- The fluent builder is configurable:
workload_name(impl Into<String>)
/set_workload_name(Option<String>)
:
required: trueThe name of the workload.
- On success, responds with
GetWorkloadOutput
with field(s):workload(Option<WorkloadData>)
:Information about the workload.
- On failure, responds with
SdkError<GetWorkloadError>
source§impl Client
impl Client
sourcepub fn list_deployment_events(&self) -> ListDeploymentEventsFluentBuilder
pub fn list_deployment_events(&self) -> ListDeploymentEventsFluentBuilder
Constructs a fluent builder for the ListDeploymentEvents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe ID of the deployment.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- On success, responds with
ListDeploymentEventsOutput
with field(s):deployment_events(Option<Vec::<DeploymentEventDataSummary>>)
:Lists the deployment events.
next_token(Option<String>)
:The token to include in another request to get the next page of items. This value is
null
when there are no more items to return.
- On failure, responds with
SdkError<ListDeploymentEventsError>
source§impl Client
impl Client
sourcepub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
pub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
Constructs a fluent builder for the ListDeployments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(DeploymentFilter)
/set_filters(Option<Vec::<DeploymentFilter>>)
:
required: falseFilters to scope the results. The following filters are supported:
-
WORKLOAD_NAME
-
DEPLOYMENT_STATUS
-
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- On success, responds with
ListDeploymentsOutput
with field(s):deployments(Option<Vec::<DeploymentDataSummary>>)
:Lists the deployments.
next_token(Option<String>)
:The token to include in another request to get the next page of items. This value is
null
when there are no more items to return.
- On failure, responds with
SdkError<ListDeploymentsError>
source§impl Client
impl Client
sourcepub fn list_workload_deployment_patterns(
&self
) -> ListWorkloadDeploymentPatternsFluentBuilder
pub fn list_workload_deployment_patterns( &self ) -> ListWorkloadDeploymentPatternsFluentBuilder
Constructs a fluent builder for the ListWorkloadDeploymentPatterns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workload_name(impl Into<String>)
/set_workload_name(Option<String>)
:
required: trueThe name of the workload.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- On success, responds with
ListWorkloadDeploymentPatternsOutput
with field(s):workload_deployment_patterns(Option<Vec::<WorkloadDeploymentPatternDataSummary>>)
:Describes the workload deployment patterns.
next_token(Option<String>)
:The token to include in another request to get the next page of items. This value is
null
when there are no more items to return.
- On failure, responds with
SdkError<ListWorkloadDeploymentPatternsError>
source§impl Client
impl Client
sourcepub fn list_workloads(&self) -> ListWorkloadsFluentBuilder
pub fn list_workloads(&self) -> ListWorkloadsFluentBuilder
Constructs a fluent builder for the ListWorkloads
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- On success, responds with
ListWorkloadsOutput
with field(s):workloads(Option<Vec::<WorkloadDataSummary>>)
:Information about the workloads.
next_token(Option<String>)
:The token to include in another request to get the next page of items. This value is
null
when there are no more items to return.
- On failure, responds with
SdkError<ListWorkloadsError>
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