You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DLM::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Data Lifecycle Manager. To construct a client, you need to configure a :region and :credentials.

dlm = Aws::DLM::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::DLM::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::DLM::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

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

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_lifecycle_policy(options = {}) ⇒ Types::CreateLifecyclePolicyResponse

Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.

Examples:

Request syntax with placeholder values


resp = client.create_lifecycle_policy({
  execution_role_arn: "ExecutionRoleArn", # required
  description: "PolicyDescription", # required
  state: "ENABLED", # required, accepts ENABLED, DISABLED
  policy_details: { # required
    policy_type: "EBS_SNAPSHOT_MANAGEMENT", # accepts EBS_SNAPSHOT_MANAGEMENT, IMAGE_MANAGEMENT
    resource_types: ["VOLUME"], # accepts VOLUME, INSTANCE
    target_tags: [
      {
        key: "String", # required
        value: "String", # required
      },
    ],
    schedules: [
      {
        name: "ScheduleName",
        copy_tags: false,
        tags_to_add: [
          {
            key: "String", # required
            value: "String", # required
          },
        ],
        variable_tags: [
          {
            key: "String", # required
            value: "String", # required
          },
        ],
        create_rule: {
          interval: 1,
          interval_unit: "HOURS", # accepts HOURS
          times: ["Time"],
          cron_expression: "CronExpression",
        },
        retain_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
        },
        fast_restore_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
          availability_zones: ["AvailabilityZone"], # required
        },
        cross_region_copy_rules: [
          {
            target_region: "TargetRegion", # required
            encrypted: false, # required
            cmk_arn: "CmkArn",
            copy_tags: false,
            retain_rule: {
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
          },
        ],
      },
    ],
    parameters: {
      exclude_boot_volume: false,
      no_reboot: false,
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.policy_id #=> String

Options Hash (options):

  • :execution_role_arn (required, String) —

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

  • :description (required, String) —

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

  • :state (required, String) —

    The desired activation state of the lifecycle policy after creation.

  • :policy_details (required, Types::PolicyDetails) —

    The configuration details of the lifecycle policy.

  • :tags (Hash<String,String>) —

    The tags to apply to the lifecycle policy during creation.

Returns:

See Also:

#delete_lifecycle_policy(options = {}) ⇒ Struct

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

Examples:

Request syntax with placeholder values


resp = client.delete_lifecycle_policy({
  policy_id: "PolicyId", # required
})

Options Hash (options):

  • :policy_id (required, String) —

    The identifier of the lifecycle policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#get_lifecycle_policies(options = {}) ⇒ Types::GetLifecyclePoliciesResponse

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.

Examples:

Request syntax with placeholder values


resp = client.get_lifecycle_policies({
  policy_ids: ["PolicyId"],
  state: "ENABLED", # accepts ENABLED, DISABLED, ERROR
  resource_types: ["VOLUME"], # accepts VOLUME, INSTANCE
  target_tags: ["TagFilter"],
  tags_to_add: ["TagFilter"],
})

Response structure


resp.policies #=> Array
resp.policies[0].policy_id #=> String
resp.policies[0].description #=> String
resp.policies[0].state #=> String, one of "ENABLED", "DISABLED", "ERROR"
resp.policies[0].tags #=> Hash
resp.policies[0].tags["TagKey"] #=> String
resp.policies[0].policy_type #=> String, one of "EBS_SNAPSHOT_MANAGEMENT", "IMAGE_MANAGEMENT"

Options Hash (options):

  • :policy_ids (Array<String>) —

    The identifiers of the data lifecycle policies.

  • :state (String) —

    The activation state.

  • :resource_types (Array<String>) —

    The resource type.

  • :target_tags (Array<String>) —

    The target tag for a policy.

    Tags are strings in the format key=value.

  • :tags_to_add (Array<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 AWS-added lifecycle tags.

Returns:

See Also:

#get_lifecycle_policy(options = {}) ⇒ Types::GetLifecyclePolicyResponse

Gets detailed information about the specified lifecycle policy.

Examples:

Request syntax with placeholder values


resp = client.get_lifecycle_policy({
  policy_id: "PolicyId", # required
})

Response structure


resp.policy.policy_id #=> String
resp.policy.description #=> String
resp.policy.state #=> String, one of "ENABLED", "DISABLED", "ERROR"
resp.policy.status_message #=> String
resp.policy.execution_role_arn #=> String
resp.policy.date_created #=> Time
resp.policy.date_modified #=> Time
resp.policy.policy_details.policy_type #=> String, one of "EBS_SNAPSHOT_MANAGEMENT", "IMAGE_MANAGEMENT"
resp.policy.policy_details.resource_types #=> Array
resp.policy.policy_details.resource_types[0] #=> String, one of "VOLUME", "INSTANCE"
resp.policy.policy_details.target_tags #=> Array
resp.policy.policy_details.target_tags[0].key #=> String
resp.policy.policy_details.target_tags[0].value #=> String
resp.policy.policy_details.schedules #=> Array
resp.policy.policy_details.schedules[0].name #=> String
resp.policy.policy_details.schedules[0].copy_tags #=> true/false
resp.policy.policy_details.schedules[0].tags_to_add #=> Array
resp.policy.policy_details.schedules[0].tags_to_add[0].key #=> String
resp.policy.policy_details.schedules[0].tags_to_add[0].value #=> String
resp.policy.policy_details.schedules[0].variable_tags #=> Array
resp.policy.policy_details.schedules[0].variable_tags[0].key #=> String
resp.policy.policy_details.schedules[0].variable_tags[0].value #=> String
resp.policy.policy_details.schedules[0].create_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].create_rule.interval_unit #=> String, one of "HOURS"
resp.policy.policy_details.schedules[0].create_rule.times #=> Array
resp.policy.policy_details.schedules[0].create_rule.times[0] #=> String
resp.policy.policy_details.schedules[0].create_rule.cron_expression #=> String
resp.policy.policy_details.schedules[0].retain_rule.count #=> Integer
resp.policy.policy_details.schedules[0].retain_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].retain_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.schedules[0].fast_restore_rule.count #=> Integer
resp.policy.policy_details.schedules[0].fast_restore_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].fast_restore_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.schedules[0].fast_restore_rule.availability_zones #=> Array
resp.policy.policy_details.schedules[0].fast_restore_rule.availability_zones[0] #=> String
resp.policy.policy_details.schedules[0].cross_region_copy_rules #=> Array
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].target_region #=> String
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].encrypted #=> true/false
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].cmk_arn #=> String
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].copy_tags #=> true/false
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].retain_rule.interval #=> Integer
resp.policy.policy_details.schedules[0].cross_region_copy_rules[0].retain_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.policy.policy_details.parameters.exclude_boot_volume #=> true/false
resp.policy.policy_details.parameters.no_reboot #=> true/false
resp.policy.tags #=> Hash
resp.policy.tags["TagKey"] #=> String
resp.policy.policy_arn #=> String

