-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_DescribeVolumeStatus.go
307 lines (271 loc) · 11.1 KB
/
api_op_DescribeVolumeStatus.go
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
// Code generated by smithy-go-codegen DO NOT EDIT.
package ec2
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ec2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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. The DescribeVolumeStatus operation provides the following information
// about the specified volumes: Status: Reflects the current status of the volume.
// The possible values are ok, impaired , warning, or insufficient-data. If all
// checks pass, the overall status of the volume is ok. If the check fails, the
// overall status is impaired. If the status is insufficient-data, 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 Monitor the
// status of your volumes
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html)
// in the Amazon Elastic Compute Cloud User Guide. Events: Reflect the cause of a
// volume status and might require you to take action. For example, if your volume
// returns an impaired status, then the volume event might be
// potential-data-inconsistency. 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. Actions: Reflect the actions you might have to take in
// response to an event. For example, if the status of the volume is impaired and
// the volume event shows potential-data-inconsistency, then the action shows
// enable-volume-io. This means that you may want to enable the I/O operations for
// the volume by calling the EnableVolumeIO action and then check the volume for
// data consistency. 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 error state (for example, when a volume is incapable of accepting I/O.)
func (c *Client) DescribeVolumeStatus(ctx context.Context, params *DescribeVolumeStatusInput, optFns ...func(*Options)) (*DescribeVolumeStatusOutput, error) {
if params == nil {
params = &DescribeVolumeStatusInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeVolumeStatus", params, optFns, c.addOperationDescribeVolumeStatusMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeVolumeStatusOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeVolumeStatusInput struct {
// Checks whether you have the required permissions for the action, without
// actually making the request, and provides an error response. If you have the
// required permissions, the error response is DryRunOperation. Otherwise, it is
// UnauthorizedOperation.
DryRun *bool
// The filters.
//
// * action.code - The action code for the event (for example,
// enable-volume-io).
//
// * action.description - A description of the action.
//
// *
// action.event-id - The event ID associated with the action.
//
// * availability-zone
// - The Availability Zone of the instance.
//
// * event.description - A description of
// the event.
//
// * event.event-id - The event ID.
//
// * event.event-type - The event
// type (for io-enabled: passed | failed; for io-performance:
// io-performance:degraded | io-performance:severely-degraded |
// io-performance:stalled).
//
// * event.not-after - The latest end time for the
// event.
//
// * event.not-before - The earliest start time for the event.
//
// *
// volume-status.details-name - The cause for volume-status.status (io-enabled |
// io-performance).
//
// * volume-status.details-status - The status of
// volume-status.details-name (for io-enabled: passed | failed; for io-performance:
// normal | degraded | severely-degraded | stalled).
//
// * volume-status.status - The
// status of the volume (ok | impaired | warning | insufficient-data).
Filters []types.Filter
// The maximum number of volume results returned by DescribeVolumeStatus in
// paginated output. When this parameter is used, the request only returns
// MaxResults results in a single page along with a NextToken response element. The
// remaining results of the initial request can be seen by sending another request
// with the returned NextToken value. This value can be between 5 and 1,000; if
// MaxResults is given a value larger than 1,000, only 1,000 results are returned.
// If this parameter is not used, then DescribeVolumeStatus returns all results.
// You cannot specify this parameter and the volume IDs parameter in the same
// request.
MaxResults *int32
// The NextToken value to include in a future DescribeVolumeStatus request. When
// the results of the request exceed MaxResults, this value can be used to retrieve
// the next page of results. This value is null when there are no more results to
// return.
NextToken *string
// The IDs of the volumes. Default: Describes all your volumes.
VolumeIds []string
noSmithyDocumentSerde
}
type DescribeVolumeStatusOutput struct {
// The token to use to retrieve the next page of results. This value is null when
// there are no more results to return.
NextToken *string
// Information about the status of the volumes.
VolumeStatuses []types.VolumeStatusItem
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeVolumeStatusMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsEc2query_serializeOpDescribeVolumeStatus{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsEc2query_deserializeOpDescribeVolumeStatus{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeVolumeStatus(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// DescribeVolumeStatusAPIClient is a client that implements the
// DescribeVolumeStatus operation.
type DescribeVolumeStatusAPIClient interface {
DescribeVolumeStatus(context.Context, *DescribeVolumeStatusInput, ...func(*Options)) (*DescribeVolumeStatusOutput, error)
}
var _ DescribeVolumeStatusAPIClient = (*Client)(nil)
// DescribeVolumeStatusPaginatorOptions is the paginator options for
// DescribeVolumeStatus
type DescribeVolumeStatusPaginatorOptions struct {
// The maximum number of volume results returned by DescribeVolumeStatus in
// paginated output. When this parameter is used, the request only returns
// MaxResults results in a single page along with a NextToken response element. The
// remaining results of the initial request can be seen by sending another request
// with the returned NextToken value. This value can be between 5 and 1,000; if
// MaxResults is given a value larger than 1,000, only 1,000 results are returned.
// If this parameter is not used, then DescribeVolumeStatus returns all results.
// You cannot specify this parameter and the volume IDs parameter in the same
// request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// DescribeVolumeStatusPaginator is a paginator for DescribeVolumeStatus
type DescribeVolumeStatusPaginator struct {
options DescribeVolumeStatusPaginatorOptions
client DescribeVolumeStatusAPIClient
params *DescribeVolumeStatusInput
nextToken *string
firstPage bool
}
// NewDescribeVolumeStatusPaginator returns a new DescribeVolumeStatusPaginator
func NewDescribeVolumeStatusPaginator(client DescribeVolumeStatusAPIClient, params *DescribeVolumeStatusInput, optFns ...func(*DescribeVolumeStatusPaginatorOptions)) *DescribeVolumeStatusPaginator {
if params == nil {
params = &DescribeVolumeStatusInput{}
}
options := DescribeVolumeStatusPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &DescribeVolumeStatusPaginator{
options: options,
client: client,
params: params,
firstPage: true,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeVolumeStatusPaginator) HasMorePages() bool {
return p.firstPage || p.nextToken != nil
}
// NextPage retrieves the next DescribeVolumeStatus page.
func (p *DescribeVolumeStatusPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeVolumeStatusOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.DescribeVolumeStatus(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opDescribeVolumeStatus(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ec2",
OperationName: "DescribeVolumeStatus",
}
}