1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package autoscaling
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/autoscaling/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Describes one or more instance refreshes. You can determine the status of a
15// request by looking at the Status parameter. The following are the possible
16// statuses:
17//
18// * Pending - The request was created, but the operation has not
19// started.
20//
21// * InProgress - The operation is in progress.
22//
23// * Successful - The
24// operation completed successfully.
25//
26// * Failed - The operation failed to complete.
27// You can troubleshoot using the status reason and the scaling activities.
28//
29// *
30// Cancelling - An ongoing operation is being cancelled. Cancellation does not roll
31// back any replacements that have already been completed, but it prevents new
32// replacements from being started.
33//
34// * Cancelled - The operation is cancelled.
35//
36// For
37// more information, see Replacing Auto Scaling Instances Based on an Instance
38// Refresh
39// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html).
40func (c *Client) DescribeInstanceRefreshes(ctx context.Context, params *DescribeInstanceRefreshesInput, optFns ...func(*Options)) (*DescribeInstanceRefreshesOutput, error) {
41	if params == nil {
42		params = &DescribeInstanceRefreshesInput{}
43	}
44
45	result, metadata, err := c.invokeOperation(ctx, "DescribeInstanceRefreshes", params, optFns, addOperationDescribeInstanceRefreshesMiddlewares)
46	if err != nil {
47		return nil, err
48	}
49
50	out := result.(*DescribeInstanceRefreshesOutput)
51	out.ResultMetadata = metadata
52	return out, nil
53}
54
55type DescribeInstanceRefreshesInput struct {
56
57	// The name of the Auto Scaling group.
58	//
59	// This member is required.
60	AutoScalingGroupName *string
61
62	// One or more instance refresh IDs.
63	InstanceRefreshIds []string
64
65	// The maximum number of items to return with this call. The default value is 50
66	// and the maximum value is 100.
67	MaxRecords *int32
68
69	// The token for the next set of items to return. (You received this token from a
70	// previous call.)
71	NextToken *string
72}
73
74type DescribeInstanceRefreshesOutput struct {
75
76	// The instance refreshes for the specified group.
77	InstanceRefreshes []types.InstanceRefresh
78
79	// A string that indicates that the response contains more items than can be
80	// returned in a single response. To receive additional items, specify this string
81	// for the NextToken value when requesting the next set of items. This value is
82	// null when there are no more items to return.
83	NextToken *string
84
85	// Metadata pertaining to the operation's result.
86	ResultMetadata middleware.Metadata
87}
88
89func addOperationDescribeInstanceRefreshesMiddlewares(stack *middleware.Stack, options Options) (err error) {
90	err = stack.Serialize.Add(&awsAwsquery_serializeOpDescribeInstanceRefreshes{}, middleware.After)
91	if err != nil {
92		return err
93	}
94	err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDescribeInstanceRefreshes{}, middleware.After)
95	if err != nil {
96		return err
97	}
98	if err = addSetLoggerMiddleware(stack, options); err != nil {
99		return err
100	}
101	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
102		return err
103	}
104	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
105		return err
106	}
107	if err = addResolveEndpointMiddleware(stack, options); err != nil {
108		return err
109	}
110	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
111		return err
112	}
113	if err = addRetryMiddlewares(stack, options); err != nil {
114		return err
115	}
116	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
117		return err
118	}
119	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
120		return err
121	}
122	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
123		return err
124	}
125	if err = addClientUserAgent(stack); err != nil {
126		return err
127	}
128	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
129		return err
130	}
131	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
132		return err
133	}
134	if err = addOpDescribeInstanceRefreshesValidationMiddleware(stack); err != nil {
135		return err
136	}
137	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeInstanceRefreshes(options.Region), middleware.Before); err != nil {
138		return err
139	}
140	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
141		return err
142	}
143	if err = addResponseErrorMiddleware(stack); err != nil {
144		return err
145	}
146	if err = addRequestResponseLogging(stack, options); err != nil {
147		return err
148	}
149	return nil
150}
151
152func newServiceMetadataMiddleware_opDescribeInstanceRefreshes(region string) *awsmiddleware.RegisterServiceMetadata {
153	return &awsmiddleware.RegisterServiceMetadata{
154		Region:        region,
155		ServiceID:     ServiceID,
156		SigningName:   "autoscaling",
157		OperationName: "DescribeInstanceRefreshes",
158	}
159}
160