Describe Replace Root Volume Tasks

ec2_describe_replace_root_volume_tasks

R Documentation

Describes a root volume replacement task¶

Description¶

Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon EC2 User Guide.

Usage¶

ec2_describe_replace_root_volume_tasks(ReplaceRootVolumeTaskIds,
  Filters, MaxResults, NextToken, DryRun)

Arguments¶

ReplaceRootVolumeTaskIds

The ID of the root volume replacement task to view.

Filters

Filter to use:

instance-id - The ID of the instance for which the root volume replacement task was created.

MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value¶

A list with the following syntax:

list(
  ReplaceRootVolumeTasks = list(
    list(
      ReplaceRootVolumeTaskId = "string",
      InstanceId = "string",
      TaskState = "pending"|"in-progress"|"failing"|"succeeded"|"failed"|"failed-detached",
      StartTime = "string",
      CompleteTime = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      ImageId = "string",
      SnapshotId = "string",
      DeleteReplacedRootVolume = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_replace_root_volume_tasks(
  ReplaceRootVolumeTaskIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE
)