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

Class: Aws::DLM::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

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

    Your AWS credentials. This can be an instance of any one of the following classes:

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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 search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_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.

  • :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.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :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. Defaults to false.

  • :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.

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

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

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :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.

    @see https://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 and auth errors from expired credentials.

  • :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.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true —

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

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

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :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 yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

  • :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.



251
252
253
 
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

#create_lifecycle_policy(params = {}) ⇒ 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
    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, # required
          interval_unit: "HOURS", # required, accepts HOURS
          times: ["Time"],
        },
        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,
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.policy_id #=> String

Parameters:

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

    ({})

Options Hash (params):

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



359
360
361
362
 
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb', line 359

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

#delete_lifecycle_policy(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The identifier of the lifecycle policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



382
383
384
385
 
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb', line 382

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

#get_lifecycle_policies(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



441
442
443
444
 
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb', line 441

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

#get_lifecycle_policy(params = {}) ⇒ 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"
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 #=> Boolean
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].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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.policy.tags #=> Hash
resp.policy.tags["TagKey"] #=> String
resp.policy.policy_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The identifier of the lifecycle policy.

Returns:

See Also:



513
514
515
516
 
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb', line 513

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

#list_tags_for_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



542
543
544
545
 
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb', line 542

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

#tag_resource(params = {}) ⇒ 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",
  },
})

Parameters:

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

    ({})

Options Hash (params):

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



570
571
572
573
 
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb', line 570

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

#untag_resource(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

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



596
597
598
599
 
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb', line 596

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

#update_lifecycle_policy(params = {}) ⇒ 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
    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, # required
          interval_unit: "HOURS", # required, accepts HOURS
          times: ["Time"],
        },
        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,
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

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



694
695
696
697
 
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/client.rb', line 694

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