Instance / Collection / volumes

volumes#

EC2.Instance.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 = instance.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 = instance.volumes.filter(
    VolumeIds=[
        'string',
    ],
    DryRun=True|False,
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • 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 = instance.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 = instance.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