EC2 / Client / describe_volumes

describe_volumes#

EC2.Client.describe_volumes(**kwargs)#

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.

Request Syntax

response = client.describe_volumes(
    VolumeIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

VolumeIds (list) –
The volume IDs. If not specified, then all volumes are included in the response.
- (string) –
DryRun (boolean) – 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 (list) –
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.
- 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, where managed is true.
- 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for 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)
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Volumes': [
        {
            'OutpostArn': 'string',
            'Iops': 123,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
            'FastRestored': True|False,
            'MultiAttachEnabled': True|False,
            'Throughput': 123,
            'SseType': 'sse-ebs'|'sse-kms'|'none',
            'Operator': {
                'Managed': True|False,
                'Principal': 'string'
            },
            'VolumeId': 'string',
            'Size': 123,
            'SnapshotId': 'string',
            'AvailabilityZone': 'string',
            'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
            'CreateTime': datetime(2015, 1, 1),
            'Attachments': [
                {
                    'DeleteOnTermination': True|False,
                    'AssociatedResource': 'string',
                    'InstanceOwningService': 'string',
                    'VolumeId': 'string',
                    'InstanceId': 'string',
                    'Device': 'string',
                    'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
                    'AttachTime': datetime(2015, 1, 1)
                },
            ],
            'Encrypted': True|False,
            'KmsKeyId': 'string'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  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.
- Volumes (list) –
  
  Information about the volumes.
  - (dict) –
    
    Describes a volume.
    - OutpostArn (string) –
      
      The Amazon Resource Name (ARN) of the Outpost.
    - Iops (integer) –
      
      The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
    - Tags (list) –
      
      Any tags assigned to the volume.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
    - VolumeType (string) –
      
      The volume type.
    - FastRestored (boolean) –
      
      Note
      This parameter is not returned by CreateVolume.
      
      Indicates whether the volume was created using fast snapshot restore.
    - MultiAttachEnabled (boolean) –
      
      Indicates whether Amazon EBS Multi-Attach is enabled.
    - Throughput (integer) –
      
      The throughput that the volume supports, in MiB/s.
    - SseType (string) –
      
      Note
      This parameter is not returned by CreateVolume.
      
      Reserved for future use.
    - Operator (dict) –
      
      The service provider that manages the volume.
      - Managed (boolean) –
        
        If true, the resource is managed by an service provider.
      - Principal (string) –
        
        If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
    - VolumeId (string) –
      
      The ID of the volume.
    - Size (integer) –
      
      The size of the volume, in GiBs.
    - SnapshotId (string) –
      
      The snapshot from which the volume was created, if applicable.
    - AvailabilityZone (string) –
      
      The Availability Zone for the volume.
    - State (string) –
      
      The volume state.
    - CreateTime (datetime) –
      
      The time stamp when volume creation was initiated.
    - Attachments (list) –
      
      Note
      This parameter is not returned by CreateVolume.
      
      Information about the volume attachments.
      - (dict) –
        
        Describes volume attachment details.
        
        DeleteOnTermination (boolean) –
        
        Indicates whether the EBS volume is deleted on instance termination.
        
        AssociatedResource (string) –
        
        The ARN of the Amazon ECS or Fargate task to which the volume is attached.
        
        InstanceOwningService (string) –
        
        The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.
        
        This parameter is returned only for volumes that are attached to Fargate tasks.
        
        VolumeId (string) –
        
        The ID of the volume.
        
        InstanceId (string) –
        
        The ID of the instance.
        
        If the volume is attached to a Fargate task, this parameter returns null.
        
        Device (string) –
        
        The device name.
        
        If the volume is attached to a Fargate task, this parameter returns null.
        
        State (string) –
        
        The attachment state of the volume.
        
        AttachTime (datetime) –
        
        The time stamp when the attachment initiated.
    - Encrypted (boolean) –
      
      Indicates whether the volume is encrypted.
    - KmsKeyId (string) –
      
      The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.

Examples

This example describes all of your volumes in the default region.

response = client.describe_volumes(
)

print(response)

Expected Output:

{
    'NextToken': '',
    'Volumes': [
        {
            'Attachments': [
                {
                    'AttachTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0),
                    'DeleteOnTermination': True,
                    'Device': '/dev/sda1',
                    'InstanceId': 'i-1234567890abcdef0',
                    'State': 'attached',
                    'VolumeId': 'vol-049df61146c4d7901',
                },
            ],
            'AvailabilityZone': 'us-east-1a',
            'CreateTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0),
            'Size': 8,
            'SnapshotId': 'snap-1234567890abcdef0',
            'State': 'in-use',
            'VolumeId': 'vol-049df61146c4d7901',
            'VolumeType': 'standard',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.

response = client.describe_volumes(
    Filters=[
        {
            'Name': 'attachment.instance-id',
            'Values': [
                'i-1234567890abcdef0',
            ],
        },
        {
            'Name': 'attachment.delete-on-termination',
            'Values': [
                'true',
            ],
        },
    ],
)

print(response)

Expected Output:

{
    'Volumes': [
        {
            'Attachments': [
                {
                    'AttachTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0),
                    'DeleteOnTermination': True,
                    'Device': '/dev/sda1',
                    'InstanceId': 'i-1234567890abcdef0',
                    'State': 'attached',
                    'VolumeId': 'vol-049df61146c4d7901',
                },
            ],
            'AvailabilityZone': 'us-east-1a',
            'CreateTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0),
            'Size': 8,
            'SnapshotId': 'snap-1234567890abcdef0',
            'State': 'in-use',
            'VolumeId': 'vol-049df61146c4d7901',
            'VolumeType': 'standard',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}