1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package opsworks
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/opsworks/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Describes Amazon ECS clusters that are registered with a stack. If you specify
16// only a stack ID, you can use the MaxResults and NextToken parameters to paginate
17// the response. However, AWS OpsWorks Stacks currently supports only one cluster
18// per layer, so the result set has a maximum of one element. Required Permissions:
19// To use this action, an IAM user must have a Show, Deploy, or Manage permissions
20// level for the stack or an attached policy that explicitly grants permission. For
21// more information about user permissions, see Managing User Permissions
22// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html).
23// This call accepts only one resource-identifying parameter.
24func (c *Client) DescribeEcsClusters(ctx context.Context, params *DescribeEcsClustersInput, optFns ...func(*Options)) (*DescribeEcsClustersOutput, error) {
25	if params == nil {
26		params = &DescribeEcsClustersInput{}
27	}
28
29	result, metadata, err := c.invokeOperation(ctx, "DescribeEcsClusters", params, optFns, addOperationDescribeEcsClustersMiddlewares)
30	if err != nil {
31		return nil, err
32	}
33
34	out := result.(*DescribeEcsClustersOutput)
35	out.ResultMetadata = metadata
36	return out, nil
37}
38
39type DescribeEcsClustersInput struct {
40
41	// A list of ARNs, one for each cluster to be described.
42	EcsClusterArns []string
43
44	// To receive a paginated response, use this parameter to specify the maximum
45	// number of results to be returned with a single call. If the number of available
46	// results exceeds this maximum, the response includes a NextToken value that you
47	// can assign to the NextToken request parameter to get the next set of results.
48	MaxResults *int32
49
50	// If the previous paginated request did not return all of the remaining results,
51	// the response object'sNextToken parameter value is set to a token. To retrieve
52	// the next set of results, call DescribeEcsClusters again and assign that token to
53	// the request object's NextToken parameter. If there are no remaining results, the
54	// previous response object's NextToken parameter is set to null.
55	NextToken *string
56
57	// A stack ID. DescribeEcsClusters returns a description of the cluster that is
58	// registered with the stack.
59	StackId *string
60}
61
62// Contains the response to a DescribeEcsClusters request.
63type DescribeEcsClustersOutput struct {
64
65	// A list of EcsCluster objects containing the cluster descriptions.
66	EcsClusters []types.EcsCluster
67
68	// If a paginated request does not return all of the remaining results, this
69	// parameter is set to a token that you can assign to the request object's
70	// NextToken parameter to retrieve the next set of results. If the previous
71	// paginated request returned all of the remaining results, this parameter is set
72	// to null.
73	NextToken *string
74
75	// Metadata pertaining to the operation's result.
76	ResultMetadata middleware.Metadata
77}
78
79func addOperationDescribeEcsClustersMiddlewares(stack *middleware.Stack, options Options) (err error) {
80	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeEcsClusters{}, middleware.After)
81	if err != nil {
82		return err
83	}
84	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeEcsClusters{}, middleware.After)
85	if err != nil {
86		return err
87	}
88	if err = addSetLoggerMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
92		return err
93	}
94	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
95		return err
96	}
97	if err = addResolveEndpointMiddleware(stack, options); err != nil {
98		return err
99	}
100	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
101		return err
102	}
103	if err = addRetryMiddlewares(stack, options); err != nil {
104		return err
105	}
106	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
107		return err
108	}
109	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
110		return err
111	}
112	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
113		return err
114	}
115	if err = addClientUserAgent(stack); err != nil {
116		return err
117	}
118	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
119		return err
120	}
121	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
122		return err
123	}
124	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeEcsClusters(options.Region), middleware.Before); err != nil {
125		return err
126	}
127	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
128		return err
129	}
130	if err = addResponseErrorMiddleware(stack); err != nil {
131		return err
132	}
133	if err = addRequestResponseLogging(stack, options); err != nil {
134		return err
135	}
136	return nil
137}
138
139// DescribeEcsClustersAPIClient is a client that implements the DescribeEcsClusters
140// operation.
141type DescribeEcsClustersAPIClient interface {
142	DescribeEcsClusters(context.Context, *DescribeEcsClustersInput, ...func(*Options)) (*DescribeEcsClustersOutput, error)
143}
144
145var _ DescribeEcsClustersAPIClient = (*Client)(nil)
146
147// DescribeEcsClustersPaginatorOptions is the paginator options for
148// DescribeEcsClusters
149type DescribeEcsClustersPaginatorOptions struct {
150	// To receive a paginated response, use this parameter to specify the maximum
151	// number of results to be returned with a single call. If the number of available
152	// results exceeds this maximum, the response includes a NextToken value that you
153	// can assign to the NextToken request parameter to get the next set of results.
154	Limit int32
155
156	// Set to true if pagination should stop if the service returns a pagination token
157	// that matches the most recent token provided to the service.
158	StopOnDuplicateToken bool
159}
160
161// DescribeEcsClustersPaginator is a paginator for DescribeEcsClusters
162type DescribeEcsClustersPaginator struct {
163	options   DescribeEcsClustersPaginatorOptions
164	client    DescribeEcsClustersAPIClient
165	params    *DescribeEcsClustersInput
166	nextToken *string
167	firstPage bool
168}
169
170// NewDescribeEcsClustersPaginator returns a new DescribeEcsClustersPaginator
171func NewDescribeEcsClustersPaginator(client DescribeEcsClustersAPIClient, params *DescribeEcsClustersInput, optFns ...func(*DescribeEcsClustersPaginatorOptions)) *DescribeEcsClustersPaginator {
172	options := DescribeEcsClustersPaginatorOptions{}
173	if params.MaxResults != nil {
174		options.Limit = *params.MaxResults
175	}
176
177	for _, fn := range optFns {
178		fn(&options)
179	}
180
181	if params == nil {
182		params = &DescribeEcsClustersInput{}
183	}
184
185	return &DescribeEcsClustersPaginator{
186		options:   options,
187		client:    client,
188		params:    params,
189		firstPage: true,
190	}
191}
192
193// HasMorePages returns a boolean indicating whether more pages are available
194func (p *DescribeEcsClustersPaginator) HasMorePages() bool {
195	return p.firstPage || p.nextToken != nil
196}
197
198// NextPage retrieves the next DescribeEcsClusters page.
199func (p *DescribeEcsClustersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEcsClustersOutput, error) {
200	if !p.HasMorePages() {
201		return nil, fmt.Errorf("no more pages available")
202	}
203
204	params := *p.params
205	params.NextToken = p.nextToken
206
207	var limit *int32
208	if p.options.Limit > 0 {
209		limit = &p.options.Limit
210	}
211	params.MaxResults = limit
212
213	result, err := p.client.DescribeEcsClusters(ctx, &params, optFns...)
214	if err != nil {
215		return nil, err
216	}
217	p.firstPage = false
218
219	prevToken := p.nextToken
220	p.nextToken = result.NextToken
221
222	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
223		p.nextToken = nil
224	}
225
226	return result, nil
227}
228
229func newServiceMetadataMiddleware_opDescribeEcsClusters(region string) *awsmiddleware.RegisterServiceMetadata {
230	return &awsmiddleware.RegisterServiceMetadata{
231		Region:        region,
232		ServiceID:     ServiceID,
233		SigningName:   "opsworks",
234		OperationName: "DescribeEcsClusters",
235	}
236}
237