pub struct Client { /* private fields */ }
Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_cloudcontrol::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_cloudcontrol::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_cloudcontrol::Client::from_conf(config);

Implementations§

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the CancelResourceRequest operation.

Constructs a fluent builder for the CreateResource operation.

Constructs a fluent builder for the DeleteResource operation.

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

      The name of the resource type.

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

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

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

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

      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>

Constructs a fluent builder for the GetResource operation.

Constructs a fluent builder for the GetResourceRequestStatus operation.

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

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

Constructs a fluent builder for the UpdateResource operation.

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.

Creates a new client from the service Config.

Panics
  • This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more