Skip to content

describe_replace_root_volume_tasks async

describe_replace_root_volume_tasks(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    replace_root_volume_task_ids: Optional[ReplaceRootVolumeTaskIds] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[DescribeReplaceRootVolumeTasksMaxResults] = None,
    next_token: Optional[NextToken] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeReplaceRootVolumeTasksResult

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

Parameters:

  • replace_root_volume_task_ids (Optional[ReplaceRootVolumeTaskIds], default: None ) –

    The ID of the root volume replacement task to view.

  • filters (Optional[FilterList], default: None ) –

    Filter to use:

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

  • max_results (Optional[DescribeReplaceRootVolumeTasksMaxResults], default: 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 (Optional[NextToken], default: None ) –

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

  • dry_run (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_replace_root_volume_tasks(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    replace_root_volume_task_ids: Optional[
        "capo_ec2.types.replace_root_volume_task_ids.ReplaceRootVolumeTaskIds"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_replace_root_volume_tasks_max_results.DescribeReplaceRootVolumeTasksMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_replace_root_volume_tasks_result.DescribeReplaceRootVolumeTasksResult":
    """<p>Describes a root volume replacement task. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html">Replace a root volume</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        replace_root_volume_task_ids: <p>The ID of the root volume replacement task to view.</p>
        filters: <p>Filter to use:</p> <ul> <li> <p> <code>instance-id</code> - The ID of the instance for which the root volume replacement task was created.</p> </li> </ul>
        max_results: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        next_token: <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_replace_root_volume_tasks_request.DescribeReplaceRootVolumeTasksRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_replace_root_volume_tasks_result.DescribeReplaceRootVolumeTasksResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_replace_root_volume_tasks

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_replace_root_volume_tasks.async_describe_replace_root_volume_tasks(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReplaceRootVolumeTasks")
    )
    input_: capo_ec2.types.describe_replace_root_volume_tasks_request.DescribeReplaceRootVolumeTasksRequest = {}
    if replace_root_volume_task_ids is not None:
        input_["replace_root_volume_task_ids"] = replace_root_volume_task_ids
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output