@aws-sdk/client-ec2 3.309.0 → 3.310.1

package/dist-types/ts3.4/commands/DescribeVolumeStatusCommand.d.ts

@@ -1,41 +1,170 @@
-import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  Handler,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-} from "@aws-sdk/types";
-import {
-  EC2ClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../EC2Client";
-import {
-  DescribeVolumeStatusRequest,
-  DescribeVolumeStatusResult,
-} from "../models/models_5";
-export interface DescribeVolumeStatusCommandInput
-  extends DescribeVolumeStatusRequest {}
-export interface DescribeVolumeStatusCommandOutput
-  extends DescribeVolumeStatusResult,
-    __MetadataBearer {}
-export declare class DescribeVolumeStatusCommand extends $Command<
-  DescribeVolumeStatusCommandInput,
-  DescribeVolumeStatusCommandOutput,
-  EC2ClientResolvedConfig
-> {
-  readonly input: DescribeVolumeStatusCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: DescribeVolumeStatusCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: EC2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<
-    DescribeVolumeStatusCommandInput,
-    DescribeVolumeStatusCommandOutput
-  >;
-  private serialize;
-  private deserialize;
-}
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client";
+import { DescribeVolumeStatusRequest, DescribeVolumeStatusResult } from "../models/models_5";
+/**
+ * @public
+ *
+ * The input for {@link DescribeVolumeStatusCommand}.
+ */
+export interface DescribeVolumeStatusCommandInput extends DescribeVolumeStatusRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeVolumeStatusCommand}.
+ */
+export interface DescribeVolumeStatusCommandOutput extends DescribeVolumeStatusResult, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Describes the status of the specified volumes. Volume status provides the result of the
+ *       checks performed on your volumes to determine events that can impair the performance of your
+ *       volumes. The performance of a volume can be affected if an issue occurs on the volume's
+ *       underlying host. If the volume's underlying host experiences a power outage or system issue,
+ *       after the system is restored, there could be data inconsistencies on the volume. Volume events
+ *       notify you if this occurs. Volume actions notify you if any action needs to be taken in
+ *       response to the event.</p>
+ *          <p>The <code>DescribeVolumeStatus</code> operation provides the following information about
+ *       the specified volumes:</p>
+ *          <p>
+ *             <i>Status</i>: Reflects the current status of the volume. The possible
+ *       values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or
+ *         <code>insufficient-data</code>. If all checks pass, the overall status of the volume is
+ *         <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the
+ *       status is <code>insufficient-data</code>, then the checks might still be taking place on your
+ *       volume at the time. We recommend that you retry the request. For more information about volume
+ *       status, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitor the status of your volumes</a> in the
+ *       <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *          <p>
+ *             <i>Events</i>: Reflect the cause of a volume status and might require you to
+ *       take action. For example, if your volume returns an <code>impaired</code> status, then the
+ *       volume event might be <code>potential-data-inconsistency</code>. This means that your volume
+ *       has been affected by an issue with the underlying host, has all I/O operations disabled, and
+ *       might have inconsistent data.</p>
+ *          <p>
+ *             <i>Actions</i>: Reflect the actions you might have to take in response to an
+ *       event. For example, if the status of the volume is <code>impaired</code> and the volume event
+ *       shows <code>potential-data-inconsistency</code>, then the action shows
+ *         <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for
+ *       the volume by calling the <a>EnableVolumeIO</a> action and then check the volume
+ *       for data consistency.</p>
+ *          <p>Volume status is based on the volume status checks, and does not reflect the volume state.
+ *       Therefore, volume status does not indicate volumes in the <code>error</code> state (for
+ *       example, when a volume is incapable of accepting I/O.)</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EC2Client, DescribeVolumeStatusCommand } from "@aws-sdk/client-ec2"; // ES Modules import
+ * // const { EC2Client, DescribeVolumeStatusCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
+ * const client = new EC2Client(config);
+ * const input = { // DescribeVolumeStatusRequest
+ *   Filters: [ // FilterList
+ *     { // Filter
+ *       Name: "STRING_VALUE",
+ *       Values: [ // ValueStringList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   ],
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ *   VolumeIds: [ // VolumeIdStringList
+ *     "STRING_VALUE",
+ *   ],
+ *   DryRun: true || false,
+ * };
+ * const command = new DescribeVolumeStatusCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param DescribeVolumeStatusCommandInput - {@link DescribeVolumeStatusCommandInput}
+ * @returns {@link DescribeVolumeStatusCommandOutput}
+ * @see {@link DescribeVolumeStatusCommandInput} for command's `input` shape.
+ * @see {@link DescribeVolumeStatusCommandOutput} for command's `response` shape.
+ * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
+ *
+ *
+ * @example To describe the status of a single volume
+ * ```javascript
+ * // This example describes the status for the volume ``vol-1234567890abcdef0``.
+ * const input = {
+ *   "VolumeIds": [
+ *     "vol-1234567890abcdef0"
+ *   ]
+ * };
+ * const command = new DescribeVolumeStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "VolumeStatuses": [
+ *     {
+ *       "Actions": [],
+ *       "AvailabilityZone": "us-east-1a",
+ *       "Events": [],
+ *       "VolumeId": "vol-1234567890abcdef0",
+ *       "VolumeStatus": {
+ *         "Details": [
+ *           {
+ *             "Name": "io-enabled",
+ *             "Status": "passed"
+ *           },
+ *           {
+ *             "Name": "io-performance",
+ *             "Status": "not-applicable"
+ *           }
+ *         ],
+ *         "Status": "ok"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-the-status-of-a-single-volume-1472507016193
+ * ```
+ *
+ * @example To describe the status of impaired volumes
+ * ```javascript
+ * // This example describes the status for all volumes that are impaired. In this example output, there are no impaired volumes.
+ * const input = {
+ *   "Filters": [
+ *     {
+ *       "Name": "volume-status.status",
+ *       "Values": [
+ *         "impaired"
+ *       ]
+ *     }
+ *   ]
+ * };
+ * const command = new DescribeVolumeStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "VolumeStatuses": []
+ * }
+ * *\/
+ * // example id: to-describe-the-status-of-impaired-volumes-1472507239821
+ * ```
+ *
+ */
+export declare class DescribeVolumeStatusCommand extends $Command<DescribeVolumeStatusCommandInput, DescribeVolumeStatusCommandOutput, EC2ClientResolvedConfig> {
+    readonly input: DescribeVolumeStatusCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DescribeVolumeStatusCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EC2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeVolumeStatusCommandInput, DescribeVolumeStatusCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/ts3.4/commands/DescribeVolumesCommand.d.ts

@@ -1,35 +1,164 @@
-import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  Handler,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-} from "@aws-sdk/types";
-import {
-  EC2ClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../EC2Client";
-import { DescribeVolumesRequest } from "../models/models_4";
-import { DescribeVolumesResult } from "../models/models_5";
-export interface DescribeVolumesCommandInput extends DescribeVolumesRequest {}
-export interface DescribeVolumesCommandOutput
-  extends DescribeVolumesResult,
-    __MetadataBearer {}
-export declare class DescribeVolumesCommand extends $Command<
-  DescribeVolumesCommandInput,
-  DescribeVolumesCommandOutput,
-  EC2ClientResolvedConfig
-> {
-  readonly input: DescribeVolumesCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: DescribeVolumesCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: EC2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<DescribeVolumesCommandInput, DescribeVolumesCommandOutput>;
-  private serialize;
-  private deserialize;
-}
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client";
+import { DescribeVolumesRequest } from "../models/models_4";
+import { DescribeVolumesResult } from "../models/models_5";
+/**
+ * @public
+ *
+ * The input for {@link DescribeVolumesCommand}.
+ */
+export interface DescribeVolumesCommandInput extends DescribeVolumesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeVolumesCommand}.
+ */
+export interface DescribeVolumesCommandOutput extends DescribeVolumesResult, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Describes the specified EBS volumes or all of your EBS volumes.</p>
+ *          <p>If you are describing a long list of volumes, we recommend that you paginate the output to make the list
+ *       more manageable. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
+ *          <p>For more information about EBS volumes, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html">Amazon EBS volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EC2Client, DescribeVolumesCommand } from "@aws-sdk/client-ec2"; // ES Modules import
+ * // const { EC2Client, DescribeVolumesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
+ * const client = new EC2Client(config);
+ * const input = { // DescribeVolumesRequest
+ *   Filters: [ // FilterList
+ *     { // Filter
+ *       Name: "STRING_VALUE",
+ *       Values: [ // ValueStringList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   ],
+ *   VolumeIds: [ // VolumeIdStringList
+ *     "STRING_VALUE",
+ *   ],
+ *   DryRun: true || false,
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new DescribeVolumesCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param DescribeVolumesCommandInput - {@link DescribeVolumesCommandInput}
+ * @returns {@link DescribeVolumesCommandOutput}
+ * @see {@link DescribeVolumesCommandInput} for command's `input` shape.
+ * @see {@link DescribeVolumesCommandOutput} for command's `response` shape.
+ * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
+ *
+ *
+ * @example To describe all volumes
+ * ```javascript
+ * // This example describes all of your volumes in the default region.
+ * const input = {};
+ * const command = new DescribeVolumesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "NextToken": "",
+ *   "Volumes": [
+ *     {
+ *       "Attachments": [
+ *         {
+ *           "AttachTime": "2013-12-18T22:35:00.000Z",
+ *           "DeleteOnTermination": true,
+ *           "Device": "/dev/sda1",
+ *           "InstanceId": "i-1234567890abcdef0",
+ *           "State": "attached",
+ *           "VolumeId": "vol-049df61146c4d7901"
+ *         }
+ *       ],
+ *       "AvailabilityZone": "us-east-1a",
+ *       "CreateTime": "2013-12-18T22:35:00.084Z",
+ *       "Size": 8,
+ *       "SnapshotId": "snap-1234567890abcdef0",
+ *       "State": "in-use",
+ *       "VolumeId": "vol-049df61146c4d7901",
+ *       "VolumeType": "standard"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-all-volumes-1472506358883
+ * ```
+ *
+ * @example To describe volumes that are attached to a specific instance
+ * ```javascript
+ * // This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.
+ * const input = {
+ *   "Filters": [
+ *     {
+ *       "Name": "attachment.instance-id",
+ *       "Values": [
+ *         "i-1234567890abcdef0"
+ *       ]
+ *     },
+ *     {
+ *       "Name": "attachment.delete-on-termination",
+ *       "Values": [
+ *         "true"
+ *       ]
+ *     }
+ *   ]
+ * };
+ * const command = new DescribeVolumesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Volumes": [
+ *     {
+ *       "Attachments": [
+ *         {
+ *           "AttachTime": "2013-12-18T22:35:00.000Z",
+ *           "DeleteOnTermination": true,
+ *           "Device": "/dev/sda1",
+ *           "InstanceId": "i-1234567890abcdef0",
+ *           "State": "attached",
+ *           "VolumeId": "vol-049df61146c4d7901"
+ *         }
+ *       ],
+ *       "AvailabilityZone": "us-east-1a",
+ *       "CreateTime": "2013-12-18T22:35:00.084Z",
+ *       "Size": 8,
+ *       "SnapshotId": "snap-1234567890abcdef0",
+ *       "State": "in-use",
+ *       "VolumeId": "vol-049df61146c4d7901",
+ *       "VolumeType": "standard"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-volumes-that-are-attached-to-a-specific-instance-1472506613578
+ * ```
+ *
+ */
+export declare class DescribeVolumesCommand extends $Command<DescribeVolumesCommandInput, DescribeVolumesCommandOutput, EC2ClientResolvedConfig> {
+    readonly input: DescribeVolumesCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DescribeVolumesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EC2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeVolumesCommandInput, DescribeVolumesCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/ts3.4/commands/DescribeVolumesModificationsCommand.d.ts

@@ -1,41 +1,82 @@
-import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  Handler,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-} from "@aws-sdk/types";
-import {
-  EC2ClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../EC2Client";
-import {
-  DescribeVolumesModificationsRequest,
-  DescribeVolumesModificationsResult,
-} from "../models/models_5";
-export interface DescribeVolumesModificationsCommandInput
-  extends DescribeVolumesModificationsRequest {}
-export interface DescribeVolumesModificationsCommandOutput
-  extends DescribeVolumesModificationsResult,
-    __MetadataBearer {}
-export declare class DescribeVolumesModificationsCommand extends $Command<
-  DescribeVolumesModificationsCommandInput,
-  DescribeVolumesModificationsCommandOutput,
-  EC2ClientResolvedConfig
-> {
-  readonly input: DescribeVolumesModificationsCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: DescribeVolumesModificationsCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: EC2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<
-    DescribeVolumesModificationsCommandInput,
-    DescribeVolumesModificationsCommandOutput
-  >;
-  private serialize;
-  private deserialize;
-}
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client";
+import { DescribeVolumesModificationsRequest, DescribeVolumesModificationsResult } from "../models/models_5";
+/**
+ * @public
+ *
+ * The input for {@link DescribeVolumesModificationsCommand}.
+ */
+export interface DescribeVolumesModificationsCommandInput extends DescribeVolumesModificationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeVolumesModificationsCommand}.
+ */
+export interface DescribeVolumesModificationsCommandOutput extends DescribeVolumesModificationsResult, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Describes the most recent volume modification request for the specified EBS volumes.</p>
+ *          <p>If a volume has never been modified, some information in the output will be null.
+ *       If a volume has been modified more than once, the output includes only the most
+ *       recent modification request.</p>
+ *          <p>You can also use CloudWatch Events to check the status of a modification to an EBS
+ *       volume. For information about CloudWatch Events, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/">Amazon CloudWatch Events User Guide</a>. For more information, see
+ *         <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html">Monitor the progress of volume modifications</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EC2Client, DescribeVolumesModificationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
+ * // const { EC2Client, DescribeVolumesModificationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
+ * const client = new EC2Client(config);
+ * const input = { // DescribeVolumesModificationsRequest
+ *   DryRun: true || false,
+ *   VolumeIds: [ // VolumeIdStringList
+ *     "STRING_VALUE",
+ *   ],
+ *   Filters: [ // FilterList
+ *     { // Filter
+ *       Name: "STRING_VALUE",
+ *       Values: [ // ValueStringList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   ],
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new DescribeVolumesModificationsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param DescribeVolumesModificationsCommandInput - {@link DescribeVolumesModificationsCommandInput}
+ * @returns {@link DescribeVolumesModificationsCommandOutput}
+ * @see {@link DescribeVolumesModificationsCommandInput} for command's `input` shape.
+ * @see {@link DescribeVolumesModificationsCommandOutput} for command's `response` shape.
+ * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
+ *
+ *
+ */
+export declare class DescribeVolumesModificationsCommand extends $Command<DescribeVolumesModificationsCommandInput, DescribeVolumesModificationsCommandOutput, EC2ClientResolvedConfig> {
+    readonly input: DescribeVolumesModificationsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DescribeVolumesModificationsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EC2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeVolumesModificationsCommandInput, DescribeVolumesModificationsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}