DescribeInstanceRefreshes
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AutoScalingGroupName
-
The name of the Auto Scaling group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: Yes
- InstanceRefreshIds.member.N
-
One or more instance refresh IDs.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- MaxRecords
-
The maximum number of items to return with this call. The default value is
50and the maximum value is100.Type: Integer
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
Response Elements
The following elements are returned by the service.
- InstanceRefreshes.member.N
-
The instance refreshes for the specified group, sorted by creation timestamp in descending order.
Type: Array of InstanceRefresh objects
- NextToken
-
A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextTokenvalue when requesting the next set of items. This value is null when there are no more items to return.Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextToken
-
The
NextTokenvalue is not valid.HTTP Status Code: 400
- ResourceContention
-
You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of DescribeInstanceRefreshes.
Sample Request
https://autoscaling.amazonaws.com/?Action=DescribeInstanceRefreshes
&AutoScalingGroupName=my-asg
&Version=2011-01-01
&AUTHPARAMS Sample Response
<DescribeInstanceRefreshesResponse xmlns="https://autoscaling.amazonaws.com/doc/2011-01-01/">
<DescribeInstanceRefreshesResult>
<InstanceRefreshes>
<member>
<InstanceRefreshId>08b91cf7-8fa6-48af-b6a6-d227f40f1b9b</InstanceRefreshId>
<AutoScalingGroupName>my-asg</AutoScalingGroupName>
<Status>InProgress</Status>
<StatusReason>Waiting for instances to warm up before continuing. For example: i-0645704820a8e83ff is warming up.</StatusReason>
<PercentageComplete>50</PercentageComplete>
<InstancesToUpdate>0</InstancesToUpdate>
<StartTime>2023-06-13T16:46:52Z</StartTime>
<Preferences>{}</Preferences>
</member>
</InstanceRefreshes>
</DescribeInstanceRefreshesResult>
<ResponseMetadata>
<RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId>
</ResponseMetadata>
</DescribeInstanceRefreshesResponse> See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
