Skip to content

EC2  >  Operations  >  describe_export_image_tasks

describe_export_image_tasks

Operation

describe_export_image_tasks async

describe_export_image_tasks(request: DescribeExportImageTasksInput | DescribeExportImageTasksInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeExportImageTasksOutput
describe_export_image_tasks(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeExportImageTasksInputDict]) -> DescribeExportImageTasksOutput

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

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
DescribeExportImageTasksOutput

An instance of DescribeExportImageTasksOutput.

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

DescribeExportImageTasksInput dataclass

Bases: _SerdeShape

Dataclass for DescribeExportImageTasksInput 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.

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

The IDs of the export image tasks.

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

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

max_results class-attribute instance-attribute
max_results: int | None = ...

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

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

A token that indicates the next page of results.

Dictionaries

DescribeExportImageTasksInputDict

Bases: TypedDict

Dictionary form of DescribeExportImageTasksInput.

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.

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

The IDs of the export image tasks.

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

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

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

A token that indicates the next page of results.

Output

DescribeExportImageTasksOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeExportImageTasksOutput structure.

Attributes

export_image_tasks class-attribute instance-attribute
export_image_tasks: list[ExportImageTask] | None = ...

Information about the export image tasks.

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

The token to use to get the next page of results. This value is null when there are no more results to return.

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.