volumes¶

volumes

A collection of Volume resources.A Volume Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()¶

Creates an iterable of all Volume resources in the collection.

See also: AWS API Documentation

Request Syntax

volume_iterator = ec2.volumes.all()

Return type: list(ec2.Volume)
Returns: A list of Volume resources

filter(**kwargs)¶

Creates an iterable of all Volume resources in the collection filtered by kwargs passed to method. A Volume collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

volume_iterator = ec2.volumes.filter(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    VolumeIds=[
        'string',
    ],
    DryRun=True|False,
    MaxResults=123,
    NextToken='string'
)

Parameters

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 )
- multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach ( true | false )
- fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore ( true | false ).
- 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.
  - 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) --
VolumeIds (list) --
The volume IDs.
- (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 .
MaxResults (integer) -- The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
NextToken (string) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.

Return type

list(ec2.Volume)

Returns

A list of Volume resources

limit(**kwargs)¶

Creates an iterable up to a specified amount of Volume resources in the collection.

See also: AWS API Documentation

Request Syntax

volume_iterator = ec2.volumes.limit(
    count=123
)

Parameters: count (integer) -- The limit to the number of resources in the iterable.
Return type: list(ec2.Volume)
Returns: A list of Volume resources

page_size(**kwargs)¶

Creates an iterable of all Volume resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

volume_iterator = ec2.volumes.page_size(
    count=123
)

Parameters: count (integer) -- The number of items returned by each service call
Return type: list(ec2.Volume)
Returns: A list of Volume resources

Table Of Contents

volumes¶