Struct aws_sdk_opsworks::Client

source ·

pub struct Client { /* private fields */ }

Expand description

Client for AWS OpsWorks

Client for invoking operations on AWS OpsWorks. Each operation on AWS OpsWorks 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_opsworks::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_opsworks::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 AssignInstance operation has a Client::assign_instance, 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.assign_instance()
    .instance_id("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.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Struct aws_sdk_opsworks::ClientCopy item path

§Constructing a Client

§Using the Client

§Waiters

Implementations§

impl Client

pub fn assign_instance(&self) -> AssignInstanceFluentBuilder

impl Client

pub fn assign_volume(&self) -> AssignVolumeFluentBuilder

impl Client

pub fn associate_elastic_ip(&self) -> AssociateElasticIpFluentBuilder

impl Client

pub fn attach_elastic_load_balancer( &self ) -> AttachElasticLoadBalancerFluentBuilder

impl Client

pub fn clone_stack(&self) -> CloneStackFluentBuilder

impl Client

pub fn create_app(&self) -> CreateAppFluentBuilder

impl Client

pub fn create_deployment(&self) -> CreateDeploymentFluentBuilder

impl Client

pub fn create_instance(&self) -> CreateInstanceFluentBuilder

impl Client

pub fn create_layer(&self) -> CreateLayerFluentBuilder

impl Client

pub fn create_stack(&self) -> CreateStackFluentBuilder

impl Client

pub fn create_user_profile(&self) -> CreateUserProfileFluentBuilder

impl Client

pub fn delete_app(&self) -> DeleteAppFluentBuilder

impl Client

pub fn delete_instance(&self) -> DeleteInstanceFluentBuilder

impl Client

pub fn delete_layer(&self) -> DeleteLayerFluentBuilder

impl Client

pub fn delete_stack(&self) -> DeleteStackFluentBuilder

impl Client

pub fn delete_user_profile(&self) -> DeleteUserProfileFluentBuilder

impl Client

pub fn deregister_ecs_cluster(&self) -> DeregisterEcsClusterFluentBuilder

impl Client

pub fn deregister_elastic_ip(&self) -> DeregisterElasticIpFluentBuilder

impl Client

pub fn deregister_instance(&self) -> DeregisterInstanceFluentBuilder

impl Client

pub fn deregister_rds_db_instance(&self) -> DeregisterRdsDbInstanceFluentBuilder

impl Client

pub fn deregister_volume(&self) -> DeregisterVolumeFluentBuilder

impl Client

pub fn describe_agent_versions(&self) -> DescribeAgentVersionsFluentBuilder

impl Client

pub fn describe_apps(&self) -> DescribeAppsFluentBuilder

impl Client

pub fn describe_commands(&self) -> DescribeCommandsFluentBuilder

impl Client

pub fn describe_deployments(&self) -> DescribeDeploymentsFluentBuilder

impl Client

pub fn describe_ecs_clusters(&self) -> DescribeEcsClustersFluentBuilder

impl Client

pub fn describe_elastic_ips(&self) -> DescribeElasticIpsFluentBuilder

impl Client

pub fn describe_elastic_load_balancers( &self ) -> DescribeElasticLoadBalancersFluentBuilder

impl Client

pub fn describe_instances(&self) -> DescribeInstancesFluentBuilder

impl Client

pub fn describe_layers(&self) -> DescribeLayersFluentBuilder

impl Client

pub fn describe_load_based_auto_scaling( &self ) -> DescribeLoadBasedAutoScalingFluentBuilder

impl Client

pub fn describe_my_user_profile(&self) -> DescribeMyUserProfileFluentBuilder

impl Client

pub fn describe_operating_systems( &self ) -> DescribeOperatingSystemsFluentBuilder

impl Client

pub fn describe_permissions(&self) -> DescribePermissionsFluentBuilder

impl Client

pub fn describe_raid_arrays(&self) -> DescribeRaidArraysFluentBuilder

impl Client

pub fn describe_rds_db_instances(&self) -> DescribeRdsDbInstancesFluentBuilder

impl Client

pub fn describe_service_errors(&self) -> DescribeServiceErrorsFluentBuilder

impl Client

Struct aws_sdk_opsworks::Client

§Constructing a `Client`

§Using the `Client`