1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package macie2
4
5import (
6	"context"
7	"fmt"
8	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
10	"github.com/aws/aws-sdk-go-v2/service/macie2/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Retrieves (queries) statistical data and other information about one or more S3
16// buckets that Amazon Macie monitors and analyzes.
17func (c *Client) DescribeBuckets(ctx context.Context, params *DescribeBucketsInput, optFns ...func(*Options)) (*DescribeBucketsOutput, error) {
18	if params == nil {
19		params = &DescribeBucketsInput{}
20	}
21
22	result, metadata, err := c.invokeOperation(ctx, "DescribeBuckets", params, optFns, c.addOperationDescribeBucketsMiddlewares)
23	if err != nil {
24		return nil, err
25	}
26
27	out := result.(*DescribeBucketsOutput)
28	out.ResultMetadata = metadata
29	return out, nil
30}
31
32type DescribeBucketsInput struct {
33
34	// The criteria to use to filter the query results.
35	Criteria map[string]types.BucketCriteriaAdditionalProperties
36
37	// The maximum number of items to include in each page of the response. The default
38	// value is 50.
39	MaxResults int32
40
41	// The nextToken string that specifies which page of results to return in a
42	// paginated response.
43	NextToken *string
44
45	// The criteria to use to sort the query results.
46	SortCriteria *types.BucketSortCriteria
47
48	noSmithyDocumentSerde
49}
50
51type DescribeBucketsOutput struct {
52
53	// An array of objects, one for each bucket that meets the filter criteria
54	// specified in the request.
55	Buckets []types.BucketMetadata
56
57	// The string to use in a subsequent request to get the next page of results in a
58	// paginated response. This value is null if there are no additional pages.
59	NextToken *string
60
61	// Metadata pertaining to the operation's result.
62	ResultMetadata middleware.Metadata
63
64	noSmithyDocumentSerde
65}
66
67func (c *Client) addOperationDescribeBucketsMiddlewares(stack *middleware.Stack, options Options) (err error) {
68	err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeBuckets{}, middleware.After)
69	if err != nil {
70		return err
71	}
72	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeBuckets{}, middleware.After)
73	if err != nil {
74		return err
75	}
76	if err = addSetLoggerMiddleware(stack, options); err != nil {
77		return err
78	}
79	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
80		return err
81	}
82	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
83		return err
84	}
85	if err = addResolveEndpointMiddleware(stack, options); err != nil {
86		return err
87	}
88	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
89		return err
90	}
91	if err = addRetryMiddlewares(stack, options); err != nil {
92		return err
93	}
94	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
95		return err
96	}
97	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
101		return err
102	}
103	if err = addClientUserAgent(stack); err != nil {
104		return err
105	}
106	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeBuckets(options.Region), middleware.Before); err != nil {
113		return err
114	}
115	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
116		return err
117	}
118	if err = addResponseErrorMiddleware(stack); err != nil {
119		return err
120	}
121	if err = addRequestResponseLogging(stack, options); err != nil {
122		return err
123	}
124	return nil
125}
126
127// DescribeBucketsAPIClient is a client that implements the DescribeBuckets
128// operation.
129type DescribeBucketsAPIClient interface {
130	DescribeBuckets(context.Context, *DescribeBucketsInput, ...func(*Options)) (*DescribeBucketsOutput, error)
131}
132
133var _ DescribeBucketsAPIClient = (*Client)(nil)
134
135// DescribeBucketsPaginatorOptions is the paginator options for DescribeBuckets
136type DescribeBucketsPaginatorOptions struct {
137	// The maximum number of items to include in each page of the response. The default
138	// value is 50.
139	Limit int32
140
141	// Set to true if pagination should stop if the service returns a pagination token
142	// that matches the most recent token provided to the service.
143	StopOnDuplicateToken bool
144}
145
146// DescribeBucketsPaginator is a paginator for DescribeBuckets
147type DescribeBucketsPaginator struct {
148	options   DescribeBucketsPaginatorOptions
149	client    DescribeBucketsAPIClient
150	params    *DescribeBucketsInput
151	nextToken *string
152	firstPage bool
153}
154
155// NewDescribeBucketsPaginator returns a new DescribeBucketsPaginator
156func NewDescribeBucketsPaginator(client DescribeBucketsAPIClient, params *DescribeBucketsInput, optFns ...func(*DescribeBucketsPaginatorOptions)) *DescribeBucketsPaginator {
157	if params == nil {
158		params = &DescribeBucketsInput{}
159	}
160
161	options := DescribeBucketsPaginatorOptions{}
162	if params.MaxResults != 0 {
163		options.Limit = params.MaxResults
164	}
165
166	for _, fn := range optFns {
167		fn(&options)
168	}
169
170	return &DescribeBucketsPaginator{
171		options:   options,
172		client:    client,
173		params:    params,
174		firstPage: true,
175	}
176}
177
178// HasMorePages returns a boolean indicating whether more pages are available
179func (p *DescribeBucketsPaginator) HasMorePages() bool {
180	return p.firstPage || p.nextToken != nil
181}
182
183// NextPage retrieves the next DescribeBuckets page.
184func (p *DescribeBucketsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBucketsOutput, error) {
185	if !p.HasMorePages() {
186		return nil, fmt.Errorf("no more pages available")
187	}
188
189	params := *p.params
190	params.NextToken = p.nextToken
191
192	params.MaxResults = p.options.Limit
193
194	result, err := p.client.DescribeBuckets(ctx, &params, optFns...)
195	if err != nil {
196		return nil, err
197	}
198	p.firstPage = false
199
200	prevToken := p.nextToken
201	p.nextToken = result.NextToken
202
203	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
204		p.nextToken = nil
205	}
206
207	return result, nil
208}
209
210func newServiceMetadataMiddleware_opDescribeBuckets(region string) *awsmiddleware.RegisterServiceMetadata {
211	return &awsmiddleware.RegisterServiceMetadata{
212		Region:        region,
213		ServiceID:     ServiceID,
214		SigningName:   "macie2",
215		OperationName: "DescribeBuckets",
216	}
217}
218