[ aws . fsx ]



Describes one or more Amazon FSx for NetApp ONTAP volumes.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


[--volume-ids <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--volume-ids (list)

IDs of the volumes whose descriptions you want to retrieve.



"string" "string" ...

--filters (list)

Enter a filter name:value pair to view a select set of volumes.


A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP volumes. You can use multiple filters to return results that meet all applied filter requirements.

Name -> (string)

The name for this filter.

Values -> (list)

The values of the filter. These are all the values for any of the applied filters.


Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

    "Name": "file-system-id"|"storage-virtual-machine-id",
    "Values": ["string", ...]

--max-results (integer)

The maximum number of resources to return in the response. This value must be an integer greater than zero.

--next-token (string)

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

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

See ‘aws help’ for descriptions of global parameters.


Volumes -> (list)

Returned after a successful DescribeVolumes operation, describing each volume.


Describes an Amazon FSx for NetApp ONTAP volume.

CreationTime -> (timestamp)

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId -> (string)

The globally unique ID of the file system, assigned by Amazon FSx.

Lifecycle -> (string)

The lifecycle status of the volume.

  • CREATED - The volume is fully available for use.

  • CREATING - Amazon FSx is creating the new volume.

  • DELETING - Amazon FSx is deleting an existing volume.

  • FAILED - Amazon FSx was unable to create the volume.

  • MISCONFIGURED - The volume is in a failed but recoverable state.

  • PENDING - Amazon FSx has not started creating the volume.

Name -> (string)

The name of the volume.

OntapConfiguration -> (structure)

The configuration of an Amazon FSx for NetApp ONTAP volume

FlexCacheEndpointType -> (string)

Specifies the FlexCache endpoint type of the volume. Valid values are the following:

  • NONE specifies that the volume doesn’t have a FlexCache configuration. NONE is the default.

  • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

  • CACHE specifies that the volume is a FlexCache volume.

JunctionPath -> (string)

Specifies the directory that NAS clients use to mount the volume, along with the SVM DNS name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3..

SecurityStyle -> (string)

The security style for the volume, which can be UNIX , NTFS , or MIXED .

SizeInMegabytes -> (integer)

The configured size of the volume, in megabytes (MBs).

StorageEfficiencyEnabled -> (boolean)

The volume’s storage efficiency setting.

StorageVirtualMachineId -> (string)

The ID of the volume’s storage virtual machine.

StorageVirtualMachineRoot -> (boolean)

A boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

This flag is useful when you’re deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

TieringPolicy -> (structure)

The volume’s TieringPolicy setting.

CoolingPeriod -> (integer)

Specifies the number of days that user data in a volume must remain inactive before it is considered “cold” and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .

Name -> (string)

Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

  • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

  • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

  • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

  • NONE - keeps a volume’s data in the primary storage tier, preventing it from being moved to the capacity pool tier.

UUID -> (string)

The volume’s UUID (universally unique identifier).

OntapVolumeType -> (string)

Specifies the type of volume. Valid values are the following:

  • RW specifies a read-write volume. RW is the default.

  • DP specifies a data protection volume. You can protect data by replicating it to data protection mirror copies and use data protection mirror copies to recover data when a disaster occurs.

  • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

ResourceARN -> (string)

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

Tags -> (list)

A list of Tag values, with a maximum of 50 elements.


Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .

VolumeId -> (string)

The system-generated, unique ID of the volume.

VolumeType -> (string)

The type of volume; ONTAP is the only valid volume type.

LifecycleTransitionReason -> (structure)

Describes why the volume lifecycle state changed.

Message -> (string)

A detailed error message.

NextToken -> (string)

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.