EC2 / Paginator / DescribeVolumes

DescribeVolumes#

class EC2.Paginator.DescribeVolumes#
paginator = client.get_paginator('describe_volumes')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from EC2.Client.describe_volumes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    VolumeIds=[
        'string',
    ],
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Volumes': [
        {
            'Attachments': [
                {
                    'AttachTime': datetime(2015, 1, 1),
                    'Device': 'string',
                    'InstanceId': 'string',
                    'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
                    'VolumeId': 'string',
                    'DeleteOnTermination': True|False,
                    'AssociatedResource': 'string',
                    'InstanceOwningService': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'Encrypted': True|False,
            'KmsKeyId': 'string',
            'OutpostArn': 'string',
            'Size': 123,
            'SnapshotId': 'string',
            'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
            'VolumeId': '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'
        },
    ],

}

Response Structure

  • (dict) –

    • Volumes (list) –

      Information about the volumes.

      • (dict) –

        Describes a volume.

        • Attachments (list) –

          Note

          This parameter is not returned by CreateVolume.

          Information about the volume attachments.

          • (dict) –

            Describes volume attachment details.

            • AttachTime (datetime) –

              The time stamp when the attachment initiated.

            • Device (string) –

              The device name.

              If the volume is attached to a Fargate task, this parameter returns null.

            • InstanceId (string) –

              The ID of the instance.

              If the volume is attached to a Fargate task, this parameter returns null.

            • State (string) –

              The attachment state of the volume.

            • VolumeId (string) –

              The ID of the volume.

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

        • AvailabilityZone (string) –

          The Availability Zone for the volume.

        • CreateTime (datetime) –

          The time stamp when volume creation was 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.

        • OutpostArn (string) –

          The Amazon Resource Name (ARN) of the Outpost.

        • Size (integer) –

          The size of the volume, in GiBs.

        • SnapshotId (string) –

          The snapshot from which the volume was created, if applicable.

        • State (string) –

          The volume state.

        • VolumeId (string) –

          The ID of the volume.

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