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

Class: Aws::EBS::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::EBS::Client

show all

Defined in:: (unknown)

Overview

An API client for Amazon Elastic Block Store. To construct a client, you need to configure a :region and :credentials.

ebs = Aws::EBS::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::EBS::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.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::EBS::Client constructor
Constructs an API client.

API Operations collapse

#complete_snapshot(options = {}) ⇒ Types::CompleteSnapshotResponse
Seals and completes the snapshot after all of the required blocks of data have been written to it.
#get_snapshot_block(options = {}) ⇒ Types::GetSnapshotBlockResponse
Returns the data in a block in an Amazon Elastic Block Store snapshot.

.
#list_changed_blocks(options = {}) ⇒ Types::ListChangedBlocksResponse
Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

.
#list_snapshot_blocks(options = {}) ⇒ Types::ListSnapshotBlocksResponse
Returns information about the blocks in an Amazon Elastic Block Store snapshot.

.
#put_snapshot_block(options = {}) ⇒ Types::PutSnapshotBlockResponse
Writes a block of data to a snapshot.
#start_snapshot(options = {}) ⇒ Types::StartSnapshotResponse
Creates a new Amazon EBS snapshot.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

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

#complete_snapshot(options = {}) ⇒ `Types::CompleteSnapshotResponse`

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

Examples:

Request syntax with placeholder values


resp = client.complete_snapshot({
  snapshot_id: "SnapshotId", # required
  changed_blocks_count: 1, # required
  checksum: "Checksum",
  checksum_algorithm: "SHA256", # accepts SHA256
  checksum_aggregation_method: "LINEAR", # accepts LINEAR
})

Response structure


resp.status #=> String, one of "completed", "pending", "error"

Options Hash (options):

:snapshot_id (required, String) —
The ID of the snapshot.
:changed_blocks_count (required, Integer) —
The number of blocks that were written to the snapshot.
:checksum (String) —
An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.
:checksum_algorithm (String) —
The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.
:checksum_aggregation_method (String) —
The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

Returns:

(Types::CompleteSnapshotResponse) —
Returns a response object which responds to the following methods:
- #status => String

See Also:

AWS API Documentation

#get_snapshot_block(options = {}) ⇒ `Types::GetSnapshotBlockResponse`

Returns the data in a block in an Amazon Elastic Block Store snapshot.

Examples:

Request syntax with placeholder values


resp = client.get_snapshot_block({
  response_target: "/path/to/file", # where to write response data, file path, or IO object
  snapshot_id: "SnapshotId", # required
  block_index: 1, # required
  block_token: "BlockToken", # required
})

Response structure


resp.data_length #=> Integer
resp.block_data #=> IO
resp.checksum #=> String
resp.checksum_algorithm #=> String, one of "SHA256"

Options Hash (options):

:response_target (IO, String) —
Specifies where to stream response data. You can provide the path where a file will be created on disk, or you can provide an IO object. If omitted, the response data will be loaded into memory and written to a StringIO object.
:snapshot_id (required, String) —
The ID of the snapshot containing the block from which to get data.
:block_index (required, Integer) —
The block index of the block from which to get data.

Obtain the BlockIndex by running the ListChangedBlocks or ListSnapshotBlocks operations.
:block_token (required, String) —
The block token of the block from which to get data.

Obtain the BlockToken by running the ListChangedBlocks or ListSnapshotBlocks operations.

Returns:

(Types::GetSnapshotBlockResponse) —
Returns a response object which responds to the following methods:
- #data_length => Integer
- #block_data => IO
- #checksum => String
- #checksum_algorithm => String

See Also:

AWS API Documentation

#list_changed_blocks(options = {}) ⇒ `Types::ListChangedBlocksResponse`

Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

Examples:

Request syntax with placeholder values


resp = client.list_changed_blocks({
  first_snapshot_id: "SnapshotId",
  second_snapshot_id: "SnapshotId", # required
  next_token: "PageToken",
  max_results: 1,
  starting_block_index: 1,
})

Response structure


resp.changed_blocks #=> Array
resp.changed_blocks[0].block_index #=> Integer
resp.changed_blocks[0].first_block_token #=> String
resp.changed_blocks[0].second_block_token #=> String
resp.expiry_time #=> Time
resp.volume_size #=> Integer
resp.block_size #=> Integer
resp.next_token #=> String

Options Hash (options):

:first_snapshot_id (String) —
The ID of the first snapshot to use for the comparison.

The FirstSnapshotID parameter must be specified with a SecondSnapshotId parameter; otherwise, an error occurs.
:second_snapshot_id (required, String) —
The ID of the second snapshot to use for the comparison.

The SecondSnapshotId parameter must be specified with a FirstSnapshotID parameter; otherwise, an error occurs.
:next_token (String) —
The token to request the next page of results.
:max_results (Integer) —
The number of results to return.
:starting_block_index (Integer) —
The block index from which the comparison should start.

The list in the response will start from this block index or the next valid block index in the snapshots.

Returns:

(Types::ListChangedBlocksResponse) —
Returns a response object which responds to the following methods:
- #changed_blocks => Array<Types::ChangedBlock>
- #expiry_time => Time
- #volume_size => Integer
- #block_size => Integer
- #next_token => String

See Also:

AWS API Documentation

#list_snapshot_blocks(options = {}) ⇒ `Types::ListSnapshotBlocksResponse`

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

Examples:

Request syntax with placeholder values


resp = client.list_snapshot_blocks({
  snapshot_id: "SnapshotId", # required
  next_token: "PageToken",
  max_results: 1,
  starting_block_index: 1,
})

