describe_store_image_tasks¶
Operation¶
describe_store_image_tasks
async
¶
describe_store_image_tasks(request: DescribeStoreImageTasksInput | DescribeStoreImageTasksInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeStoreImageTasksOutput
describe_store_image_tasks(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeStoreImageTasksInputDict]) -> DescribeStoreImageTasksOutput
Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress,
Completed, or Failed. For tasks InProgress, the response shows the
estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using S3 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 |
|---|---|
DescribeStoreImageTasksOutput
|
An instance of |
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¶
DescribeStoreImageTasksInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeStoreImageTasksInput 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
¶
The filters.
-
task-state- Returns tasks in a certain state (InProgress|Completed|Failed) -
bucket- Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.
Note
When you specify the ImageIds parameter, any filters that you specify
are ignored. To use the filters, you must remove the ImageIds
parameter.
image_ids
class-attribute
instance-attribute
¶
The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
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.
You cannot specify this parameter and the ImageIds parameter in the
same call.
Dictionaries¶
DescribeStoreImageTasksInputDict
¶
Bases: TypedDict
Dictionary form of DescribeStoreImageTasksInput.
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
The filters.
-
task-state- Returns tasks in a certain state (InProgress|Completed|Failed) -
bucket- Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.
Note
When you specify the ImageIds parameter, any filters that you specify
are ignored. To use the filters, you must remove the ImageIds
parameter.
image_ids
instance-attribute
¶
The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
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.
You cannot specify this parameter and the ImageIds parameter in the
same call.
Output¶
DescribeStoreImageTasksOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeStoreImageTasksOutput 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.
response_metadata
class-attribute
instance-attribute
¶
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.
store_image_task_results
class-attribute
instance-attribute
¶
store_image_task_results: list[StoreImageTaskResult] | None = ...
The information about the AMI store tasks.