Struct aws_sdk_dlm::Client

pub struct Client { /* private fields */ }

Client for Amazon Data Lifecycle Manager

Client for invoking operations on Amazon Data Lifecycle Manager. Each operation on Amazon Data Lifecycle Manager 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_dlm::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_dlm::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_dlm::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn create_lifecycle_policy(&self) -> CreateLifecyclePolicy

Constructs a fluent builder for the CreateLifecyclePolicy operation.

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

    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

  • state(SettablePolicyStateValues) / set_state(Option<SettablePolicyStateValues>):

    The desired activation state of the lifecycle policy after creation.

  • policy_details(PolicyDetails) / set_policy_details(Option<PolicyDetails>):

    The configuration details of the lifecycle policy.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags to apply to the lifecycle policy during creation.

• On success, responds with CreateLifecyclePolicyOutput with field(s):
  • policy_id(Option<String>):

    The identifier of the lifecycle policy.

• On failure, responds with SdkError<CreateLifecyclePolicyError>

pub fn delete_lifecycle_policy(&self) -> DeleteLifecyclePolicy

Constructs a fluent builder for the DeleteLifecyclePolicy operation.

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

    The identifier of the lifecycle policy.

• On success, responds with DeleteLifecyclePolicyOutput
• On failure, responds with SdkError<DeleteLifecyclePolicyError>

pub fn get_lifecycle_policies(&self) -> GetLifecyclePolicies

Constructs a fluent builder for the GetLifecyclePolicies operation.

• The fluent builder is configurable:
  • policy_ids(Vec<String>) / set_policy_ids(Option<Vec<String>>):

    The identifiers of the data lifecycle policies.

  • state(GettablePolicyStateValues) / set_state(Option<GettablePolicyStateValues>):

    The activation state.

  • resource_types(Vec<ResourceTypeValues>) / set_resource_types(Option<Vec<ResourceTypeValues>>):

    The resource type.

  • target_tags(Vec<String>) / set_target_tags(Option<Vec<String>>):

    The target tag for a policy.

    Tags are strings in the format key=value.

  • tags_to_add(Vec<String>) / set_tags_to_add(Option<Vec<String>>):

    The tags to add to objects created by the policy.

    Tags are strings in the format key=value.

    These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.

• On success, responds with GetLifecyclePoliciesOutput with field(s):
  • policies(Option<Vec<LifecyclePolicySummary>>):

    Summary information about the lifecycle policies.

• On failure, responds with SdkError<GetLifecyclePoliciesError>

pub fn get_lifecycle_policy(&self) -> GetLifecyclePolicy

Constructs a fluent builder for the GetLifecyclePolicy operation.

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

    The identifier of the lifecycle policy.

• On success, responds with GetLifecyclePolicyOutput with field(s):
  • policy(Option<LifecyclePolicy>):

    Detailed information about the lifecycle policy.

• On failure, responds with SdkError<GetLifecyclePolicyError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

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

    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>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    One or more tags.

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

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The tag keys.

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

pub fn update_lifecycle_policy(&self) -> UpdateLifecyclePolicy

Constructs a fluent builder for the UpdateLifecyclePolicy operation.

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

    The identifier of the lifecycle policy.

  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

  • state(SettablePolicyStateValues) / set_state(Option<SettablePolicyStateValues>):

    The desired activation state of the lifecycle policy after creation.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the lifecycle policy.

  • policy_details(PolicyDetails) / set_policy_details(Option<PolicyDetails>):

    The configuration of the lifecycle policy. You cannot update the policy type or the resource type.

• On success, responds with UpdateLifecyclePolicyOutput
• On failure, responds with SdkError<UpdateLifecyclePolicyError>

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.

pub fn from_conf(conf: Config) -> Self

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

impl Clone for Client

fn clone(&self) -> Self

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 From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.