Skip to content

EC2  >  Operations  >  describe_replace_root_volume_tasks

describe_replace_root_volume_tasks

Operation

describe_replace_root_volume_tasks async

describe_replace_root_volume_tasks(request: DescribeReplaceRootVolumeTasksInput | DescribeReplaceRootVolumeTasksInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeReplaceRootVolumeTasksOutput
describe_replace_root_volume_tasks(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReplaceRootVolumeTasksInputDict]) -> DescribeReplaceRootVolumeTasksOutput

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

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeReplaceRootVolumeTasksOutput

An instance of DescribeReplaceRootVolumeTasksOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeReplaceRootVolumeTasksInput dataclass

Bases: _SerdeShape

Dataclass for DescribeReplaceRootVolumeTasksInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

Filter to use:

  • instance-id - The ID of the instance for which the root volume replacement task was created.
max_results class-attribute instance-attribute
max_results: int | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

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

replace_root_volume_task_ids class-attribute instance-attribute
replace_root_volume_task_ids: list[str] | None = ...

The ID of the root volume replacement task to view.

Dictionaries

DescribeReplaceRootVolumeTasksInputDict

Bases: TypedDict

Dictionary form of DescribeReplaceRootVolumeTasksInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

Filter to use:

  • instance-id - The ID of the instance for which the root volume replacement task was created.
max_results instance-attribute
max_results: int | None

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.

next_token instance-attribute
next_token: str | None

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

replace_root_volume_task_ids instance-attribute
replace_root_volume_task_ids: Sequence[str] | None

The ID of the root volume replacement task to view.

Output

DescribeReplaceRootVolumeTasksOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeReplaceRootVolumeTasksOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

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.

replace_root_volume_tasks class-attribute instance-attribute
replace_root_volume_tasks: list[ReplaceRootVolumeTask] | None = ...

Information about the root volume replacement task.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.