-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_ListGroupResources.go
293 lines (255 loc) · 10.2 KB
/
api_op_ListGroupResources.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package resourcegroups
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/resourcegroups/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns a list of ARNs of the resources that are members of a specified resource
// group. Minimum permissions To run this command, you must have the following
// permissions:
//
// * resource-groups:ListGroupResources
//
// *
// cloudformation:DescribeStacks
//
// * cloudformation:ListStackResources
//
// *
// tag:GetResources
func (c *Client) ListGroupResources(ctx context.Context, params *ListGroupResourcesInput, optFns ...func(*Options)) (*ListGroupResourcesOutput, error) {
if params == nil {
params = &ListGroupResourcesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListGroupResources", params, optFns, c.addOperationListGroupResourcesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListGroupResourcesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListGroupResourcesInput struct {
// Filters, formatted as ResourceFilter objects, that you want to apply to a
// ListGroupResources operation. Filters the results to include only those of the
// specified resource types.
//
// * resource-type - Filter resources by their type.
// Specify up to five resource types in the format AWS::ServiceCode::ResourceType.
// For example, AWS::EC2::Instance, or AWS::S3::Bucket.
//
// When you specify a
// resource-type filter for ListGroupResources, AWS Resource Groups validates your
// filter resource types against the types that are defined in the query associated
// with the group. For example, if a group contains only S3 buckets because its
// query specifies only that resource type, but your resource-type filter includes
// EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this
// case, a ListGroupResources request returns a BadRequestException error with a
// message similar to the following: The resource types specified as filters in the
// request are not valid. The error includes a list of resource types that failed
// the validation because they are not part of the query associated with the group.
// This validation doesn't occur when the group query specifies AWS::AllSupported,
// because a group based on such a query can contain any of the allowed resource
// types for the query type (tag-based or AWS CloudFormation stack-based queries).
Filters []types.ResourceFilter
// The name or the ARN of the resource group
Group *string
// Deprecated - don't use this parameter. Use the Group request field instead.
//
// Deprecated: This field is deprecated, use Group instead.
GroupName *string
// The total number of results that you want included on each page of the response.
// If you do not include this parameter, it defaults to a value that is specific to
// the operation. If additional items exist beyond the maximum you specify, the
// NextToken response element is present and has a value (is not null). Include
// that value as the NextToken request parameter in the next call to the operation
// to get the next part of the results. Note that the service might return fewer
// results than the maximum even when there are more results available. You should
// check NextToken after every operation to ensure that you receive all of the
// results.
MaxResults *int32
// The parameter for receiving additional results if you receive a NextToken
// response in a previous request. A NextToken response indicates that more output
// is available. Set this parameter to the value provided by a previous call's
// NextToken response to indicate where the output should continue from.
NextToken *string
noSmithyDocumentSerde
}
type ListGroupResourcesOutput struct {
// If present, indicates that more output is available than is included in the
// current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null.
NextToken *string
// A list of QueryError objects. Each error is an object that contains ErrorCode
// and Message structures. Possible values for ErrorCode are
// CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
QueryErrors []types.QueryError
// Deprecated - don't use this parameter. Use the Resources response field instead.
//
// Deprecated: This field is deprecated, use Resources instead.
ResourceIdentifiers []types.ResourceIdentifier
// An array of resources from which you can determine each resource's identity,
// type, and group membership status.
Resources []types.ListGroupResourcesItem
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListGroupResourcesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListGroupResources{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListGroupResources{}, 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 = addOpListGroupResourcesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListGroupResources(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
}
// ListGroupResourcesAPIClient is a client that implements the ListGroupResources
// operation.
type ListGroupResourcesAPIClient interface {
ListGroupResources(context.Context, *ListGroupResourcesInput, ...func(*Options)) (*ListGroupResourcesOutput, error)
}
var _ ListGroupResourcesAPIClient = (*Client)(nil)
// ListGroupResourcesPaginatorOptions is the paginator options for
// ListGroupResources
type ListGroupResourcesPaginatorOptions struct {
// The total number of results that you want included on each page of the response.
// If you do not include this parameter, it defaults to a value that is specific to
// the operation. If additional items exist beyond the maximum you specify, the
// NextToken response element is present and has a value (is not null). Include
// that value as the NextToken request parameter in the next call to the operation
// to get the next part of the results. Note that the service might return fewer
// results than the maximum even when there are more results available. You should
// check NextToken after every operation to ensure that you receive all of the
// results.
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
}
// ListGroupResourcesPaginator is a paginator for ListGroupResources
type ListGroupResourcesPaginator struct {
options ListGroupResourcesPaginatorOptions
client ListGroupResourcesAPIClient
params *ListGroupResourcesInput
nextToken *string
firstPage bool
}
// NewListGroupResourcesPaginator returns a new ListGroupResourcesPaginator
func NewListGroupResourcesPaginator(client ListGroupResourcesAPIClient, params *ListGroupResourcesInput, optFns ...func(*ListGroupResourcesPaginatorOptions)) *ListGroupResourcesPaginator {
if params == nil {
params = &ListGroupResourcesInput{}
}
options := ListGroupResourcesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListGroupResourcesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListGroupResourcesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListGroupResources page.
func (p *ListGroupResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupResourcesOutput, 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.ListGroupResources(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_opListGroupResources(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "resource-groups",
OperationName: "ListGroupResources",
}
}