Class: Aws::EBS::Client

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

Overview

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

client = Aws::EBS::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 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` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :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::EBS::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::EBS::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.



473
474
475
 
# File 'lib/aws-sdk-ebs/client.rb', line 473

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. 



1103
1104
1105
 
# File 'lib/aws-sdk-ebs/client.rb', line 1103

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. 



1106
1107
1108
 
# File 'lib/aws-sdk-ebs/client.rb', line 1106

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: {}) 


1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/aws-sdk-ebs/client.rb', line 1076

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::EBS')
  )
  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-ebs'
  context[:gem_version] = '1.67.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

<note markdown=“1”> You should always retry requests that receive server (‘5xx`) error responses, and `ThrottlingException` and `RequestThrottledException` client error responses. For more information see [Error retries] in the *Amazon Elastic Compute Cloud User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html

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"

Parameters:

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

    ({})

Options Hash (params):

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

See Also:



541
542
543
544
 
# File 'lib/aws-sdk-ebs/client.rb', line 541

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

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

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

<note markdown=“1”> You should always retry requests that receive server (‘5xx`) error responses, and `ThrottlingException` and `RequestThrottledException` client error responses. For more information see [Error retries] in the *Amazon Elastic Compute Cloud User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html

Examples:

Request syntax with placeholder values


resp = client.get_snapshot_block({
  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"

Parameters:

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

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The ID of the snapshot containing the block from which to get data.

    If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see [ Using encryption] in the *Amazon Elastic Compute Cloud User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html

  • :block_index (required, Integer) —

    The block index of the block in which to read 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_token (required, String) —

    The block token of the block from which to get data. You can obtain the ‘BlockToken` by running the `ListChangedBlocks` or `ListSnapshotBlocks` operations.

Returns:

See Also:



609
610
611
612
 
# File 'lib/aws-sdk-ebs/client.rb', line 609

def get_snapshot_block(params = {}, options = {}, &block)
  req = build_request(:get_snapshot_block, params)
  req.send_request(options, &block)
end

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

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

<note markdown=“1”> You should always retry requests that receive server (‘5xx`) error responses, and `ThrottlingException` and `RequestThrottledException` client error responses. For more information see [Error retries] in the *Amazon Elastic Compute Cloud User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html

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_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

Parameters:

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

    ({})

Options Hash (params):

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

    If you specify NextToken, then StartingBlockIndex is ignored.

  • :max_results (Integer) —

    The maximum number of blocks to be returned by the request.

    Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

    To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is ‘null` when there are no more blocks 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.

    If you specify NextToken, then StartingBlockIndex is ignored.

Returns:

See Also:



700
701
702
703
 
# File 'lib/aws-sdk-ebs/client.rb', line 700

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

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

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

<note markdown=“1”> You should always retry requests that receive server (‘5xx`) error responses, and `ThrottlingException` and `RequestThrottledException` client error responses. For more information see [Error retries] in the *Amazon Elastic Compute Cloud User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html

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_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

Parameters:

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

    ({})

Options Hash (params):

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

    If you specify NextToken, then StartingBlockIndex is ignored.

  • :max_results (Integer) —

    The maximum number of blocks to be returned by the request.

    Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

    To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is ‘null` when there are no more blocks 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.

    If you specify NextToken, then StartingBlockIndex is ignored.

Returns:

See Also:



779
780
781
782
 
# File 'lib/aws-sdk-ebs/client.rb', line 779

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

#put_snapshot_block(params = {}) ⇒ 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-KiB sectors.

<note markdown=“1”> You should always retry requests that receive server (‘5xx`) error responses, and `ThrottlingException` and `RequestThrottledException` client error responses. For more information see [Error retries] in the *Amazon Elastic Compute Cloud User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html

Examples:

Request syntax with placeholder values


resp = client.put_snapshot_block({
  snapshot_id: "SnapshotId", # required
  block_index: 1, # required
  block_data: "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"

Parameters:

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

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The ID of the snapshot.

    If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see [ Using encryption] in the *Amazon Elastic Compute Cloud User Guide*..

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html

  • :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, String, IO) —

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

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums

  • :data_length (required, Integer) —

    The size of the data to write to the block, in bytes. Currently, the only supported size is ‘524288` bytes.

    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:

See Also:



882
883
884
885
 
# File 'lib/aws-sdk-ebs/client.rb', line 882

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

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

<note markdown=“1”> You should always retry requests that receive server (‘5xx`) error responses, and `ThrottlingException` and `RequestThrottledException` client error responses. For more information see [Error retries] in the *Amazon Elastic Compute Cloud User Guide*.

</note>

[1]: docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html

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
resp.sse_type #=> String, one of "sse-ebs", "sse-kms", "none"

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1067
1068
1069
1070
 
# File 'lib/aws-sdk-ebs/client.rb', line 1067

def start_snapshot(params = {}, options = {})
  req = build_request(:start_snapshot, 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. 


1096
1097
1098
 
# File 'lib/aws-sdk-ebs/client.rb', line 1096

def waiter_names
  []
end