Amazon Workspaces Instances

Modifies the size, volume type, IOPS (input/output operations per second), or throughput of a volume. When you modify a volume, you must specify at least one of these parameters. You can modify a volume only after any previous modification for that volume has finished.

To track the progress of a modification, use the Amazon EC2 DescribeVolumesModifications operation. For more information, see Monitor the progress of Amazon EBS volume modifications in the Amazon EBS User Guide.

After you increase the size of a volume, you must extend the partition and file system to use the new storage capacity. For more information, see Extend the file system after resizing an Amazon EBS volume in the Amazon EBS User Guide, which covers both Linux and Windows instances.

See also: AWS API Documentation

Request Syntax

client.modify_volume(
    VolumeId='string',
    SizeInGB=123,
    VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
    Iops=123,
    Throughput=123,
    ClientToken='string'
)

type VolumeId:

string

param VolumeId:

[REQUIRED]

Specifies the identifier of the volume to modify.

type SizeInGB:

integer

param SizeInGB:

Specifies the target size of the volume, in GiB. The target size must be greater than or equal to the current size of the volume. If you don't specify a size, the current size is retained.

type VolumeType:

string

param VolumeType:

Specifies the target Amazon Elastic Block Store (Amazon EBS) volume type. If you don't specify a volume type, the current volume type is retained.

type Iops:

integer

param Iops:

Specifies the target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes. If you don't specify IOPS and keep the same volume type, the current IOPS rate is retained.

type Throughput:

integer

param Throughput:

Specifies the target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. If you don't specify throughput and the volume remains gp3, the current throughput is retained.

type ClientToken:

string

param ClientToken:

Unique token to ensure idempotent volume modification, preventing duplicate volume modifications.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'VolumeId': 'string',
    'TargetSize': 123,
    'TargetVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
    'TargetIops': 123,
    'TargetThroughput': 123
}

Response Structure

• (dict) --

  Contains the target configuration of the volume after the modification, including the size, volume type, IOPS, and throughput where applicable.

  • VolumeId (string) --

    Specifies the identifier of the modified volume.

  • TargetSize (integer) --

    Specifies the target size of the volume, in GiB.

  • TargetVolumeType (string) --

    Specifies the target Amazon EBS volume type.

  • TargetIops (integer) --

    Specifies the target IOPS rate of the volume.

  • TargetThroughput (integer) --

    Specifies the target throughput of the volume, in MiB/s.