Class: Aws::RecycleBin::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-recyclebin/client.rb

Overview

An API client for RecycleBin. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::RecycleBin::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and `adaptive` retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - A retry mode that includes all the functionality of `standard` mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::RecycleBin::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::RecycleBin::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 471

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1156
1157
1158
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 1156

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1159
1160
1161
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 1159

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 1129

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::RecycleBin')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-recyclebin'
  context[:gem_version] = '1.55.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_rule(params = {}) ⇒ Types::CreateRuleResponse

Creates a Recycle Bin retention rule. You can create two types of retention rules:

  • **Tag-level retention rules** - These retention rules use resource tags to identify the resources to protect. For each retention rule, you specify one or more tag key and value pairs. Resources (of the specified type) that have at least one of these tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this type of retention rule to protect specific resources in your account based on their tags.

  • **Region-level retention rules** - These retention rules, by default, apply to all of the resources (of the specified type) in the Region, even if the resources are not tagged. However, you can specify exclusion tags to exclude resources that have specific tags. Use this type of retention rule to protect all resources of a specific type in a Region.

For more information, see [ Create Recycle Bin retention rules] in the *Amazon EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/recycle-bin.html

Examples:

Request syntax with placeholder values


resp = client.create_rule({
  retention_period: { # required
    retention_period_value: 1, # required
    retention_period_unit: "DAYS", # required, accepts DAYS
  },
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  resource_type: "EBS_SNAPSHOT", # required, accepts EBS_SNAPSHOT, EC2_IMAGE, EBS_VOLUME
  resource_tags: [
    {
      resource_tag_key: "ResourceTagKey", # required
      resource_tag_value: "ResourceTagValue",
    },
  ],
  lock_configuration: {
    unlock_delay: { # required
      unlock_delay_value: 1, # required
      unlock_delay_unit: "DAYS", # required, accepts DAYS
    },
  },
  exclude_resource_tags: [
    {
      resource_tag_key: "ResourceTagKey", # required
      resource_tag_value: "ResourceTagValue",
    },
  ],
})

Response structure


