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, 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
49type DescribeBucketsOutput struct {
50
51	// An array of objects, one for each bucket that meets the filter criteria
52	// specified in the request.
53	Buckets []types.BucketMetadata
54
55	// The string to use in a subsequent request to get the next page of results in a
56	// paginated response. This value is null if there are no additional pages.
57	NextToken *string
58
59	// Metadata pertaining to the operation's result.
60	ResultMetadata middleware.Metadata
61}
62
63func addOperationDescribeBucketsMiddlewares(stack *middleware.Stack, options Options) (err error) {
64	err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeBuckets{}, middleware.After)
65	if err != nil {
66		return err
67	}
68	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeBuckets{}, middleware.After)
69	if err != nil {
70		return err
71	}
72	if err = addSetLoggerMiddleware(stack, options); err != nil {
73		return err
74	}
75	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
76		return err
77	}
78	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
79		return err
80	}
81	if err = addResolveEndpointMiddleware(stack, options); err != nil {
82		return err
83	}
84	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
85		return err
86	}
87	if err = addRetryMiddlewares(stack, options); err != nil {
88		return err
89	}
90	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
91		return err
92	}
93	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
94		return err
95	}
96	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
97		return err
98	}
99	if err = addClientUserAgent(stack); err != nil {
100		return err
101	}
102	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
103		return err
104	}
105	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
106		return err
107	}
108	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeBuckets(options.Region), middleware.Before); err != nil {
109		return err
110	}
111	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
112		return err
113	}
114	if err = addResponseErrorMiddleware(stack); err != nil {
115		return err
116	}
117	if err = addRequestResponseLogging(stack, options); err != nil {
118		return err
119	}
120	return nil
121}
122
123// DescribeBucketsAPIClient is a client that implements the DescribeBuckets
124// operation.
125type DescribeBucketsAPIClient interface {
126	DescribeBuckets(context.Context, *DescribeBucketsInput, ...func(*Options)) (*DescribeBucketsOutput, error)
127}
128
129var _ DescribeBucketsAPIClient = (*Client)(nil)
130
131// DescribeBucketsPaginatorOptions is the paginator options for DescribeBuckets
132type DescribeBucketsPaginatorOptions struct {
133	// The maximum number of items to include in each page of the response. The default
134	// value is 50.
135	Limit int32
136
137	// Set to true if pagination should stop if the service returns a pagination token
138	// that matches the most recent token provided to the service.
139	StopOnDuplicateToken bool
140}
141
142// DescribeBucketsPaginator is a paginator for DescribeBuckets
143type DescribeBucketsPaginator struct {
144	options   DescribeBucketsPaginatorOptions
145	client    DescribeBucketsAPIClient
146	params    *DescribeBucketsInput
147	nextToken *string
148	firstPage bool
149}
150
151// NewDescribeBucketsPaginator returns a new DescribeBucketsPaginator
152func NewDescribeBucketsPaginator(client DescribeBucketsAPIClient, params *DescribeBucketsInput, optFns ...func(*DescribeBucketsPaginatorOptions)) *DescribeBucketsPaginator {
153	options := DescribeBucketsPaginatorOptions{}
154	if params.MaxResults != 0 {
155		options.Limit = params.MaxResults
156	}
157
158	for _, fn := range optFns {
159		fn(&options)
160	}
161
162	if params == nil {
163		params = &DescribeBucketsInput{}
164	}
165
166	return &DescribeBucketsPaginator{
167		options:   options,
168		client:    client,
169		params:    params,
170		firstPage: true,
171	}
172}
173
174// HasMorePages returns a boolean indicating whether more pages are available
175func (p *DescribeBucketsPaginator) HasMorePages() bool {
176	return p.firstPage || p.nextToken != nil
177}
178
179// NextPage retrieves the next DescribeBuckets page.
180func (p *DescribeBucketsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBucketsOutput, error) {
181	if !p.HasMorePages() {
182		return nil, fmt.Errorf("no more pages available")
183	}
184
185	params := *p.params
186	params.NextToken = p.nextToken
187
188	params.MaxResults = p.options.Limit
189
190	result, err := p.client.DescribeBuckets(ctx, &params, optFns...)
191	if err != nil {
192		return nil, err
193	}
194	p.firstPage = false
195
196	prevToken := p.nextToken
197	p.nextToken = result.NextToken
198
199	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
200		p.nextToken = nil
201	}
202
203	return result, nil
204}
205
206func newServiceMetadataMiddleware_opDescribeBuckets(region string) *awsmiddleware.RegisterServiceMetadata {
207	return &awsmiddleware.RegisterServiceMetadata{
208		Region:        region,
209		ServiceID:     ServiceID,
210		SigningName:   "macie2",
211		OperationName: "DescribeBuckets",
212	}
213}
214