OpsWorks / Client / describe_volumes

describe_volumes#

OpsWorks.Client.describe_volumes(**kwargs)#

Describes an instance’s Amazon EBS volumes.

Note

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.describe_volumes(
    InstanceId='string',
    StackId='string',
    RaidArrayId='string',
    VolumeIds=[
        'string',
    ]
)
Parameters:

  • InstanceId (string) – The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

  • StackId (string) – A stack ID. The action describes the stack’s registered Amazon EBS volumes.

  • RaidArrayId (string) – The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

  • VolumeIds (list) –

    Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Volumes': [
        {
            'VolumeId': 'string',
            'Ec2VolumeId': 'string',
            'Name': 'string',
            'RaidArrayId': 'string',
            'InstanceId': 'string',
            'Status': 'string',
            'Size': 123,
            'Device': 'string',
            'MountPoint': 'string',
            'Region': 'string',
            'AvailabilityZone': 'string',
            'VolumeType': 'string',
            'Iops': 123,
            'Encrypted': True|False
        },
    ]
}

Response Structure

  • (dict) –

    Contains the response to a DescribeVolumes request.

    • Volumes (list) –

      An array of volume IDs.

      • (dict) –

        Describes an instance’s Amazon EBS volume.

        • VolumeId (string) –

          The volume ID.

        • Ec2VolumeId (string) –

          The Amazon EC2 volume ID.

        • Name (string) –

          The volume name.

        • RaidArrayId (string) –

          The RAID array ID.

        • InstanceId (string) –

          The instance ID.

        • Status (string) –

          The value returned by DescribeVolumes.

        • Size (integer) –

          The volume size.

        • Device (string) –

          The device name.

        • MountPoint (string) –

          The volume mount point. For example, “/mnt/disk1”.

        • Region (string) –

          The AWS region. For more information about AWS regions, see Regions and Endpoints.

        • AvailabilityZone (string) –

          The volume Availability Zone. For more information, see Regions and Endpoints.

        • VolumeType (string) –

          The volume type. For more information, see Amazon EBS Volume Types.

          • standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

          • io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

          • gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

          • st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

          • sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

        • Iops (integer) –

          For PIOPS volumes, the IOPS per disk.

        • Encrypted (boolean) –

          Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.

Exceptions

  • OpsWorks.Client.exceptions.ValidationException

  • OpsWorks.Client.exceptions.ResourceNotFoundException