describe_volumes¶
Operation¶
describe_volumes
async
¶
describe_volumes(request: DescribeVolumesInput | DescribeVolumesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeVolumesOutput
describe_volumes(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVolumesInputDict]) -> DescribeVolumesOutput
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
Warning
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
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 |
|---|---|
DescribeVolumesOutput
|
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¶
DescribeVolumesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVolumesInput 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.
-
attachment.attach-time- The time stamp when the attachment initiated. -
attachment.delete-on-termination- Whether the volume is deleted on instance termination. -
attachment.device- The device name specified in the block device mapping (for example,/dev/sda1). -
attachment.instance-id- The ID of the instance the volume is attached to. -
attachment.status- The attachment state (attaching|attached|detaching). -
availability-zone- The Availability Zone in which the volume was created. -
availability-zone-id- The ID of the Availability Zone in which the volume was created. -
create-time- The time stamp when the volume was created. -
encrypted- Indicates whether the volume is encrypted (true|false) -
fast-restored- Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true|false). -
multi-attach-enabled- Indicates whether the volume is enabled for Multi-Attach (true|false) -
operator.managed- A Boolean that indicates whether this is a managed volume. -
operator.principal- The principal that manages the volume. Only valid for managed volumes, wheremanagedistrue. -
size- The size of the volume, in GiB. -
snapshot-id- The snapshot from which the volume was created. -
status- The state of the volume (creating|available|in-use|deleting|deleted|error). -
tag:<key>- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
volume-id- The volume ID. -
volume-type- The Amazon EBS volume type (gp2|gp3|io1|io2|st1|sc1|standard)
include_managed_resources
class-attribute
instance-attribute
¶
include_managed_resources: bool | None = ...
Indicates whether to include managed resources in the output. If this
parameter is set to true, the output includes resources that are
managed by Amazon Web Services services, even if managed resource
visibility is set to hidden.
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.
Dictionaries¶
DescribeVolumesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVolumesInput.
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.
-
attachment.attach-time- The time stamp when the attachment initiated. -
attachment.delete-on-termination- Whether the volume is deleted on instance termination. -
attachment.device- The device name specified in the block device mapping (for example,/dev/sda1). -
attachment.instance-id- The ID of the instance the volume is attached to. -
attachment.status- The attachment state (attaching|attached|detaching). -
availability-zone- The Availability Zone in which the volume was created. -
availability-zone-id- The ID of the Availability Zone in which the volume was created. -
create-time- The time stamp when the volume was created. -
encrypted- Indicates whether the volume is encrypted (true|false) -
fast-restored- Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true|false). -
multi-attach-enabled- Indicates whether the volume is enabled for Multi-Attach (true|false) -
operator.managed- A Boolean that indicates whether this is a managed volume. -
operator.principal- The principal that manages the volume. Only valid for managed volumes, wheremanagedistrue. -
size- The size of the volume, in GiB. -
snapshot-id- The snapshot from which the volume was created. -
status- The state of the volume (creating|available|in-use|deleting|deleted|error). -
tag:<key>- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
volume-id- The volume ID. -
volume-type- The Amazon EBS volume type (gp2|gp3|io1|io2|st1|sc1|standard)
include_managed_resources
instance-attribute
¶
include_managed_resources: bool | None
Indicates whether to include managed resources in the output. If this
parameter is set to true, the output includes resources that are
managed by Amazon Web Services services, even if managed resource
visibility is set to hidden.
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.
Output¶
DescribeVolumesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVolumesOutput 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.