aws-sdk-ebs 1.4.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0409f53a6aee215d8b93786bd4cb550b35746632b39fbf30db2a94518aeba819'
-  data.tar.gz: 9ca32894ab8e35c2fc39ea65a16f4f2240346a005f1de1db1c4e03991fa860a4
+  metadata.gz: ddba9a0efe683f000f117556552564b9fe383fbb5f47094bafda97aeded53b38
+  data.tar.gz: 350c2159ee3fe84554f374dc658b44d12bd3b17e94e50b67bcb03ba525c6f798
 SHA512:
-  metadata.gz: 7bf80eaa9ab0178601b11de4a315a341f93de27e8d13abd8a63a2d633c61958411050f02c31481f435320cfc490f5b188368bbce11051fcefcbf9bcdf69f4dbc
-  data.tar.gz: 42bf23a56719af77b94b7e9aaecfe70299a683273d0006bc17ae1fd777e8eb960dfa931f022191385377b03622bd4d53047ec4eccfd8c54fbcf8b16ce261e549
+  metadata.gz: 445c0c17cf2c729af53e4a4611d409313ece7c3435683d42f4edc2c20eae148daa1841670494be071ed33f14b7a54e7b6c2edf24d77a4c2fef9af0392bb912d6
+  data.tar.gz: c9e579ab4d01cd49bc5804356094300dc32d4b58627c7a6ddeaa05193502100ac36eb51df743c3a2e22ca2ea72620d3b7212e5ec5171f081267acc0cf71723d3

data/lib/aws-sdk-ebs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -25,7 +27,7 @@ require_relative 'aws-sdk-ebs/customizations'
 # structure.
 #
 #     ebs = Aws::EBS::Client.new
-#     resp = ebs.get_snapshot_block(params)
+#     resp = ebs.complete_snapshot(params)
 #
 # See {Client} for more information.
 #
@@ -42,9 +44,9 @@ require_relative 'aws-sdk-ebs/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::EBS
 
-  GEM_VERSION = '1.4.0'
+  GEM_VERSION = '1.9.0'
 
 end

data/lib/aws-sdk-ebs/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 
@@ -69,6 +72,7 @@ module Aws::EBS
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
 
@@ -81,13 +85,28 @@ module Aws::EBS
     #     * `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::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `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:
@@ -97,10 +116,10 @@ module Aws::EBS
     #     * 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.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -161,7 +180,7 @@ module Aws::EBS
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be a valid HTTP(S) URI.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -308,6 +327,62 @@ module Aws::EBS
 
     # @!group API Operations
 
+    # 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.
+    #
+    # @option params [required, String] :snapshot_id
+    #   The ID of the snapshot.
+    #
+    # @option params [required, Integer] :changed_blocks_count
+    #   The number of blocks that were written to the snapshot.
+    #
+    # @option params [String] :checksum
+    #   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.
+    #
+    # @option params [String] :checksum_algorithm
+    #   The algorithm used to generate the checksum. Currently, the only
+    #   supported algorithm is `SHA256`.
+    #
+    # @option params [String] :checksum_aggregation_method
+    #   The aggregation method used to generate the checksum. Currently, the
+    #   only supported aggregation method is `LINEAR`.
+    #
+    # @return [Types::CompleteSnapshotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CompleteSnapshotResponse#status #status} => String
+    #
+    # @example 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
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.status #=> String, one of "completed", "pending", "error"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/CompleteSnapshot AWS API Documentation
+    #
+    # @overload complete_snapshot(params = {})
+    # @param [Hash] params ({})
+    def complete_snapshot(params = {}, options = {})
+      req = build_request(:complete_snapshot, params)
+      req.send_request(options)
+    end
+
     # Returns the data in a block in an Amazon Elastic Block Store snapshot.
     #
     # @option params [required, String] :snapshot_id
@@ -356,9 +431,9 @@ module Aws::EBS
       req.send_request(options, &block)
     end
 
-    # Returns the block indexes and block tokens for blocks that are
-    # different between two Amazon Elastic Block Store snapshots of the same
-    # volume/snapshot lineage.
+    # Returns information about the blocks that are different between two
+    # Amazon Elastic Block Store snapshots of the same volume/snapshot
+    # lineage.
     #
     # @option params [String] :first_snapshot_id
     #   The ID of the first snapshot to use for the comparison.
@@ -424,8 +499,8 @@ module Aws::EBS
       req.send_request(options)
     end
 
