paws.management (version 0.1.12)

autoscaling_describe_instance_refreshes: Describes one or more instance refreshes

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:

• Pending - The request was created, but the operation has not started.

• InProgress - The operation is in progress.

• Successful - The operation completed successfully.

• Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

• Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

• Cancelled - The operation is cancelled.

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

Usage

autoscaling_describe_instance_refreshes(AutoScalingGroupName,
  InstanceRefreshIds, NextToken, MaxRecords)

Value

A list with the following syntax:

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"
)

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.

Request syntax

svc$describe_instance_refreshes(
  AutoScalingGroupName = "string",
  InstanceRefreshIds = list(
    "string"
  ),
  NextToken = "string",
  MaxRecords = 123
)

Examples

if (FALSE) {
# This example describes the instance refreshes for the specified Auto
# Scaling group.
svc$describe_instance_refreshes(
  AutoScalingGroupName = "my-auto-scaling-group"
)
}