/
api_op_DescribeBackups.go
243 lines (210 loc) · 7.87 KB
/
api_op_DescribeBackups.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package fsx
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/fsx/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns the description of specific Amazon FSx backups, if a BackupIds value is
// provided for that backup. Otherwise, it returns all backups owned by your AWS
// account in the AWS Region of the endpoint that you're calling. When retrieving
// all backups, you can optionally specify the MaxResults parameter to limit the
// number of backups in a response. If more backups remain, Amazon FSx returns a
// NextToken value in the response. In this case, send a later request with the
// NextToken request parameter set to the value of NextToken from the last
// response. This action is used in an iterative process to retrieve a list of your
// backups. DescribeBackups is called first without a NextTokenvalue. Then the
// action continues to be called with the NextToken parameter set to the value of
// the last NextToken value until a response has no NextToken. When using this
// action, keep the following in mind:
//
// * The implementation might return fewer
// than MaxResults file system descriptions while still including a NextToken
// value.
//
// * The order of backups returned in the response of one DescribeBackups
// call and the order of backups returned across the responses of a multi-call
// iteration is unspecified.
func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInput, optFns ...func(*Options)) (*DescribeBackupsOutput, error) {
if params == nil {
params = &DescribeBackupsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeBackups", params, optFns, addOperationDescribeBackupsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeBackupsOutput)
out.ResultMetadata = metadata
return out, nil
}
// The request object for DescribeBackups operation.
type DescribeBackupsInput struct {
// IDs of the backups you want to retrieve (String). This overrides any filters. If
// any IDs are not found, BackupNotFound will be thrown.
BackupIds []string
// Filters structure. Supported names are file-system-id and backup-type.
Filters []types.Filter
// Maximum number of backups to return in the response (integer). This parameter
// value must be greater than 0. The number of items that Amazon FSx returns is the
// minimum of the MaxResults parameter specified in the request and the service's
// internal maximum number of items per page.
MaxResults *int32
// Opaque pagination token returned from a previous DescribeBackups operation
// (String). If a token present, the action continues the list from where the
// returning call left off.
NextToken *string
}
// Response object for DescribeBackups operation.
type DescribeBackupsOutput struct {
// Any array of backups.
Backups []types.Backup
// This is present if there are more backups than returned in the response
// (String). You can use the NextToken value in the later request to fetch the
// backups.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
func addOperationDescribeBackupsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeBackups{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeBackups{}, 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_opDescribeBackups(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
}
// DescribeBackupsAPIClient is a client that implements the DescribeBackups
// operation.
type DescribeBackupsAPIClient interface {
DescribeBackups(context.Context, *DescribeBackupsInput, ...func(*Options)) (*DescribeBackupsOutput, error)
}
var _ DescribeBackupsAPIClient = (*Client)(nil)
// DescribeBackupsPaginatorOptions is the paginator options for DescribeBackups
type DescribeBackupsPaginatorOptions struct {
// Maximum number of backups to return in the response (integer). This parameter
// value must be greater than 0. The number of items that Amazon FSx returns is the
// minimum of the MaxResults parameter specified in the request and the service's
// internal maximum number of items per page.
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
}
// DescribeBackupsPaginator is a paginator for DescribeBackups
type DescribeBackupsPaginator struct {
options DescribeBackupsPaginatorOptions
client DescribeBackupsAPIClient
params *DescribeBackupsInput
nextToken *string
firstPage bool
}
// NewDescribeBackupsPaginator returns a new DescribeBackupsPaginator
func NewDescribeBackupsPaginator(client DescribeBackupsAPIClient, params *DescribeBackupsInput, optFns ...func(*DescribeBackupsPaginatorOptions)) *DescribeBackupsPaginator {
options := DescribeBackupsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
if params == nil {
params = &DescribeBackupsInput{}
}
return &DescribeBackupsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeBackupsPaginator) HasMorePages() bool {
return p.firstPage || p.nextToken != nil
}
// NextPage retrieves the next DescribeBackups page.
func (p *DescribeBackupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBackupsOutput, 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.DescribeBackups(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_opDescribeBackups(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "fsx",
OperationName: "DescribeBackups",
}
}