Options Hash (options):

  • :policy_id (required, String) —

    The identifier of the lifecycle policy.

Returns:

See Also:

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

Lists the tags for the specified resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Options Hash (options):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Adds the specified tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "PolicyArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Options Hash (options):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

    One or more tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes the specified tags from the specified resource.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

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

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#update_lifecycle_policy(options = {}) ⇒ Struct

Updates the specified lifecycle policy.

Examples:

Request syntax with placeholder values


resp = client.update_lifecycle_policy({
  policy_id: "PolicyId", # required
  execution_role_arn: "ExecutionRoleArn",
  state: "ENABLED", # accepts ENABLED, DISABLED
  description: "PolicyDescription",
  policy_details: {
    policy_type: "EBS_SNAPSHOT_MANAGEMENT", # accepts EBS_SNAPSHOT_MANAGEMENT, IMAGE_MANAGEMENT
    resource_types: ["VOLUME"], # accepts VOLUME, INSTANCE
    target_tags: [
      {
        key: "String", # required
        value: "String", # required
      },
    ],
    schedules: [
      {
        name: "ScheduleName",
        copy_tags: false,
        tags_to_add: [
          {
            key: "String", # required
            value: "String", # required
          },
        ],
        variable_tags: [
          {
            key: "String", # required
            value: "String", # required
          },
        ],
        create_rule: {
          interval: 1,
          interval_unit: "HOURS", # accepts HOURS
          times: ["Time"],
          cron_expression: "CronExpression",
        },
        retain_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
        },
        fast_restore_rule: {
          count: 1,
          interval: 1,
          interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
          availability_zones: ["AvailabilityZone"], # required
        },
        cross_region_copy_rules: [
          {
            target_region: "TargetRegion", # required
            encrypted: false, # required
            cmk_arn: "CmkArn",
            copy_tags: false,
            retain_rule: {
              interval: 1,
              interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
            },
          },
        ],
      },
    ],
    parameters: {
      exclude_boot_volume: false,
      no_reboot: false,
    },
  },
})

Options Hash (options):

  • :policy_id (required, String) —

    The identifier of the lifecycle policy.

  • :execution_role_arn (String) —

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

  • :state (String) —

    The desired activation state of the lifecycle policy after creation.

  • :description (String) —

    A description of the lifecycle policy.

  • :policy_details (Types::PolicyDetails) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.