autoscaling_describe_instance_refreshes: Describes one or more instance refreshes

Description Usage Arguments Value Request syntax Examples

View source: R/autoscaling_operations.R

Description

Describes one or more instance refreshes.

You can determine the status of a request by looking at the Status parameter. The following are the possible statuses:

For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.

Usage

1
2
autoscaling_describe_instance_refreshes(AutoScalingGroupName,
  InstanceRefreshIds, NextToken, MaxRecords)

Arguments

AutoScalingGroupName

[required] The name of the Auto Scaling group.

InstanceRefreshIds

One or more instance refresh IDs.

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

MaxRecords

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
list(
  InstanceRefreshes = list(
    list(
      InstanceRefreshId = "string",
      AutoScalingGroupName = "string",
      Status = "Pending"|"InProgress"|"Successful"|"Failed"|"Cancelling"|"Cancelled",
      StatusReason = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      PercentageComplete = 123,
      InstancesToUpdate = 123
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
6
7
8
svc$describe_instance_refreshes(
  AutoScalingGroupName = "string",
  InstanceRefreshIds = list(
    "string"
  ),
  NextToken = "string",
  MaxRecords = 123
)

Examples

1
2
3
4
5
6
7
8
## Not run: 
# This example describes the instance refreshes for the specified Auto
# Scaling group.
svc$describe_instance_refreshes(
  AutoScalingGroupName = "my-auto-scaling-group"
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.