Struct Client

pub struct Client { /* private fields */ }

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 Builder 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.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateDeployment operation has a Client::create_deployment, 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_deployment()
    .workload_name("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_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: true
    

    The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.

    
    
  • deployment_pattern_name(impl Into<String>) / set_deployment_pattern_name(Option<String>):
    required: true
    

    The 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: true
    

    The name of the deployment.

    
    
  • specifications(impl Into<String>, impl Into<String>) / set_specifications(Option<HashMap::<String, String>>):
    required: true
    

    The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    

    Checks 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 is UnauthorizedOperation.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to add to the deployment.

    
    
• On success, responds with CreateDeploymentOutput with field(s):
  • deployment_id(Option<String>):

    The ID of the deployment.

• On failure, responds with SdkError<CreateDeploymentError>

impl Client

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: true
    

    The 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>

impl Client

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: true
    

    The 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>

impl Client

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: true
    

    The 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>

impl Client

pub fn get_workload_deployment_pattern( &self, ) -> GetWorkloadDeploymentPatternFluentBuilder

Constructs a fluent builder for the GetWorkloadDeploymentPattern operation.

• The fluent builder is configurable:
  • workload_name(impl Into<String>) / set_workload_name(Option<String>):
    required: true
    

    The name of the workload.

    
    
  • deployment_pattern_name(impl Into<String>) / set_deployment_pattern_name(Option<String>):
    required: true
    

    The name of the deployment pattern.

    
    
• On success, responds with GetWorkloadDeploymentPatternOutput with field(s):
  • workload_deployment_pattern(Option<WorkloadDeploymentPatternData>):

    Details about the workload deployment pattern.

• On failure, responds with SdkError<GetWorkloadDeploymentPatternError>

impl Client

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: true
    

    The ID of the deployment.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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: false
    

    The 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>

impl Client

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: false
    

    Filters to scope the results. The following filters are supported:

    • WORKLOAD_NAME - The name used in deployments.

    • DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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: false
    

    The 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>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    Information about the tags.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

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: true
    

    The name of the workload.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The 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: false
    

    The 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>

impl Client

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: false
    

    The 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: false
    

    The 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>

impl Client

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: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    One or more tags to attach to the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

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: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Keys identifying the tags to remove.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

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 duplicate 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.