-    # Returns the block indexes and block tokens for blocks in an Amazon
-    # Elastic Block Store snapshot.
+    # Returns information about the blocks in an Amazon Elastic Block Store
+    # snapshot.
     #
     # @option params [required, String] :snapshot_id
     #   The ID of the snapshot from which to get block indexes and block
@@ -480,6 +555,244 @@ module Aws::EBS
       req.send_request(options)
     end
 
+    # 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.
+    #
+    # @option params [required, String] :snapshot_id
+    #   The ID of the snapshot.
+    #
+    # @option params [required, Integer] :block_index
+    #   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.
+    #
+    # @option params [required, String, IO] :block_data
+    #   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][1] in the *Amazon Elastic Compute
+    #   Cloud User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums
+    #
+    # @option params [required, Integer] :data_length
+    #   The size of the data to write to the block, in bytes. Currently, the
+    #   only supported size is `524288`.
+    #
+    #   Valid values: `524288`
+    #
+    # @option params [Integer] :progress
+    #   The progress of the write process, as a percentage.
+    #
+    # @option params [required, String] :checksum
+    #   A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums
+    #   are supported.
+    #
+    # @option params [required, String] :checksum_algorithm
+    #   The algorithm used to generate the checksum. Currently, the only
+    #   supported algorithm is `SHA256`.
+    #
+    # @return [Types::PutSnapshotBlockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::PutSnapshotBlockResponse#checksum #checksum} => String
+    #   * {Types::PutSnapshotBlockResponse#checksum_algorithm #checksum_algorithm} => String
+    #
+    # @example 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
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.checksum #=> String
+    #   resp.checksum_algorithm #=> String, one of "SHA256"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/PutSnapshotBlock AWS API Documentation
+    #
+    # @overload put_snapshot_block(params = {})
+    # @param [Hash] params ({})
+    def put_snapshot_block(params = {}, options = {})
+      req = build_request(:put_snapshot_block, params)
+      req.send_request(options)
+    end
+
+    # Creates a new Amazon EBS snapshot. The new snapshot enters the
+    # `pending` state after the request completes.
+    #
+    # After creating the snapshot, use [ PutSnapshotBlock][1] to write
+    # blocks of data to the snapshot.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html
+    #
+    # @option params [required, Integer] :volume_size
+    #   The size of the volume, in GiB. The maximum size is `16384` GiB (16
+    #   TiB).
+    #
+    # @option params [String] :parent_snapshot_id
+    #   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][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopySnapshot.html
+    #
+    # @option params [Array<Types::Tag>] :tags
+    #   The tags to apply to the snapshot.
+    #
+    # @option params [String] :description
+    #   A description for the snapshot.
+    #
+    # @option params [String] :client_token
+    #   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][1] in
+    #   the *Amazon Elastic Compute Cloud User Guide*.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html
+    #
+    # @option params [Boolean] :encrypted
+    #   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][1].
+    #
+    #   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][2] in the *Amazon
+    #   Elastic Compute Cloud User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyEbsDefaultKmsKeyId.html
+    #   [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-encryption
+    #
+    # @option params [String] :kms_key_arn
+    #   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.
+    #
+    # @option params [Integer] :timeout
+    #   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.
+    #
+    # @return [Types::StartSnapshotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartSnapshotResponse#description #description} => String
+    #   * {Types::StartSnapshotResponse#snapshot_id #snapshot_id} => String
+    #   * {Types::StartSnapshotResponse#owner_id #owner_id} => String
+    #   * {Types::StartSnapshotResponse#status #status} => String
+    #   * {Types::StartSnapshotResponse#start_time #start_time} => Time
+    #   * {Types::StartSnapshotResponse#volume_size #volume_size} => Integer
+    #   * {Types::StartSnapshotResponse#block_size #block_size} => Integer
+    #   * {Types::StartSnapshotResponse#tags #tags} => Array&lt;Types::Tag&gt;
+    #   * {Types::StartSnapshotResponse#parent_snapshot_id #parent_snapshot_id} => String
+    #   * {Types::StartSnapshotResponse#kms_key_arn #kms_key_arn} => String
+    #
+    # @example 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,
+    #   })
+    #
+    # @example 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
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/StartSnapshot AWS API Documentation
+    #
+    # @overload start_snapshot(params = {})
+    # @param [Hash] params ({})
+    def start_snapshot(params = {}, options = {})
+      req = build_request(:start_snapshot, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -493,7 +806,7 @@ module Aws::EBS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ebs'
-      context[:gem_version] = '1.4.0'
+      context[:gem_version] = '1.9.0'
       Seahorse::Client::Request.new(handlers, context)
     end