File: api_op_DescribeRecoverySnapshots.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (240 lines) | stat: -rw-r--r-- 7,261 bytes parent folder | download
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
// Code generated by smithy-go-codegen DO NOT EDIT.

package drs

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/drs/types"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
)

// Lists all Recovery Snapshots for a single Source Server.
func (c *Client) DescribeRecoverySnapshots(ctx context.Context, params *DescribeRecoverySnapshotsInput, optFns ...func(*Options)) (*DescribeRecoverySnapshotsOutput, error) {
	if params == nil {
		params = &DescribeRecoverySnapshotsInput{}
	}

	result, metadata, err := c.invokeOperation(ctx, "DescribeRecoverySnapshots", params, optFns, c.addOperationDescribeRecoverySnapshotsMiddlewares)
	if err != nil {
		return nil, err
	}

	out := result.(*DescribeRecoverySnapshotsOutput)
	out.ResultMetadata = metadata
	return out, nil
}

type DescribeRecoverySnapshotsInput struct {

	// Filter Recovery Snapshots by Source Server ID.
	//
	// This member is required.
	SourceServerID *string

	// A set of filters by which to return Recovery Snapshots.
	Filters *types.DescribeRecoverySnapshotsRequestFilters

	// Maximum number of Recovery Snapshots to retrieve.
	MaxResults int32

	// The token of the next Recovery Snapshot to retrieve.
	NextToken *string

	// The sorted ordering by which to return Recovery Snapshots.
	Order types.RecoverySnapshotsOrder

	noSmithyDocumentSerde
}

type DescribeRecoverySnapshotsOutput struct {

	// An array of Recovery Snapshots.
	Items []types.RecoverySnapshot

	// The token of the next Recovery Snapshot to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata

	noSmithyDocumentSerde
}

func (c *Client) addOperationDescribeRecoverySnapshotsMiddlewares(stack *middleware.Stack, options Options) (err error) {
	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
		return err
	}
	err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeRecoverySnapshots{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeRecoverySnapshots{}, middleware.After)
	if err != nil {
		return err
	}
	if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeRecoverySnapshots"); err != nil {
		return fmt.Errorf("add protocol finalizers: %v", err)
	}

	if err = addlegacyEndpointContextSetter(stack, options); 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
		return err
	}
	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
		return err
	}
	if err = addClientUserAgent(stack, options); err != nil {
		return err
	}
	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
		return err
	}
	if err = addOpDescribeRecoverySnapshotsValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeRecoverySnapshots(options.Region), middleware.Before); err != nil {
		return err
	}
	if err = awsmiddleware.AddRecursionDetection(stack); 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
	}
	if err = addDisableHTTPSMiddleware(stack, options); err != nil {
		return err
	}
	return nil
}

// DescribeRecoverySnapshotsAPIClient is a client that implements the
// DescribeRecoverySnapshots operation.
type DescribeRecoverySnapshotsAPIClient interface {
	DescribeRecoverySnapshots(context.Context, *DescribeRecoverySnapshotsInput, ...func(*Options)) (*DescribeRecoverySnapshotsOutput, error)
}

var _ DescribeRecoverySnapshotsAPIClient = (*Client)(nil)

// DescribeRecoverySnapshotsPaginatorOptions is the paginator options for
// DescribeRecoverySnapshots
type DescribeRecoverySnapshotsPaginatorOptions struct {
	// Maximum number of Recovery Snapshots to retrieve.
	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
}

// DescribeRecoverySnapshotsPaginator is a paginator for DescribeRecoverySnapshots
type DescribeRecoverySnapshotsPaginator struct {
	options   DescribeRecoverySnapshotsPaginatorOptions
	client    DescribeRecoverySnapshotsAPIClient
	params    *DescribeRecoverySnapshotsInput
	nextToken *string
	firstPage bool
}

// NewDescribeRecoverySnapshotsPaginator returns a new
// DescribeRecoverySnapshotsPaginator
func NewDescribeRecoverySnapshotsPaginator(client DescribeRecoverySnapshotsAPIClient, params *DescribeRecoverySnapshotsInput, optFns ...func(*DescribeRecoverySnapshotsPaginatorOptions)) *DescribeRecoverySnapshotsPaginator {
	if params == nil {
		params = &DescribeRecoverySnapshotsInput{}
	}

	options := DescribeRecoverySnapshotsPaginatorOptions{}
	if params.MaxResults != 0 {
		options.Limit = params.MaxResults
	}

	for _, fn := range optFns {
		fn(&options)
	}

	return &DescribeRecoverySnapshotsPaginator{
		options:   options,
		client:    client,
		params:    params,
		firstPage: true,
		nextToken: params.NextToken,
	}
}

// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeRecoverySnapshotsPaginator) HasMorePages() bool {
	return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}

// NextPage retrieves the next DescribeRecoverySnapshots page.
func (p *DescribeRecoverySnapshotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRecoverySnapshotsOutput, error) {
	if !p.HasMorePages() {
		return nil, fmt.Errorf("no more pages available")
	}

	params := *p.params
	params.NextToken = p.nextToken

	params.MaxResults = p.options.Limit

	result, err := p.client.DescribeRecoverySnapshots(ctx, &params, 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_opDescribeRecoverySnapshots(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		OperationName: "DescribeRecoverySnapshots",
	}
}