list_volumes_in_recycle_bin¶
Operation¶
list_volumes_in_recycle_bin
¶
list_volumes_in_recycle_bin(request: ListVolumesInRecycleBinInput | ListVolumesInRecycleBinInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListVolumesInRecycleBinInputDict]) -> ListVolumesInRecycleBinOutput
Lists one or more volumes that are currently in the Recycle Bin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListVolumesInRecycleBinInput | ListVolumesInRecycleBinInputDict | 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[ListVolumesInRecycleBinInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListVolumesInRecycleBinOutput
|
An instance of |
list_volumes_in_recycle_bin
async
¶
list_volumes_in_recycle_bin(request: ListVolumesInRecycleBinInput | ListVolumesInRecycleBinInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListVolumesInRecycleBinInputDict]) -> ListVolumesInRecycleBinOutput
Lists one or more volumes that are currently in the Recycle Bin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListVolumesInRecycleBinInput | ListVolumesInRecycleBinInputDict | 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[ListVolumesInRecycleBinInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListVolumesInRecycleBinOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListVolumesInRecycleBinInputDict
¶
Bases: TypedDict
Dictionary form of ListVolumesInRecycleBinInput.
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.
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.
Valid range: 5 - 500
ListVolumesInRecycleBinInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListVolumesInRecycleBinInput 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.
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.
Valid range: 5 - 500
Output¶
ListVolumesInRecycleBinOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListVolumesInRecycleBinOutput 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.
volumes
class-attribute
instance-attribute
¶
volumes: list[VolumeRecycleBinInfo] | None = ...
Information about the volumes.