1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package opsworkscm
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/opsworkscm/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Lists all configuration management servers that are identified with your
16// account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks
17// CM does not query other services. This operation is synchronous. A
18// ResourceNotFoundException is thrown when the server does not exist. A
19// ValidationException is raised when parameters of the request are not valid.
20func (c *Client) DescribeServers(ctx context.Context, params *DescribeServersInput, optFns ...func(*Options)) (*DescribeServersOutput, error) {
21	if params == nil {
22		params = &DescribeServersInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "DescribeServers", params, optFns, addOperationDescribeServersMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*DescribeServersOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35type DescribeServersInput struct {
36
37	// This is not currently implemented for DescribeServers requests.
38	MaxResults *int32
39
40	// This is not currently implemented for DescribeServers requests.
41	NextToken *string
42
43	// Describes the server with the specified ServerName.
44	ServerName *string
45}
46
47type DescribeServersOutput struct {
48
49	// This is not currently implemented for DescribeServers requests.
50	NextToken *string
51
52	// Contains the response to a DescribeServers request. For Chef Automate servers:
53	// If DescribeServersResponse$Servers$EngineAttributes includes
54	// CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef
55	// Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must
56	// have had at least one successful maintenance run after November 1, 2019. For
57	// Puppet Server: DescribeServersResponse$Servers$EngineAttributes contains
58	// PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by the
59	// Puppet API over TCP port number 8140. The CA certificate is also used to sign
60	// node certificates.
61	Servers []types.Server
62
63	// Metadata pertaining to the operation's result.
64	ResultMetadata middleware.Metadata
65}
66
67func addOperationDescribeServersMiddlewares(stack *middleware.Stack, options Options) (err error) {
68	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeServers{}, middleware.After)
69	if err != nil {
70		return err
71	}
72	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeServers{}, 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_opDescribeServers(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// DescribeServersAPIClient is a client that implements the DescribeServers
128// operation.
129type DescribeServersAPIClient interface {
130	DescribeServers(context.Context, *DescribeServersInput, ...func(*Options)) (*DescribeServersOutput, error)
131}
132
133var _ DescribeServersAPIClient = (*Client)(nil)
134
135// DescribeServersPaginatorOptions is the paginator options for DescribeServers
136type DescribeServersPaginatorOptions struct {
137	// This is not currently implemented for DescribeServers requests.
138	Limit int32
139
140	// Set to true if pagination should stop if the service returns a pagination token
141	// that matches the most recent token provided to the service.
142	StopOnDuplicateToken bool
143}
144
145// DescribeServersPaginator is a paginator for DescribeServers
146type DescribeServersPaginator struct {
147	options   DescribeServersPaginatorOptions
148	client    DescribeServersAPIClient
149	params    *DescribeServersInput
150	nextToken *string
151	firstPage bool
152}
153
154// NewDescribeServersPaginator returns a new DescribeServersPaginator
155func NewDescribeServersPaginator(client DescribeServersAPIClient, params *DescribeServersInput, optFns ...func(*DescribeServersPaginatorOptions)) *DescribeServersPaginator {
156	options := DescribeServersPaginatorOptions{}
157	if params.MaxResults != nil {
158		options.Limit = *params.MaxResults
159	}
160
161	for _, fn := range optFns {
162		fn(&options)
163	}
164
165	if params == nil {
166		params = &DescribeServersInput{}
167	}
168
169	return &DescribeServersPaginator{
170		options:   options,
171		client:    client,
172		params:    params,
173		firstPage: true,
174	}
175}
176
177// HasMorePages returns a boolean indicating whether more pages are available
178func (p *DescribeServersPaginator) HasMorePages() bool {
179	return p.firstPage || p.nextToken != nil
180}
181
182// NextPage retrieves the next DescribeServers page.
183func (p *DescribeServersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeServersOutput, error) {
184	if !p.HasMorePages() {
185		return nil, fmt.Errorf("no more pages available")
186	}
187
188	params := *p.params
189	params.NextToken = p.nextToken
190
191	var limit *int32
192	if p.options.Limit > 0 {
193		limit = &p.options.Limit
194	}
195	params.MaxResults = limit
196
197	result, err := p.client.DescribeServers(ctx, &params, optFns...)
198	if err != nil {
199		return nil, err
200	}
201	p.firstPage = false
202
203	prevToken := p.nextToken
204	p.nextToken = result.NextToken
205
206	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
207		p.nextToken = nil
208	}
209
210	return result, nil
211}
212
213func newServiceMetadataMiddleware_opDescribeServers(region string) *awsmiddleware.RegisterServiceMetadata {
214	return &awsmiddleware.RegisterServiceMetadata{
215		Region:        region,
216		ServiceID:     ServiceID,
217		SigningName:   "opsworks-cm",
218		OperationName: "DescribeServers",
219	}
220}
221