resp.identifier #=> String
resp.retention_period.retention_period_value #=> Integer
resp.retention_period.retention_period_unit #=> String, one of "DAYS"
resp.description #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.resource_type #=> String, one of "EBS_SNAPSHOT", "EC2_IMAGE", "EBS_VOLUME"
resp.resource_tags #=> Array
resp.resource_tags[0].resource_tag_key #=> String
resp.resource_tags[0].resource_tag_value #=> String
resp.status #=> String, one of "pending", "available"
resp.lock_configuration.unlock_delay.unlock_delay_value #=> Integer
resp.lock_configuration.unlock_delay.unlock_delay_unit #=> String, one of "DAYS"
resp.lock_state #=> String, one of "locked", "pending_unlock", "unlocked"
resp.rule_arn #=> String
resp.exclude_resource_tags #=> Array
resp.exclude_resource_tags[0].resource_tag_key #=> String
resp.exclude_resource_tags[0].resource_tag_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :retention_period (required, Types::RetentionPeriod) —

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

  • :description (String) —

    The retention rule description.

  • :tags (Array<Types::Tag>) —

    Information about the tags to assign to the retention rule.

  • :resource_type (required, String) —

    The resource type to be retained by the retention rule. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.

    • To retain EBS volumes, specify ‘EBS_VOLUME`.

    • To retain EBS snapshots, specify ‘EBS_SNAPSHOT`

    • To retain EBS-backed AMIs, specify ‘EC2_IMAGE`.

  • :resource_tags (Array<Types::ResourceTag>) —

    [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 (Types::LockConfiguration) —

    Information about the retention rule lock configuration.

  • :exclude_resource_tags (Array<Types::ResourceTag>) —

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

Returns:

See Also:



626
627
628
629
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 626

def create_rule(params = {}, options = {})
  req = build_request(:create_rule, params)
  req.send_request(options)
end

#delete_rule(params = {}) ⇒ Struct

Deletes a Recycle Bin retention rule. For more information, see [ Delete Recycle Bin retention rules] in the *Amazon Elastic Compute Cloud User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-delete-rule

Examples:

Request syntax with placeholder values


resp = client.delete_rule({
  identifier: "RuleIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The unique ID of the retention rule.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



654
655
656
657
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 654

def delete_rule(params = {}, options = {})
  req = build_request(:delete_rule, params)
  req.send_request(options)
end

#get_rule(params = {}) ⇒ Types::GetRuleResponse

Gets information about a Recycle Bin retention rule.

Examples:

Request syntax with placeholder values


resp = client.get_rule({
  identifier: "RuleIdentifier", # required
})

Response structure


resp.identifier #=> String
resp.description #=> String
resp.resource_type #=> String, one of "EBS_SNAPSHOT", "EC2_IMAGE", "EBS_VOLUME"
resp.retention_period.retention_period_value #=> Integer
resp.retention_period.retention_period_unit #=> String, one of "DAYS"
resp.resource_tags #=> Array
resp.resource_tags[0].resource_tag_key #=> String
resp.resource_tags[0].resource_tag_value #=> String
resp.status #=> String, one of "pending", "available"
resp.lock_configuration.unlock_delay.unlock_delay_value #=> Integer
resp.lock_configuration.unlock_delay.unlock_delay_unit #=> String, one of "DAYS"
resp.lock_state #=> String, one of "locked", "pending_unlock", "unlocked"
resp.lock_end_time #=> Time
resp.rule_arn #=> String
resp.exclude_resource_tags #=> Array
resp.exclude_resource_tags[0].resource_tag_key #=> String
resp.exclude_resource_tags[0].resource_tag_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The unique ID of the retention rule.

Returns:

See Also:



708
709
710
711
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 708

def get_rule(params = {}, options = {})
  req = build_request(:get_rule, params)
  req.send_request(options)
end

#list_rules(params = {}) ⇒ Types::ListRulesResponse

Lists the Recycle Bin retention rules in the Region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_rules({
  max_results: 1,
  next_token: "NextToken",
  resource_type: "EBS_SNAPSHOT", # required, accepts EBS_SNAPSHOT, EC2_IMAGE, EBS_VOLUME
  resource_tags: [
    {
      resource_tag_key: "ResourceTagKey", # required
      resource_tag_value: "ResourceTagValue",
    },
  ],
  lock_state: "locked", # accepts locked, pending_unlock, unlocked
  exclude_resource_tags: [
    {
      resource_tag_key: "ResourceTagKey", # required
      resource_tag_value: "ResourceTagValue",
    },
  ],
})

Response structure


resp.rules #=> Array
resp.rules[0].identifier #=> String
resp.rules[0].description #=> String
resp.rules[0].retention_period.retention_period_value #=> Integer
resp.rules[0].retention_period.retention_period_unit #=> String, one of "DAYS"
resp.rules[0].lock_state #=> String, one of "locked", "pending_unlock", "unlocked"
resp.rules[0].rule_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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 (String) —

    The token for the next page of results.

  • :resource_type (required, String) —

    The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.

    • To list retention rules that retain EBS volumes, specify ‘EBS_VOLUME`.

    • To list retention rules that retain EBS snapshots, specify ‘EBS_SNAPSHOT`.

    • To list retention rules that retain EBS-backed AMIs, specify ‘EC2_IMAGE`.

  • :resource_tags (Array<Types::ResourceTag>) —

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

  • :lock_state (String) —

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

  • :exclude_resource_tags (Array<Types::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.

Returns:

See Also:



793
794
795
796
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 793

def list_rules(params = {}, options = {})
  req = build_request(:list_rules, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags assigned to a retention rule.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "RuleArn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



823
824
825
826
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 823

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#lock_rule(params = {}) ⇒ Types::LockRuleResponse

Locks a Region-level retention rule. A locked retention rule can’t be modified or deleted.

<note markdown=“1”> You can’t lock tag-level retention rules, or Region-level retention rules that have exclusion tags.

</note>

Examples:

Request syntax with placeholder values


resp = client.lock_rule({
  identifier: "RuleIdentifier", # required
  lock_configuration: { # required
    unlock_delay: { # required
      unlock_delay_value: 1, # required
      unlock_delay_unit: "DAYS", # required, accepts DAYS
    },
  },
})

Response structure


resp.identifier #=> String
resp.description #=> String
resp.resource_type #=> String, one of "EBS_SNAPSHOT", "EC2_IMAGE", "EBS_VOLUME"
resp.retention_period.retention_period_value #=> Integer
resp.retention_period.retention_period_unit #=> String, one of "DAYS"
resp.resource_tags #=> Array
resp.resource_tags[0].resource_tag_key #=> String
resp.resource_tags[0].resource_tag_value #=> String
resp.status #=> String, one of "pending", "available"
resp.lock_configuration.unlock_delay.unlock_delay_value #=> Integer
resp.lock_configuration.unlock_delay.unlock_delay_unit #=> String, one of "DAYS"
resp.lock_state #=> String, one of "locked", "pending_unlock", "unlocked"
resp.rule_arn #=> String
resp.exclude_resource_tags #=> Array
resp.exclude_resource_tags[0].resource_tag_key #=> String
resp.exclude_resource_tags[0].resource_tag_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The unique ID of the retention rule.

  • :lock_configuration (required, Types::LockConfiguration) —

    Information about the retention rule lock configuration.

Returns:

See Also:



890
891
892
893
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 890

def lock_rule(params = {}, options = {})
  req = build_request(:lock_rule, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Assigns tags to the specified retention rule.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "RuleArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Array<Types::Tag>) —

    Information about the tags to assign to the retention rule.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



921
922
923
924
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 921

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#unlock_rule(params = {}) ⇒ Types::UnlockRuleResponse

Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.

Examples:

Request syntax with placeholder values


resp = client.unlock_rule({
  identifier: "RuleIdentifier", # required
})

Response structure


resp.identifier #=> String
resp.description #=> String
resp.resource_type #=> String, one of "EBS_SNAPSHOT", "EC2_IMAGE", "EBS_VOLUME"
resp.retention_period.retention_period_value #=> Integer
resp.retention_period.retention_period_unit #=> String, one of "DAYS"
resp.resource_tags #=> Array
resp.resource_tags[0].resource_tag_key #=> String
resp.resource_tags[0].resource_tag_value #=> String
resp.status #=> String, one of "pending", "available"
resp.lock_configuration.unlock_delay.unlock_delay_value #=> Integer
resp.lock_configuration.unlock_delay.unlock_delay_unit #=> String, one of "DAYS"
resp.lock_state #=> String, one of "locked", "pending_unlock", "unlocked"
resp.lock_end_time #=> Time
resp.rule_arn #=> String
resp.exclude_resource_tags #=> Array
resp.exclude_resource_tags[0].resource_tag_key #=> String
resp.exclude_resource_tags[0].resource_tag_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The unique ID of the retention rule.

Returns:

See Also:



976
977
978
979
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 976

def unlock_rule(params = {}, options = {})
  req = build_request(:unlock_rule, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Unassigns a tag from a retention rule.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "RuleArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1003
1004
1005
1006
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 1003

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_rule(params = {}) ⇒ Types::UpdateRuleResponse

Updates an existing Recycle Bin retention rule. You can update a retention rule’s description, resource tags, and retention period at any time after creation. You can’t update a retention rule’s resource type after creation. For more information, see [ Update Recycle Bin retention rules] in the *Amazon Elastic Compute Cloud User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-update-rule

Examples:

Request syntax with placeholder values


resp = client.update_rule({
  identifier: "RuleIdentifier", # required
  retention_period: {
    retention_period_value: 1, # required
    retention_period_unit: "DAYS", # required, accepts DAYS
  },
  description: "Description",
  resource_type: "EBS_SNAPSHOT", # accepts EBS_SNAPSHOT, EC2_IMAGE, EBS_VOLUME
  resource_tags: [
    {
      resource_tag_key: "ResourceTagKey", # required
      resource_tag_value: "ResourceTagValue",
    },
  ],
  exclude_resource_tags: [
    {
      resource_tag_key: "ResourceTagKey", # required
      resource_tag_value: "ResourceTagValue",
    },
  ],
})

Response structure


resp.identifier #=> String
resp.retention_period.retention_period_value #=> Integer
resp.retention_period.retention_period_unit #=> String, one of "DAYS"
resp.description #=> String
resp.resource_type #=> String, one of "EBS_SNAPSHOT", "EC2_IMAGE", "EBS_VOLUME"
resp.resource_tags #=> Array
resp.resource_tags[0].resource_tag_key #=> String
resp.resource_tags[0].resource_tag_value #=> String
resp.status #=> String, one of "pending", "available"
resp.lock_state #=> String, one of "locked", "pending_unlock", "unlocked"
resp.lock_end_time #=> Time
resp.rule_arn #=> String
resp.exclude_resource_tags #=> Array
resp.exclude_resource_tags[0].resource_tag_key #=> String
resp.exclude_resource_tags[0].resource_tag_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The unique ID of the retention rule.

  • :retention_period (Types::RetentionPeriod) —

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

  • :description (String) —

    The retention rule description.

  • :resource_type (String) —

    <note markdown=“1”> This parameter is currently not supported. You can’t update a retention rule’s resource type after creation.

    </note>
  • :resource_tags (Array<Types::ResourceTag>) —

    [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 (Array<Types::ResourceTag>) —

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

Returns:

See Also:



1120
1121
1122
1123
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 1120

def update_rule(params = {}, options = {})
  req = build_request(:update_rule, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1149
1150
1151
 
# File 'lib/aws-sdk-recyclebin/client.rb', line 1149

def waiter_names
  []
end