Response structure


resp.blocks #=> Array
resp.blocks[0].block_index #=> Integer
resp.blocks[0].block_token #=> String
resp.expiry_time #=> Time
resp.volume_size #=> Integer
resp.block_size #=> Integer
resp.next_token #=> String

Options Hash (options):

:snapshot_id (required, String) —
The ID of the snapshot from which to get block indexes and block tokens.
:next_token (String) —
The token to request the next page of results.
:max_results (Integer) —
The number of results to return.
:starting_block_index (Integer) —
The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.

Returns:

(Types::ListSnapshotBlocksResponse) —
Returns a response object which responds to the following methods:
- #blocks => Array<Types::Block>
- #expiry_time => Time
- #volume_size => Integer
- #block_size => Integer
- #next_token => String

See Also:

AWS API Documentation

#put_snapshot_block(options = {}) ⇒ `Types::PutSnapshotBlockResponse`

Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-byte sectors.

Examples:

Request syntax with placeholder values


resp = client.put_snapshot_block({
  snapshot_id: "SnapshotId", # required
  block_index: 1, # required
  block_data: source_file, # file/IO object, or string data, required
  data_length: 1, # required
  progress: 1,
  checksum: "Checksum", # required
  checksum_algorithm: "SHA256", # required, accepts SHA256
})

Response structure


resp.checksum #=> String
resp.checksum_algorithm #=> String, one of "SHA256"

Options Hash (options):

:snapshot_id (required, String) —
The ID of the snapshot.
:block_index (required, Integer) —
The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.
:block_data (required, IO, String) —
The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.
:data_length (required, Integer) —
The size of the data to write to the block, in bytes. Currently, the only supported size is 524288.

Valid values: 524288
:progress (Integer) —
The progress of the write process, as a percentage.
:checksum (required, String) —
A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.
:checksum_algorithm (required, String) —
The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

Returns:

(Types::PutSnapshotBlockResponse) —
Returns a response object which responds to the following methods:
- #checksum => String
- #checksum_algorithm => String

See Also:

AWS API Documentation

#start_snapshot(options = {}) ⇒ `Types::StartSnapshotResponse`

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

Examples:

Request syntax with placeholder values


resp = client.start_snapshot({
  volume_size: 1, # required
  parent_snapshot_id: "SnapshotId",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  description: "Description",
  client_token: "IdempotencyToken",
  encrypted: false,
  kms_key_arn: "KmsKeyArn",
  timeout: 1,
})

Response structure


resp.description #=> String
resp.snapshot_id #=> String
resp.owner_id #=> String
resp.status #=> String, one of "completed", "pending", "error"
resp.start_time #=> Time
resp.volume_size #=> Integer
resp.block_size #=> Integer
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.parent_snapshot_id #=> String
resp.kms_key_arn #=> String

Options Hash (options):

:volume_size (required, Integer) —
The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).
:parent_snapshot_id (String) —
The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.
:tags (Array<Types::Tag>) —
The tags to apply to the snapshot.
:description (String) —
A description for the snapshot.
:client_token (String) —
This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.
:encrypted (Boolean) —
Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true. To create an unencrypted snapshot, omit this parameter.

If you specify a value for ParentSnapshotId, omit this parameter.

If you specify true, the snapshot is encrypted using the CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use ModifyEbsDefaultKmsKeyId.

If your account is enabled for encryption by default, you cannot set this parameter to false. In this case, you can omit this parameter.

For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.
:kms_key_arn (String) —
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.
:timeout (Integer) —
The amount of time (in minutes) after which the snapshot is automatically cancelled if:
- No blocks are written to the snapshot.
- The snapshot is not completed after writing the last block of data.
If no value is specified, the timeout defaults to 60 minutes.

Returns:

(Types::StartSnapshotResponse) —
Returns a response object which responds to the following methods:
- #description => String
- #snapshot_id => String
- #owner_id => String
- #status => String
- #start_time => Time
- #volume_size => Integer
- #block_size => Integer
- #tags => Array<Types::Tag>
- #parent_snapshot_id => String
- #kms_key_arn => String

See Also:

AWS API Documentation

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

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

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 Name	Client Method	Default Delay:	Default Max Attempts:

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::EBS::Client

Overview

Region

Credentials

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

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

Instance Method Details

#complete_snapshot(options = {}) ⇒ Types::CompleteSnapshotResponse

#get_snapshot_block(options = {}) ⇒ Types::GetSnapshotBlockResponse

#list_changed_blocks(options = {}) ⇒ Types::ListChangedBlocksResponse

#list_snapshot_blocks(options = {}) ⇒ Types::ListSnapshotBlocksResponse

#put_snapshot_block(options = {}) ⇒ Types::PutSnapshotBlockResponse

#start_snapshot(options = {}) ⇒ Types::StartSnapshotResponse

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

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

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

#complete_snapshot(options = {}) ⇒ `Types::CompleteSnapshotResponse`

#get_snapshot_block(options = {}) ⇒ `Types::GetSnapshotBlockResponse`

#list_changed_blocks(options = {}) ⇒ `Types::ListChangedBlocksResponse`

#list_snapshot_blocks(options = {}) ⇒ `Types::ListSnapshotBlocksResponse`

#put_snapshot_block(options = {}) ⇒ `Types::PutSnapshotBlockResponse`

#start_snapshot(options = {}) ⇒ `Types::StartSnapshotResponse`

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

#waiter_names ⇒ `Array<Symbol>`