Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Recycle Bin

Client for invoking operations on Amazon Recycle Bin. Each operation on Amazon Recycle Bin 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_rbin::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_rbin::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 CreateRule operation has a Client::create_rule, 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_rule()
    .description("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_rule(&self) -> CreateRuleFluentBuilder

Constructs a fluent builder for the CreateRule operation.

• The fluent builder is configurable:
  • retention_period(RetentionPeriod) / set_retention_period(Option<RetentionPeriod>):
    required: true
    

    Information about the retention period for which the retention rule is to retain resources.

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

    The retention rule description.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Information about the tags to assign to the retention rule.

    
    
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: true
    

    The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

    
    
  • resource_tags(ResourceTag) / set_resource_tags(Option<Vec::<ResourceTag>>):
    required: false
    

    [Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

    You can add the same tag key and value pair to a maximum or five retention rules.

    To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

    
    
  • lock_configuration(LockConfiguration) / set_lock_configuration(Option<LockConfiguration>):
    required: false
    

    Information about the retention rule lock configuration.

    
    
  • exclude_resource_tags(ResourceTag) / set_exclude_resource_tags(Option<Vec::<ResourceTag>>):
    required: false
    

    [Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

    You can’t specify exclusion tags for tag-level retention rules.

    
    
• On success, responds with CreateRuleOutput with field(s):
  • identifier(Option<String>):

    The unique ID of the retention rule.

  • retention_period(Option<RetentionPeriod>):

    Information about the retention period for which the retention rule is to retain resources.

  • description(Option<String>):

    The retention rule description.

  • tags(Option<Vec::<Tag>>):

    Information about the tags assigned to the retention rule.

  • resource_type(Option<ResourceType>):

    The resource type retained by the retention rule.

  • resource_tags(Option<Vec::<ResourceTag>>):

    [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

  • status(Option<RuleStatus>):

    The state of the retention rule. Only retention rules that are in the available state retain resources.

  • lock_configuration(Option<LockConfiguration>):

    Information about the retention rule lock configuration.

  • lock_state(Option<LockState>):

    [Region-level retention rules only] The lock state for the retention rule.

    • locked - The retention rule is locked and can’t be modified or deleted.

    • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

    • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

    • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the retention rule.

  • exclude_resource_tags(Option<Vec::<ResourceTag>>):

    [Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

• On failure, responds with SdkError<CreateRuleError>

impl Client

pub fn delete_rule(&self) -> DeleteRuleFluentBuilder

Constructs a fluent builder for the DeleteRule operation.

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

    The unique ID of the retention rule.

    
    
• On success, responds with DeleteRuleOutput
• On failure, responds with SdkError<DeleteRuleError>

impl Client

pub fn get_rule(&self) -> GetRuleFluentBuilder

Constructs a fluent builder for the GetRule operation.

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

    The unique ID of the retention rule.

    
    
• On success, responds with GetRuleOutput with field(s):
  • identifier(Option<String>):

    The unique ID of the retention rule.

  • description(Option<String>):

    The retention rule description.

  • resource_type(Option<ResourceType>):

    The resource type retained by the retention rule.

  • retention_period(Option<RetentionPeriod>):

    Information about the retention period for which the retention rule is to retain resources.

  • resource_tags(Option<Vec::<ResourceTag>>):

    [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

  • status(Option<RuleStatus>):

    The state of the retention rule. Only retention rules that are in the available state retain resources.

  • lock_configuration(Option<LockConfiguration>):

    Information about the retention rule lock configuration.

  • lock_state(Option<LockState>):

    [Region-level retention rules only] The lock state for the retention rule.

    • locked - The retention rule is locked and can’t be modified or deleted.

    • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

    • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

    • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

  • lock_end_time(Option<DateTime>):

    The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the retention rule.

  • exclude_resource_tags(Option<Vec::<ResourceTag>>):

    [Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

• On failure, responds with SdkError<GetRuleError>

impl Client

pub fn list_rules(&self) -> ListRulesFluentBuilder

Constructs a fluent builder for the ListRules 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 return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

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

    The token for the next page of results.

    
    
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: true
    

    The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

    
    
  • resource_tags(ResourceTag) / set_resource_tags(Option<Vec::<ResourceTag>>):
    required: false
    

    [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

    
    
  • lock_state(LockState) / set_lock_state(Option<LockState>):
    required: false
    

    The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

    
    
  • exclude_resource_tags(ResourceTag) / set_exclude_resource_tags(Option<Vec::<ResourceTag>>):
    required: false
    

    [Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

    
    
• On success, responds with ListRulesOutput with field(s):
  • rules(Option<Vec::<RuleSummary>>):

    Information about the retention rules.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListRulesError>

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 retention rule.

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

    Information about the tags assigned to the retention rule.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn lock_rule(&self) -> LockRuleFluentBuilder

Constructs a fluent builder for the LockRule operation.

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

    The unique ID of the retention rule.

    
    
  • lock_configuration(LockConfiguration) / set_lock_configuration(Option<LockConfiguration>):
    required: true
    

    Information about the retention rule lock configuration.

    
    
• On success, responds with LockRuleOutput with field(s):
  • identifier(Option<String>):

    The unique ID of the retention rule.

  • description(Option<String>):

    The retention rule description.

  • resource_type(Option<ResourceType>):

    The resource type retained by the retention rule.

  • retention_period(Option<RetentionPeriod>):

    Information about the retention period for which the retention rule is to retain resources.

  • resource_tags(Option<Vec::<ResourceTag>>):

    [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

  • status(Option<RuleStatus>):

    The state of the retention rule. Only retention rules that are in the available state retain resources.

  • lock_configuration(Option<LockConfiguration>):

    Information about the retention rule lock configuration.

  • lock_state(Option<LockState>):

    [Region-level retention rules only] The lock state for the retention rule.

    • locked - The retention rule is locked and can’t be modified or deleted.

    • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

    • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

    • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the retention rule.

  • exclude_resource_tags(Option<Vec::<ResourceTag>>):

    [Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

• On failure, responds with SdkError<LockRuleError>

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 retention rule.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    Information about the tags to assign to the retention rule.

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

impl Client

pub fn unlock_rule(&self) -> UnlockRuleFluentBuilder

Constructs a fluent builder for the UnlockRule operation.

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

    The unique ID of the retention rule.

    
    
• On success, responds with UnlockRuleOutput with field(s):
  • identifier(Option<String>):

    The unique ID of the retention rule.

  • description(Option<String>):

    The retention rule description.

  • resource_type(Option<ResourceType>):

    The resource type retained by the retention rule.

  • retention_period(Option<RetentionPeriod>):

    Information about the retention period for which the retention rule is to retain resources.

  • resource_tags(Option<Vec::<ResourceTag>>):

    [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

  • status(Option<RuleStatus>):

    The state of the retention rule. Only retention rules that are in the available state retain resources.

  • lock_configuration(Option<LockConfiguration>):

    Information about the retention rule lock configuration.

  • lock_state(Option<LockState>):

    [Region-level retention rules only] The lock state for the retention rule.

    • locked - The retention rule is locked and can’t be modified or deleted.

    • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

    • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

    • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

  • lock_end_time(Option<DateTime>):

    The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the retention rule.

  • exclude_resource_tags(Option<Vec::<ResourceTag>>):

    [Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

• On failure, responds with SdkError<UnlockRuleError>

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 retention rule.

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

    The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.

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

impl Client

pub fn update_rule(&self) -> UpdateRuleFluentBuilder

Constructs a fluent builder for the UpdateRule operation.

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

    The unique ID of the retention rule.

    
    
  • retention_period(RetentionPeriod) / set_retention_period(Option<RetentionPeriod>):
    required: false
    

    Information about the retention period for which the retention rule is to retain resources.

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

    The retention rule description.

    
    
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: false
    

    This parameter is currently not supported. You can’t update a retention rule’s resource type after creation.

    
    
  • resource_tags(ResourceTag) / set_resource_tags(Option<Vec::<ResourceTag>>):
    required: false
    

    [Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

    You can add the same tag key and value pair to a maximum or five retention rules.

    To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

    
    
  • exclude_resource_tags(ResourceTag) / set_exclude_resource_tags(Option<Vec::<ResourceTag>>):
    required: false
    

    [Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

    You can’t specify exclusion tags for tag-level retention rules.

    
    
• On success, responds with UpdateRuleOutput with field(s):
  • identifier(Option<String>):

    The unique ID of the retention rule.

  • retention_period(Option<RetentionPeriod>):

    Information about the retention period for which the retention rule is to retain resources.

  • description(Option<String>):

    The retention rule description.

  • resource_type(Option<ResourceType>):

    The resource type retained by the retention rule.

  • resource_tags(Option<Vec::<ResourceTag>>):

    [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

  • status(Option<RuleStatus>):

    The state of the retention rule. Only retention rules that are in the available state retain resources.

  • lock_state(Option<LockState>):

    [Region-level retention rules only] The lock state for the retention rule.

    • locked - The retention rule is locked and can’t be modified or deleted.

    • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

    • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

    • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

  • lock_end_time(Option<DateTime>):

    The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

  • rule_arn(Option<String>):

    The Amazon Resource Name (ARN) of the retention rule.

  • exclude_resource_tags(Option<Vec::<ResourceTag>>):

    [Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

• On failure, responds with SdkError<UpdateRuleError>

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.