Skip to content

describe_export_image_tasks

describe_export_image_tasks(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
    export_image_task_ids: Optional[ExportImageTaskIdList] = None,
    max_results: Optional[DescribeExportImageTasksMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeExportImageTasksResult

Describes the specified export image tasks or all of your export image tasks.

Parameters:

  • 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.

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

    Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.

  • export_image_task_ids (Optional[ExportImageTaskIdList], default: None ) –

    The IDs of the export image tasks.

  • max_results (Optional[DescribeExportImageTasksMaxResults], default: None ) –

    The maximum number of results to return in a single call.

  • next_token (Optional[NextToken], default: None ) –

    A token that indicates the next page of results.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_export_image_tasks(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    export_image_task_ids: Optional[
        "capo_ec2.types.export_image_task_id_list.ExportImageTaskIdList"
    ] = None,
    max_results: Optional[
        "capo_ec2.types.describe_export_image_tasks_max_results.DescribeExportImageTasksMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
) -> "capo_ec2.types.describe_export_image_tasks_result.DescribeExportImageTasksResult":
    """<p>Describes the specified export image tasks or all of your export image tasks.</p>

    Args:
        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>
        filters: <p>Filter tasks using the <code>task-state</code> filter and one of the following values: <code>active</code>, <code>completed</code>, <code>deleting</code>, or <code>deleted</code>.</p>
        export_image_task_ids: <p>The IDs of the export image tasks.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>
        next_token: <p>A token that indicates the next page of results.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_export_image_tasks_request.DescribeExportImageTasksRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_export_image_tasks_result.DescribeExportImageTasksResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_export_image_tasks

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_export_image_tasks.describe_export_image_tasks(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeExportImageTasks")
    )
    input_: capo_ec2.types.describe_export_image_tasks_request.DescribeExportImageTasksRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters
    if export_image_task_ids is not None:
        input_["export_image_task_ids"] = export_image_task_ids
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output