DescribeReplaceRootVolumeTasks
Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon EC2 User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- 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 isUnauthorizedOperation
.Type: Boolean
Required: No
- Filter.N
-
Filter to use:
-
instance-id
- The ID of the instance for which the root volume replacement task was created.
Type: Array of Filter objects
Required: No
-
- 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- NextToken
-
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Type: String
Required: No
- ReplaceRootVolumeTaskId.N
-
The ID of the root volume replacement task to view.
Type: Array of strings
Required: No
Response Elements
The following elements are returned by the service.
- nextToken
-
The token to include in another request to get the next page of items. This value is
null
when there are no more items to return.Type: String
- replaceRootVolumeTaskSet
-
Information about the root volume replacement task.
Type: Array of ReplaceRootVolumeTask objects
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: