@aws-sdk/client-ebs 3.379.1 → 3.382.0

package/dist-types/models/models_0.d.ts

@@ -22,6 +22,7 @@ export declare class AccessDeniedException extends __BaseException {
     readonly $fault: "client";
     Message?: string;
     /**
+     * @public
      * <p>The reason for the exception.</p>
      */
     Reason: AccessDeniedExceptionReason | string | undefined;
@@ -36,10 +37,12 @@ export declare class AccessDeniedException extends __BaseException {
  */
 export interface Block {
     /**
+     * @public
      * <p>The block index.</p>
      */
     BlockIndex?: number;
     /**
+     * @public
      * <p>The block token for the block index.</p>
      */
     BlockToken?: string;
@@ -51,16 +54,19 @@ export interface Block {
  */
 export interface ChangedBlock {
     /**
+     * @public
      * <p>The block index.</p>
      */
     BlockIndex?: number;
     /**
+     * @public
      * <p>The block token for the block index of the <code>FirstSnapshotId</code> specified in
      *             the <code>ListChangedBlocks</code> operation. This value is absent if the first snapshot
      *             does not have the changed block that is on the second snapshot.</p>
      */
     FirstBlockToken?: string;
     /**
+     * @public
      * <p>The block token for the block index of the <code>SecondSnapshotId</code> specified in
      *             the <code>ListChangedBlocks</code> operation.</p>
      */
@@ -93,14 +99,17 @@ export type ChecksumAlgorithm = (typeof ChecksumAlgorithm)[keyof typeof Checksum
  */
 export interface CompleteSnapshotRequest {
     /**
+     * @public
      * <p>The ID of the snapshot.</p>
      */
     SnapshotId: string | undefined;
     /**
+     * @public
      * <p>The number of blocks that were written to the snapshot.</p>
      */
     ChangedBlocksCount: number | undefined;
     /**
+     * @public
      * <p>An aggregated Base-64 SHA256 checksum based on the checksums of each written
      *             block.</p>
      *          <p>To generate the aggregated checksum using the linear aggregation method, arrange the
@@ -110,11 +119,13 @@ export interface CompleteSnapshotRequest {
      */
     Checksum?: string;
     /**
+     * @public
      * <p>The algorithm used to generate the checksum. Currently, the only supported algorithm
      *             is <code>SHA256</code>.</p>
      */
     ChecksumAlgorithm?: ChecksumAlgorithm | string;
     /**
+     * @public
      * <p>The aggregation method used to generate the checksum. Currently, the only supported
      *             aggregation method is <code>LINEAR</code>.</p>
      */
@@ -138,6 +149,7 @@ export type Status = (typeof Status)[keyof typeof Status];
  */
 export interface CompleteSnapshotResponse {
     /**
+     * @public
      * <p>The status of the snapshot.</p>
      */
     Status?: Status | string;
@@ -178,6 +190,7 @@ export declare class RequestThrottledException extends __BaseException {
     readonly $fault: "client";
     Message?: string;
     /**
+     * @public
      * <p>The reason for the exception.</p>
      */
     Reason?: RequestThrottledExceptionReason | string;
@@ -209,6 +222,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     readonly $fault: "client";
     Message?: string;
     /**
+     * @public
      * <p>The reason for the exception.</p>
      */
     Reason?: ResourceNotFoundExceptionReason | string;
@@ -237,6 +251,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     readonly $fault: "client";
     Message?: string;
     /**
+     * @public
      * <p>The reason for the exception.</p>
      */
     Reason?: ServiceQuotaExceededExceptionReason | string;
@@ -279,6 +294,7 @@ export declare class ValidationException extends __BaseException {
     readonly $fault: "client";
     Message?: string;
     /**
+     * @public
      * <p>The reason for the validation exception.</p>
      */
     Reason?: ValidationExceptionReason | string;
@@ -321,6 +337,7 @@ export declare class ConflictException extends __BaseException {
  */
 export interface GetSnapshotBlockRequest {
     /**
+     * @public
      * <p>The ID of the snapshot containing the block from which to get data.</p>
      *          <important>
      *             <p>If the specified snapshot is encrypted, you must have permission to use the
@@ -332,6 +349,7 @@ export interface GetSnapshotBlockRequest {
      */
     SnapshotId: string | undefined;
     /**
+     * @public
      * <p>The block index of the block in which to read the data. A block index is a logical
      *             index in units of <code>512</code> KiB blocks. To identify the block index, divide
      *             the logical offset of the data in the logical volume by the block size (logical offset
@@ -340,6 +358,7 @@ export interface GetSnapshotBlockRequest {
      */
     BlockIndex: number | undefined;
     /**
+     * @public
      * <p>The block token of the block from which to get data. You can obtain the <code>BlockToken</code>
      *             by running the <code>ListChangedBlocks</code> or <code>ListSnapshotBlocks</code> operations.</p>
      */
@@ -350,18 +369,22 @@ export interface GetSnapshotBlockRequest {
  */
 export interface GetSnapshotBlockResponse {
     /**
+     * @public
      * <p>The size of the data in the block.</p>
      */
     DataLength?: number;
     /**
+     * @public
      * <p>The data content of the block.</p>
      */
     BlockData?: StreamingBlobTypes;
     /**
+     * @public
      * <p>The checksum generated for the block, which is Base64 encoded.</p>
      */
     Checksum?: string;
     /**
+     * @public
      * <p>The algorithm used to generate the checksum for the block, such as SHA256.</p>
      */
     ChecksumAlgorithm?: ChecksumAlgorithm | string;
@@ -371,6 +394,7 @@ export interface GetSnapshotBlockResponse {
  */
 export interface ListChangedBlocksRequest {
     /**
+     * @public
      * <p>The ID of the first snapshot to use for the comparison.</p>
      *          <important>
      *             <p>The <code>FirstSnapshotID</code> parameter must be specified with a
@@ -379,6 +403,7 @@ export interface ListChangedBlocksRequest {
      */
     FirstSnapshotId?: string;
     /**
+     * @public
      * <p>The ID of the second snapshot to use for the comparison.</p>
      *          <important>
      *             <p>The <code>SecondSnapshotId</code> parameter must be specified with a
@@ -387,12 +412,14 @@ export interface ListChangedBlocksRequest {
      */
     SecondSnapshotId: string | undefined;
     /**
+     * @public
      * <p>The token to request the next page of results.</p>
      *          <p>If you specify <b>NextToken</b>, then
      *             <b>StartingBlockIndex</b> is ignored.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>The maximum number of blocks to be returned by the request.</p>
      *          <p>Even if additional blocks can be retrieved from the snapshot, the request can
      *             return less blocks than <b>MaxResults</b> or an empty
@@ -404,6 +431,7 @@ export interface ListChangedBlocksRequest {
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>The block index from which the comparison should start.</p>
      *          <p>The list in the response will start from this block index or the next valid block
      *             index in the snapshots.</p>
@@ -417,22 +445,27 @@ export interface ListChangedBlocksRequest {
  */
 export interface ListChangedBlocksResponse {
     /**
+     * @public
      * <p>An array of objects containing information about the changed blocks.</p>
      */
     ChangedBlocks?: ChangedBlock[];
     /**
+     * @public
      * <p>The time when the <code>BlockToken</code> expires.</p>
      */
     ExpiryTime?: Date;
     /**
+     * @public
      * <p>The size of the volume in GB.</p>
      */
     VolumeSize?: number;
     /**
+     * @public
      * <p>The size of the blocks in the snapshot, in bytes.</p>
      */
     BlockSize?: number;
     /**
+     * @public
      * <p>The token to use to retrieve the next page of results. This value is null when there
      *             are no more results to return.</p>
      */
@@ -443,16 +476,19 @@ export interface ListChangedBlocksResponse {
  */
 export interface ListSnapshotBlocksRequest {
     /**
+     * @public
      * <p>The ID of the snapshot from which to get block indexes and block tokens.</p>
      */
     SnapshotId: string | undefined;
     /**
+     * @public
      * <p>The token to request the next page of results.</p>
      *          <p>If you specify <b>NextToken</b>, then
      *             <b>StartingBlockIndex</b> is ignored.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>The maximum number of blocks to be returned by the request.</p>
      *          <p>Even if additional blocks can be retrieved from the snapshot, the request can
      *             return less blocks than <b>MaxResults</b> or an empty
@@ -464,6 +500,7 @@ export interface ListSnapshotBlocksRequest {
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>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.</p>
      *          <p>If you specify <b>NextToken</b>, then
@@ -476,22 +513,27 @@ export interface ListSnapshotBlocksRequest {
  */
 export interface ListSnapshotBlocksResponse {
     /**
+     * @public
      * <p>An array of objects containing information about the blocks.</p>
      */
     Blocks?: Block[];
     /**
+     * @public
      * <p>The time when the <code>BlockToken</code> expires.</p>
      */
     ExpiryTime?: Date;
     /**
+     * @public
      * <p>The size of the volume in GB.</p>
      */
     VolumeSize?: number;
     /**
+     * @public
      * <p>The size of the blocks in the snapshot, in bytes.</p>
      */
     BlockSize?: number;
     /**
+     * @public
      * <p>The token to use to retrieve the next page of results. This value is null when there
      *             are no more results to return.</p>
      */
@@ -502,6 +544,7 @@ export interface ListSnapshotBlocksResponse {
  */
 export interface PutSnapshotBlockRequest {
     /**
+     * @public
      * <p>The ID of the snapshot.</p>
      *          <important>
      *             <p>If the specified snapshot is encrypted, you must have permission to use
@@ -513,6 +556,7 @@ export interface PutSnapshotBlockRequest {
      */
     SnapshotId: string | undefined;
     /**
+     * @public
      * <p>The block index of the block in which to write the data. A block index is a logical
      *     	index in units of <code>512</code> 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
@@ -521,6 +565,7 @@ export interface PutSnapshotBlockRequest {
      */
     BlockIndex: number | undefined;
     /**
+     * @public
      * <p>The data to write to the block.</p>
      *          <p>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
@@ -535,6 +580,7 @@ export interface PutSnapshotBlockRequest {
      */
     BlockData: StreamingBlobTypes | undefined;
     /**
+     * @public
      * <p>The size of the data to write to the block, in bytes. Currently, the only supported
      *             size is <code>524288</code> bytes.</p>
      *          <p>Valid values: <code>524288</code>
@@ -542,15 +588,18 @@ export interface PutSnapshotBlockRequest {
      */
     DataLength: number | undefined;
     /**
+     * @public
      * <p>The progress of the write process, as a percentage.</p>
      */
     Progress?: number;
     /**
+     * @public
      * <p>A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are
      *             supported.</p>
      */
     Checksum: string | undefined;
     /**
+     * @public
      * <p>The algorithm used to generate the checksum. Currently, the only supported algorithm
      *             is <code>SHA256</code>.</p>
      */
@@ -561,10 +610,12 @@ export interface PutSnapshotBlockRequest {
  */
 export interface PutSnapshotBlockResponse {
     /**
+     * @public
      * <p>The SHA256 checksum generated for the block data by Amazon EBS.</p>
      */
     Checksum?: string;
     /**
+     * @public
      * <p>The algorithm used by Amazon EBS to generate the checksum.</p>
      */
     ChecksumAlgorithm?: ChecksumAlgorithm | string;
@@ -575,10 +626,12 @@ export interface PutSnapshotBlockResponse {
  */
 export interface Tag {
     /**
+     * @public
      * <p>The key of the tag.</p>
      */
     Key?: string;
     /**
+     * @public
      * <p>The value of the tag.</p>
      */
     Value?: string;
@@ -588,11 +641,13 @@ export interface Tag {
  */
 export interface StartSnapshotRequest {
     /**
+     * @public
      * <p>The size of the volume, in GiB. The maximum size is <code>65536</code> GiB (64
      *             TiB).</p>
      */
     VolumeSize: number | undefined;
     /**
+     * @public
      * <p>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.</p>
      *          <p>You can't specify <b>ParentSnapshotId</b> and
@@ -614,14 +669,17 @@ export interface StartSnapshotRequest {
      */
     ParentSnapshotId?: string;
     /**
+     * @public
      * <p>The tags to apply to the snapshot.</p>
      */
     Tags?: Tag[];
     /**
+     * @public
      * <p>A description for the snapshot.</p>
      */
     Description?: string;
     /**
+     * @public
      * <p>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
@@ -633,6 +691,7 @@ export interface StartSnapshotRequest {
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>Indicates whether to encrypt the snapshot.</p>
      *          <p>You can't specify <b>Encrypted</b> and <b>
      *             ParentSnapshotId</b> in the same request. If you specify both parameters, the
@@ -652,6 +711,7 @@ export interface StartSnapshotRequest {
      */
     Encrypted?: boolean;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.</p>
      *          <p>The encryption status of the snapshot depends on the values that you specify for
      *             <b>Encrypted</b>, <b>KmsKeyArn</b>,
@@ -668,6 +728,7 @@ export interface StartSnapshotRequest {
      */
     KmsKeyArn?: string;
     /**
+     * @public
      * <p>The amount of time (in minutes) after which the snapshot is automatically cancelled
      *             if:</p>
      *          <ul>
@@ -700,48 +761,59 @@ export type SSEType = (typeof SSEType)[keyof typeof SSEType];
  */
 export interface StartSnapshotResponse {
     /**
+     * @public
      * <p>The description of the snapshot.</p>
      */
     Description?: string;
     /**
+     * @public
      * <p>The ID of the snapshot.</p>
      */
     SnapshotId?: string;
     /**
+     * @public
      * <p>The Amazon Web Services account ID of the snapshot owner.</p>
      */
     OwnerId?: string;
     /**
+     * @public
      * <p>The status of the snapshot.</p>
      */
     Status?: Status | string;
     /**
+     * @public
      * <p>The timestamp when the snapshot was created.</p>
      */
     StartTime?: Date;
     /**
+     * @public
      * <p>The size of the volume, in GiB.</p>
      */
     VolumeSize?: number;
     /**
+     * @public
      * <p>The size of the blocks in the snapshot, in bytes.</p>
      */
     BlockSize?: number;
     /**
+     * @public
      * <p>The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more
      *             information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html"> Tagging your Amazon EC2
      *                 resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
      */
     Tags?: Tag[];
     /**
+     * @public
      * <p>The ID of the parent snapshot.</p>
      */
     ParentSnapshotId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.</p>
      */
     KmsKeyArn?: string;
     /**
+     * @public
      * <p>Reserved for future use.</p>
      */
     SseType?: SSEType | string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-ebs",
   "description": "AWS SDK for JavaScript Ebs Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",