AWS CLI Command Reference

[ aws . workspaces-instances ]

modify-volume

Description

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

Synopsis

  modify-volume
--volume-id <value>
[--size-in-gb <value>]
[--volume-type <value>]
[--iops <value>]
[--throughput <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--volume-id (string) [required]

Specifies the identifier of the volume to modify.

Constraints:

  • pattern: vol-[0-9a-zA-Z]{1,63}

--size-in-gb (integer)

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.

Constraints:

  • min: 1
  • max: 16384

--volume-type (string)

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.

Possible values:

  • standard
  • io1
  • io2
  • gp2
  • sc1
  • st1
  • gp3

--iops (integer)

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.

Constraints:

  • min: 0

--throughput (integer)

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.

Constraints:

  • min: 0

--client-token (string)

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

Constraints:

  • min: 1
  • max: 64
  • pattern: [\x20-\x7E]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

VolumeId -> (string)

Specifies the identifier of the modified volume.

Constraints:

  • pattern: vol-[0-9a-zA-Z]{1,63}

TargetSize -> (integer)

Specifies the target size of the volume, in GiB.

Constraints:

  • min: 0

TargetVolumeType -> (string)

Specifies the target Amazon EBS volume type.

Possible values:

  • standard
  • io1
  • io2
  • gp2
  • sc1
  • st1
  • gp3

TargetIops -> (integer)

Specifies the target IOPS rate of the volume.

Constraints:

  • min: 0

TargetThroughput -> (integer)

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

Constraints:

  • min: 0
© Copyright 2026, Amazon Web Services. Created using Sphinx.