Skip to content

list_images_in_recycle_bin

Operation

list_images_in_recycle_bin

list_images_in_recycle_bin(request: ListImagesInRecycleBinInput | ListImagesInRecycleBinInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListImagesInRecycleBinInputDict]) -> ListImagesInRecycleBinOutput

Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.

Parameters:

Name Type Description Default
request ListImagesInRecycleBinInput | ListImagesInRecycleBinInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListImagesInRecycleBinInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListImagesInRecycleBinOutput

An instance of ListImagesInRecycleBinOutput.

list_images_in_recycle_bin async

list_images_in_recycle_bin(request: ListImagesInRecycleBinInput | ListImagesInRecycleBinInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListImagesInRecycleBinInputDict]) -> ListImagesInRecycleBinOutput

Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.

Parameters:

Name Type Description Default
request ListImagesInRecycleBinInput | ListImagesInRecycleBinInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListImagesInRecycleBinInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListImagesInRecycleBinOutput

An instance of ListImagesInRecycleBinOutput.

Input

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

ListImagesInRecycleBinInputDict

Bases: TypedDict

Dictionary form of ListImagesInRecycleBinInput.

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.

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

The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single 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.

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.

ListImagesInRecycleBinInput dataclass

Bases: _SerdeShape

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

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

The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single 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.

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.

Output

ListImagesInRecycleBinOutput dataclass

Bases: _SerdeShape

Dataclass for ListImagesInRecycleBinOutput structure.

Attributes

images class-attribute instance-attribute
images: list[ImageRecycleBinInfo] | None = ...

Information about the AMIs.

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