Struct aws_sdk_cloudcontrol::Client

pub struct Client { /* private fields */ }

Client for AWS Cloud Control API

Client for invoking operations on AWS Cloud Control API. Each operation on AWS Cloud Control API 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_cloudcontrol::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_cloudcontrol::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 CancelResourceRequest operation has a Client::cancel_resource_request, 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.cancel_resource_request()
    .request_token("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;

Implementations

impl Client

pub fn cancel_resource_request(&self) -> CancelResourceRequestFluentBuilder

Constructs a fluent builder for the CancelResourceRequest operation.

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

    The RequestToken of the ProgressEvent object returned by the resource operation request.

    
    
• On success, responds with CancelResourceRequestOutput with field(s):
  • progress_event(Option<ProgressEvent>):

    Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide.

• On failure, responds with SdkError<CancelResourceRequestError>

impl Client

pub fn create_resource(&self) -> CreateResourceFluentBuilder

Constructs a fluent builder for the CreateResource operation.

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

    The name of the resource type.

    
    
  • type_version_id(impl Into<String>) / set_type_version_id(Option<String>):
    required: false
    

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

    A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

    If you do not specify a client token, one is generated for inclusion in the request.

    For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

    
    
  • desired_state(impl Into<String>) / set_desired_state(Option<String>):
    required: true
    

    Structured data format representing the desired state of the resource, consisting of that resource’s properties and their desired values.

    Cloud Control API currently supports JSON as a structured data format.

    Specify the desired state as one of the following:

    • A JSON blob

    • A local path containing the desired state in JSON data format

    For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.

    For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.

    
    
• On success, responds with CreateResourceOutput with field(s):
  • progress_event(Option<ProgressEvent>):

    Represents the current status of the resource creation request.

    After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by CreateResource.

• On failure, responds with SdkError<CreateResourceError>

impl Client

pub fn delete_resource(&self) -> DeleteResourceFluentBuilder

Constructs a fluent builder for the DeleteResource operation.

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

    The name of the resource type.

    
    
  • type_version_id(impl Into<String>) / set_type_version_id(Option<String>):
    required: false
    

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

    A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

    If you do not specify a client token, one is generated for inclusion in the request.

    For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The identifier for the resource.

    You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

    For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

    For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

    
    
• On success, responds with DeleteResourceOutput with field(s):
  • progress_event(Option<ProgressEvent>):

    Represents the current status of the resource deletion request.

    After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.

• On failure, responds with SdkError<DeleteResourceError>

impl Client

pub fn get_resource(&self) -> GetResourceFluentBuilder

Constructs a fluent builder for the GetResource operation.

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

    The name of the resource type.

    
    
  • type_version_id(impl Into<String>) / set_type_version_id(Option<String>):
    required: false
    

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The identifier for the resource.

    You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

    For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

    For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

    
    
• On success, responds with GetResourceOutput with field(s):
  • type_name(Option<String>):

    The name of the resource type.

  • resource_description(Option<ResourceDescription>):

    Represents information about a provisioned resource.

• On failure, responds with SdkError<GetResourceError>

impl Client

pub fn get_resource_request_status( &self, ) -> GetResourceRequestStatusFluentBuilder

Constructs a fluent builder for the GetResourceRequestStatus operation.

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

    A unique token used to track the progress of the resource operation request.

    Request tokens are included in the ProgressEvent type returned by a resource operation request.

    
    
• On success, responds with GetResourceRequestStatusOutput with field(s):
  • progress_event(Option<ProgressEvent>):

    Represents the current status of the resource operation request.

• On failure, responds with SdkError<GetResourceRequestStatusError>

impl Client

pub fn list_resource_requests(&self) -> ListResourceRequestsFluentBuilder

Constructs a fluent builder for the ListResourceRequests 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 results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    The default is 20.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous paginated request didn’t return all of the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    
    
  • resource_request_status_filter(ResourceRequestStatusFilter) / set_resource_request_status_filter(Option<ResourceRequestStatusFilter>):
    required: false
    

    The filter criteria to apply to the requests returned.

    
    
• On success, responds with ListResourceRequestsOutput with field(s):
  • resource_request_status_summaries(Option<Vec::<ProgressEvent>>):

    The requests that match the specified filter criteria.

  • next_token(Option<String>):

    If the request doesn’t return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.

• On failure, responds with SdkError<ListResourceRequestsError>

impl Client

pub fn list_resources(&self) -> ListResourcesFluentBuilder

Constructs a fluent builder for the ListResources operation. This operation supports pagination; See into_paginator().

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

    The name of the resource type.

    
    
  • type_version_id(impl Into<String>) / set_type_version_id(Option<String>):
    required: false
    

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous paginated request didn’t return all of the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

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

    Reserved.

    
    
  • resource_model(impl Into<String>) / set_resource_model(Option<String>):
    required: false
    

    The resource model to use to select the resources to return.

    
    
• On success, responds with ListResourcesOutput with field(s):
  • type_name(Option<String>):

    The name of the resource type.

  • resource_descriptions(Option<Vec::<ResourceDescription>>):

    Information about the specified resources, including primary identifier and resource model.

  • next_token(Option<String>):

    If the request doesn’t return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.

• On failure, responds with SdkError<ListResourcesError>

impl Client

pub fn update_resource(&self) -> UpdateResourceFluentBuilder

Constructs a fluent builder for the UpdateResource operation.

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

    The name of the resource type.

    
    
  • type_version_id(impl Into<String>) / set_type_version_id(Option<String>):
    required: false
    

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

    A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

    If you do not specify a client token, one is generated for inclusion in the request.

    For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

    
    
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The identifier for the resource.

    You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

    For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

    For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

    
    
  • patch_document(impl Into<String>) / set_patch_document(Option<String>):
    required: true
    

    A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties. For details, see Composing the patch document in the Amazon Web Services Cloud Control API User Guide.

    
    
• On success, responds with UpdateResourceOutput with field(s):
  • progress_event(Option<ProgressEvent>):

    Represents the current status of the resource update request.

    Use the RequestToken of the ProgressEvent with GetResourceRequestStatus to return the current status of a resource operation request.

• On failure, responds with SdkError<UpdateResourceError>

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

impl Waiters for Client

fn wait_until_resource_request_success( &self, ) -> ResourceRequestSuccessFluentBuilder

Wait until resource operation request is successful