/
DescribeVolumeAttributeCommand.ts
157 lines (146 loc) · 5.68 KB
/
DescribeVolumeAttributeCommand.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
// smithy-typescript generated code
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
import { Command as $Command } from "@aws-sdk/smithy-client";
import {
FinalizeHandlerArguments,
Handler,
HandlerExecutionContext,
HttpHandlerOptions as __HttpHandlerOptions,
MetadataBearer as __MetadataBearer,
MiddlewareStack,
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";
import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client";
import { DescribeVolumeAttributeRequest } from "../models/models_4";
import { DescribeVolumeAttributeResult } from "../models/models_5";
import { de_DescribeVolumeAttributeCommand, se_DescribeVolumeAttributeCommand } from "../protocols/Aws_ec2";
/**
* @public
*
* The input for {@link DescribeVolumeAttributeCommand}.
*/
export interface DescribeVolumeAttributeCommandInput extends DescribeVolumeAttributeRequest {}
/**
* @public
*
* The output of {@link DescribeVolumeAttributeCommand}.
*/
export interface DescribeVolumeAttributeCommandOutput extends DescribeVolumeAttributeResult, __MetadataBearer {}
/**
* @public
* <p>Describes the specified attribute of the specified volume. You can specify only one
* attribute at a time.</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, DescribeVolumeAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import
* // const { EC2Client, DescribeVolumeAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
* const client = new EC2Client(config);
* const input = { // DescribeVolumeAttributeRequest
* Attribute: "autoEnableIO" || "productCodes", // required
* VolumeId: "STRING_VALUE", // required
* DryRun: true || false,
* };
* const command = new DescribeVolumeAttributeCommand(input);
* const response = await client.send(command);
* ```
*
* @param DescribeVolumeAttributeCommandInput - {@link DescribeVolumeAttributeCommandInput}
* @returns {@link DescribeVolumeAttributeCommandOutput}
* @see {@link DescribeVolumeAttributeCommandInput} for command's `input` shape.
* @see {@link DescribeVolumeAttributeCommandOutput} for command's `response` shape.
* @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
*
*
* @example To describe a volume attribute
* ```javascript
* // This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.
* const input = {
* "Attribute": "autoEnableIO",
* "VolumeId": "vol-049df61146c4d7901"
* };
* const command = new DescribeVolumeAttributeCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "AutoEnableIO": {
* "Value": false
* },
* "VolumeId": "vol-049df61146c4d7901"
* }
* *\/
* // example id: to-describe-a-volume-attribute-1472505773492
* ```
*
*/
export class DescribeVolumeAttributeCommand extends $Command<
DescribeVolumeAttributeCommandInput,
DescribeVolumeAttributeCommandOutput,
EC2ClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
return {
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
Endpoint: { type: "builtInParams", name: "endpoint" },
Region: { type: "builtInParams", name: "region" },
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
};
}
/**
* @public
*/
constructor(readonly input: DescribeVolumeAttributeCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: EC2ClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<DescribeVolumeAttributeCommandInput, DescribeVolumeAttributeCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, DescribeVolumeAttributeCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "EC2Client";
const commandName = "DescribeVolumeAttributeCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: (_: any) => _,
outputFilterSensitiveLog: (_: any) => _,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments<any>) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
/**
* @internal
*/
private serialize(input: DescribeVolumeAttributeCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_DescribeVolumeAttributeCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<DescribeVolumeAttributeCommandOutput> {
return de_DescribeVolumeAttributeCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}