SDK for PHP 3.x

Client: Aws\FSx\FSxClient
Service ID: fsx
Version: 2018-03-01

This page describes the parameters and results for the operations of the Amazon FSx (2018-03-01), and shows how to use the Aws\FSx\FSxClient object to call the described operations. This documentation is specific to the 2018-03-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateFileSystemAliases ( array $params = [] )
Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system.
CancelDataRepositoryTask ( array $params = [] )
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state.
CopyBackup ( array $params = [] )
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy).
CopySnapshotAndUpdateVolume ( array $params = [] )
Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system.
CreateBackup ( array $params = [] )
Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.
CreateDataRepositoryAssociation ( array $params = [] )
Creates an Amazon FSx for Lustre data repository association (DRA).
CreateDataRepositoryTask ( array $params = [] )
Creates an Amazon FSx for Lustre data repository task.
CreateFileCache ( array $params = [] )
Creates a new Amazon File Cache resource.
CreateFileSystem ( array $params = [] )
Creates a new, empty Amazon FSx file system.
CreateFileSystemFromBackup ( array $params = [] )
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
CreateSnapshot ( array $params = [] )
Creates a snapshot of an existing Amazon FSx for OpenZFS volume.
CreateStorageVirtualMachine ( array $params = [] )
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
CreateVolume ( array $params = [] )
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
CreateVolumeFromBackup ( array $params = [] )
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
DeleteBackup ( array $params = [] )
Deletes an Amazon FSx backup.
DeleteDataRepositoryAssociation ( array $params = [] )
Deletes a data repository association on an Amazon FSx for Lustre file system.
DeleteFileCache ( array $params = [] )
Deletes an Amazon File Cache resource.
DeleteFileSystem ( array $params = [] )
Deletes a file system.
DeleteSnapshot ( array $params = [] )
Deletes an Amazon FSx for OpenZFS snapshot.
DeleteStorageVirtualMachine ( array $params = [] )
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM).
DeleteVolume ( array $params = [] )
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
DescribeBackups ( array $params = [] )
Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup.
DescribeDataRepositoryAssociations ( array $params = [] )
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request.
DescribeDataRepositoryTasks ( array $params = [] )
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request.
DescribeFileCaches ( array $params = [] )
Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache.
DescribeFileSystemAliases ( array $params = [] )
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
DescribeFileSystems ( array $params = [] )
Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system.
DescribeSharedVpcConfiguration ( array $params = [] )
Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner.
DescribeSnapshots ( array $params = [] )
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided.
DescribeStorageVirtualMachines ( array $params = [] )
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
DescribeVolumes ( array $params = [] )
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
DisassociateFileSystemAliases ( array $params = [] )
Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system.
ListTagsForResource ( array $params = [] )
Lists tags for Amazon FSx resources.
ReleaseFileSystemNfsV3Locks ( array $params = [] )
Releases the file system lock from an Amazon FSx for OpenZFS file system.
RestoreVolumeFromSnapshot ( array $params = [] )
Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
StartMisconfiguredStateRecovery ( array $params = [] )
After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system.
TagResource ( array $params = [] )
Tags an Amazon FSx resource.
UntagResource ( array $params = [] )
This action removes a tag from an Amazon FSx resource.
UpdateDataRepositoryAssociation ( array $params = [] )
Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system.
UpdateFileCache ( array $params = [] )
Updates the configuration of an existing Amazon File Cache resource.
UpdateFileSystem ( array $params = [] )
Use this operation to update the configuration of an existing Amazon FSx file system.
UpdateSharedVpcConfiguration ( array $params = [] )
Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner.
UpdateSnapshot ( array $params = [] )
Updates the name of an Amazon FSx for OpenZFS snapshot.
UpdateStorageVirtualMachine ( array $params = [] )
Updates an FSx for ONTAP storage virtual machine (SVM).
UpdateVolume ( array $params = [] )
Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeBackups
DescribeDataRepositoryAssociations
DescribeDataRepositoryTasks
DescribeFileCaches
DescribeFileSystemAliases
DescribeFileSystems
DescribeSnapshots
DescribeStorageVirtualMachines
DescribeVolumes
ListTagsForResource

Operations

AssociateFileSystemAliases

$result = $client->associateFileSystemAliases([/* ... */]);
$promise = $client->associateFileSystemAliasesAsync([/* ... */]);

Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.

Parameter Syntax

$result = $client->associateFileSystemAliases([
    'Aliases' => ['<string>', ...], // REQUIRED
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Aliases
Required: Yes
Type: Array of strings

An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com.

  • Can contain alphanumeric characters and the hyphen (-).

  • Cannot start or end with a hyphen.

  • Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Required: Yes
Type: string

Specifies the file system with which you want to associate one or more DNS aliases.

Result Syntax

[
    'Aliases' => [
        [
            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Aliases
Type: Array of Alias structures

An array of the DNS aliases that Amazon FSx is associating with the file system.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

InternalServerError:

A generic error indicating a server-side failure.

CancelDataRepositoryTask

$result = $client->cancelDataRepositoryTask([/* ... */]);
$promise = $client->cancelDataRepositoryTaskAsync([/* ... */]);

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel am export task, Amazon FSx does the following.

  • Any files that FSx has already exported are not reverted.

  • FSx continues to export any files that are in-flight when the cancel operation is received.

  • FSx does not export any files that have not yet been exported.

For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.

Parameter Syntax

$result = $client->cancelDataRepositoryTask([
    'TaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
TaskId
Required: Yes
Type: string

Specifies the data repository task to cancel.

Result Syntax

[
    'Lifecycle' => 'PENDING|EXECUTING|FAILED|SUCCEEDED|CANCELED|CANCELING',
    'TaskId' => '<string>',
]

Result Details

Members
Lifecycle
Type: string

The lifecycle status of the data repository task, as follows:

  • PENDING - Amazon FSx has not started the task.

  • EXECUTING - Amazon FSx is processing the task.

  • FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.

  • SUCCEEDED - FSx completed the task successfully.

  • CANCELED - Amazon FSx canceled the task and it did not complete.

  • CANCELING - FSx is in process of canceling the task.

TaskId
Type: string

The ID of the task being canceled.

Errors

BadRequest:

A generic error indicating a failure with a client request.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

DataRepositoryTaskNotFound:

The data repository task or tasks you specified could not be found.

DataRepositoryTaskEnded:

The data repository task could not be canceled because the task has already ended.

InternalServerError:

A generic error indicating a server-side failure.

CopyBackup

$result = $client->copyBackup([/* ... */]);
$promise = $client->copyBackupAsync([/* ... */]);

Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.

You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).

You can also use backup copies to clone your file dataset to another Region or within the same Region.

You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).

For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.

Parameter Syntax

$result = $client->copyBackup([
    'ClientRequestToken' => '<string>',
    'CopyTags' => true || false,
    'KmsKeyId' => '<string>',
    'SourceBackupId' => '<string>', // REQUIRED
    'SourceRegion' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

CopyTags
Type: boolean

A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

KmsKeyId
Type: string

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:

  • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

    SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

  • Amazon FSx for NetApp ONTAP

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

SourceBackupId
Required: Yes
Type: string

The ID of the source backup. Specifies the ID of the backup that's being copied.

SourceRegion
Type: string

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).

Tags
Type: Array of Tag structures

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

Result Syntax

[
    'Backup' => [
        'BackupId' => '<string>',
        'CreationTime' => <DateTime>,
        'DirectoryInformation' => [
            'ActiveDirectoryId' => '<string>',
            'DomainName' => '<string>',
            'ResourceARN' => '<string>',
        ],
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystem' => [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RemainingTransferBytes' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                    'TargetFileSystemValues' => [...], // RECURSIVE
                    'TargetSnapshotValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'ResourceARN' => '<string>',
                        'SnapshotId' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                    ],
                    'TargetVolumeValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'FileSystemId' => '<string>',
                        'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'OntapConfiguration' => [
                            'AggregateConfiguration' => [
                                'Aggregates' => ['<string>', ...],
                                'TotalConstituents' => <integer>,
                            ],
                            'CopyTagsToBackups' => true || false,
                            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                            'JunctionPath' => '<string>',
                            'OntapVolumeType' => 'RW|DP|LS',
                            'SecurityStyle' => 'UNIX|NTFS|MIXED',
                            'SizeInBytes' => <integer>,
                            'SizeInMegabytes' => <integer>,
                            'SnaplockConfiguration' => [
                                'AuditLogVolume' => true || false,
                                'AutocommitPeriod' => [
                                    'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                    'Value' => <integer>,
                                ],
                                'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                                'RetentionPeriod' => [
                                    'DefaultRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                    'MaximumRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                    'MinimumRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                ],
                                'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                                'VolumeAppendModeEnabled' => true || false,
                            ],
                            'SnapshotPolicy' => '<string>',
                            'StorageEfficiencyEnabled' => true || false,
                            'StorageVirtualMachineId' => '<string>',
                            'StorageVirtualMachineRoot' => true || false,
                            'TieringPolicy' => [
                                'CoolingPeriod' => <integer>,
                                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                            ],
                            'UUID' => '<string>',
                            'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                        ],
                        'OpenZFSConfiguration' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'CopyTagsToSnapshots' => true || false,
                            'DataCompressionType' => 'NONE|ZSTD|LZ4',
                            'DeleteClonedVolumes' => true || false,
                            'DeleteIntermediateData' => true || false,
                            'DeleteIntermediateSnaphots' => true || false,
                            'DestinationSnapshot' => '<string>',
                            'NfsExports' => [
                                [
                                    'ClientConfigurations' => [
                                        [
                                            'Clients' => '<string>',
                                            'Options' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OriginSnapshot' => [
                                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                                'SnapshotARN' => '<string>',
                            ],
                            'ParentVolumeId' => '<string>',
                            'ReadOnly' => true || false,
                            'RecordSizeKiB' => <integer>,
                            'RestoreToSnapshot' => '<string>',
                            'SourceSnapshotARN' => '<string>',
                            'StorageCapacityQuotaGiB' => <integer>,
                            'StorageCapacityReservationGiB' => <integer>,
                            'UserAndGroupQuotas' => [
                                [
                                    'Id' => <integer>,
                                    'StorageCapacityQuotaGiB' => <integer>,
                                    'Type' => 'USER|GROUP',
                                ],
                                // ...
                            ],
                            'VolumePath' => '<string>',
                        ],
                        'ResourceARN' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                        'VolumeType' => 'ONTAP|OPENZFS',
                    ],
                    'TotalTransferBytes' => <integer>,
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
            'FileSystemTypeVersion' => '<string>',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DataCompressionType' => 'NONE|LZ4',
                'DataRepositoryConfiguration' => [
                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                    'ExportPath' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                ],
                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                'DriveCacheType' => 'NONE|READ',
                'LogConfiguration' => [
                    'Destination' => '<string>',
                    'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                ],
                'MetadataConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'RootSquashConfiguration' => [
                    'NoSquashNids' => ['<string>', ...],
                    'RootSquash' => '<string>',
                ],
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OntapConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'EndpointIpAddressRange' => '<string>',
                'Endpoints' => [
                    'Intercluster' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                    'Management' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                ],
                'FsxAdminPassword' => '<string>',
                'HAPairs' => <integer>,
                'PreferredSubnetId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'ThroughputCapacityPerHAPair' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OpenZFSConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'CopyTagsToVolumes' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'EndpointIpAddress' => '<string>',
                'EndpointIpAddressRange' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RootVolumeId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD',
            'SubnetIds' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => '<string>',
                'Aliases' => [
                    [
                        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'AuditLogConfiguration' => [
                    'AuditLogDestination' => '<string>',
                    'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                    'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                ],
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'MaintenanceOperationsInProgress' => ['<string>', ...],
                'PreferredFileServerIp' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RemoteAdministrationEndpoint' => '<string>',
                'SelfManagedActiveDirectoryConfiguration' => [
                    'DnsIps' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'FileSystemAdministratorsGroup' => '<string>',
                    'OrganizationalUnitDistinguishedName' => '<string>',
                    'UserName' => '<string>',
                ],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
        ],
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING|COPYING',
        'OwnerId' => '<string>',
        'ProgressPercent' => <integer>,
        'ResourceARN' => '<string>',
        'ResourceType' => 'FILE_SYSTEM|VOLUME',
        'SourceBackupId' => '<string>',
        'SourceBackupRegion' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
        'Volume' => [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RemainingTransferBytes' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                    'TargetFileSystemValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'DNSName' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'FileSystemId' => '<string>',
                        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                        'FileSystemTypeVersion' => '<string>',
                        'KmsKeyId' => '<string>',
                        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                        'LustreConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DataCompressionType' => 'NONE|LZ4',
                            'DataRepositoryConfiguration' => [
                                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                                'ExportPath' => '<string>',
                                'FailureDetails' => [
                                    'Message' => '<string>',
                                ],
                                'ImportPath' => '<string>',
                                'ImportedFileChunkSize' => <integer>,
                                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                            ],
                            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                            'DriveCacheType' => 'NONE|READ',
                            'LogConfiguration' => [
                                'Destination' => '<string>',
                                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                            ],
                            'MetadataConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'MountName' => '<string>',
                            'PerUnitStorageThroughput' => <integer>,
                            'RootSquashConfiguration' => [
                                'NoSquashNids' => ['<string>', ...],
                                'RootSquash' => '<string>',
                            ],
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'NetworkInterfaceIds' => ['<string>', ...],
                        'OntapConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddressRange' => '<string>',
                            'Endpoints' => [
                                'Intercluster' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                                'Management' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                            ],
                            'FsxAdminPassword' => '<string>',
                            'HAPairs' => <integer>,
                            'PreferredSubnetId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'ThroughputCapacityPerHAPair' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OpenZFSConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'CopyTagsToVolumes' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddress' => '<string>',
                            'EndpointIpAddressRange' => '<string>',
                            'PreferredSubnetId' => '<string>',
                            'RootVolumeId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD',
                        'SubnetIds' => ['<string>', ...],
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VpcId' => '<string>',
                        'WindowsConfiguration' => [
                            'ActiveDirectoryId' => '<string>',
                            'Aliases' => [
                                [
                                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'AuditLogConfiguration' => [
                                'AuditLogDestination' => '<string>',
                                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            ],
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'MaintenanceOperationsInProgress' => ['<string>', ...],
                            'PreferredFileServerIp' => '<string>',
                            'PreferredSubnetId' => '<string>',
                            'RemoteAdministrationEndpoint' => '<string>',
                            'SelfManagedActiveDirectoryConfiguration' => [
                                'DnsIps' => ['<string>', ...],
                                'DomainName' => '<string>',
                                'FileSystemAdministratorsGroup' => '<string>',
                                'OrganizationalUnitDistinguishedName' => '<string>',
                                'UserName' => '<string>',
                            ],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                    ],
                    'TargetSnapshotValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'ResourceARN' => '<string>',
                        'SnapshotId' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                    ],
                    'TargetVolumeValues' => [...], // RECURSIVE
                    'TotalTransferBytes' => <integer>,
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'FileSystemId' => '<string>',
            'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
            'LifecycleTransitionReason' => [
                'Message' => '<string>',
            ],
            'Name' => '<string>',
            'OntapConfiguration' => [
                'AggregateConfiguration' => [
                    'Aggregates' => ['<string>', ...],
                    'TotalConstituents' => <integer>,
                ],
                'CopyTagsToBackups' => true || false,
                'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                'JunctionPath' => '<string>',
                'OntapVolumeType' => 'RW|DP|LS',
                'SecurityStyle' => 'UNIX|NTFS|MIXED',
                'SizeInBytes' => <integer>,
                'SizeInMegabytes' => <integer>,
                'SnaplockConfiguration' => [
                    'AuditLogVolume' => true || false,
                    'AutocommitPeriod' => [
                        'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                        'Value' => <integer>,
                    ],
                    'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                    'RetentionPeriod' => [
                        'DefaultRetention' => [
                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                            'Value' => <integer>,
                        ],
                        'MaximumRetention' => [
                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                            'Value' => <integer>,
                        ],
                        'MinimumRetention' => [
                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                            'Value' => <integer>,
                        ],
                    ],
                    'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                    'VolumeAppendModeEnabled' => true || false,
                ],
                'SnapshotPolicy' => '<string>',
                'StorageEfficiencyEnabled' => true || false,
                'StorageVirtualMachineId' => '<string>',
                'StorageVirtualMachineRoot' => true || false,
                'TieringPolicy' => [
                    'CoolingPeriod' => <integer>,
                    'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                ],
                'UUID' => '<string>',
                'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
            ],
            'OpenZFSConfiguration' => [
                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                'CopyTagsToSnapshots' => true || false,
                'DataCompressionType' => 'NONE|ZSTD|LZ4',
                'DeleteClonedVolumes' => true || false,
                'DeleteIntermediateData' => true || false,
                'DeleteIntermediateSnaphots' => true || false,
                'DestinationSnapshot' => '<string>',
                'NfsExports' => [
                    [
                        'ClientConfigurations' => [
                            [
                                'Clients' => '<string>',
                                'Options' => ['<string>', ...],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'OriginSnapshot' => [
                    'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                    'SnapshotARN' => '<string>',
                ],
                'ParentVolumeId' => '<string>',
                'ReadOnly' => true || false,
                'RecordSizeKiB' => <integer>,
                'RestoreToSnapshot' => '<string>',
                'SourceSnapshotARN' => '<string>',
                'StorageCapacityQuotaGiB' => <integer>,
                'StorageCapacityReservationGiB' => <integer>,
                'UserAndGroupQuotas' => [
                    [
                        'Id' => <integer>,
                        'StorageCapacityQuotaGiB' => <integer>,
                        'Type' => 'USER|GROUP',
                    ],
                    // ...
                ],
                'VolumePath' => '<string>',
            ],
            'ResourceARN' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VolumeId' => '<string>',
            'VolumeType' => 'ONTAP|OPENZFS',
        ],
    ],
]

Result Details

Members
Backup
Type: Backup structure

A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

Errors

BadRequest:

A generic error indicating a failure with a client request.

BackupNotFound:

No Amazon FSx backups were found based upon the supplied parameters.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

InvalidSourceKmsKey:

The Key Management Service (KMS) key of the source backup is not valid.

InvalidDestinationKmsKey:

The Key Management Service (KMS) key of the destination backup is not valid.

InvalidRegion:

The Region provided for SourceRegion is not valid or is in a different Amazon Web Services partition.

SourceBackupUnavailable:

The request was rejected because the lifecycle status of the source backup isn't AVAILABLE.

IncompatibleRegionForMultiAZ:

Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.

Examples

Example 1: To copy a backup

This operation copies an Amazon FSx backup.

$result = $client->copyBackup([
    'SourceBackupId' => 'backup-03e3c82e0183b7b6b',
    'SourceRegion' => 'us-east-2',
]);

Result syntax:

[
    'Backup' => [
        'BackupId' => 'backup-0a3364eded1014b28',
        'CreationTime' => ,
        'FileSystem' => [
            'FileSystemId' => 'fs-0498eed5fe91001ec',
            'FileSystemType' => 'LUSTRE',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => 0,
                'DeploymentType' => 'PERSISTENT_1',
                'PerUnitStorageThroughput' => 50,
                'WeeklyMaintenanceStartTime' => '1:05:00',
            ],
            'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0f5179e395f597e66',
            'StorageCapacity' => 2400,
            'StorageType' => 'SSD',
        ],
        'KmsKeyId' => 'arn:aws:fsx:us-east-1:012345678912:key/d1234e22-543a-12b7-a98f-e12c2b54001a',
        'Lifecycle' => 'COPYING',
        'OwnerId' => '123456789012',
        'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:backup/backup-0a3364eded1014b28',
        'Tags' => [
            [
                'Key' => 'Name',
                'Value' => 'MyBackup',
            ],
        ],
        'Type' => 'USER_INITIATED',
    ],
]

CopySnapshotAndUpdateVolume

$result = $client->copySnapshotAndUpdateVolume([/* ... */]);
$promise = $client->copySnapshotAndUpdateVolumeAsync([/* ... */]);

Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS User Guide.

Parameter Syntax

$result = $client->copySnapshotAndUpdateVolume([
    'ClientRequestToken' => '<string>',
    'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
    'Options' => ['<string>', ...],
    'SourceSnapshotARN' => '<string>', // REQUIRED
    'VolumeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

CopyStrategy
Type: string

Specifies the strategy to use when copying data from a snapshot to the volume.

  • FULL_COPY - Copies all data from the snapshot to the volume.

  • INCREMENTAL_COPY - Copies only the snapshot data that's changed since the previous replication.

CLONE isn't a valid copy strategy option for the CopySnapshotAndUpdateVolume operation.

Options
Type: Array of strings

Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication.

Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include DELETE_INTERMEDIATE_SNAPSHOTS and there are intermediate snapshots on the destination, you can’t copy the snapshot.

  • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination volume that aren’t on the source volume.

  • DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination volume that aren't on the source volume.

  • DELETE_INTERMEDIATE_DATA - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying.

SourceSnapshotARN
Required: Yes
Type: 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.

VolumeId
Required: Yes
Type: string

Specifies the ID of the volume that you are copying the snapshot to.

Result Syntax

[
    'AdministrativeActions' => [
        [
            'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'ProgressPercent' => <integer>,
            'RemainingTransferBytes' => <integer>,
            'RequestTime' => <DateTime>,
            'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
            'TargetFileSystemValues' => [
                'AdministrativeActions' => [...], // RECURSIVE
                'CreationTime' => <DateTime>,
                'DNSName' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'FileSystemId' => '<string>',
                'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                'FileSystemTypeVersion' => '<string>',
                'KmsKeyId' => '<string>',
                'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                'LustreConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DataCompressionType' => 'NONE|LZ4',
                    'DataRepositoryConfiguration' => [
                        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                        'ExportPath' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ImportPath' => '<string>',
                        'ImportedFileChunkSize' => <integer>,
                        'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                    ],
                    'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                    'DriveCacheType' => 'NONE|READ',
                    'LogConfiguration' => [
                        'Destination' => '<string>',
                        'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                    ],
                    'MetadataConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'MountName' => '<string>',
                    'PerUnitStorageThroughput' => <integer>,
                    'RootSquashConfiguration' => [
                        'NoSquashNids' => ['<string>', ...],
                        'RootSquash' => '<string>',
                    ],
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'NetworkInterfaceIds' => ['<string>', ...],
                'OntapConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'EndpointIpAddressRange' => '<string>',
                    'Endpoints' => [
                        'Intercluster' => [
                            'DNSName' => '<string>',
                            'IpAddresses' => ['<string>', ...],
                        ],
                        'Management' => [
                            'DNSName' => '<string>',
                            'IpAddresses' => ['<string>', ...],
                        ],
                    ],
                    'FsxAdminPassword' => '<string>',
                    'HAPairs' => <integer>,
                    'PreferredSubnetId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'ThroughputCapacityPerHAPair' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OpenZFSConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'CopyTagsToVolumes' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'EndpointIpAddress' => '<string>',
                    'EndpointIpAddressRange' => '<string>',
                    'PreferredSubnetId' => '<string>',
                    'RootVolumeId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OwnerId' => '<string>',
                'ResourceARN' => '<string>',
                'StorageCapacity' => <integer>,
                'StorageType' => 'SSD|HDD',
                'SubnetIds' => ['<string>', ...],
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VpcId' => '<string>',
                'WindowsConfiguration' => [
                    'ActiveDirectoryId' => '<string>',
                    'Aliases' => [
                        [
                            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                    'AuditLogConfiguration' => [
                        'AuditLogDestination' => '<string>',
                        'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                    ],
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'MaintenanceOperationsInProgress' => ['<string>', ...],
                    'PreferredFileServerIp' => '<string>',
                    'PreferredSubnetId' => '<string>',
                    'RemoteAdministrationEndpoint' => '<string>',
                    'SelfManagedActiveDirectoryConfiguration' => [
                        'DnsIps' => ['<string>', ...],
                        'DomainName' => '<string>',
                        'FileSystemAdministratorsGroup' => '<string>',
                        'OrganizationalUnitDistinguishedName' => '<string>',
                        'UserName' => '<string>',
                    ],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
            ],
            'TargetSnapshotValues' => [
                'AdministrativeActions' => [...], // RECURSIVE
                'CreationTime' => <DateTime>,
                'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                'LifecycleTransitionReason' => [
                    'Message' => '<string>',
                ],
                'Name' => '<string>',
                'ResourceARN' => '<string>',
                'SnapshotId' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VolumeId' => '<string>',
            ],
            'TargetVolumeValues' => [
                'AdministrativeActions' => [...], // RECURSIVE
                'CreationTime' => <DateTime>,
                'FileSystemId' => '<string>',
                'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                'LifecycleTransitionReason' => [
                    'Message' => '<string>',
                ],
                'Name' => '<string>',
                'OntapConfiguration' => [
                    'AggregateConfiguration' => [
                        'Aggregates' => ['<string>', ...],
                        'TotalConstituents' => <integer>,
                    ],
                    'CopyTagsToBackups' => true || false,
                    'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                    'JunctionPath' => '<string>',
                    'OntapVolumeType' => 'RW|DP|LS',
                    'SecurityStyle' => 'UNIX|NTFS|MIXED',
                    'SizeInBytes' => <integer>,
                    'SizeInMegabytes' => <integer>,
                    'SnaplockConfiguration' => [
                        'AuditLogVolume' => true || false,
                        'AutocommitPeriod' => [
                            'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                            'Value' => <integer>,
                        ],
                        'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                        'RetentionPeriod' => [
                            'DefaultRetention' => [
                                'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                'Value' => <integer>,
                            ],
                            'MaximumRetention' => [
                                'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                'Value' => <integer>,
                            ],
                            'MinimumRetention' => [
                                'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                'Value' => <integer>,
                            ],
                        ],
                        'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                        'VolumeAppendModeEnabled' => true || false,
                    ],
                    'SnapshotPolicy' => '<string>',
                    'StorageEfficiencyEnabled' => true || false,
                    'StorageVirtualMachineId' => '<string>',
                    'StorageVirtualMachineRoot' => true || false,
                    'TieringPolicy' => [
                        'CoolingPeriod' => <integer>,
                        'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                    ],
                    'UUID' => '<string>',
                    'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                ],
                'OpenZFSConfiguration' => [
                    'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                    'CopyTagsToSnapshots' => true || false,
                    'DataCompressionType' => 'NONE|ZSTD|LZ4',
                    'DeleteClonedVolumes' => true || false,
                    'DeleteIntermediateData' => true || false,
                    'DeleteIntermediateSnaphots' => true || false,
                    'DestinationSnapshot' => '<string>',
                    'NfsExports' => [
                        [
                            'ClientConfigurations' => [
                                [
                                    'Clients' => '<string>',
                                    'Options' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'OriginSnapshot' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'SnapshotARN' => '<string>',
                    ],
                    'ParentVolumeId' => '<string>',
                    'ReadOnly' => true || false,
                    'RecordSizeKiB' => <integer>,
                    'RestoreToSnapshot' => '<string>',
                    'SourceSnapshotARN' => '<string>',
                    'StorageCapacityQuotaGiB' => <integer>,
                    'StorageCapacityReservationGiB' => <integer>,
                    'UserAndGroupQuotas' => [
                        [
                            'Id' => <integer>,
                            'StorageCapacityQuotaGiB' => <integer>,
                            'Type' => 'USER|GROUP',
                        ],
                        // ...
                    ],
                    'VolumePath' => '<string>',
                ],
                'ResourceARN' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VolumeId' => '<string>',
                'VolumeType' => 'ONTAP|OPENZFS',
            ],
            'TotalTransferBytes' => <integer>,
        ],
        // ...
    ],
    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
    'VolumeId' => '<string>',
]

Result Details

Members
AdministrativeActions
Type: Array of AdministrativeAction structures

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

Lifecycle
Type: string

The lifecycle state of the destination volume.

VolumeId
Type: string

The ID of the volume that you copied the snapshot to.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

CreateBackup

$result = $client->createBackup([/* ... */]);
$promise = $client->createBackupAsync([/* ... */]);

Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.

For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:

  • A Persistent deployment type

  • Are not linked to a data repository

For more information about backups, see the following:

If a backup with the specified client request token exists and the parameters match, this operation returns the description of the existing backup. If a backup with the specified client request token exists and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

  • Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

Parameter Syntax

$result = $client->createBackup([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VolumeId' => '<string>',
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Type: string

The ID of the file system to back up.

Tags
Type: Array of Tag structures

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.

VolumeId
Type: string

(Optional) The ID of the FSx for ONTAP volume to back up.

Result Syntax

[
    'Backup' => [
        'BackupId' => '<string>',
        'CreationTime' => <DateTime>,
        'DirectoryInformation' => [
            'ActiveDirectoryId' => '<string>',
            'DomainName' => '<string>',
            'ResourceARN' => '<string>',
        ],
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystem' => [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RemainingTransferBytes' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                    'TargetFileSystemValues' => [...], // RECURSIVE
                    'TargetSnapshotValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'ResourceARN' => '<string>',
                        'SnapshotId' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                    ],
                    'TargetVolumeValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'FileSystemId' => '<string>',
                        'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'OntapConfiguration' => [
                            'AggregateConfiguration' => [
                                'Aggregates' => ['<string>', ...],
                                'TotalConstituents' => <integer>,
                            ],
                            'CopyTagsToBackups' => true || false,
                            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                            'JunctionPath' => '<string>',
                            'OntapVolumeType' => 'RW|DP|LS',
                            'SecurityStyle' => 'UNIX|NTFS|MIXED',
                            'SizeInBytes' => <integer>,
                            'SizeInMegabytes' => <integer>,
                            'SnaplockConfiguration' => [
                                'AuditLogVolume' => true || false,
                                'AutocommitPeriod' => [
                                    'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                    'Value' => <integer>,
                                ],
                                'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                                'RetentionPeriod' => [
                                    'DefaultRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                    'MaximumRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                    'MinimumRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                ],
                                'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                                'VolumeAppendModeEnabled' => true || false,
                            ],
                            'SnapshotPolicy' => '<string>',
                            'StorageEfficiencyEnabled' => true || false,
                            'StorageVirtualMachineId' => '<string>',
                            'StorageVirtualMachineRoot' => true || false,
                            'TieringPolicy' => [
                                'CoolingPeriod' => <integer>,
                                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                            ],
                            'UUID' => '<string>',
                            'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                        ],
                        'OpenZFSConfiguration' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'CopyTagsToSnapshots' => true || false,
                            'DataCompressionType' => 'NONE|ZSTD|LZ4',
                            'DeleteClonedVolumes' => true || false,
                            'DeleteIntermediateData' => true || false,
                            'DeleteIntermediateSnaphots' => true || false,
                            'DestinationSnapshot' => '<string>',
                            'NfsExports' => [
                                [
                                    'ClientConfigurations' => [
                                        [
                                            'Clients' => '<string>',
                                            'Options' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OriginSnapshot' => [
                                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                                'SnapshotARN' => '<string>',
                            ],
                            'ParentVolumeId' => '<string>',
                            'ReadOnly' => true || false,
                            'RecordSizeKiB' => <integer>,
                            'RestoreToSnapshot' => '<string>',
                            'SourceSnapshotARN' => '<string>',
                            'StorageCapacityQuotaGiB' => <integer>,
                            'StorageCapacityReservationGiB' => <integer>,
                            'UserAndGroupQuotas' => [
                                [
                                    'Id' => <integer>,
                                    'StorageCapacityQuotaGiB' => <integer>,
                                    'Type' => 'USER|GROUP',
                                ],
                                // ...
                            ],
                            'VolumePath' => '<string>',
                        ],
                        'ResourceARN' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                        'VolumeType' => 'ONTAP|OPENZFS',
                    ],
                    'TotalTransferBytes' => <integer>,
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
            'FileSystemTypeVersion' => '<string>',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DataCompressionType' => 'NONE|LZ4',
                'DataRepositoryConfiguration' => [
                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                    'ExportPath' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                ],
                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                'DriveCacheType' => 'NONE|READ',
                'LogConfiguration' => [
                    'Destination' => '<string>',
                    'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                ],
                'MetadataConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'RootSquashConfiguration' => [
                    'NoSquashNids' => ['<string>', ...],
                    'RootSquash' => '<string>',
                ],
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OntapConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'EndpointIpAddressRange' => '<string>',
                'Endpoints' => [
                    'Intercluster' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                    'Management' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                ],
                'FsxAdminPassword' => '<string>',
                'HAPairs' => <integer>,
                'PreferredSubnetId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'ThroughputCapacityPerHAPair' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OpenZFSConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'CopyTagsToVolumes' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'EndpointIpAddress' => '<string>',
                'EndpointIpAddressRange' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RootVolumeId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD',
            'SubnetIds' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => '<string>',
                'Aliases' => [
                    [
                        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'AuditLogConfiguration' => [
                    'AuditLogDestination' => '<string>',
                    'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                    'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                ],
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'MaintenanceOperationsInProgress' => ['<string>', ...],
                'PreferredFileServerIp' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RemoteAdministrationEndpoint' => '<string>',
                'SelfManagedActiveDirectoryConfiguration' => [
                    'DnsIps' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'FileSystemAdministratorsGroup' => '<string>',
                    'OrganizationalUnitDistinguishedName' => '<string>',
                    'UserName' => '<string>',
                ],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
        ],
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING|COPYING',
        'OwnerId' => '<string>',
        'ProgressPercent' => <integer>,
        'ResourceARN' => '<string>',
        'ResourceType' => 'FILE_SYSTEM|VOLUME',
        'SourceBackupId' => '<string>',
        'SourceBackupRegion' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
        'Volume' => [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RemainingTransferBytes' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                    'TargetFileSystemValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'DNSName' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'FileSystemId' => '<string>',
                        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                        'FileSystemTypeVersion' => '<string>',
                        'KmsKeyId' => '<string>',
                        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                        'LustreConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DataCompressionType' => 'NONE|LZ4',
                            'DataRepositoryConfiguration' => [
                                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                                'ExportPath' => '<string>',
                                'FailureDetails' => [
                                    'Message' => '<string>',
                                ],
                                'ImportPath' => '<string>',
                                'ImportedFileChunkSize' => <integer>,
                                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                            ],
                            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                            'DriveCacheType' => 'NONE|READ',
                            'LogConfiguration' => [
                                'Destination' => '<string>',
                                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                            ],
                            'MetadataConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'MountName' => '<string>',
                            'PerUnitStorageThroughput' => <integer>,
                            'RootSquashConfiguration' => [
                                'NoSquashNids' => ['<string>', ...],
                                'RootSquash' => '<string>',
                            ],
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'NetworkInterfaceIds' => ['<string>', ...],
                        'OntapConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddressRange' => '<string>',
                            'Endpoints' => [
                                'Intercluster' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                                'Management' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                            ],
                            'FsxAdminPassword' => '<string>',
                            'HAPairs' => <integer>,
                            'PreferredSubnetId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'ThroughputCapacityPerHAPair' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OpenZFSConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'CopyTagsToVolumes' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddress' => '<string>',
                            'EndpointIpAddressRange' => '<string>',
                            'PreferredSubnetId' => '<string>',
                            'RootVolumeId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD',
                        'SubnetIds' => ['<string>', ...],
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VpcId' => '<string>',
                        'WindowsConfiguration' => [
                            'ActiveDirectoryId' => '<string>',
                            'Aliases' => [
                                [
                                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'AuditLogConfiguration' => [
                                'AuditLogDestination' => '<string>',
                                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            ],
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'MaintenanceOperationsInProgress' => ['<string>', ...],
                            'PreferredFileServerIp' => '<string>',
                            'PreferredSubnetId' => '<string>',
                            'RemoteAdministrationEndpoint' => '<string>',
                            'SelfManagedActiveDirectoryConfiguration' => [
                                'DnsIps' => ['<string>', ...],
                                'DomainName' => '<string>',
                                'FileSystemAdministratorsGroup' => '<string>',
                                'OrganizationalUnitDistinguishedName' => '<string>',
                                'UserName' => '<string>',
                            ],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                    ],
                    'TargetSnapshotValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'ResourceARN' => '<string>',
                        'SnapshotId' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                    ],
                    'TargetVolumeValues' => [...], // RECURSIVE
                    'TotalTransferBytes' => <integer>,
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'FileSystemId' => '<string>',
            'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
            'LifecycleTransitionReason' => [
                'Message' => '<string>',
            ],
            'Name' => '<string>',
            'OntapConfiguration' => [
                'AggregateConfiguration' => [
                    'Aggregates' => ['<string>', ...],
                    'TotalConstituents' => <integer>,
                ],
                'CopyTagsToBackups' => true || false,
                'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                'JunctionPath' => '<string>',
                'OntapVolumeType' => 'RW|DP|LS',
                'SecurityStyle' => 'UNIX|NTFS|MIXED',
                'SizeInBytes' => <integer>,
                'SizeInMegabytes' => <integer>,
                'SnaplockConfiguration' => [
                    'AuditLogVolume' => true || false,
                    'AutocommitPeriod' => [
                        'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                        'Value' => <integer>,
                    ],
                    'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                    'RetentionPeriod' => [
                        'DefaultRetention' => [
                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                            'Value' => <integer>,
                        ],
                        'MaximumRetention' => [
                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                            'Value' => <integer>,
                        ],
                        'MinimumRetention' => [
                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                            'Value' => <integer>,
                        ],
                    ],
                    'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                    'VolumeAppendModeEnabled' => true || false,
                ],
                'SnapshotPolicy' => '<string>',
                'StorageEfficiencyEnabled' => true || false,
                'StorageVirtualMachineId' => '<string>',
                'StorageVirtualMachineRoot' => true || false,
                'TieringPolicy' => [
                    'CoolingPeriod' => <integer>,
                    'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                ],
                'UUID' => '<string>',
                'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
            ],
            'OpenZFSConfiguration' => [
                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                'CopyTagsToSnapshots' => true || false,
                'DataCompressionType' => 'NONE|ZSTD|LZ4',
                'DeleteClonedVolumes' => true || false,
                'DeleteIntermediateData' => true || false,
                'DeleteIntermediateSnaphots' => true || false,
                'DestinationSnapshot' => '<string>',
                'NfsExports' => [
                    [
                        'ClientConfigurations' => [
                            [
                                'Clients' => '<string>',
                                'Options' => ['<string>', ...],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'OriginSnapshot' => [
                    'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                    'SnapshotARN' => '<string>',
                ],
                'ParentVolumeId' => '<string>',
                'ReadOnly' => true || false,
                'RecordSizeKiB' => <integer>,
                'RestoreToSnapshot' => '<string>',
                'SourceSnapshotARN' => '<string>',
                'StorageCapacityQuotaGiB' => <integer>,
                'StorageCapacityReservationGiB' => <integer>,
                'UserAndGroupQuotas' => [
                    [
                        'Id' => <integer>,
                        'StorageCapacityQuotaGiB' => <integer>,
                        'Type' => 'USER|GROUP',
                    ],
                    // ...
                ],
                'VolumePath' => '<string>',
            ],
            'ResourceARN' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VolumeId' => '<string>',
            'VolumeType' => 'ONTAP|OPENZFS',
        ],
    ],
]

Result Details

Members
Backup
Type: Backup structure

A description of the backup.

Errors

BadRequest:

A generic error indicating a failure with a client request.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

VolumeNotFound:

No Amazon FSx volumes were found based upon the supplied parameters.

BackupInProgress:

Another backup is already under way. Wait for completion before initiating additional backups of this file system.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

Examples

Example 1: To create a new backup

This operation creates a new backup.

$result = $client->createBackup([
    'FileSystemId' => 'fs-0498eed5fe91001ec',
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyBackup',
        ],
    ],
]);

Result syntax:

[
    'Backup' => [
        'BackupId' => 'backup-03e3c82e0183b7b6b',
        'CreationTime' => ,
        'FileSystem' => [
            'FileSystemId' => 'fs-0498eed5fe91001ec',
            'OwnerId' => '012345678912',
            'StorageCapacity' => 300,
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => 'd-1234abcd12',
                'AutomaticBackupRetentionDays' => 30,
                'DailyAutomaticBackupStartTime' => '05:00',
                'WeeklyMaintenanceStartTime' => '1:05:00',
            ],
        ],
        'Lifecycle' => 'CREATING',
        'ProgressPercent' => 0,
        'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b',
        'Tags' => [
            [
                'Key' => 'Name',
                'Value' => 'MyBackup',
            ],
        ],
        'Type' => 'USER_INITIATED',
    ],
]

CreateDataRepositoryAssociation

$result = $client->createDataRepositoryAssociation([/* ... */]);
$promise = $client->createDataRepositoryAssociationAsync([/* ... */]);

Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.

Parameter Syntax

$result = $client->createDataRepositoryAssociation([
    'BatchImportMetaDataOnCreate' => true || false,
    'ClientRequestToken' => '<string>',
    'DataRepositoryPath' => '<string>', // REQUIRED
    'FileSystemId' => '<string>', // REQUIRED
    'FileSystemPath' => '<string>',
    'ImportedFileChunkSize' => <integer>,
    'S3' => [
        'AutoExportPolicy' => [
            'Events' => ['<string>', ...],
        ],
        'AutoImportPolicy' => [
            'Events' => ['<string>', ...],
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
BatchImportMetaDataOnCreate
Type: boolean

Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.

ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

DataRepositoryPath
Required: Yes
Type: string

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.

FileSystemId
Required: Yes
Type: string

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

FileSystemPath
Type: string

A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.

ImportedFileChunkSize
Type: int

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

S3

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

Tags
Type: Array of Tag structures

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

Result Syntax

[
    'Association' => [
        'AssociationId' => '<string>',
        'BatchImportMetaDataOnCreate' => true || false,
        'CreationTime' => <DateTime>,
        'DataRepositoryPath' => '<string>',
        'DataRepositorySubdirectories' => ['<string>', ...],
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileCacheId' => '<string>',
        'FileCachePath' => '<string>',
        'FileSystemId' => '<string>',
        'FileSystemPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
        'NFS' => [
            'AutoExportPolicy' => [
                'Events' => ['<string>', ...],
            ],
            'DnsIps' => ['<string>', ...],
            'Version' => 'NFS3',
        ],
        'ResourceARN' => '<string>',
        'S3' => [
            'AutoExportPolicy' => [
                'Events' => ['<string>', ...],
            ],
            'AutoImportPolicy' => [
                'Events' => ['<string>', ...],
            ],
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Association
Type: DataRepositoryAssociation structure

The response object returned after the data repository association is created.

Errors

BadRequest:

A generic error indicating a failure with a client request.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

CreateDataRepositoryTask

$result = $client->createDataRepositoryTask([/* ... */]);
$promise = $client->createDataRepositoryTaskAsync([/* ... */]);

Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system.

You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository.

You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre file system.

To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

Parameter Syntax

$result = $client->createDataRepositoryTask([
    'CapacityToRelease' => <integer>,
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'Paths' => ['<string>', ...],
    'ReleaseConfiguration' => [
        'DurationSinceLastAccess' => [
            'Unit' => 'DAYS',
            'Value' => <integer>,
        ],
    ],
    'Report' => [ // REQUIRED
        'Enabled' => true || false, // REQUIRED
        'Format' => 'REPORT_CSV_20191124',
        'Path' => '<string>',
        'Scope' => 'FAILED_FILES_ONLY',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'EXPORT_TO_REPOSITORY|IMPORT_METADATA_FROM_REPOSITORY|RELEASE_DATA_FROM_FILESYSTEM|AUTO_RELEASE_DATA', // REQUIRED
]);

Parameter Details

Members
CapacityToRelease
Type: long (int|float)

Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Required: Yes
Type: string

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

Paths
Type: Array of strings

A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).

  • For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.

  • For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

  • For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.

    A file must also meet the last accessed time criteria specified in for the file to be released.

ReleaseConfiguration
Type: ReleaseConfiguration structure

The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.

Report
Required: Yes
Type: CompletionReport structure

Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter. For more information, see Working with Task Completion Reports.

Tags
Type: Array of Tag structures

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

Type
Required: Yes
Type: string

Specifies the type of data repository task to create.

  • EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.

  • IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.

  • RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.

  • AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

Result Syntax

[
    'DataRepositoryTask' => [
        'CapacityToRelease' => <integer>,
        'CreationTime' => <DateTime>,
        'EndTime' => <DateTime>,
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileCacheId' => '<string>',
        'FileSystemId' => '<string>',
        'Lifecycle' => 'PENDING|EXECUTING|FAILED|SUCCEEDED|CANCELED|CANCELING',
        'Paths' => ['<string>', ...],
        'ReleaseConfiguration' => [
            'DurationSinceLastAccess' => [
                'Unit' => 'DAYS',
                'Value' => <integer>,
            ],
        ],
        'Report' => [
            'Enabled' => true || false,
            'Format' => 'REPORT_CSV_20191124',
            'Path' => '<string>',
            'Scope' => 'FAILED_FILES_ONLY',
        ],
        'ResourceARN' => '<string>',
        'StartTime' => <DateTime>,
        'Status' => [
            'FailedCount' => <integer>,
            'LastUpdatedTime' => <DateTime>,
            'ReleasedCapacity' => <integer>,
            'SucceededCount' => <integer>,
            'TotalCount' => <integer>,
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TaskId' => '<string>',
        'Type' => 'EXPORT_TO_REPOSITORY|IMPORT_METADATA_FROM_REPOSITORY|RELEASE_DATA_FROM_FILESYSTEM|AUTO_RELEASE_DATA',
    ],
]

Result Details

Members
DataRepositoryTask
Type: DataRepositoryTask structure

The description of the data repository task that you just created.

Errors

BadRequest:

A generic error indicating a failure with a client request.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

DataRepositoryTaskExecuting:

An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.

CreateFileCache

$result = $client->createFileCache([/* ... */]);
$promise = $client->createFileCacheAsync([/* ... */]);

Creates a new Amazon File Cache resource.

You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following:

  • Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the cache in JSON format.

The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.

Parameter Syntax

$result = $client->createFileCache([
    'ClientRequestToken' => '<string>',
    'CopyTagsToDataRepositoryAssociations' => true || false,
    'DataRepositoryAssociations' => [
        [
            'DataRepositoryPath' => '<string>', // REQUIRED
            'DataRepositorySubdirectories' => ['<string>', ...],
            'FileCachePath' => '<string>', // REQUIRED
            'NFS' => [
                'DnsIps' => ['<string>', ...],
                'Version' => 'NFS3', // REQUIRED
            ],
        ],
        // ...
    ],
    'FileCacheType' => 'LUSTRE', // REQUIRED
    'FileCacheTypeVersion' => '<string>', // REQUIRED
    'KmsKeyId' => '<string>',
    'LustreConfiguration' => [
        'DeploymentType' => 'CACHE_1', // REQUIRED
        'MetadataConfiguration' => [ // REQUIRED
            'StorageCapacity' => <integer>, // REQUIRED
        ],
        'PerUnitStorageThroughput' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'StorageCapacity' => <integer>, // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

By using the idempotent operation, you can retry a CreateFileCache operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.

CopyTagsToDataRepositoryAssociations
Type: boolean

A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

DataRepositoryAssociations
Type: Array of FileCacheDataRepositoryAssociation structures

A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.

The DRA configurations must meet the following requirements:

  • All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.

  • An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.

DRA automatic import and automatic export is not supported.

FileCacheType
Required: Yes
Type: string

The type of cache that you're creating, which must be LUSTRE.

FileCacheTypeVersion
Required: Yes
Type: string

Sets the Lustre version for the cache that you're creating, which must be 2.12.

KmsKeyId
Type: string

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

LustreConfiguration

The configuration for the Amazon File Cache resource being created.

SecurityGroupIds
Type: Array of strings

A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.

StorageCapacity
Required: Yes
Type: int

The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

SubnetIds
Required: Yes
Type: Array of strings

A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the CreateFileCache operation.

Tags
Type: Array of Tag structures

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

Result Syntax

[
    'FileCache' => [
        'CopyTagsToDataRepositoryAssociations' => true || false,
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'DataRepositoryAssociationIds' => ['<string>', ...],
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileCacheId' => '<string>',
        'FileCacheType' => 'LUSTRE',
        'FileCacheTypeVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|UPDATING|FAILED',
        'LustreConfiguration' => [
            'DeploymentType' => 'CACHE_1',
            'LogConfiguration' => [
                'Destination' => '<string>',
                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
            ],
            'MetadataConfiguration' => [
                'StorageCapacity' => <integer>,
            ],
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members
FileCache
Type: FileCacheCreating structure

A description of the cache that was created.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InvalidNetworkSettings:

One or more network settings specified in the request are invalid.

InvalidPerUnitStorageThroughput:

An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

MissingFileCacheConfiguration:

A cache configuration is required for this operation.

CreateFileSystem

$result = $client->createFileSystem([/* ... */]);
$promise = $client->createFileSystemAsync([/* ... */]);

Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:

  • Amazon FSx for Lustre

  • Amazon FSx for NetApp ONTAP

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:

  • Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system in JSON format.

The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

Parameter Syntax

$result = $client->createFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS', // REQUIRED
    'FileSystemTypeVersion' => '<string>',
    'KmsKeyId' => '<string>',
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DataCompressionType' => 'NONE|LZ4',
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
        'DriveCacheType' => 'NONE|READ',
        'ExportPath' => '<string>',
        'ImportPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'LogConfiguration' => [
            'Destination' => '<string>',
            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR', // REQUIRED
        ],
        'MetadataConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED', // REQUIRED
        ],
        'PerUnitStorageThroughput' => <integer>,
        'RootSquashConfiguration' => [
            'NoSquashNids' => ['<string>', ...],
            'RootSquash' => '<string>',
        ],
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'OntapConfiguration' => [
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2', // REQUIRED
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'EndpointIpAddressRange' => '<string>',
        'FsxAdminPassword' => '<string>',
        'HAPairs' => <integer>,
        'PreferredSubnetId' => '<string>',
        'RouteTableIds' => ['<string>', ...],
        'ThroughputCapacity' => <integer>,
        'ThroughputCapacityPerHAPair' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'OpenZFSConfiguration' => [
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'CopyTagsToVolumes' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1', // REQUIRED
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'EndpointIpAddressRange' => '<string>',
        'PreferredSubnetId' => '<string>',
        'RootVolumeConfiguration' => [
            'CopyTagsToSnapshots' => true || false,
            'DataCompressionType' => 'NONE|ZSTD|LZ4',
            'NfsExports' => [
                [
                    'ClientConfigurations' => [ // REQUIRED
                        [
                            'Clients' => '<string>', // REQUIRED
                            'Options' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'ReadOnly' => true || false,
            'RecordSizeKiB' => <integer>,
            'UserAndGroupQuotas' => [
                [
                    'Id' => <integer>, // REQUIRED
                    'StorageCapacityQuotaGiB' => <integer>, // REQUIRED
                    'Type' => 'USER|GROUP', // REQUIRED
                ],
                // ...
            ],
        ],
        'RouteTableIds' => ['<string>', ...],
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'StorageCapacity' => <integer>, // REQUIRED
    'StorageType' => 'SSD|HDD',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => '<string>',
        'Aliases' => ['<string>', ...],
        'AuditLogConfiguration' => [
            'AuditLogDestination' => '<string>',
            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
        ],
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'PreferredSubnetId' => '<string>',
        'SelfManagedActiveDirectoryConfiguration' => [
            'DnsIps' => ['<string>', ...], // REQUIRED
            'DomainName' => '<string>', // REQUIRED
            'FileSystemAdministratorsGroup' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
            'Password' => '<string>', // REQUIRED
            'UserName' => '<string>', // REQUIRED
        ],
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemType
Required: Yes
Type: string

The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.

FileSystemTypeVersion
Type: string

For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10, 2.12, and 2.15:

  • 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.

  • 2.12 is supported by all Lustre deployment types, except for PERSISTENT_2 with a metadata configuration mode.

  • 2.15 is supported by all Lustre deployment types and is recommended for all new file systems.

Default value is 2.10, except for the following deployments:

  • Default value is 2.12 when DeploymentType is set to PERSISTENT_2 without a metadata configuration mode.

  • Default value is 2.15 when DeploymentType is set to PERSISTENT_2 with a metadata configuration mode.

KmsKeyId
Type: string

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:

  • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

    SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

  • Amazon FSx for NetApp ONTAP

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

LustreConfiguration

The Lustre configuration for the file system being created.

The following parameters are not supported for file systems with a data repository association created with .

  • AutoImportPolicy

  • ExportPath

  • ImportedFileChunkSize

  • ImportPath

OntapConfiguration

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

OpenZFSConfiguration

The OpenZFS configuration for the file system that's being created.

SecurityGroupIds
Type: Array of strings

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.

StorageCapacity
Required: Yes
Type: int

Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).

FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType, as follows:

  • For SCRATCH_2, PERSISTENT_2, and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

  • For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.

  • For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.

FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).

FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:

  • For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).

  • For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).

StorageType
Type: string

Sets the storage type for the file system that you're creating. Valid values are SSD and HDD.

  • Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.

  • Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.

Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.

SubnetIds
Required: Yes
Type: Array of strings

Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.

For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Tags
Type: Array of Tag structures

The tags to apply to the file system that's being created. The key value of the Name tag appears in the console as the file system name.

WindowsConfiguration

The Microsoft Windows configuration for the file system that's being created.

Result Syntax

[
    'FileSystem' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
                'TargetSnapshotValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'ResourceARN' => '<string>',
                    'SnapshotId' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                ],
                'TargetVolumeValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'FileSystemId' => '<string>',
                    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'OntapConfiguration' => [
                        'AggregateConfiguration' => [
                            'Aggregates' => ['<string>', ...],
                            'TotalConstituents' => <integer>,
                        ],
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInBytes' => <integer>,
                        'SizeInMegabytes' => <integer>,
                        'SnaplockConfiguration' => [
                            'AuditLogVolume' => true || false,
                            'AutocommitPeriod' => [
                                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                'Value' => <integer>,
                            ],
                            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                            'RetentionPeriod' => [
                                'DefaultRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MaximumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MinimumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                            ],
                            'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                            'VolumeAppendModeEnabled' => true || false,
                        ],
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                        'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateData' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'DestinationSnapshot' => '<string>',
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<string>',
                        'SourceSnapshotARN' => '<string>',
                        'StorageCapacityQuotaGiB' => <integer>,
                        'StorageCapacityReservationGiB' => <integer>,
                        'UserAndGroupQuotas' => [
                            [
                                'Id' => <integer>,
                                'StorageCapacityQuotaGiB' => <integer>,
                                'Type' => 'USER|GROUP',
                            ],
                            // ...
                        ],
                        'VolumePath' => '<string>',
                    ],
                    'ResourceARN' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                    'VolumeType' => 'ONTAP|OPENZFS',
                ],
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
        'FileSystemTypeVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataCompressionType' => 'NONE|LZ4',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
            'DriveCacheType' => 'NONE|READ',
            'LogConfiguration' => [
                'Destination' => '<string>',
                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
            ],
            'MetadataConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'RootSquashConfiguration' => [
                'NoSquashNids' => ['<string>', ...],
                'RootSquash' => '<string>',
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OntapConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddressRange' => '<string>',
            'Endpoints' => [
                'Intercluster' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Management' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
            ],
            'FsxAdminPassword' => '<string>',
            'HAPairs' => <integer>,
            'PreferredSubnetId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'ThroughputCapacityPerHAPair' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OpenZFSConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'CopyTagsToVolumes' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddress' => '<string>',
            'EndpointIpAddressRange' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AuditLogConfiguration' => [
                'AuditLogDestination' => '<string>',
                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'PreferredFileServerIp' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RemoteAdministrationEndpoint' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members
FileSystem
Type: FileSystem structure

The configuration of the file system that was created.

Errors

BadRequest:

A generic error indicating a failure with a client request.

ActiveDirectoryError:

An Active Directory error.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InvalidImportPath:

The path provided for data repository import isn't valid.

InvalidExportPath:

The path provided for data repository export isn't valid.

InvalidNetworkSettings:

One or more network settings specified in the request are invalid.

InvalidPerUnitStorageThroughput:

An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

MissingFileSystemConfiguration:

A file system configuration is required for this operation.

Examples

Example 1: To create a new file system

This operation creates a new Amazon FSx for Windows File Server file system.

$result = $client->createFileSystem([
    'ClientRequestToken' => 'a8ca07e4-61ec-4399-99f4-19853801bcd5',
    'FileSystemType' => 'WINDOWS',
    'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff',
    'SecurityGroupIds' => [
        'sg-edcd9784',
    ],
    'StorageCapacity' => 3200,
    'StorageType' => 'HDD',
    'SubnetIds' => [
        'subnet-1234abcd',
    ],
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyFileSystem',
        ],
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => 'd-1234abcd12',
        'Aliases' => [
            'accounting.corp.example.com',
        ],
        'AutomaticBackupRetentionDays' => 30,
        'DailyAutomaticBackupStartTime' => '05:00',
        'ThroughputCapacity' => 32,
        'WeeklyMaintenanceStartTime' => '1:05:00',
    ],
]);

Result syntax:

[
    'FileSystem' => [
        'CreationTime' => ,
        'DNSName' => 'fs-0123456789abcdef0.fsx.com',
        'FileSystemId' => 'fs-0123456789abcdef0',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff',
        'Lifecycle' => 'CREATING',
        'OwnerId' => '012345678912',
        'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0123456789abcdef0',
        'StorageCapacity' => 3200,
        'StorageType' => 'HDD',
        'SubnetIds' => [
            'subnet-1234abcd',
        ],
        'Tags' => [
            [
                'Key' => 'Name',
                'Value' => 'MyFileSystem',
            ],
        ],
        'VpcId' => 'vpc-ab1234cd',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => 'd-1234abcd12',
            'Aliases' => [
                [
                    'Lifecycle' => 'CREATING',
                    'Name' => 'accounting.corp.example.com',
                ],
            ],
            'AutomaticBackupRetentionDays' => 30,
            'DailyAutomaticBackupStartTime' => '05:00',
            'ThroughputCapacity' => 32,
            'WeeklyMaintenanceStartTime' => '1:05:00',
        ],
    ],
]

CreateFileSystemFromBackup

$result = $client->createFileSystemFromBackup([/* ... */]);
$promise = $client->createFileSystemFromBackupAsync([/* ... */]);

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a file system with the specified client request token exists but the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

  • Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.

The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

Parameter Syntax

$result = $client->createFileSystemFromBackup([
    'BackupId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'FileSystemTypeVersion' => '<string>',
    'KmsKeyId' => '<string>',
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DataCompressionType' => 'NONE|LZ4',
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
        'DriveCacheType' => 'NONE|READ',
        'ExportPath' => '<string>',
        'ImportPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'LogConfiguration' => [
            'Destination' => '<string>',
            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR', // REQUIRED
        ],
        'MetadataConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED', // REQUIRED
        ],
        'PerUnitStorageThroughput' => <integer>,
        'RootSquashConfiguration' => [
            'NoSquashNids' => ['<string>', ...],
            'RootSquash' => '<string>',
        ],
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'OpenZFSConfiguration' => [
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'CopyTagsToVolumes' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1', // REQUIRED
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'EndpointIpAddressRange' => '<string>',
        'PreferredSubnetId' => '<string>',
        'RootVolumeConfiguration' => [
            'CopyTagsToSnapshots' => true || false,
            'DataCompressionType' => 'NONE|ZSTD|LZ4',
            'NfsExports' => [
                [
                    'ClientConfigurations' => [ // REQUIRED
                        [
                            'Clients' => '<string>', // REQUIRED
                            'Options' => ['<string>', ...], // REQUIRED
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'ReadOnly' => true || false,
            'RecordSizeKiB' => <integer>,
            'UserAndGroupQuotas' => [
                [
                    'Id' => <integer>, // REQUIRED
                    'StorageCapacityQuotaGiB' => <integer>, // REQUIRED
                    'Type' => 'USER|GROUP', // REQUIRED
                ],
                // ...
            ],
        ],
        'RouteTableIds' => ['<string>', ...],
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'StorageCapacity' => <integer>,
    'StorageType' => 'SSD|HDD',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => '<string>',
        'Aliases' => ['<string>', ...],
        'AuditLogConfiguration' => [
            'AuditLogDestination' => '<string>',
            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
        ],
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'PreferredSubnetId' => '<string>',
        'SelfManagedActiveDirectoryConfiguration' => [
            'DnsIps' => ['<string>', ...], // REQUIRED
            'DomainName' => '<string>', // REQUIRED
            'FileSystemAdministratorsGroup' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
            'Password' => '<string>', // REQUIRED
            'UserName' => '<string>', // REQUIRED
        ],
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members
BackupId
Required: Yes
Type: string

The ID of the source backup. Specifies the backup that you are copying.

ClientRequestToken
Type: string

A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemTypeVersion
Type: string

Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10, 2.12, and 2.15.

You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.

KmsKeyId
Type: string

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:

  • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

    SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

  • Amazon FSx for NetApp ONTAP

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

LustreConfiguration

The Lustre configuration for the file system being created.

The following parameters are not supported for file systems with a data repository association created with .

  • AutoImportPolicy

  • ExportPath

  • ImportedFileChunkSize

  • ImportPath

OpenZFSConfiguration

The OpenZFS configuration for the file system that's being created.

SecurityGroupIds
Type: Array of strings

A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.

StorageCapacity
Type: int

Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.

If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.

StorageType
Type: string

Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.

  • Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.

  • Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.

The default value is SSD.

HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.

SubnetIds
Required: Yes
Type: Array of strings

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Tags
Type: Array of Tag structures

The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

WindowsConfiguration

The configuration for this Microsoft Windows file system.

Result Syntax

[
    'FileSystem' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
                'TargetSnapshotValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'ResourceARN' => '<string>',
                    'SnapshotId' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                ],
                'TargetVolumeValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'FileSystemId' => '<string>',
                    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'OntapConfiguration' => [
                        'AggregateConfiguration' => [
                            'Aggregates' => ['<string>', ...],
                            'TotalConstituents' => <integer>,
                        ],
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInBytes' => <integer>,
                        'SizeInMegabytes' => <integer>,
                        'SnaplockConfiguration' => [
                            'AuditLogVolume' => true || false,
                            'AutocommitPeriod' => [
                                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                'Value' => <integer>,
                            ],
                            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                            'RetentionPeriod' => [
                                'DefaultRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MaximumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MinimumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                            ],
                            'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                            'VolumeAppendModeEnabled' => true || false,
                        ],
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                        'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateData' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'DestinationSnapshot' => '<string>',
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<string>',
                        'SourceSnapshotARN' => '<string>',
                        'StorageCapacityQuotaGiB' => <integer>,
                        'StorageCapacityReservationGiB' => <integer>,
                        'UserAndGroupQuotas' => [
                            [
                                'Id' => <integer>,
                                'StorageCapacityQuotaGiB' => <integer>,
                                'Type' => 'USER|GROUP',
                            ],
                            // ...
                        ],
                        'VolumePath' => '<string>',
                    ],
                    'ResourceARN' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                    'VolumeType' => 'ONTAP|OPENZFS',
                ],
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
        'FileSystemTypeVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataCompressionType' => 'NONE|LZ4',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
            'DriveCacheType' => 'NONE|READ',
            'LogConfiguration' => [
                'Destination' => '<string>',
                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
            ],
            'MetadataConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'RootSquashConfiguration' => [
                'NoSquashNids' => ['<string>', ...],
                'RootSquash' => '<string>',
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OntapConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddressRange' => '<string>',
            'Endpoints' => [
                'Intercluster' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Management' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
            ],
            'FsxAdminPassword' => '<string>',
            'HAPairs' => <integer>,
            'PreferredSubnetId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'ThroughputCapacityPerHAPair' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OpenZFSConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'CopyTagsToVolumes' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddress' => '<string>',
            'EndpointIpAddressRange' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AuditLogConfiguration' => [
                'AuditLogDestination' => '<string>',
                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'PreferredFileServerIp' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RemoteAdministrationEndpoint' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members
FileSystem
Type: FileSystem structure

A description of the file system.

Errors

BadRequest:

A generic error indicating a failure with a client request.

ActiveDirectoryError:

An Active Directory error.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InvalidNetworkSettings:

One or more network settings specified in the request are invalid.

InvalidPerUnitStorageThroughput:

An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

BackupNotFound:

No Amazon FSx backups were found based upon the supplied parameters.

InternalServerError:

A generic error indicating a server-side failure.

MissingFileSystemConfiguration:

A file system configuration is required for this operation.

Examples

Example 1: To create a new file system from backup

This operation creates a new file system from backup.

$result = $client->createFileSystemFromBackup([
    'BackupId' => 'backup-03e3c82e0183b7b6b',
    'ClientRequestToken' => 'f4c94ed7-238d-4c46-93db-48cd62ec33b7',
    'SecurityGroupIds' => [
        'sg-edcd9784',
    ],
    'SubnetIds' => [
        'subnet-1234abcd',
    ],
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyFileSystem',
        ],
    ],
    'WindowsConfiguration' => [
        'ThroughputCapacity' => 8,
    ],
]);

Result syntax:

[
    'FileSystem' => [
        'CreationTime' => ,
        'DNSName' => 'fs-0498eed5fe91001ec.fsx.com',
        'FileSystemId' => 'fs-0498eed5fe91001ec',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6',
        'Lifecycle' => 'CREATING',
        'OwnerId' => '012345678912',
        'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
        'StorageCapacity' => 300,
        'SubnetIds' => [
            'subnet-1234abcd',
        ],
        'Tags' => [
            [
                'Key' => 'Name',
                'Value' => 'MyFileSystem',
            ],
        ],
        'VpcId' => 'vpc-ab1234cd',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => 'd-1234abcd12',
            'AutomaticBackupRetentionDays' => 30,
            'DailyAutomaticBackupStartTime' => '05:00',
            'ThroughputCapacity' => 8,
            'WeeklyMaintenanceStartTime' => '1:05:00',
        ],
    ],
]

CreateSnapshot

$result = $client->createSnapshot([/* ... */]);
$promise = $client->createSnapshotAsync([/* ... */]);

Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.

If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following:

  • Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the snapshot.

By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.

The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.

Parameter Syntax

$result = $client->createSnapshot([
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VolumeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Name
Required: Yes
Type: string

The name of the snapshot.

Tags
Type: Array of Tag structures

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

VolumeId
Required: Yes
Type: string

The ID of the volume that you are taking a snapshot of.

Result Syntax

[
    'Snapshot' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'DNSName' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'FileSystemId' => '<string>',
                    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                    'FileSystemTypeVersion' => '<string>',
                    'KmsKeyId' => '<string>',
                    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                    'LustreConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DataCompressionType' => 'NONE|LZ4',
                        'DataRepositoryConfiguration' => [
                            'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                            'ExportPath' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'ImportPath' => '<string>',
                            'ImportedFileChunkSize' => <integer>,
                            'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                        ],
                        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                        'DriveCacheType' => 'NONE|READ',
                        'LogConfiguration' => [
                            'Destination' => '<string>',
                            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                        ],
                        'MetadataConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MountName' => '<string>',
                        'PerUnitStorageThroughput' => <integer>,
                        'RootSquashConfiguration' => [
                            'NoSquashNids' => ['<string>', ...],
                            'RootSquash' => '<string>',
                        ],
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'NetworkInterfaceIds' => ['<string>', ...],
                    'OntapConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddressRange' => '<string>',
                        'Endpoints' => [
                            'Intercluster' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                            'Management' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                        ],
                        'FsxAdminPassword' => '<string>',
                        'HAPairs' => <integer>,
                        'PreferredSubnetId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'ThroughputCapacityPerHAPair' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'CopyTagsToVolumes' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddress' => '<string>',
                        'EndpointIpAddressRange' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD',
                    'SubnetIds' => ['<string>', ...],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                    'WindowsConfiguration' => [
                        'ActiveDirectoryId' => '<string>',
                        'Aliases' => [
                            [
                                'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'AuditLogConfiguration' => [
                            'AuditLogDestination' => '<string>',
                            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        ],
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MaintenanceOperationsInProgress' => ['<string>', ...],
                        'PreferredFileServerIp' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RemoteAdministrationEndpoint' => '<string>',
                        'SelfManagedActiveDirectoryConfiguration' => [
                            'DnsIps' => ['<string>', ...],
                            'DomainName' => '<string>',
                            'FileSystemAdministratorsGroup' => '<string>',
                            'OrganizationalUnitDistinguishedName' => '<string>',
                            'UserName' => '<string>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                ],
                'TargetSnapshotValues' => [...], // RECURSIVE
                'TargetVolumeValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'FileSystemId' => '<string>',
                    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'OntapConfiguration' => [
                        'AggregateConfiguration' => [
                            'Aggregates' => ['<string>', ...],
                            'TotalConstituents' => <integer>,
                        ],
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInBytes' => <integer>,
                        'SizeInMegabytes' => <integer>,
                        'SnaplockConfiguration' => [
                            'AuditLogVolume' => true || false,
                            'AutocommitPeriod' => [
                                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                'Value' => <integer>,
                            ],
                            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                            'RetentionPeriod' => [
                                'DefaultRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MaximumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MinimumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                            ],
                            'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                            'VolumeAppendModeEnabled' => true || false,
                        ],
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                        'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateData' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'DestinationSnapshot' => '<string>',
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<string>',
                        'SourceSnapshotARN' => '<string>',
                        'StorageCapacityQuotaGiB' => <integer>,
                        'StorageCapacityReservationGiB' => <integer>,
                        'UserAndGroupQuotas' => [
                            [
                                'Id' => <integer>,
                                'StorageCapacityQuotaGiB' => <integer>,
                                'Type' => 'USER|GROUP',
                            ],
                            // ...
                        ],
                        'VolumePath' => '<string>',
                    ],
                    'ResourceARN' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                    'VolumeType' => 'ONTAP|OPENZFS',
                ],
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
        'LifecycleTransitionReason' => [
            'Message' => '<string>',
        ],
        'Name' => '<string>',
        'ResourceARN' => '<string>',
        'SnapshotId' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VolumeId' => '<string>',
    ],
]

Result Details

Members
Snapshot
Type: Snapshot structure

A description of the snapshot.

Errors

BadRequest:

A generic error indicating a failure with a client request.

VolumeNotFound:

No Amazon FSx volumes were found based upon the supplied parameters.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

CreateStorageVirtualMachine

$result = $client->createStorageVirtualMachine([/* ... */]);
$promise = $client->createStorageVirtualMachineAsync([/* ... */]);

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

Parameter Syntax

$result = $client->createStorageVirtualMachine([
    'ActiveDirectoryConfiguration' => [
        'NetBiosName' => '<string>', // REQUIRED
        'SelfManagedActiveDirectoryConfiguration' => [
            'DnsIps' => ['<string>', ...], // REQUIRED
            'DomainName' => '<string>', // REQUIRED
            'FileSystemAdministratorsGroup' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
            'Password' => '<string>', // REQUIRED
            'UserName' => '<string>', // REQUIRED
        ],
    ],
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RootVolumeSecurityStyle' => 'UNIX|NTFS|MIXED',
    'SvmAdminPassword' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ActiveDirectoryConfiguration

Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system.

ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Required: Yes
Type: string

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

Name
Required: Yes
Type: string

The name of the SVM.

RootVolumeSecurityStyle
Type: string

The security style of the root volume of the SVM. Specify one of the following values:

  • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.

  • NTFS if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account.

  • MIXED This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.

SvmAdminPassword
Type: string

The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin user to manage the SVM.

Tags
Type: Array of Tag structures

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

Result Syntax

[
    'StorageVirtualMachine' => [
        'ActiveDirectoryConfiguration' => [
            'NetBiosName' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
        ],
        'CreationTime' => <DateTime>,
        'Endpoints' => [
            'Iscsi' => [
                'DNSName' => '<string>',
                'IpAddresses' => ['<string>', ...],
            ],
            'Management' => [
                'DNSName' => '<string>',
                'IpAddresses' => ['<string>', ...],
            ],
            'Nfs' => [
                'DNSName' => '<string>',
                'IpAddresses' => ['<string>', ...],
            ],
            'Smb' => [
                'DNSName' => '<string>',
                'IpAddresses' => ['<string>', ...],
            ],
        ],
        'FileSystemId' => '<string>',
        'Lifecycle' => 'CREATED|CREATING|DELETING|FAILED|MISCONFIGURED|PENDING',
        'LifecycleTransitionReason' => [
            'Message' => '<string>',
        ],
        'Name' => '<string>',
        'ResourceARN' => '<string>',
        'RootVolumeSecurityStyle' => 'UNIX|NTFS|MIXED',
        'StorageVirtualMachineId' => '<string>',
        'Subtype' => 'DEFAULT|DP_DESTINATION|SYNC_DESTINATION|SYNC_SOURCE',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UUID' => '<string>',
    ],
]

Result Details

Members
StorageVirtualMachine
Type: StorageVirtualMachine structure

Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.

Errors

ActiveDirectoryError:

An Active Directory error.

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

CreateVolume

$result = $client->createVolume([/* ... */]);
$promise = $client->createVolumeAsync([/* ... */]);

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

Parameter Syntax

$result = $client->createVolume([
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'OntapConfiguration' => [
        'AggregateConfiguration' => [
            'Aggregates' => ['<string>', ...],
            'ConstituentsPerAggregate' => <integer>,
        ],
        'CopyTagsToBackups' => true || false,
        'JunctionPath' => '<string>',
        'OntapVolumeType' => 'RW|DP',
        'SecurityStyle' => 'UNIX|NTFS|MIXED',
        'SizeInBytes' => <integer>,
        'SizeInMegabytes' => <integer>,
        'SnaplockConfiguration' => [
            'AuditLogVolume' => true || false,
            'AutocommitPeriod' => [
                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE', // REQUIRED
                'Value' => <integer>,
            ],
            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
            'RetentionPeriod' => [
                'DefaultRetention' => [ // REQUIRED
                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED', // REQUIRED
                    'Value' => <integer>,
                ],
                'MaximumRetention' => [ // REQUIRED
                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED', // REQUIRED
                    'Value' => <integer>,
                ],
                'MinimumRetention' => [ // REQUIRED
                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED', // REQUIRED
                    'Value' => <integer>,
                ],
            ],
            'SnaplockType' => 'COMPLIANCE|ENTERPRISE', // REQUIRED
            'VolumeAppendModeEnabled' => true || false,
        ],
        'SnapshotPolicy' => '<string>',
        'StorageEfficiencyEnabled' => true || false,
        'StorageVirtualMachineId' => '<string>', // REQUIRED
        'TieringPolicy' => [
            'CoolingPeriod' => <integer>,
            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
        ],
        'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
    ],
    'OpenZFSConfiguration' => [
        'CopyTagsToSnapshots' => true || false,
        'DataCompressionType' => 'NONE|ZSTD|LZ4',
        'NfsExports' => [
            [
                'ClientConfigurations' => [ // REQUIRED
                    [
                        'Clients' => '<string>', // REQUIRED
                        'Options' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'OriginSnapshot' => [
            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY', // REQUIRED
            'SnapshotARN' => '<string>', // REQUIRED
        ],
        'ParentVolumeId' => '<string>', // REQUIRED
        'ReadOnly' => true || false,
        'RecordSizeKiB' => <integer>,
        'StorageCapacityQuotaGiB' => <integer>,
        'StorageCapacityReservationGiB' => <integer>,
        'UserAndGroupQuotas' => [
            [
                'Id' => <integer>, // REQUIRED
                'StorageCapacityQuotaGiB' => <integer>, // REQUIRED
                'Type' => 'USER|GROUP', // REQUIRED
            ],
            // ...
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VolumeType' => 'ONTAP|OPENZFS', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Name
Required: Yes
Type: string

Specifies the name of the volume that you're creating.

OntapConfiguration

Specifies the configuration to use when creating the ONTAP volume.

OpenZFSConfiguration

Specifies the configuration to use when creating the OpenZFS volume.

Tags
Type: Array of Tag structures

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

VolumeType
Required: Yes
Type: string

Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume types.

Result Syntax

[
    'Volume' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'DNSName' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'FileSystemId' => '<string>',
                    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                    'FileSystemTypeVersion' => '<string>',
                    'KmsKeyId' => '<string>',
                    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                    'LustreConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DataCompressionType' => 'NONE|LZ4',
                        'DataRepositoryConfiguration' => [
                            'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                            'ExportPath' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'ImportPath' => '<string>',
                            'ImportedFileChunkSize' => <integer>,
                            'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                        ],
                        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                        'DriveCacheType' => 'NONE|READ',
                        'LogConfiguration' => [
                            'Destination' => '<string>',
                            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                        ],
                        'MetadataConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MountName' => '<string>',
                        'PerUnitStorageThroughput' => <integer>,
                        'RootSquashConfiguration' => [
                            'NoSquashNids' => ['<string>', ...],
                            'RootSquash' => '<string>',
                        ],
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'NetworkInterfaceIds' => ['<string>', ...],
                    'OntapConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddressRange' => '<string>',
                        'Endpoints' => [
                            'Intercluster' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                            'Management' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                        ],
                        'FsxAdminPassword' => '<string>',
                        'HAPairs' => <integer>,
                        'PreferredSubnetId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'ThroughputCapacityPerHAPair' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'CopyTagsToVolumes' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddress' => '<string>',
                        'EndpointIpAddressRange' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD',
                    'SubnetIds' => ['<string>', ...],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                    'WindowsConfiguration' => [
                        'ActiveDirectoryId' => '<string>',
                        'Aliases' => [
                            [
                                'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'AuditLogConfiguration' => [
                            'AuditLogDestination' => '<string>',
                            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        ],
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MaintenanceOperationsInProgress' => ['<string>', ...],
                        'PreferredFileServerIp' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RemoteAdministrationEndpoint' => '<string>',
                        'SelfManagedActiveDirectoryConfiguration' => [
                            'DnsIps' => ['<string>', ...],
                            'DomainName' => '<string>',
                            'FileSystemAdministratorsGroup' => '<string>',
                            'OrganizationalUnitDistinguishedName' => '<string>',
                            'UserName' => '<string>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                ],
                'TargetSnapshotValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'ResourceARN' => '<string>',
                    'SnapshotId' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                ],
                'TargetVolumeValues' => [...], // RECURSIVE
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'FileSystemId' => '<string>',
        'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
        'LifecycleTransitionReason' => [
            'Message' => '<string>',
        ],
        'Name' => '<string>',
        'OntapConfiguration' => [
            'AggregateConfiguration' => [
                'Aggregates' => ['<string>', ...],
                'TotalConstituents' => <integer>,
            ],
            'CopyTagsToBackups' => true || false,
            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
            'JunctionPath' => '<string>',
            'OntapVolumeType' => 'RW|DP|LS',
            'SecurityStyle' => 'UNIX|NTFS|MIXED',
            'SizeInBytes' => <integer>,
            'SizeInMegabytes' => <integer>,
            'SnaplockConfiguration' => [
                'AuditLogVolume' => true || false,
                'AutocommitPeriod' => [
                    'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                    'Value' => <integer>,
                ],
                'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                'RetentionPeriod' => [
                    'DefaultRetention' => [
                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                        'Value' => <integer>,
                    ],
                    'MaximumRetention' => [
                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                        'Value' => <integer>,
                    ],
                    'MinimumRetention' => [
                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                        'Value' => <integer>,
                    ],
                ],
                'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                'VolumeAppendModeEnabled' => true || false,
            ],
            'SnapshotPolicy' => '<string>',
            'StorageEfficiencyEnabled' => true || false,
            'StorageVirtualMachineId' => '<string>',
            'StorageVirtualMachineRoot' => true || false,
            'TieringPolicy' => [
                'CoolingPeriod' => <integer>,
                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
            ],
            'UUID' => '<string>',
            'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
        ],
        'OpenZFSConfiguration' => [
            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
            'CopyTagsToSnapshots' => true || false,
            'DataCompressionType' => 'NONE|ZSTD|LZ4',
            'DeleteClonedVolumes' => true || false,
            'DeleteIntermediateData' => true || false,
            'DeleteIntermediateSnaphots' => true || false,
            'DestinationSnapshot' => '<string>',
            'NfsExports' => [
                [
                    'ClientConfigurations' => [
                        [
                            'Clients' => '<string>',
                            'Options' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'OriginSnapshot' => [
                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                'SnapshotARN' => '<string>',
            ],
            'ParentVolumeId' => '<string>',
            'ReadOnly' => true || false,
            'RecordSizeKiB' => <integer>,
            'RestoreToSnapshot' => '<string>',
            'SourceSnapshotARN' => '<string>',
            'StorageCapacityQuotaGiB' => <integer>,
            'StorageCapacityReservationGiB' => <integer>,
            'UserAndGroupQuotas' => [
                [
                    'Id' => <integer>,
                    'StorageCapacityQuotaGiB' => <integer>,
                    'Type' => 'USER|GROUP',
                ],
                // ...
            ],
            'VolumePath' => '<string>',
        ],
        'ResourceARN' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VolumeId' => '<string>',
        'VolumeType' => 'ONTAP|OPENZFS',
    ],
]

Result Details

Members
Volume
Type: Volume structure

Returned after a successful CreateVolume API operation, describing the volume just created.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

MissingVolumeConfiguration:

A volume configuration is required for this operation.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

StorageVirtualMachineNotFound:

No FSx for ONTAP SVMs were found based upon the supplied parameters.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

CreateVolumeFromBackup

$result = $client->createVolumeFromBackup([/* ... */]);
$promise = $client->createVolumeFromBackupAsync([/* ... */]);

Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.

Parameter Syntax

$result = $client->createVolumeFromBackup([
    'BackupId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'OntapConfiguration' => [
        'AggregateConfiguration' => [
            'Aggregates' => ['<string>', ...],
            'ConstituentsPerAggregate' => <integer>,
        ],
        'CopyTagsToBackups' => true || false,
        'JunctionPath' => '<string>',
        'OntapVolumeType' => 'RW|DP',
        'SecurityStyle' => 'UNIX|NTFS|MIXED',
        'SizeInBytes' => <integer>,
        'SizeInMegabytes' => <integer>,
        'SnaplockConfiguration' => [
            'AuditLogVolume' => true || false,
            'AutocommitPeriod' => [
                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE', // REQUIRED
                'Value' => <integer>,
            ],
            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
            'RetentionPeriod' => [
                'DefaultRetention' => [ // REQUIRED
                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED', // REQUIRED
                    'Value' => <integer>,
                ],
                'MaximumRetention' => [ // REQUIRED
                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED', // REQUIRED
                    'Value' => <integer>,
                ],
                'MinimumRetention' => [ // REQUIRED
                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED', // REQUIRED
                    'Value' => <integer>,
                ],
            ],
            'SnaplockType' => 'COMPLIANCE|ENTERPRISE', // REQUIRED
            'VolumeAppendModeEnabled' => true || false,
        ],
        'SnapshotPolicy' => '<string>',
        'StorageEfficiencyEnabled' => true || false,
        'StorageVirtualMachineId' => '<string>', // REQUIRED
        'TieringPolicy' => [
            'CoolingPeriod' => <integer>,
            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
        ],
        'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
BackupId
Required: Yes
Type: string

The ID of the source backup. Specifies the backup that you are copying.

ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Name
Required: Yes
Type: string

The name of the new volume you're creating.

OntapConfiguration

Specifies the configuration of the ONTAP volume that you are creating.

Tags
Type: Array of Tag structures

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

Result Syntax

[
    'Volume' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'DNSName' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'FileSystemId' => '<string>',
                    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                    'FileSystemTypeVersion' => '<string>',
                    'KmsKeyId' => '<string>',
                    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                    'LustreConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DataCompressionType' => 'NONE|LZ4',
                        'DataRepositoryConfiguration' => [
                            'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                            'ExportPath' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'ImportPath' => '<string>',
                            'ImportedFileChunkSize' => <integer>,
                            'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                        ],
                        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                        'DriveCacheType' => 'NONE|READ',
                        'LogConfiguration' => [
                            'Destination' => '<string>',
                            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                        ],
                        'MetadataConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MountName' => '<string>',
                        'PerUnitStorageThroughput' => <integer>,
                        'RootSquashConfiguration' => [
                            'NoSquashNids' => ['<string>', ...],
                            'RootSquash' => '<string>',
                        ],
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'NetworkInterfaceIds' => ['<string>', ...],
                    'OntapConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddressRange' => '<string>',
                        'Endpoints' => [
                            'Intercluster' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                            'Management' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                        ],
                        'FsxAdminPassword' => '<string>',
                        'HAPairs' => <integer>,
                        'PreferredSubnetId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'ThroughputCapacityPerHAPair' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'CopyTagsToVolumes' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddress' => '<string>',
                        'EndpointIpAddressRange' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD',
                    'SubnetIds' => ['<string>', ...],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                    'WindowsConfiguration' => [
                        'ActiveDirectoryId' => '<string>',
                        'Aliases' => [
                            [
                                'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'AuditLogConfiguration' => [
                            'AuditLogDestination' => '<string>',
                            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        ],
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MaintenanceOperationsInProgress' => ['<string>', ...],
                        'PreferredFileServerIp' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RemoteAdministrationEndpoint' => '<string>',
                        'SelfManagedActiveDirectoryConfiguration' => [
                            'DnsIps' => ['<string>', ...],
                            'DomainName' => '<string>',
                            'FileSystemAdministratorsGroup' => '<string>',
                            'OrganizationalUnitDistinguishedName' => '<string>',
                            'UserName' => '<string>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                ],
                'TargetSnapshotValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'ResourceARN' => '<string>',
                    'SnapshotId' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                ],
                'TargetVolumeValues' => [...], // RECURSIVE
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'FileSystemId' => '<string>',
        'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
        'LifecycleTransitionReason' => [
            'Message' => '<string>',
        ],
        'Name' => '<string>',
        'OntapConfiguration' => [
            'AggregateConfiguration' => [
                'Aggregates' => ['<string>', ...],
                'TotalConstituents' => <integer>,
            ],
            'CopyTagsToBackups' => true || false,
            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
            'JunctionPath' => '<string>',
            'OntapVolumeType' => 'RW|DP|LS',
            'SecurityStyle' => 'UNIX|NTFS|MIXED',
            'SizeInBytes' => <integer>,
            'SizeInMegabytes' => <integer>,
            'SnaplockConfiguration' => [
                'AuditLogVolume' => true || false,
                'AutocommitPeriod' => [
                    'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                    'Value' => <integer>,
                ],
                'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                'RetentionPeriod' => [
                    'DefaultRetention' => [
                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                        'Value' => <integer>,
                    ],
                    'MaximumRetention' => [
                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                        'Value' => <integer>,
                    ],
                    'MinimumRetention' => [
                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                        'Value' => <integer>,
                    ],
                ],
                'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                'VolumeAppendModeEnabled' => true || false,
            ],
            'SnapshotPolicy' => '<string>',
            'StorageEfficiencyEnabled' => true || false,
            'StorageVirtualMachineId' => '<string>',
            'StorageVirtualMachineRoot' => true || false,
            'TieringPolicy' => [
                'CoolingPeriod' => <integer>,
                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
            ],
            'UUID' => '<string>',
            'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
        ],
        'OpenZFSConfiguration' => [
            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
            'CopyTagsToSnapshots' => true || false,
            'DataCompressionType' => 'NONE|ZSTD|LZ4',
            'DeleteClonedVolumes' => true || false,
            'DeleteIntermediateData' => true || false,
            'DeleteIntermediateSnaphots' => true || false,
            'DestinationSnapshot' => '<string>',
            'NfsExports' => [
                [
                    'ClientConfigurations' => [
                        [
                            'Clients' => '<string>',
                            'Options' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'OriginSnapshot' => [
                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                'SnapshotARN' => '<string>',
            ],
            'ParentVolumeId' => '<string>',
            'ReadOnly' => true || false,
            'RecordSizeKiB' => <integer>,
            'RestoreToSnapshot' => '<string>',
            'SourceSnapshotARN' => '<string>',
            'StorageCapacityQuotaGiB' => <integer>,
            'StorageCapacityReservationGiB' => <integer>,
            'UserAndGroupQuotas' => [
                [
                    'Id' => <integer>,
                    'StorageCapacityQuotaGiB' => <integer>,
                    'Type' => 'USER|GROUP',
                ],
                // ...
            ],
            'VolumePath' => '<string>',
        ],
        'ResourceARN' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VolumeId' => '<string>',
        'VolumeType' => 'ONTAP|OPENZFS',
    ],
]

Result Details

Members
Volume
Type: Volume structure

Returned after a successful CreateVolumeFromBackup API operation, describing the volume just created.

Errors

BackupNotFound:

No Amazon FSx backups were found based upon the supplied parameters.

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

MissingVolumeConfiguration:

A volume configuration is required for this operation.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

StorageVirtualMachineNotFound:

No FSx for ONTAP SVMs were found based upon the supplied parameters.

DeleteBackup

$result = $client->deleteBackup([/* ... */]);
$promise = $client->deleteBackupAsync([/* ... */]);

Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup won't show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

Parameter Syntax

$result = $client->deleteBackup([
    'BackupId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
]);

Parameter Details

Members
BackupId
Required: Yes
Type: string

The ID of the backup that you want to delete.

ClientRequestToken
Type: string

A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK.

Result Syntax

[
    'BackupId' => '<string>',
    'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING|COPYING',
]

Result Details

Members
BackupId
Type: string

The ID of the backup that was deleted.

Lifecycle
Type: string

The lifecycle status of the backup. If the DeleteBackup operation is successful, the status is DELETED.

Errors

BadRequest:

A generic error indicating a failure with a client request.

BackupInProgress:

Another backup is already under way. Wait for completion before initiating additional backups of this file system.

BackupNotFound:

No Amazon FSx backups were found based upon the supplied parameters.

BackupRestoring:

You can't delete a backup while it's being used to restore a file system.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

BackupBeingCopied:

You can't delete a backup while it's being copied.

Examples

Example 1: To delete a backup

This operation deletes an Amazon FSx file system backup.

$result = $client->deleteBackup([
    'BackupId' => 'backup-03e3c82e0183b7b6b',
]);

Result syntax:

[
    'BackupId' => 'backup-03e3c82e0183b7b6b',
    'Lifecycle' => 'DELETED',
]

DeleteDataRepositoryAssociation

$result = $client->deleteDataRepositoryAssociation([/* ... */]);
$promise = $client->deleteDataRepositoryAssociationAsync([/* ... */]);

Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

Parameter Syntax

$result = $client->deleteDataRepositoryAssociation([
    'AssociationId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'DeleteDataInFileSystem' => true || false,
]);

Parameter Details

Members
AssociationId
Required: Yes
Type: string

The ID of the data repository association that you want to delete.

ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

DeleteDataInFileSystem
Type: boolean

Set to true to delete the data in the file system that corresponds to the data repository association.

Result Syntax

[
    'AssociationId' => '<string>',
    'DeleteDataInFileSystem' => true || false,
    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
]

Result Details

Members
AssociationId
Type: string

The ID of the data repository association being deleted.

DeleteDataInFileSystem
Type: boolean

Indicates whether data in the file system that corresponds to the data repository association is being deleted. Default is false.

Lifecycle
Type: string

Describes the lifecycle state of the data repository association being deleted.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

DataRepositoryAssociationNotFound:

No data repository associations were found based upon the supplied parameters.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

DeleteFileCache

$result = $client->deleteFileCache([/* ... */]);
$promise = $client->deleteFileCacheAsync([/* ... */]);

Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.

The DeleteFileCache operation returns while the cache has the DELETING status. You can check the cache deletion status by calling the DescribeFileCaches operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error.

The data in a deleted cache is also deleted and can't be recovered by any means.

Parameter Syntax

$result = $client->deleteFileCache([
    'ClientRequestToken' => '<string>',
    'FileCacheId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileCacheId
Required: Yes
Type: string

The ID of the cache that's being deleted.

Result Syntax

[
    'FileCacheId' => '<string>',
    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|UPDATING|FAILED',
]

Result Details

Members
FileCacheId
Type: string

The ID of the cache that's being deleted.

Lifecycle
Type: string

The cache lifecycle for the deletion request. If the DeleteFileCache operation is successful, this status is DELETING.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

FileCacheNotFound:

No caches were found based upon supplied parameters.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

DeleteFileSystem

$result = $client->deleteFileSystem([/* ... */]);
$promise = $client->deleteFileSystemAsync([/* ... */]);

Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a FileSystemId value to the DeleteFileSystem operation.

By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted.

To delete an Amazon FSx for Lustre file system, first unmount it from every connected Amazon EC2 instance, then provide a FileSystemId value to the DeleteFileSystem operation. By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked. On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository task. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task.

The DeleteFileSystem operation returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems operation returns a FileSystemNotFound error.

If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).

The data in a deleted file system is also deleted and can't be recovered by any means.

Parameter Syntax

$result = $client->deleteFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'LustreConfiguration' => [
        'FinalBackupTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'SkipFinalBackup' => true || false,
    ],
    'OpenZFSConfiguration' => [
        'FinalBackupTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Options' => ['<string>', ...],
        'SkipFinalBackup' => true || false,
    ],
    'WindowsConfiguration' => [
        'FinalBackupTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'SkipFinalBackup' => true || false,
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Required: Yes
Type: string

The ID of the file system that you want to delete.

LustreConfiguration

The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

OpenZFSConfiguration

The configuration object for the OpenZFS file system used in the DeleteFileSystem operation.

WindowsConfiguration

The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.

Result Syntax

[
    'FileSystemId' => '<string>',
    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
    'LustreResponse' => [
        'FinalBackupId' => '<string>',
        'FinalBackupTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'OpenZFSResponse' => [
        'FinalBackupId' => '<string>',
        'FinalBackupTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'WindowsResponse' => [
        'FinalBackupId' => '<string>',
        'FinalBackupTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
FileSystemId
Type: string

The ID of the file system that's being deleted.

Lifecycle
Type: string

The file system lifecycle for the deletion request. If the DeleteFileSystem operation is successful, this status is DELETING.

LustreResponse

The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

OpenZFSResponse

The response object for the OpenZFS file system that's being deleted in the DeleteFileSystem operation.

WindowsResponse

The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

Examples

Example 1: To delete a file system

This operation deletes an Amazon FSx file system.

$result = $client->deleteFileSystem([
    'FileSystemId' => 'fs-0498eed5fe91001ec',
]);

Result syntax:

[
    'FileSystemId' => 'fs-0498eed5fe91001ec',
    'Lifecycle' => 'DELETING',
]

DeleteSnapshot

$result = $client->deleteSnapshot([/* ... */]);
$promise = $client->deleteSnapshotAsync([/* ... */]);

Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.

The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.

Parameter Syntax

$result = $client->deleteSnapshot([
    'ClientRequestToken' => '<string>',
    'SnapshotId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

SnapshotId
Required: Yes
Type: string

The ID of the snapshot that you want to delete.

Result Syntax

[
    'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
    'SnapshotId' => '<string>',
]

Result Details

Members
Lifecycle
Type: string

The lifecycle status of the snapshot. If the DeleteSnapshot operation is successful, this status is DELETING.

SnapshotId
Type: string

The ID of the deleted snapshot.

Errors

BadRequest:

A generic error indicating a failure with a client request.

InternalServerError:

A generic error indicating a server-side failure.

SnapshotNotFound:

No Amazon FSx snapshots were found based on the supplied parameters.

DeleteStorageVirtualMachine

$result = $client->deleteStorageVirtualMachine([/* ... */]);
$promise = $client->deleteStorageVirtualMachineAsync([/* ... */]);

Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.

Parameter Syntax

$result = $client->deleteStorageVirtualMachine([
    'ClientRequestToken' => '<string>',
    'StorageVirtualMachineId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

StorageVirtualMachineId
Required: Yes
Type: string

The ID of the SVM that you want to delete.

Result Syntax

[
    'Lifecycle' => 'CREATED|CREATING|DELETING|FAILED|MISCONFIGURED|PENDING',
    'StorageVirtualMachineId' => '<string>',
]

Result Details

Members
Lifecycle
Type: string

Describes the lifecycle state of the SVM being deleted.

StorageVirtualMachineId
Type: string

The ID of the SVM Amazon FSx is deleting.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

StorageVirtualMachineNotFound:

No FSx for ONTAP SVMs were found based upon the supplied parameters.

DeleteVolume

$result = $client->deleteVolume([/* ... */]);
$promise = $client->deleteVolumeAsync([/* ... */]);

Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

Parameter Syntax

$result = $client->deleteVolume([
    'ClientRequestToken' => '<string>',
    'OntapConfiguration' => [
        'BypassSnaplockEnterpriseRetention' => true || false,
        'FinalBackupTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'SkipFinalBackup' => true || false,
    ],
    'OpenZFSConfiguration' => [
        'Options' => ['<string>', ...],
    ],
    'VolumeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

OntapConfiguration

For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the fsx:TagResource permission.

OpenZFSConfiguration

For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.

VolumeId
Required: Yes
Type: string

The ID of the volume that you are deleting.

Result Syntax

[
    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
    'OntapResponse' => [
        'FinalBackupId' => '<string>',
        'FinalBackupTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'VolumeId' => '<string>',
]

Result Details

Members
Lifecycle
Type: string

The lifecycle state of the volume being deleted. If the DeleteVolume operation is successful, this value is DELETING.

OntapResponse
Type: DeleteVolumeOntapResponse structure

Returned after a DeleteVolume request, showing the status of the delete request.

VolumeId
Type: string

The ID of the volume that's being deleted.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

VolumeNotFound:

No Amazon FSx volumes were found based upon the supplied parameters.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

DescribeBackups

$result = $client->describeBackups([/* ... */]);
$promise = $client->describeBackupsAsync([/* ... */]);

Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of the NextToken value from the last response.

This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

When using this operation, keep the following in mind:

  • The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value.

  • The order of the backups returned in the response of one DescribeBackups call and the order of the backups returned across the responses of a multi-call iteration is unspecified.

Parameter Syntax

$result = $client->describeBackups([
    'BackupIds' => ['<string>', ...],
    'Filters' => [
        [
            'Name' => 'file-system-id|backup-type|file-system-type|volume-id|data-repository-type|file-cache-id|file-cache-type',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
BackupIds
Type: Array of strings

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

Filters
Type: Array of Filter structures

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

MaxResults
Type: int

Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken
Type: string

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Result Syntax

[
    'Backups' => [
        [
            'BackupId' => '<string>',
            'CreationTime' => <DateTime>,
            'DirectoryInformation' => [
                'ActiveDirectoryId' => '<string>',
                'DomainName' => '<string>',
                'ResourceARN' => '<string>',
            ],
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystem' => [
                'AdministrativeActions' => [
                    [
                        'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ProgressPercent' => <integer>,
                        'RemainingTransferBytes' => <integer>,
                        'RequestTime' => <DateTime>,
                        'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                        'TargetFileSystemValues' => [...], // RECURSIVE
                        'TargetSnapshotValues' => [
                            'AdministrativeActions' => [...], // RECURSIVE
                            'CreationTime' => <DateTime>,
                            'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                            'LifecycleTransitionReason' => [
                                'Message' => '<string>',
                            ],
                            'Name' => '<string>',
                            'ResourceARN' => '<string>',
                            'SnapshotId' => '<string>',
                            'Tags' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'VolumeId' => '<string>',
                        ],
                        'TargetVolumeValues' => [
                            'AdministrativeActions' => [...], // RECURSIVE
                            'CreationTime' => <DateTime>,
                            'FileSystemId' => '<string>',
                            'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                            'LifecycleTransitionReason' => [
                                'Message' => '<string>',
                            ],
                            'Name' => '<string>',
                            'OntapConfiguration' => [
                                'AggregateConfiguration' => [
                                    'Aggregates' => ['<string>', ...],
                                    'TotalConstituents' => <integer>,
                                ],
                                'CopyTagsToBackups' => true || false,
                                'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                                'JunctionPath' => '<string>',
                                'OntapVolumeType' => 'RW|DP|LS',
                                'SecurityStyle' => 'UNIX|NTFS|MIXED',
                                'SizeInBytes' => <integer>,
                                'SizeInMegabytes' => <integer>,
                                'SnaplockConfiguration' => [
                                    'AuditLogVolume' => true || false,
                                    'AutocommitPeriod' => [
                                        'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                        'Value' => <integer>,
                                    ],
                                    'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                                    'RetentionPeriod' => [
                                        'DefaultRetention' => [
                                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                            'Value' => <integer>,
                                        ],
                                        'MaximumRetention' => [
                                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                            'Value' => <integer>,
                                        ],
                                        'MinimumRetention' => [
                                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                            'Value' => <integer>,
                                        ],
                                    ],
                                    'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                                    'VolumeAppendModeEnabled' => true || false,
                                ],
                                'SnapshotPolicy' => '<string>',
                                'StorageEfficiencyEnabled' => true || false,
                                'StorageVirtualMachineId' => '<string>',
                                'StorageVirtualMachineRoot' => true || false,
                                'TieringPolicy' => [
                                    'CoolingPeriod' => <integer>,
                                    'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                                ],
                                'UUID' => '<string>',
                                'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                            ],
                            'OpenZFSConfiguration' => [
                                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                                'CopyTagsToSnapshots' => true || false,
                                'DataCompressionType' => 'NONE|ZSTD|LZ4',
                                'DeleteClonedVolumes' => true || false,
                                'DeleteIntermediateData' => true || false,
                                'DeleteIntermediateSnaphots' => true || false,
                                'DestinationSnapshot' => '<string>',
                                'NfsExports' => [
                                    [
                                        'ClientConfigurations' => [
                                            [
                                                'Clients' => '<string>',
                                                'Options' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                    ],
                                    // ...
                                ],
                                'OriginSnapshot' => [
                                    'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                                    'SnapshotARN' => '<string>',
                                ],
                                'ParentVolumeId' => '<string>',
                                'ReadOnly' => true || false,
                                'RecordSizeKiB' => <integer>,
                                'RestoreToSnapshot' => '<string>',
                                'SourceSnapshotARN' => '<string>',
                                'StorageCapacityQuotaGiB' => <integer>,
                                'StorageCapacityReservationGiB' => <integer>,
                                'UserAndGroupQuotas' => [
                                    [
                                        'Id' => <integer>,
                                        'StorageCapacityQuotaGiB' => <integer>,
                                        'Type' => 'USER|GROUP',
                                    ],
                                    // ...
                                ],
                                'VolumePath' => '<string>',
                            ],
                            'ResourceARN' => '<string>',
                            'Tags' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'VolumeId' => '<string>',
                            'VolumeType' => 'ONTAP|OPENZFS',
                        ],
                        'TotalTransferBytes' => <integer>,
                    ],
                    // ...
                ],
                'CreationTime' => <DateTime>,
                'DNSName' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'FileSystemId' => '<string>',
                'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                'FileSystemTypeVersion' => '<string>',
                'KmsKeyId' => '<string>',
                'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                'LustreConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DataCompressionType' => 'NONE|LZ4',
                    'DataRepositoryConfiguration' => [
                        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                        'ExportPath' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ImportPath' => '<string>',
                        'ImportedFileChunkSize' => <integer>,
                        'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                    ],
                    'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                    'DriveCacheType' => 'NONE|READ',
                    'LogConfiguration' => [
                        'Destination' => '<string>',
                        'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                    ],
                    'MetadataConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'MountName' => '<string>',
                    'PerUnitStorageThroughput' => <integer>,
                    'RootSquashConfiguration' => [
                        'NoSquashNids' => ['<string>', ...],
                        'RootSquash' => '<string>',
                    ],
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'NetworkInterfaceIds' => ['<string>', ...],
                'OntapConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'EndpointIpAddressRange' => '<string>',
                    'Endpoints' => [
                        'Intercluster' => [
                            'DNSName' => '<string>',
                            'IpAddresses' => ['<string>', ...],
                        ],
                        'Management' => [
                            'DNSName' => '<string>',
                            'IpAddresses' => ['<string>', ...],
                        ],
                    ],
                    'FsxAdminPassword' => '<string>',
                    'HAPairs' => <integer>,
                    'PreferredSubnetId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'ThroughputCapacityPerHAPair' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OpenZFSConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'CopyTagsToVolumes' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'EndpointIpAddress' => '<string>',
                    'EndpointIpAddressRange' => '<string>',
                    'PreferredSubnetId' => '<string>',
                    'RootVolumeId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OwnerId' => '<string>',
                'ResourceARN' => '<string>',
                'StorageCapacity' => <integer>,
                'StorageType' => 'SSD|HDD',
                'SubnetIds' => ['<string>', ...],
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VpcId' => '<string>',
                'WindowsConfiguration' => [
                    'ActiveDirectoryId' => '<string>',
                    'Aliases' => [
                        [
                            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                    'AuditLogConfiguration' => [
                        'AuditLogDestination' => '<string>',
                        'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                    ],
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'MaintenanceOperationsInProgress' => ['<string>', ...],
                    'PreferredFileServerIp' => '<string>',
                    'PreferredSubnetId' => '<string>',
                    'RemoteAdministrationEndpoint' => '<string>',
                    'SelfManagedActiveDirectoryConfiguration' => [
                        'DnsIps' => ['<string>', ...],
                        'DomainName' => '<string>',
                        'FileSystemAdministratorsGroup' => '<string>',
                        'OrganizationalUnitDistinguishedName' => '<string>',
                        'UserName' => '<string>',
                    ],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
            ],
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING|COPYING',
            'OwnerId' => '<string>',
            'ProgressPercent' => <integer>,
            'ResourceARN' => '<string>',
            'ResourceType' => 'FILE_SYSTEM|VOLUME',
            'SourceBackupId' => '<string>',
            'SourceBackupRegion' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
            'Volume' => [
                'AdministrativeActions' => [
                    [
                        'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ProgressPercent' => <integer>,
                        'RemainingTransferBytes' => <integer>,
                        'RequestTime' => <DateTime>,
                        'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                        'TargetFileSystemValues' => [
                            'AdministrativeActions' => [...], // RECURSIVE
                            'CreationTime' => <DateTime>,
                            'DNSName' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'FileSystemId' => '<string>',
                            'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                            'FileSystemTypeVersion' => '<string>',
                            'KmsKeyId' => '<string>',
                            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                            'LustreConfiguration' => [
                                'AutomaticBackupRetentionDays' => <integer>,
                                'CopyTagsToBackups' => true || false,
                                'DailyAutomaticBackupStartTime' => '<string>',
                                'DataCompressionType' => 'NONE|LZ4',
                                'DataRepositoryConfiguration' => [
                                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                                    'ExportPath' => '<string>',
                                    'FailureDetails' => [
                                        'Message' => '<string>',
                                    ],
                                    'ImportPath' => '<string>',
                                    'ImportedFileChunkSize' => <integer>,
                                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                                ],
                                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                                'DriveCacheType' => 'NONE|READ',
                                'LogConfiguration' => [
                                    'Destination' => '<string>',
                                    'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                                ],
                                'MetadataConfiguration' => [
                                    'Iops' => <integer>,
                                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                                ],
                                'MountName' => '<string>',
                                'PerUnitStorageThroughput' => <integer>,
                                'RootSquashConfiguration' => [
                                    'NoSquashNids' => ['<string>', ...],
                                    'RootSquash' => '<string>',
                                ],
                                'WeeklyMaintenanceStartTime' => '<string>',
                            ],
                            'NetworkInterfaceIds' => ['<string>', ...],
                            'OntapConfiguration' => [
                                'AutomaticBackupRetentionDays' => <integer>,
                                'DailyAutomaticBackupStartTime' => '<string>',
                                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                                'DiskIopsConfiguration' => [
                                    'Iops' => <integer>,
                                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                                ],
                                'EndpointIpAddressRange' => '<string>',
                                'Endpoints' => [
                                    'Intercluster' => [
                                        'DNSName' => '<string>',
                                        'IpAddresses' => ['<string>', ...],
                                    ],
                                    'Management' => [
                                        'DNSName' => '<string>',
                                        'IpAddresses' => ['<string>', ...],
                                    ],
                                ],
                                'FsxAdminPassword' => '<string>',
                                'HAPairs' => <integer>,
                                'PreferredSubnetId' => '<string>',
                                'RouteTableIds' => ['<string>', ...],
                                'ThroughputCapacity' => <integer>,
                                'ThroughputCapacityPerHAPair' => <integer>,
                                'WeeklyMaintenanceStartTime' => '<string>',
                            ],
                            'OpenZFSConfiguration' => [
                                'AutomaticBackupRetentionDays' => <integer>,
                                'CopyTagsToBackups' => true || false,
                                'CopyTagsToVolumes' => true || false,
                                'DailyAutomaticBackupStartTime' => '<string>',
                                'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                                'DiskIopsConfiguration' => [
                                    'Iops' => <integer>,
                                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                                ],
                                'EndpointIpAddress' => '<string>',
                                'EndpointIpAddressRange' => '<string>',
                                'PreferredSubnetId' => '<string>',
                                'RootVolumeId' => '<string>',
                                'RouteTableIds' => ['<string>', ...],
                                'ThroughputCapacity' => <integer>,
                                'WeeklyMaintenanceStartTime' => '<string>',
                            ],
                            'OwnerId' => '<string>',
                            'ResourceARN' => '<string>',
                            'StorageCapacity' => <integer>,
                            'StorageType' => 'SSD|HDD',
                            'SubnetIds' => ['<string>', ...],
                            'Tags' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'VpcId' => '<string>',
                            'WindowsConfiguration' => [
                                'ActiveDirectoryId' => '<string>',
                                'Aliases' => [
                                    [
                                        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                        'Name' => '<string>',
                                    ],
                                    // ...
                                ],
                                'AuditLogConfiguration' => [
                                    'AuditLogDestination' => '<string>',
                                    'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                    'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                ],
                                'AutomaticBackupRetentionDays' => <integer>,
                                'CopyTagsToBackups' => true || false,
                                'DailyAutomaticBackupStartTime' => '<string>',
                                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                                'DiskIopsConfiguration' => [
                                    'Iops' => <integer>,
                                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                                ],
                                'MaintenanceOperationsInProgress' => ['<string>', ...],
                                'PreferredFileServerIp' => '<string>',
                                'PreferredSubnetId' => '<string>',
                                'RemoteAdministrationEndpoint' => '<string>',
                                'SelfManagedActiveDirectoryConfiguration' => [
                                    'DnsIps' => ['<string>', ...],
                                    'DomainName' => '<string>',
                                    'FileSystemAdministratorsGroup' => '<string>',
                                    'OrganizationalUnitDistinguishedName' => '<string>',
                                    'UserName' => '<string>',
                                ],
                                'ThroughputCapacity' => <integer>,
                                'WeeklyMaintenanceStartTime' => '<string>',
                            ],
                        ],
                        'TargetSnapshotValues' => [
                            'AdministrativeActions' => [...], // RECURSIVE
                            'CreationTime' => <DateTime>,
                            'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                            'LifecycleTransitionReason' => [
                                'Message' => '<string>',
                            ],
                            'Name' => '<string>',
                            'ResourceARN' => '<string>',
                            'SnapshotId' => '<string>',
                            'Tags' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'VolumeId' => '<string>',
                        ],
                        'TargetVolumeValues' => [...], // RECURSIVE
                        'TotalTransferBytes' => <integer>,
                    ],
                    // ...
                ],
                'CreationTime' => <DateTime>,
                'FileSystemId' => '<string>',
                'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                'LifecycleTransitionReason' => [
                    'Message' => '<string>',
                ],
                'Name' => '<string>',
                'OntapConfiguration' => [
                    'AggregateConfiguration' => [
                        'Aggregates' => ['<string>', ...],
                        'TotalConstituents' => <integer>,
                    ],
                    'CopyTagsToBackups' => true || false,
                    'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                    'JunctionPath' => '<string>',
                    'OntapVolumeType' => 'RW|DP|LS',
                    'SecurityStyle' => 'UNIX|NTFS|MIXED',
                    'SizeInBytes' => <integer>,
                    'SizeInMegabytes' => <integer>,
                    'SnaplockConfiguration' => [
                        'AuditLogVolume' => true || false,
                        'AutocommitPeriod' => [
                            'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                            'Value' => <integer>,
                        ],
                        'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                        'RetentionPeriod' => [
                            'DefaultRetention' => [
                                'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                'Value' => <integer>,
                            ],
                            'MaximumRetention' => [
                                'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                'Value' => <integer>,
                            ],
                            'MinimumRetention' => [
                                'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                'Value' => <integer>,
                            ],
                        ],
                        'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                        'VolumeAppendModeEnabled' => true || false,
                    ],
                    'SnapshotPolicy' => '<string>',
                    'StorageEfficiencyEnabled' => true || false,
                    'StorageVirtualMachineId' => '<string>',
                    'StorageVirtualMachineRoot' => true || false,
                    'TieringPolicy' => [
                        'CoolingPeriod' => <integer>,
                        'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                    ],
                    'UUID' => '<string>',
                    'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                ],
                'OpenZFSConfiguration' => [
                    'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                    'CopyTagsToSnapshots' => true || false,
                    'DataCompressionType' => 'NONE|ZSTD|LZ4',
                    'DeleteClonedVolumes' => true || false,
                    'DeleteIntermediateData' => true || false,
                    'DeleteIntermediateSnaphots' => true || false,
                    'DestinationSnapshot' => '<string>',
                    'NfsExports' => [
                        [
                            'ClientConfigurations' => [
                                [
                                    'Clients' => '<string>',
                                    'Options' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'OriginSnapshot' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'SnapshotARN' => '<string>',
                    ],
                    'ParentVolumeId' => '<string>',
                    'ReadOnly' => true || false,
                    'RecordSizeKiB' => <integer>,
                    'RestoreToSnapshot' => '<string>',
                    'SourceSnapshotARN' => '<string>',
                    'StorageCapacityQuotaGiB' => <integer>,
                    'StorageCapacityReservationGiB' => <integer>,
                    'UserAndGroupQuotas' => [
                        [
                            'Id' => <integer>,
                            'StorageCapacityQuotaGiB' => <integer>,
                            'Type' => 'USER|GROUP',
                        ],
                        // ...
                    ],
                    'VolumePath' => '<string>',
                ],
                'ResourceARN' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VolumeId' => '<string>',
                'VolumeType' => 'ONTAP|OPENZFS',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Backups
Type: Array of Backup structures

An array of backups.

NextToken
Type: string

A NextToken value is present if there are more backups than returned in the response. You can use the NextToken value in the subsequent request to fetch the backups.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

VolumeNotFound:

No Amazon FSx volumes were found based upon the supplied parameters.

BackupNotFound:

No Amazon FSx backups were found based upon the supplied parameters.

InternalServerError:

A generic error indicating a server-side failure.

Examples

Example 1: To describe Amazon FSx backups

This operation describes all of the Amazon FSx backups in an account.

$result = $client->describeBackups([
]);

Result syntax:

[
    'Backups' => [
        [
            'BackupId' => 'backup-03e3c82e0183b7b6b',
            'CreationTime' => ,
            'FileSystem' => [
                'FileSystemId' => 'fs-0498eed5fe91001ec',
                'OwnerId' => '012345678912',
                'StorageCapacity' => 300,
                'WindowsConfiguration' => [
                    'ActiveDirectoryId' => 'd-1234abcd12',
                    'AutomaticBackupRetentionDays' => 30,
                    'DailyAutomaticBackupStartTime' => '05:00',
                    'WeeklyMaintenanceStartTime' => '1:05:00',
                ],
            ],
            'Lifecycle' => 'AVAILABLE',
            'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b',
            'Tags' => [
                [
                    'Key' => 'Name',
                    'Value' => 'MyBackup',
                ],
            ],
            'Type' => 'USER_INITIATED',
        ],
    ],
]

DescribeDataRepositoryAssociations

$result = $client->describeDataRepositoryAssociations([/* ... */]);
$promise = $client->describeDataRepositoryAssociationsAsync([/* ... */]);

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type.

You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

Parameter Syntax

$result = $client->describeDataRepositoryAssociations([
    'AssociationIds' => ['<string>', ...],
    'Filters' => [
        [
            'Name' => 'file-system-id|backup-type|file-system-type|volume-id|data-repository-type|file-cache-id|file-cache-type',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
AssociationIds
Type: Array of strings

IDs of the data repository associations whose descriptions you want to retrieve (String).

Filters
Type: Array of Filter structures

A list of Filter elements.

MaxResults
Type: int

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

NextToken
Type: 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.

Result Syntax

[
    'Associations' => [
        [
            'AssociationId' => '<string>',
            'BatchImportMetaDataOnCreate' => true || false,
            'CreationTime' => <DateTime>,
            'DataRepositoryPath' => '<string>',
            'DataRepositorySubdirectories' => ['<string>', ...],
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileCacheId' => '<string>',
            'FileCachePath' => '<string>',
            'FileSystemId' => '<string>',
            'FileSystemPath' => '<string>',
            'ImportedFileChunkSize' => <integer>,
            'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
            'NFS' => [
                'AutoExportPolicy' => [
                    'Events' => ['<string>', ...],
                ],
                'DnsIps' => ['<string>', ...],
                'Version' => 'NFS3',
            ],
            'ResourceARN' => '<string>',
            'S3' => [
                'AutoExportPolicy' => [
                    'Events' => ['<string>', ...],
                ],
                'AutoImportPolicy' => [
                    'Events' => ['<string>', ...],
                ],
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Associations
Type: Array of DataRepositoryAssociation structures

An array of one or more data repository association descriptions.

NextToken
Type: 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.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

DataRepositoryAssociationNotFound:

No data repository associations were found based upon the supplied parameters.

InvalidDataRepositoryType:

You have filtered the response to a data repository type that is not supported.

InternalServerError:

A generic error indicating a server-side failure.

DescribeDataRepositoryTasks

$result = $client->describeDataRepositoryTasks([/* ... */]);
$promise = $client->describeDataRepositoryTasksAsync([/* ... */]);

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

Parameter Syntax

$result = $client->describeDataRepositoryTasks([
    'Filters' => [
        [
            'Name' => 'file-system-id|task-lifecycle|data-repository-association-id|file-cache-id',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TaskIds' => ['<string>', ...],
]);

Parameter Details

Members
Filters
Type: Array of DataRepositoryTaskFilter structures

(Optional) You can use filters to narrow the DescribeDataRepositoryTasks response to include just tasks for specific file systems, or tasks in a specific lifecycle state.

MaxResults
Type: int

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

NextToken
Type: 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.

TaskIds
Type: Array of strings

(Optional) IDs of the tasks whose descriptions you want to retrieve (String).

Result Syntax

[
    'DataRepositoryTasks' => [
        [
            'CapacityToRelease' => <integer>,
            'CreationTime' => <DateTime>,
            'EndTime' => <DateTime>,
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileCacheId' => '<string>',
            'FileSystemId' => '<string>',
            'Lifecycle' => 'PENDING|EXECUTING|FAILED|SUCCEEDED|CANCELED|CANCELING',
            'Paths' => ['<string>', ...],
            'ReleaseConfiguration' => [
                'DurationSinceLastAccess' => [
                    'Unit' => 'DAYS',
                    'Value' => <integer>,
                ],
            ],
            'Report' => [
                'Enabled' => true || false,
                'Format' => 'REPORT_CSV_20191124',
                'Path' => '<string>',
                'Scope' => 'FAILED_FILES_ONLY',
            ],
            'ResourceARN' => '<string>',
            'StartTime' => <DateTime>,
            'Status' => [
                'FailedCount' => <integer>,
                'LastUpdatedTime' => <DateTime>,
                'ReleasedCapacity' => <integer>,
                'SucceededCount' => <integer>,
                'TotalCount' => <integer>,
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TaskId' => '<string>',
            'Type' => 'EXPORT_TO_REPOSITORY|IMPORT_METADATA_FROM_REPOSITORY|RELEASE_DATA_FROM_FILESYSTEM|AUTO_RELEASE_DATA',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
DataRepositoryTasks
Type: Array of DataRepositoryTask structures

The collection of data repository task descriptions returned.

NextToken
Type: 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.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

DataRepositoryTaskNotFound:

The data repository task or tasks you specified could not be found.

InternalServerError:

A generic error indicating a server-side failure.

DescribeFileCaches

$result = $client->describeFileCaches([/* ... */]);
$promise = $client->describeFileCachesAsync([/* ... */]);

Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this operation, keep the following in mind:

  • The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value.

  • The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified.

Parameter Syntax

$result = $client->describeFileCaches([
    'FileCacheIds' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
FileCacheIds
Type: Array of strings

IDs of the caches whose descriptions you want to retrieve (String).

MaxResults
Type: int

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

NextToken
Type: 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.

Result Syntax

[
    'FileCaches' => [
        [
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'DataRepositoryAssociationIds' => ['<string>', ...],
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileCacheId' => '<string>',
            'FileCacheType' => 'LUSTRE',
            'FileCacheTypeVersion' => '<string>',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|UPDATING|FAILED',
            'LustreConfiguration' => [
                'DeploymentType' => 'CACHE_1',
                'LogConfiguration' => [
                    'Destination' => '<string>',
                    'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                ],
                'MetadataConfiguration' => [
                    'StorageCapacity' => <integer>,
                ],
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'SubnetIds' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
FileCaches
Type: Array of FileCache structures

The response object for the DescribeFileCaches operation.

NextToken
Type: 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.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileCacheNotFound:

No caches were found based upon supplied parameters.

InternalServerError:

A generic error indicating a server-side failure.

DescribeFileSystemAliases

$result = $client->describeFileSystemAliases([/* ... */]);
$promise = $client->describeFileSystemAliasesAsync([/* ... */]);

Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.

Parameter Syntax

$result = $client->describeFileSystemAliases([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Required: Yes
Type: string

The ID of the file system to return the associated DNS aliases for (String).

MaxResults
Type: int

Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken
Type: string

Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

Result Syntax

[
    'Aliases' => [
        [
            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Aliases
Type: Array of Alias structures

An array of one or more DNS aliases currently associated with the specified file system.

NextToken
Type: string

Present if there are more DNS aliases than returned in the response (String). You can use the NextToken value in a later request to fetch additional descriptions.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

InternalServerError:

A generic error indicating a server-side failure.

DescribeFileSystems

$result = $client->describeFileSystems([/* ... */]);
$promise = $client->describeFileSystemsAsync([/* ... */]);

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this operation, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

Parameter Syntax

$result = $client->describeFileSystems([
    'FileSystemIds' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
FileSystemIds
Type: Array of strings

IDs of the file systems whose descriptions you want to retrieve (String).

MaxResults
Type: int

Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken
Type: string

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.

Result Syntax

[
    'FileSystems' => [
        [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RemainingTransferBytes' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                    'TargetFileSystemValues' => [...], // RECURSIVE
                    'TargetSnapshotValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'ResourceARN' => '<string>',
                        'SnapshotId' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                    ],
                    'TargetVolumeValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'FileSystemId' => '<string>',
                        'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'OntapConfiguration' => [
                            'AggregateConfiguration' => [
                                'Aggregates' => ['<string>', ...],
                                'TotalConstituents' => <integer>,
                            ],
                            'CopyTagsToBackups' => true || false,
                            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                            'JunctionPath' => '<string>',
                            'OntapVolumeType' => 'RW|DP|LS',
                            'SecurityStyle' => 'UNIX|NTFS|MIXED',
                            'SizeInBytes' => <integer>,
                            'SizeInMegabytes' => <integer>,
                            'SnaplockConfiguration' => [
                                'AuditLogVolume' => true || false,
                                'AutocommitPeriod' => [
                                    'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                    'Value' => <integer>,
                                ],
                                'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                                'RetentionPeriod' => [
                                    'DefaultRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                    'MaximumRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                    'MinimumRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                ],
                                'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                                'VolumeAppendModeEnabled' => true || false,
                            ],
                            'SnapshotPolicy' => '<string>',
                            'StorageEfficiencyEnabled' => true || false,
                            'StorageVirtualMachineId' => '<string>',
                            'StorageVirtualMachineRoot' => true || false,
                            'TieringPolicy' => [
                                'CoolingPeriod' => <integer>,
                                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                            ],
                            'UUID' => '<string>',
                            'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                        ],
                        'OpenZFSConfiguration' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'CopyTagsToSnapshots' => true || false,
                            'DataCompressionType' => 'NONE|ZSTD|LZ4',
                            'DeleteClonedVolumes' => true || false,
                            'DeleteIntermediateData' => true || false,
                            'DeleteIntermediateSnaphots' => true || false,
                            'DestinationSnapshot' => '<string>',
                            'NfsExports' => [
                                [
                                    'ClientConfigurations' => [
                                        [
                                            'Clients' => '<string>',
                                            'Options' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OriginSnapshot' => [
                                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                                'SnapshotARN' => '<string>',
                            ],
                            'ParentVolumeId' => '<string>',
                            'ReadOnly' => true || false,
                            'RecordSizeKiB' => <integer>,
                            'RestoreToSnapshot' => '<string>',
                            'SourceSnapshotARN' => '<string>',
                            'StorageCapacityQuotaGiB' => <integer>,
                            'StorageCapacityReservationGiB' => <integer>,
                            'UserAndGroupQuotas' => [
                                [
                                    'Id' => <integer>,
                                    'StorageCapacityQuotaGiB' => <integer>,
                                    'Type' => 'USER|GROUP',
                                ],
                                // ...
                            ],
                            'VolumePath' => '<string>',
                        ],
                        'ResourceARN' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                        'VolumeType' => 'ONTAP|OPENZFS',
                    ],
                    'TotalTransferBytes' => <integer>,
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
            'FileSystemTypeVersion' => '<string>',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DataCompressionType' => 'NONE|LZ4',
                'DataRepositoryConfiguration' => [
                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                    'ExportPath' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                ],
                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                'DriveCacheType' => 'NONE|READ',
                'LogConfiguration' => [
                    'Destination' => '<string>',
                    'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                ],
                'MetadataConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'RootSquashConfiguration' => [
                    'NoSquashNids' => ['<string>', ...],
                    'RootSquash' => '<string>',
                ],
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OntapConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'EndpointIpAddressRange' => '<string>',
                'Endpoints' => [
                    'Intercluster' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                    'Management' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                ],
                'FsxAdminPassword' => '<string>',
                'HAPairs' => <integer>,
                'PreferredSubnetId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'ThroughputCapacityPerHAPair' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OpenZFSConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'CopyTagsToVolumes' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'EndpointIpAddress' => '<string>',
                'EndpointIpAddressRange' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RootVolumeId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD',
            'SubnetIds' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => '<string>',
                'Aliases' => [
                    [
                        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'AuditLogConfiguration' => [
                    'AuditLogDestination' => '<string>',
                    'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                    'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                ],
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'MaintenanceOperationsInProgress' => ['<string>', ...],
                'PreferredFileServerIp' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RemoteAdministrationEndpoint' => '<string>',
                'SelfManagedActiveDirectoryConfiguration' => [
                    'DnsIps' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'FileSystemAdministratorsGroup' => '<string>',
                    'OrganizationalUnitDistinguishedName' => '<string>',
                    'UserName' => '<string>',
                ],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
FileSystems
Type: Array of FileSystem structures

An array of file system descriptions.

NextToken
Type: string

Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

InternalServerError:

A generic error indicating a server-side failure.

Examples

Example 1: To describe an Amazon FSx file system

This operation describes all of the Amazon FSx file systems in an account.

$result = $client->describeFileSystems([
]);

Result syntax:

[
    'FileSystems' => [
        [
            'CreationTime' => ,
            'DNSName' => 'fs-0498eed5fe91001ec.fsx.com',
            'FileSystemId' => 'fs-0498eed5fe91001ec',
            'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6',
            'Lifecycle' => 'AVAILABLE',
            'NetworkInterfaceIds' => [
                'eni-abcd1234',
            ],
            'OwnerId' => '012345678912',
            'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
            'StorageCapacity' => 300,
            'SubnetIds' => [
                'subnet-1234abcd',
            ],
            'Tags' => [
                [
                    'Key' => 'Name',
                    'Value' => 'MyFileSystem',
                ],
            ],
            'VpcId' => 'vpc-ab1234cd',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => 'd-1234abcd12',
                'AutomaticBackupRetentionDays' => 30,
                'DailyAutomaticBackupStartTime' => '05:00',
                'ThroughputCapacity' => 8,
                'WeeklyMaintenanceStartTime' => '1:05:00',
            ],
        ],
    ],
]

DescribeSharedVpcConfiguration

$result = $client->describeSharedVpcConfiguration([/* ... */]);
$promise = $client->describeSharedVpcConfigurationAsync([/* ... */]);

Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets.

Parameter Syntax

$result = $client->describeSharedVpcConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'EnableFsxRouteTableUpdatesFromParticipantAccounts' => '<string>',
]

Result Details

Members
EnableFsxRouteTableUpdatesFromParticipantAccounts
Type: string

Indicates whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets.

Errors

BadRequest:

A generic error indicating a failure with a client request.

InternalServerError:

A generic error indicating a server-side failure.

DescribeSnapshots

$result = $client->describeSnapshots([/* ... */]);
$promise = $client->describeSnapshotsAsync([/* ... */]);

Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

When using this operation, keep the following in mind:

  • The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.

  • The order of snapshots returned in the response of one DescribeSnapshots call and the order of backups returned across the responses of a multi-call iteration is unspecified.

Parameter Syntax

$result = $client->describeSnapshots([
    'Filters' => [
        [
            'Name' => 'file-system-id|volume-id',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'IncludeShared' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SnapshotIds' => ['<string>', ...],
]);

Parameter Details

Members
Filters
Type: Array of SnapshotFilter structures

The filters structure. The supported names are file-system-id or volume-id.

IncludeShared
Type: boolean

Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

MaxResults
Type: int

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

NextToken
Type: 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.

SnapshotIds
Type: Array of strings

The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

Result Syntax

[
    'NextToken' => '<string>',
    'Snapshots' => [
        [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RemainingTransferBytes' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                    'TargetFileSystemValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'DNSName' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'FileSystemId' => '<string>',
                        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                        'FileSystemTypeVersion' => '<string>',
                        'KmsKeyId' => '<string>',
                        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                        'LustreConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DataCompressionType' => 'NONE|LZ4',
                            'DataRepositoryConfiguration' => [
                                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                                'ExportPath' => '<string>',
                                'FailureDetails' => [
                                    'Message' => '<string>',
                                ],
                                'ImportPath' => '<string>',
                                'ImportedFileChunkSize' => <integer>,
                                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                            ],
                            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                            'DriveCacheType' => 'NONE|READ',
                            'LogConfiguration' => [
                                'Destination' => '<string>',
                                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                            ],
                            'MetadataConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'MountName' => '<string>',
                            'PerUnitStorageThroughput' => <integer>,
                            'RootSquashConfiguration' => [
                                'NoSquashNids' => ['<string>', ...],
                                'RootSquash' => '<string>',
                            ],
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'NetworkInterfaceIds' => ['<string>', ...],
                        'OntapConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddressRange' => '<string>',
                            'Endpoints' => [
                                'Intercluster' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                                'Management' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                            ],
                            'FsxAdminPassword' => '<string>',
                            'HAPairs' => <integer>,
                            'PreferredSubnetId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'ThroughputCapacityPerHAPair' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OpenZFSConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'CopyTagsToVolumes' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddress' => '<string>',
                            'EndpointIpAddressRange' => '<string>',
                            'PreferredSubnetId' => '<string>',
                            'RootVolumeId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD',
                        'SubnetIds' => ['<string>', ...],
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VpcId' => '<string>',
                        'WindowsConfiguration' => [
                            'ActiveDirectoryId' => '<string>',
                            'Aliases' => [
                                [
                                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'AuditLogConfiguration' => [
                                'AuditLogDestination' => '<string>',
                                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            ],
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'MaintenanceOperationsInProgress' => ['<string>', ...],
                            'PreferredFileServerIp' => '<string>',
                            'PreferredSubnetId' => '<string>',
                            'RemoteAdministrationEndpoint' => '<string>',
                            'SelfManagedActiveDirectoryConfiguration' => [
                                'DnsIps' => ['<string>', ...],
                                'DomainName' => '<string>',
                                'FileSystemAdministratorsGroup' => '<string>',
                                'OrganizationalUnitDistinguishedName' => '<string>',
                                'UserName' => '<string>',
                            ],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                    ],
                    'TargetSnapshotValues' => [...], // RECURSIVE
                    'TargetVolumeValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'FileSystemId' => '<string>',
                        'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'OntapConfiguration' => [
                            'AggregateConfiguration' => [
                                'Aggregates' => ['<string>', ...],
                                'TotalConstituents' => <integer>,
                            ],
                            'CopyTagsToBackups' => true || false,
                            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                            'JunctionPath' => '<string>',
                            'OntapVolumeType' => 'RW|DP|LS',
                            'SecurityStyle' => 'UNIX|NTFS|MIXED',
                            'SizeInBytes' => <integer>,
                            'SizeInMegabytes' => <integer>,
                            'SnaplockConfiguration' => [
                                'AuditLogVolume' => true || false,
                                'AutocommitPeriod' => [
                                    'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                    'Value' => <integer>,
                                ],
                                'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                                'RetentionPeriod' => [
                                    'DefaultRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                    'MaximumRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                    'MinimumRetention' => [
                                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                        'Value' => <integer>,
                                    ],
                                ],
                                'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                                'VolumeAppendModeEnabled' => true || false,
                            ],
                            'SnapshotPolicy' => '<string>',
                            'StorageEfficiencyEnabled' => true || false,
                            'StorageVirtualMachineId' => '<string>',
                            'StorageVirtualMachineRoot' => true || false,
                            'TieringPolicy' => [
                                'CoolingPeriod' => <integer>,
                                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                            ],
                            'UUID' => '<string>',
                            'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                        ],
                        'OpenZFSConfiguration' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'CopyTagsToSnapshots' => true || false,
                            'DataCompressionType' => 'NONE|ZSTD|LZ4',
                            'DeleteClonedVolumes' => true || false,
                            'DeleteIntermediateData' => true || false,
                            'DeleteIntermediateSnaphots' => true || false,
                            'DestinationSnapshot' => '<string>',
                            'NfsExports' => [
                                [
                                    'ClientConfigurations' => [
                                        [
                                            'Clients' => '<string>',
                                            'Options' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OriginSnapshot' => [
                                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                                'SnapshotARN' => '<string>',
                            ],
                            'ParentVolumeId' => '<string>',
                            'ReadOnly' => true || false,
                            'RecordSizeKiB' => <integer>,
                            'RestoreToSnapshot' => '<string>',
                            'SourceSnapshotARN' => '<string>',
                            'StorageCapacityQuotaGiB' => <integer>,
                            'StorageCapacityReservationGiB' => <integer>,
                            'UserAndGroupQuotas' => [
                                [
                                    'Id' => <integer>,
                                    'StorageCapacityQuotaGiB' => <integer>,
                                    'Type' => 'USER|GROUP',
                                ],
                                // ...
                            ],
                            'VolumePath' => '<string>',
                        ],
                        'ResourceARN' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                        'VolumeType' => 'ONTAP|OPENZFS',
                    ],
                    'TotalTransferBytes' => <integer>,
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
            'LifecycleTransitionReason' => [
                'Message' => '<string>',
            ],
            'Name' => '<string>',
            'ResourceARN' => '<string>',
            'SnapshotId' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VolumeId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: 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.

Snapshots
Type: Array of Snapshot structures

An array of snapshots.

Errors

BadRequest:

A generic error indicating a failure with a client request.

InternalServerError:

A generic error indicating a server-side failure.

SnapshotNotFound:

No Amazon FSx snapshots were found based on the supplied parameters.

DescribeStorageVirtualMachines

$result = $client->describeStorageVirtualMachines([/* ... */]);
$promise = $client->describeStorageVirtualMachinesAsync([/* ... */]);

Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).

Parameter Syntax

$result = $client->describeStorageVirtualMachines([
    'Filters' => [
        [
            'Name' => 'file-system-id',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StorageVirtualMachineIds' => ['<string>', ...],
]);

Parameter Details

Members
Filters
Type: Array of StorageVirtualMachineFilter structures

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

MaxResults
Type: int

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

NextToken
Type: 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.

StorageVirtualMachineIds
Type: Array of strings

Enter the ID of one or more SVMs that you want to view.

Result Syntax

[
    'NextToken' => '<string>',
    'StorageVirtualMachines' => [
        [
            'ActiveDirectoryConfiguration' => [
                'NetBiosName' => '<string>',
                'SelfManagedActiveDirectoryConfiguration' => [
                    'DnsIps' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'FileSystemAdministratorsGroup' => '<string>',
                    'OrganizationalUnitDistinguishedName' => '<string>',
                    'UserName' => '<string>',
                ],
            ],
            'CreationTime' => <DateTime>,
            'Endpoints' => [
                'Iscsi' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Management' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Nfs' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Smb' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
            ],
            'FileSystemId' => '<string>',
            'Lifecycle' => 'CREATED|CREATING|DELETING|FAILED|MISCONFIGURED|PENDING',
            'LifecycleTransitionReason' => [
                'Message' => '<string>',
            ],
            'Name' => '<string>',
            'ResourceARN' => '<string>',
            'RootVolumeSecurityStyle' => 'UNIX|NTFS|MIXED',
            'StorageVirtualMachineId' => '<string>',
            'Subtype' => 'DEFAULT|DP_DESTINATION|SYNC_DESTINATION|SYNC_SOURCE',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UUID' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: 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.

StorageVirtualMachines
Type: Array of StorageVirtualMachine structures

Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.

Errors

BadRequest:

A generic error indicating a failure with a client request.

InternalServerError:

A generic error indicating a server-side failure.

StorageVirtualMachineNotFound:

No FSx for ONTAP SVMs were found based upon the supplied parameters.

DescribeVolumes

$result = $client->describeVolumes([/* ... */]);
$promise = $client->describeVolumesAsync([/* ... */]);

Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.

Parameter Syntax

$result = $client->describeVolumes([
    'Filters' => [
        [
            'Name' => 'file-system-id|storage-virtual-machine-id',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'VolumeIds' => ['<string>', ...],
]);

Parameter Details

Members
Filters
Type: Array of VolumeFilter structures

Enter a filter Name and Values pair to view a select set of volumes.

MaxResults
Type: int

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

NextToken
Type: 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.

VolumeIds
Type: Array of strings

The IDs of the volumes whose descriptions you want to retrieve.

Result Syntax

[
    'NextToken' => '<string>',
    'Volumes' => [
        [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RemainingTransferBytes' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                    'TargetFileSystemValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'DNSName' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'FileSystemId' => '<string>',
                        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                        'FileSystemTypeVersion' => '<string>',
                        'KmsKeyId' => '<string>',
                        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                        'LustreConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DataCompressionType' => 'NONE|LZ4',
                            'DataRepositoryConfiguration' => [
                                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                                'ExportPath' => '<string>',
                                'FailureDetails' => [
                                    'Message' => '<string>',
                                ],
                                'ImportPath' => '<string>',
                                'ImportedFileChunkSize' => <integer>,
                                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                            ],
                            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                            'DriveCacheType' => 'NONE|READ',
                            'LogConfiguration' => [
                                'Destination' => '<string>',
                                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                            ],
                            'MetadataConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'MountName' => '<string>',
                            'PerUnitStorageThroughput' => <integer>,
                            'RootSquashConfiguration' => [
                                'NoSquashNids' => ['<string>', ...],
                                'RootSquash' => '<string>',
                            ],
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'NetworkInterfaceIds' => ['<string>', ...],
                        'OntapConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddressRange' => '<string>',
                            'Endpoints' => [
                                'Intercluster' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                                'Management' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                            ],
                            'FsxAdminPassword' => '<string>',
                            'HAPairs' => <integer>,
                            'PreferredSubnetId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'ThroughputCapacityPerHAPair' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OpenZFSConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'CopyTagsToVolumes' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddress' => '<string>',
                            'EndpointIpAddressRange' => '<string>',
                            'PreferredSubnetId' => '<string>',
                            'RootVolumeId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD',
                        'SubnetIds' => ['<string>', ...],
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VpcId' => '<string>',
                        'WindowsConfiguration' => [
                            'ActiveDirectoryId' => '<string>',
                            'Aliases' => [
                                [
                                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'AuditLogConfiguration' => [
                                'AuditLogDestination' => '<string>',
                                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            ],
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'MaintenanceOperationsInProgress' => ['<string>', ...],
                            'PreferredFileServerIp' => '<string>',
                            'PreferredSubnetId' => '<string>',
                            'RemoteAdministrationEndpoint' => '<string>',
                            'SelfManagedActiveDirectoryConfiguration' => [
                                'DnsIps' => ['<string>', ...],
                                'DomainName' => '<string>',
                                'FileSystemAdministratorsGroup' => '<string>',
                                'OrganizationalUnitDistinguishedName' => '<string>',
                                'UserName' => '<string>',
                            ],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                    ],
                    'TargetSnapshotValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                        'LifecycleTransitionReason' => [
                            'Message' => '<string>',
                        ],
                        'Name' => '<string>',
                        'ResourceARN' => '<string>',
                        'SnapshotId' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VolumeId' => '<string>',
                    ],
                    'TargetVolumeValues' => [...], // RECURSIVE
                    'TotalTransferBytes' => <integer>,
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'FileSystemId' => '<string>',
            'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
            'LifecycleTransitionReason' => [
                'Message' => '<string>',
            ],
            'Name' => '<string>',
            'OntapConfiguration' => [
                'AggregateConfiguration' => [
                    'Aggregates' => ['<string>', ...],
                    'TotalConstituents' => <integer>,
                ],
                'CopyTagsToBackups' => true || false,
                'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                'JunctionPath' => '<string>',
                'OntapVolumeType' => 'RW|DP|LS',
                'SecurityStyle' => 'UNIX|NTFS|MIXED',
                'SizeInBytes' => <integer>,
                'SizeInMegabytes' => <integer>,
                'SnaplockConfiguration' => [
                    'AuditLogVolume' => true || false,
                    'AutocommitPeriod' => [
                        'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                        'Value' => <integer>,
                    ],
                    'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                    'RetentionPeriod' => [
                        'DefaultRetention' => [
                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                            'Value' => <integer>,
                        ],
                        'MaximumRetention' => [
                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                            'Value' => <integer>,
                        ],
                        'MinimumRetention' => [
                            'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                            'Value' => <integer>,
                        ],
                    ],
                    'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                    'VolumeAppendModeEnabled' => true || false,
                ],
                'SnapshotPolicy' => '<string>',
                'StorageEfficiencyEnabled' => true || false,
                'StorageVirtualMachineId' => '<string>',
                'StorageVirtualMachineRoot' => true || false,
                'TieringPolicy' => [
                    'CoolingPeriod' => <integer>,
                    'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                ],
                'UUID' => '<string>',
                'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
            ],
            'OpenZFSConfiguration' => [
                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                'CopyTagsToSnapshots' => true || false,
                'DataCompressionType' => 'NONE|ZSTD|LZ4',
                'DeleteClonedVolumes' => true || false,
                'DeleteIntermediateData' => true || false,
                'DeleteIntermediateSnaphots' => true || false,
                'DestinationSnapshot' => '<string>',
                'NfsExports' => [
                    [
                        'ClientConfigurations' => [
                            [
                                'Clients' => '<string>',
                                'Options' => ['<string>', ...],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'OriginSnapshot' => [
                    'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                    'SnapshotARN' => '<string>',
                ],
                'ParentVolumeId' => '<string>',
                'ReadOnly' => true || false,
                'RecordSizeKiB' => <integer>,
                'RestoreToSnapshot' => '<string>',
                'SourceSnapshotARN' => '<string>',
                'StorageCapacityQuotaGiB' => <integer>,
                'StorageCapacityReservationGiB' => <integer>,
                'UserAndGroupQuotas' => [
                    [
                        'Id' => <integer>,
                        'StorageCapacityQuotaGiB' => <integer>,
                        'Type' => 'USER|GROUP',
                    ],
                    // ...
                ],
                'VolumePath' => '<string>',
            ],
            'ResourceARN' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VolumeId' => '<string>',
            'VolumeType' => 'ONTAP|OPENZFS',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: 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.

Volumes
Type: Array of Volume structures

Returned after a successful DescribeVolumes operation, describing each volume.

Errors

BadRequest:

A generic error indicating a failure with a client request.

InternalServerError:

A generic error indicating a server-side failure.

VolumeNotFound:

No Amazon FSx volumes were found based upon the supplied parameters.

DisassociateFileSystemAliases

$result = $client->disassociateFileSystemAliases([/* ... */]);
$promise = $client->disassociateFileSystemAliasesAsync([/* ... */]);

Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with an HTTP status code 400 (Bad Request). For more information, see Working with DNS Aliases.

The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.

Parameter Syntax

$result = $client->disassociateFileSystemAliases([
    'Aliases' => ['<string>', ...], // REQUIRED
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Aliases
Required: Yes
Type: Array of strings

An array of one or more DNS alias names to disassociate, or remove, from the file system.

ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Required: Yes
Type: string

Specifies the file system from which to disassociate the DNS aliases.

Result Syntax

[
    'Aliases' => [
        [
            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Aliases
Type: Array of Alias structures

An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

InternalServerError:

A generic error indicating a server-side failure.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for Amazon FSx resources.

When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken
Type: string

Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token present, the action continues the list from where the returning call left off.

ResourceARN
Required: Yes
Type: string

The ARN of the Amazon FSx resource that will have its tags listed.

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

This is present if there are more tags than returned in the response (String). You can use the NextToken value in the later request to fetch the tags.

Tags
Type: Array of Tag structures

A list of tags on the resource.

Errors

BadRequest:

A generic error indicating a failure with a client request.

InternalServerError:

A generic error indicating a server-side failure.

ResourceNotFound:

The resource specified by the Amazon Resource Name (ARN) can't be found.

NotServiceResourceError:

The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

ResourceDoesNotSupportTagging:

The resource specified does not support tagging.

Examples

Example 1: To list tags for a resource

This operation lists tags for an Amazon FSx resource.

$result = $client->listTagsForResource([
    'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
]);

Result syntax:

[
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyFileSystem',
        ],
    ],
]

ReleaseFileSystemNfsV3Locks

$result = $client->releaseFileSystemNfsV3Locks([/* ... */]);
$promise = $client->releaseFileSystemNfsV3LocksAsync([/* ... */]);

Releases the file system lock from an Amazon FSx for OpenZFS file system.

Parameter Syntax

$result = $client->releaseFileSystemNfsV3Locks([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Required: Yes
Type: string

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

Result Syntax

[
    'FileSystem' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
                'TargetSnapshotValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'ResourceARN' => '<string>',
                    'SnapshotId' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                ],
                'TargetVolumeValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'FileSystemId' => '<string>',
                    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'OntapConfiguration' => [
                        'AggregateConfiguration' => [
                            'Aggregates' => ['<string>', ...],
                            'TotalConstituents' => <integer>,
                        ],
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInBytes' => <integer>,
                        'SizeInMegabytes' => <integer>,
                        'SnaplockConfiguration' => [
                            'AuditLogVolume' => true || false,
                            'AutocommitPeriod' => [
                                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                'Value' => <integer>,
                            ],
                            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                            'RetentionPeriod' => [
                                'DefaultRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MaximumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MinimumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                            ],
                            'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                            'VolumeAppendModeEnabled' => true || false,
                        ],
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                        'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateData' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'DestinationSnapshot' => '<string>',
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<string>',
                        'SourceSnapshotARN' => '<string>',
                        'StorageCapacityQuotaGiB' => <integer>,
                        'StorageCapacityReservationGiB' => <integer>,
                        'UserAndGroupQuotas' => [
                            [
                                'Id' => <integer>,
                                'StorageCapacityQuotaGiB' => <integer>,
                                'Type' => 'USER|GROUP',
                            ],
                            // ...
                        ],
                        'VolumePath' => '<string>',
                    ],
                    'ResourceARN' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                    'VolumeType' => 'ONTAP|OPENZFS',
                ],
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
        'FileSystemTypeVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataCompressionType' => 'NONE|LZ4',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
            'DriveCacheType' => 'NONE|READ',
            'LogConfiguration' => [
                'Destination' => '<string>',
                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
            ],
            'MetadataConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'RootSquashConfiguration' => [
                'NoSquashNids' => ['<string>', ...],
                'RootSquash' => '<string>',
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OntapConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddressRange' => '<string>',
            'Endpoints' => [
                'Intercluster' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Management' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
            ],
            'FsxAdminPassword' => '<string>',
            'HAPairs' => <integer>,
            'PreferredSubnetId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'ThroughputCapacityPerHAPair' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OpenZFSConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'CopyTagsToVolumes' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddress' => '<string>',
            'EndpointIpAddressRange' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AuditLogConfiguration' => [
                'AuditLogDestination' => '<string>',
                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'PreferredFileServerIp' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RemoteAdministrationEndpoint' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members
FileSystem
Type: FileSystem structure

A description of a specific Amazon FSx file system.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

RestoreVolumeFromSnapshot

$result = $client->restoreVolumeFromSnapshot([/* ... */]);
$promise = $client->restoreVolumeFromSnapshotAsync([/* ... */]);

Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.

Parameter Syntax

$result = $client->restoreVolumeFromSnapshot([
    'ClientRequestToken' => '<string>',
    'Options' => ['<string>', ...],
    'SnapshotId' => '<string>', // REQUIRED
    'VolumeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Options
Type: Array of strings

The settings used when restoring the specified volume from snapshot.

  • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.

  • DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

SnapshotId
Required: Yes
Type: string

The ID of the source snapshot. Specifies the snapshot that you are restoring from.

VolumeId
Required: Yes
Type: string

The ID of the volume that you are restoring.

Result Syntax

[
    'AdministrativeActions' => [
        [
            'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'ProgressPercent' => <integer>,
            'RemainingTransferBytes' => <integer>,
            'RequestTime' => <DateTime>,
            'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
            'TargetFileSystemValues' => [
                'AdministrativeActions' => [...], // RECURSIVE
                'CreationTime' => <DateTime>,
                'DNSName' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'FileSystemId' => '<string>',
                'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                'FileSystemTypeVersion' => '<string>',
                'KmsKeyId' => '<string>',
                'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                'LustreConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DataCompressionType' => 'NONE|LZ4',
                    'DataRepositoryConfiguration' => [
                        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                        'ExportPath' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ImportPath' => '<string>',
                        'ImportedFileChunkSize' => <integer>,
                        'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                    ],
                    'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                    'DriveCacheType' => 'NONE|READ',
                    'LogConfiguration' => [
                        'Destination' => '<string>',
                        'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                    ],
                    'MetadataConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'MountName' => '<string>',
                    'PerUnitStorageThroughput' => <integer>,
                    'RootSquashConfiguration' => [
                        'NoSquashNids' => ['<string>', ...],
                        'RootSquash' => '<string>',
                    ],
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'NetworkInterfaceIds' => ['<string>', ...],
                'OntapConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'EndpointIpAddressRange' => '<string>',
                    'Endpoints' => [
                        'Intercluster' => [
                            'DNSName' => '<string>',
                            'IpAddresses' => ['<string>', ...],
                        ],
                        'Management' => [
                            'DNSName' => '<string>',
                            'IpAddresses' => ['<string>', ...],
                        ],
                    ],
                    'FsxAdminPassword' => '<string>',
                    'HAPairs' => <integer>,
                    'PreferredSubnetId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'ThroughputCapacityPerHAPair' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OpenZFSConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'CopyTagsToVolumes' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'EndpointIpAddress' => '<string>',
                    'EndpointIpAddressRange' => '<string>',
                    'PreferredSubnetId' => '<string>',
                    'RootVolumeId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OwnerId' => '<string>',
                'ResourceARN' => '<string>',
                'StorageCapacity' => <integer>,
                'StorageType' => 'SSD|HDD',
                'SubnetIds' => ['<string>', ...],
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VpcId' => '<string>',
                'WindowsConfiguration' => [
                    'ActiveDirectoryId' => '<string>',
                    'Aliases' => [
                        [
                            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                    'AuditLogConfiguration' => [
                        'AuditLogDestination' => '<string>',
                        'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                    ],
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'MaintenanceOperationsInProgress' => ['<string>', ...],
                    'PreferredFileServerIp' => '<string>',
                    'PreferredSubnetId' => '<string>',
                    'RemoteAdministrationEndpoint' => '<string>',
                    'SelfManagedActiveDirectoryConfiguration' => [
                        'DnsIps' => ['<string>', ...],
                        'DomainName' => '<string>',
                        'FileSystemAdministratorsGroup' => '<string>',
                        'OrganizationalUnitDistinguishedName' => '<string>',
                        'UserName' => '<string>',
                    ],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
            ],
            'TargetSnapshotValues' => [
                'AdministrativeActions' => [...], // RECURSIVE
                'CreationTime' => <DateTime>,
                'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                'LifecycleTransitionReason' => [
                    'Message' => '<string>',
                ],
                'Name' => '<string>',
                'ResourceARN' => '<string>',
                'SnapshotId' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VolumeId' => '<string>',
            ],
            'TargetVolumeValues' => [
                'AdministrativeActions' => [...], // RECURSIVE
                'CreationTime' => <DateTime>,
                'FileSystemId' => '<string>',
                'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                'LifecycleTransitionReason' => [
                    'Message' => '<string>',
                ],
                'Name' => '<string>',
                'OntapConfiguration' => [
                    'AggregateConfiguration' => [
                        'Aggregates' => ['<string>', ...],
                        'TotalConstituents' => <integer>,
                    ],
                    'CopyTagsToBackups' => true || false,
                    'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                    'JunctionPath' => '<string>',
                    'OntapVolumeType' => 'RW|DP|LS',
                    'SecurityStyle' => 'UNIX|NTFS|MIXED',
                    'SizeInBytes' => <integer>,
                    'SizeInMegabytes' => <integer>,
                    'SnaplockConfiguration' => [
                        'AuditLogVolume' => true || false,
                        'AutocommitPeriod' => [
                            'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                            'Value' => <integer>,
                        ],
                        'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                        'RetentionPeriod' => [
                            'DefaultRetention' => [
                                'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                'Value' => <integer>,
                            ],
                            'MaximumRetention' => [
                                'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                'Value' => <integer>,
                            ],
                            'MinimumRetention' => [
                                'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                'Value' => <integer>,
                            ],
                        ],
                        'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                        'VolumeAppendModeEnabled' => true || false,
                    ],
                    'SnapshotPolicy' => '<string>',
                    'StorageEfficiencyEnabled' => true || false,
                    'StorageVirtualMachineId' => '<string>',
                    'StorageVirtualMachineRoot' => true || false,
                    'TieringPolicy' => [
                        'CoolingPeriod' => <integer>,
                        'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                    ],
                    'UUID' => '<string>',
                    'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                ],
                'OpenZFSConfiguration' => [
                    'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                    'CopyTagsToSnapshots' => true || false,
                    'DataCompressionType' => 'NONE|ZSTD|LZ4',
                    'DeleteClonedVolumes' => true || false,
                    'DeleteIntermediateData' => true || false,
                    'DeleteIntermediateSnaphots' => true || false,
                    'DestinationSnapshot' => '<string>',
                    'NfsExports' => [
                        [
                            'ClientConfigurations' => [
                                [
                                    'Clients' => '<string>',
                                    'Options' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'OriginSnapshot' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'SnapshotARN' => '<string>',
                    ],
                    'ParentVolumeId' => '<string>',
                    'ReadOnly' => true || false,
                    'RecordSizeKiB' => <integer>,
                    'RestoreToSnapshot' => '<string>',
                    'SourceSnapshotARN' => '<string>',
                    'StorageCapacityQuotaGiB' => <integer>,
                    'StorageCapacityReservationGiB' => <integer>,
                    'UserAndGroupQuotas' => [
                        [
                            'Id' => <integer>,
                            'StorageCapacityQuotaGiB' => <integer>,
                            'Type' => 'USER|GROUP',
                        ],
                        // ...
                    ],
                    'VolumePath' => '<string>',
                ],
                'ResourceARN' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VolumeId' => '<string>',
                'VolumeType' => 'ONTAP|OPENZFS',
            ],
            'TotalTransferBytes' => <integer>,
        ],
        // ...
    ],
    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
    'VolumeId' => '<string>',
]

Result Details

Members
AdministrativeActions
Type: Array of AdministrativeAction structures

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

Lifecycle
Type: string

The lifecycle state of the volume being restored.

VolumeId
Type: string

The ID of the volume that you restored.

Errors

BadRequest:

A generic error indicating a failure with a client request.

InternalServerError:

A generic error indicating a server-side failure.

VolumeNotFound:

No Amazon FSx volumes were found based upon the supplied parameters.

StartMisconfiguredStateRecovery

$result = $client->startMisconfiguredStateRecovery([/* ... */]);
$promise = $client->startMisconfiguredStateRecoveryAsync([/* ... */]);

After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system.

Parameter Syntax

$result = $client->startMisconfiguredStateRecovery([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Required: Yes
Type: string

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

Result Syntax

[
    'FileSystem' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
                'TargetSnapshotValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'ResourceARN' => '<string>',
                    'SnapshotId' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                ],
                'TargetVolumeValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'FileSystemId' => '<string>',
                    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'OntapConfiguration' => [
                        'AggregateConfiguration' => [
                            'Aggregates' => ['<string>', ...],
                            'TotalConstituents' => <integer>,
                        ],
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInBytes' => <integer>,
                        'SizeInMegabytes' => <integer>,
                        'SnaplockConfiguration' => [
                            'AuditLogVolume' => true || false,
                            'AutocommitPeriod' => [
                                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                'Value' => <integer>,
                            ],
                            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                            'RetentionPeriod' => [
                                'DefaultRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MaximumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MinimumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                            ],
                            'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                            'VolumeAppendModeEnabled' => true || false,
                        ],
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                        'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateData' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'DestinationSnapshot' => '<string>',
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<string>',
                        'SourceSnapshotARN' => '<string>',
                        'StorageCapacityQuotaGiB' => <integer>,
                        'StorageCapacityReservationGiB' => <integer>,
                        'UserAndGroupQuotas' => [
                            [
                                'Id' => <integer>,
                                'StorageCapacityQuotaGiB' => <integer>,
                                'Type' => 'USER|GROUP',
                            ],
                            // ...
                        ],
                        'VolumePath' => '<string>',
                    ],
                    'ResourceARN' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                    'VolumeType' => 'ONTAP|OPENZFS',
                ],
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
        'FileSystemTypeVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataCompressionType' => 'NONE|LZ4',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
            'DriveCacheType' => 'NONE|READ',
            'LogConfiguration' => [
                'Destination' => '<string>',
                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
            ],
            'MetadataConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'RootSquashConfiguration' => [
                'NoSquashNids' => ['<string>', ...],
                'RootSquash' => '<string>',
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OntapConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddressRange' => '<string>',
            'Endpoints' => [
                'Intercluster' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Management' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
            ],
            'FsxAdminPassword' => '<string>',
            'HAPairs' => <integer>,
            'PreferredSubnetId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'ThroughputCapacityPerHAPair' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OpenZFSConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'CopyTagsToVolumes' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddress' => '<string>',
            'EndpointIpAddressRange' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AuditLogConfiguration' => [
                'AuditLogDestination' => '<string>',
                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'PreferredFileServerIp' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RemoteAdministrationEndpoint' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members
FileSystem
Type: FileSystem structure

A description of a specific Amazon FSx file system.

Errors

BadRequest:

A generic error indicating a failure with a client request.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

InternalServerError:

A generic error indicating a server-side failure.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags an Amazon FSx resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.

Tags
Required: Yes
Type: Array of Tag structures

A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequest:

A generic error indicating a failure with a client request.

InternalServerError:

A generic error indicating a server-side failure.

ResourceNotFound:

The resource specified by the Amazon Resource Name (ARN) can't be found.

NotServiceResourceError:

The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

ResourceDoesNotSupportTagging:

The resource specified does not support tagging.

Examples

Example 1: To tag a resource

This operation tags an Amazon FSx resource.

$result = $client->tagResource([
    'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyFileSystem',
        ],
    ],
]);

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

This action removes a tag from an Amazon FSx resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the Amazon FSx resource to untag.

TagKeys
Required: Yes
Type: Array of strings

A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequest:

A generic error indicating a failure with a client request.

InternalServerError:

A generic error indicating a server-side failure.

ResourceNotFound:

The resource specified by the Amazon Resource Name (ARN) can't be found.

NotServiceResourceError:

The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

ResourceDoesNotSupportTagging:

The resource specified does not support tagging.

Examples

Example 1: To untag a resource

This operation untags an Amazon FSx resource.

$result = $client->untagResource([
    'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
    'TagKeys' => [
        'Name',
    ],
]);

UpdateDataRepositoryAssociation

$result = $client->updateDataRepositoryAssociation([/* ... */]);
$promise = $client->updateDataRepositoryAssociationAsync([/* ... */]);

Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

Parameter Syntax

$result = $client->updateDataRepositoryAssociation([
    'AssociationId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'ImportedFileChunkSize' => <integer>,
    'S3' => [
        'AutoExportPolicy' => [
            'Events' => ['<string>', ...],
        ],
        'AutoImportPolicy' => [
            'Events' => ['<string>', ...],
        ],
    ],
]);

Parameter Details

Members
AssociationId
Required: Yes
Type: string

The ID of the data repository association that you are updating.

ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

ImportedFileChunkSize
Type: int

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

S3

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

Result Syntax

[
    'Association' => [
        'AssociationId' => '<string>',
        'BatchImportMetaDataOnCreate' => true || false,
        'CreationTime' => <DateTime>,
        'DataRepositoryPath' => '<string>',
        'DataRepositorySubdirectories' => ['<string>', ...],
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileCacheId' => '<string>',
        'FileCachePath' => '<string>',
        'FileSystemId' => '<string>',
        'FileSystemPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
        'NFS' => [
            'AutoExportPolicy' => [
                'Events' => ['<string>', ...],
            ],
            'DnsIps' => ['<string>', ...],
            'Version' => 'NFS3',
        ],
        'ResourceARN' => '<string>',
        'S3' => [
            'AutoExportPolicy' => [
                'Events' => ['<string>', ...],
            ],
            'AutoImportPolicy' => [
                'Events' => ['<string>', ...],
            ],
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Association
Type: DataRepositoryAssociation structure

The response object returned after the data repository association is updated.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

DataRepositoryAssociationNotFound:

No data repository associations were found based upon the supplied parameters.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

InternalServerError:

A generic error indicating a server-side failure.

UpdateFileCache

$result = $client->updateFileCache([/* ... */]);
$promise = $client->updateFileCacheAsync([/* ... */]);

Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.

Parameter Syntax

$result = $client->updateFileCache([
    'ClientRequestToken' => '<string>',
    'FileCacheId' => '<string>', // REQUIRED
    'LustreConfiguration' => [
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileCacheId
Required: Yes
Type: string

The ID of the cache that you are updating.

LustreConfiguration

The configuration updates for an Amazon File Cache resource.

Result Syntax

[
    'FileCache' => [
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'DataRepositoryAssociationIds' => ['<string>', ...],
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileCacheId' => '<string>',
        'FileCacheType' => 'LUSTRE',
        'FileCacheTypeVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|UPDATING|FAILED',
        'LustreConfiguration' => [
            'DeploymentType' => 'CACHE_1',
            'LogConfiguration' => [
                'Destination' => '<string>',
                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
            ],
            'MetadataConfiguration' => [
                'StorageCapacity' => <integer>,
            ],
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'SubnetIds' => ['<string>', ...],
        'VpcId' => '<string>',
    ],
]

Result Details

Members
FileCache
Type: FileCache structure

A description of the cache that was updated.

Errors

BadRequest:

A generic error indicating a failure with a client request.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

FileCacheNotFound:

No caches were found based upon supplied parameters.

MissingFileCacheConfiguration:

A cache configuration is required for this operation.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

UpdateFileSystem

$result = $client->updateFileSystem([/* ... */]);
$promise = $client->updateFileSystemAsync([/* ... */]);

Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.

For FSx for Windows File Server file systems, you can update the following properties:

  • AuditLogConfiguration

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • SelfManagedActiveDirectoryConfiguration

  • StorageCapacity

  • StorageType

  • ThroughputCapacity

  • DiskIopsConfiguration

  • WeeklyMaintenanceStartTime

For FSx for Lustre file systems, you can update the following properties:

  • AutoImportPolicy

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • DataCompressionType

  • LogConfiguration

  • LustreRootSquashConfiguration

  • MetadataConfiguration

  • PerUnitStorageThroughput

  • StorageCapacity

  • WeeklyMaintenanceStartTime

For FSx for ONTAP file systems, you can update the following properties:

  • AddRouteTableIds

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • DiskIopsConfiguration

  • FsxAdminPassword

  • HAPairs

  • RemoveRouteTableIds

  • StorageCapacity

  • ThroughputCapacity

  • ThroughputCapacityPerHAPair

  • WeeklyMaintenanceStartTime

For FSx for OpenZFS file systems, you can update the following properties:

  • AddRouteTableIds

  • AutomaticBackupRetentionDays

  • CopyTagsToBackups

  • CopyTagsToVolumes

  • DailyAutomaticBackupStartTime

  • DiskIopsConfiguration

  • RemoveRouteTableIds

  • StorageCapacity

  • ThroughputCapacity

  • WeeklyMaintenanceStartTime

Parameter Syntax

$result = $client->updateFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DataCompressionType' => 'NONE|LZ4',
        'LogConfiguration' => [
            'Destination' => '<string>',
            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR', // REQUIRED
        ],
        'MetadataConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'PerUnitStorageThroughput' => <integer>,
        'RootSquashConfiguration' => [
            'NoSquashNids' => ['<string>', ...],
            'RootSquash' => '<string>',
        ],
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'OntapConfiguration' => [
        'AddRouteTableIds' => ['<string>', ...],
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'FsxAdminPassword' => '<string>',
        'HAPairs' => <integer>,
        'RemoveRouteTableIds' => ['<string>', ...],
        'ThroughputCapacity' => <integer>,
        'ThroughputCapacityPerHAPair' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'OpenZFSConfiguration' => [
        'AddRouteTableIds' => ['<string>', ...],
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'CopyTagsToVolumes' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'RemoveRouteTableIds' => ['<string>', ...],
        'ThroughputCapacity' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'StorageCapacity' => <integer>,
    'StorageType' => 'SSD|HDD',
    'WindowsConfiguration' => [
        'AuditLogConfiguration' => [
            'AuditLogDestination' => '<string>',
            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
        ],
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'SelfManagedActiveDirectoryConfiguration' => [
            'DnsIps' => ['<string>', ...],
            'DomainName' => '<string>',
            'FileSystemAdministratorsGroup' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
            'Password' => '<string>',
            'UserName' => '<string>',
        ],
        'ThroughputCapacity' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

FileSystemId
Required: Yes
Type: string

The ID of the file system that you are updating.

LustreConfiguration

The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

OntapConfiguration

The configuration updates for an Amazon FSx for NetApp ONTAP file system.

OpenZFSConfiguration

The configuration updates for an FSx for OpenZFS file system.

StorageCapacity
Type: int

Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Lustre file systems, the storage capacity target value can be the following:

  • For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

  • For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.

  • For SCRATCH_1 file systems, you can't increase the storage capacity.

For more information, see Managing storage and throughput capacity in the FSx for Lustre User Guide.

For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity in the FSx for OpenZFS User Guide.

For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSxfor Windows File Server User Guide.

For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

StorageType
Type: string

Specifies the file system's storage type.

WindowsConfiguration

The configuration updates for an Amazon FSx for Windows File Server file system.

Result Syntax

[
    'FileSystem' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
                'TargetSnapshotValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'ResourceARN' => '<string>',
                    'SnapshotId' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                ],
                'TargetVolumeValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'FileSystemId' => '<string>',
                    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'OntapConfiguration' => [
                        'AggregateConfiguration' => [
                            'Aggregates' => ['<string>', ...],
                            'TotalConstituents' => <integer>,
                        ],
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInBytes' => <integer>,
                        'SizeInMegabytes' => <integer>,
                        'SnaplockConfiguration' => [
                            'AuditLogVolume' => true || false,
                            'AutocommitPeriod' => [
                                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                'Value' => <integer>,
                            ],
                            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                            'RetentionPeriod' => [
                                'DefaultRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MaximumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MinimumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                            ],
                            'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                            'VolumeAppendModeEnabled' => true || false,
                        ],
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                        'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateData' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'DestinationSnapshot' => '<string>',
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<string>',
                        'SourceSnapshotARN' => '<string>',
                        'StorageCapacityQuotaGiB' => <integer>,
                        'StorageCapacityReservationGiB' => <integer>,
                        'UserAndGroupQuotas' => [
                            [
                                'Id' => <integer>,
                                'StorageCapacityQuotaGiB' => <integer>,
                                'Type' => 'USER|GROUP',
                            ],
                            // ...
                        ],
                        'VolumePath' => '<string>',
                    ],
                    'ResourceARN' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                    'VolumeType' => 'ONTAP|OPENZFS',
                ],
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
        'FileSystemTypeVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataCompressionType' => 'NONE|LZ4',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
            'DriveCacheType' => 'NONE|READ',
            'LogConfiguration' => [
                'Destination' => '<string>',
                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
            ],
            'MetadataConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'RootSquashConfiguration' => [
                'NoSquashNids' => ['<string>', ...],
                'RootSquash' => '<string>',
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OntapConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddressRange' => '<string>',
            'Endpoints' => [
                'Intercluster' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Management' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
            ],
            'FsxAdminPassword' => '<string>',
            'HAPairs' => <integer>,
            'PreferredSubnetId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'ThroughputCapacityPerHAPair' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OpenZFSConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'CopyTagsToVolumes' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddress' => '<string>',
            'EndpointIpAddressRange' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AuditLogConfiguration' => [
                'AuditLogDestination' => '<string>',
                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'PreferredFileServerIp' => '<string>',
            'PreferredSubnetId' => '<string>',
            'RemoteAdministrationEndpoint' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members
FileSystem
Type: FileSystem structure

A description of the file system that was updated.

Errors

BadRequest:

A generic error indicating a failure with a client request.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InvalidNetworkSettings:

One or more network settings specified in the request are invalid.

InternalServerError:

A generic error indicating a server-side failure.

FileSystemNotFound:

No Amazon FSx file systems were found based upon supplied parameters.

MissingFileSystemConfiguration:

A file system configuration is required for this operation.

ServiceLimitExceeded:

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

Examples

Example 1: To update an existing file system

This operation updates an existing file system.

$result = $client->updateFileSystem([
    'FileSystemId' => 'fs-0498eed5fe91001ec',
    'WindowsConfiguration' => [
        'AutomaticBackupRetentionDays' => 10,
        'DailyAutomaticBackupStartTime' => '06:00',
        'WeeklyMaintenanceStartTime' => '3:06:00',
    ],
]);

Result syntax:

[
    'FileSystem' => [
        'CreationTime' => ,
        'DNSName' => 'fs-0498eed5fe91001ec.fsx.com',
        'FileSystemId' => 'fs-0498eed5fe91001ec',
        'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6',
        'Lifecycle' => 'AVAILABLE',
        'OwnerId' => '012345678912',
        'ResourceARN' => 'arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
        'StorageCapacity' => 300,
        'SubnetIds' => [
            'subnet-1234abcd',
        ],
        'Tags' => [
            [
                'Key' => 'Name',
                'Value' => 'MyFileSystem',
            ],
        ],
        'VpcId' => 'vpc-ab1234cd',
        'WindowsConfiguration' => [
            'AutomaticBackupRetentionDays' => 10,
            'DailyAutomaticBackupStartTime' => '06:00',
            'ThroughputCapacity' => 8,
            'WeeklyMaintenanceStartTime' => '3:06:00',
        ],
    ],
]

UpdateSharedVpcConfiguration

$result = $client->updateSharedVpcConfiguration([/* ... */]);
$promise = $client->updateSharedVpcConfigurationAsync([/* ... */]);

Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide.

We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a MISCONFIGURED state and behave like Single-AZ file systems. For more information, see Important considerations before disabling shared VPC support for Multi-AZ file systems.

Parameter Syntax

$result = $client->updateSharedVpcConfiguration([
    'ClientRequestToken' => '<string>',
    'EnableFsxRouteTableUpdatesFromParticipantAccounts' => '<string>',
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

EnableFsxRouteTableUpdatesFromParticipantAccounts
Type: string

Specifies whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets. Set to true to enable or false to disable.

Result Syntax

[
    'EnableFsxRouteTableUpdatesFromParticipantAccounts' => '<string>',
]

Result Details

Members
EnableFsxRouteTableUpdatesFromParticipantAccounts
Type: string

Indicates whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

UpdateSnapshot

$result = $client->updateSnapshot([/* ... */]);
$promise = $client->updateSnapshotAsync([/* ... */]);

Updates the name of an Amazon FSx for OpenZFS snapshot.

Parameter Syntax

$result = $client->updateSnapshot([
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'SnapshotId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Name
Required: Yes
Type: string

The name of the snapshot to update.

SnapshotId
Required: Yes
Type: string

The ID of the snapshot that you want to update, in the format fsvolsnap-0123456789abcdef0.

Result Syntax

[
    'Snapshot' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'DNSName' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'FileSystemId' => '<string>',
                    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                    'FileSystemTypeVersion' => '<string>',
                    'KmsKeyId' => '<string>',
                    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                    'LustreConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DataCompressionType' => 'NONE|LZ4',
                        'DataRepositoryConfiguration' => [
                            'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                            'ExportPath' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'ImportPath' => '<string>',
                            'ImportedFileChunkSize' => <integer>,
                            'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                        ],
                        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                        'DriveCacheType' => 'NONE|READ',
                        'LogConfiguration' => [
                            'Destination' => '<string>',
                            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                        ],
                        'MetadataConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MountName' => '<string>',
                        'PerUnitStorageThroughput' => <integer>,
                        'RootSquashConfiguration' => [
                            'NoSquashNids' => ['<string>', ...],
                            'RootSquash' => '<string>',
                        ],
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'NetworkInterfaceIds' => ['<string>', ...],
                    'OntapConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddressRange' => '<string>',
                        'Endpoints' => [
                            'Intercluster' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                            'Management' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                        ],
                        'FsxAdminPassword' => '<string>',
                        'HAPairs' => <integer>,
                        'PreferredSubnetId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'ThroughputCapacityPerHAPair' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'CopyTagsToVolumes' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddress' => '<string>',
                        'EndpointIpAddressRange' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD',
                    'SubnetIds' => ['<string>', ...],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                    'WindowsConfiguration' => [
                        'ActiveDirectoryId' => '<string>',
                        'Aliases' => [
                            [
                                'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'AuditLogConfiguration' => [
                            'AuditLogDestination' => '<string>',
                            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        ],
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MaintenanceOperationsInProgress' => ['<string>', ...],
                        'PreferredFileServerIp' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RemoteAdministrationEndpoint' => '<string>',
                        'SelfManagedActiveDirectoryConfiguration' => [
                            'DnsIps' => ['<string>', ...],
                            'DomainName' => '<string>',
                            'FileSystemAdministratorsGroup' => '<string>',
                            'OrganizationalUnitDistinguishedName' => '<string>',
                            'UserName' => '<string>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                ],
                'TargetSnapshotValues' => [...], // RECURSIVE
                'TargetVolumeValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'FileSystemId' => '<string>',
                    'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'OntapConfiguration' => [
                        'AggregateConfiguration' => [
                            'Aggregates' => ['<string>', ...],
                            'TotalConstituents' => <integer>,
                        ],
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInBytes' => <integer>,
                        'SizeInMegabytes' => <integer>,
                        'SnaplockConfiguration' => [
                            'AuditLogVolume' => true || false,
                            'AutocommitPeriod' => [
                                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                                'Value' => <integer>,
                            ],
                            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                            'RetentionPeriod' => [
                                'DefaultRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MaximumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                                'MinimumRetention' => [
                                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                                    'Value' => <integer>,
                                ],
                            ],
                            'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                            'VolumeAppendModeEnabled' => true || false,
                        ],
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                        'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateData' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'DestinationSnapshot' => '<string>',
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<string>',
                        'SourceSnapshotARN' => '<string>',
                        'StorageCapacityQuotaGiB' => <integer>,
                        'StorageCapacityReservationGiB' => <integer>,
                        'UserAndGroupQuotas' => [
                            [
                                'Id' => <integer>,
                                'StorageCapacityQuotaGiB' => <integer>,
                                'Type' => 'USER|GROUP',
                            ],
                            // ...
                        ],
                        'VolumePath' => '<string>',
                    ],
                    'ResourceARN' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                    'VolumeType' => 'ONTAP|OPENZFS',
                ],
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
        'LifecycleTransitionReason' => [
            'Message' => '<string>',
        ],
        'Name' => '<string>',
        'ResourceARN' => '<string>',
        'SnapshotId' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VolumeId' => '<string>',
    ],
]

Result Details

Members
Snapshot
Type: Snapshot structure

Returned after a successful UpdateSnapshot operation, describing the snapshot that you updated.

Errors

BadRequest:

A generic error indicating a failure with a client request.

SnapshotNotFound:

No Amazon FSx snapshots were found based on the supplied parameters.

InternalServerError:

A generic error indicating a server-side failure.

UpdateStorageVirtualMachine

$result = $client->updateStorageVirtualMachine([/* ... */]);
$promise = $client->updateStorageVirtualMachineAsync([/* ... */]);

Updates an FSx for ONTAP storage virtual machine (SVM).

Parameter Syntax

$result = $client->updateStorageVirtualMachine([
    'ActiveDirectoryConfiguration' => [
        'NetBiosName' => '<string>',
        'SelfManagedActiveDirectoryConfiguration' => [
            'DnsIps' => ['<string>', ...],
            'DomainName' => '<string>',
            'FileSystemAdministratorsGroup' => '<string>',
            'OrganizationalUnitDistinguishedName' => '<string>',
            'Password' => '<string>',
            'UserName' => '<string>',
        ],
    ],
    'ClientRequestToken' => '<string>',
    'StorageVirtualMachineId' => '<string>', // REQUIRED
    'SvmAdminPassword' => '<string>',
]);

Parameter Details

Members
ActiveDirectoryConfiguration

Specifies updates to an SVM's Microsoft Active Directory (AD) configuration.

ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

StorageVirtualMachineId
Required: Yes
Type: string

The ID of the SVM that you want to update, in the format svm-0123456789abcdef0.

SvmAdminPassword
Type: string

Specifies a new SvmAdminPassword.

Result Syntax

[
    'StorageVirtualMachine' => [
        'ActiveDirectoryConfiguration' => [
            'NetBiosName' => '<string>',
            'SelfManagedActiveDirectoryConfiguration' => [
                'DnsIps' => ['<string>', ...],
                'DomainName' => '<string>',
                'FileSystemAdministratorsGroup' => '<string>',
                'OrganizationalUnitDistinguishedName' => '<string>',
                'UserName' => '<string>',
            ],
        ],
        'CreationTime' => <DateTime>,
        'Endpoints' => [
            'Iscsi' => [
                'DNSName' => '<string>',
                'IpAddresses' => ['<string>', ...],
            ],
            'Management' => [
                'DNSName' => '<string>',
                'IpAddresses' => ['<string>', ...],
            ],
            'Nfs' => [
                'DNSName' => '<string>',
                'IpAddresses' => ['<string>', ...],
            ],
            'Smb' => [
                'DNSName' => '<string>',
                'IpAddresses' => ['<string>', ...],
            ],
        ],
        'FileSystemId' => '<string>',
        'Lifecycle' => 'CREATED|CREATING|DELETING|FAILED|MISCONFIGURED|PENDING',
        'LifecycleTransitionReason' => [
            'Message' => '<string>',
        ],
        'Name' => '<string>',
        'ResourceARN' => '<string>',
        'RootVolumeSecurityStyle' => 'UNIX|NTFS|MIXED',
        'StorageVirtualMachineId' => '<string>',
        'Subtype' => 'DEFAULT|DP_DESTINATION|SYNC_DESTINATION|SYNC_SOURCE',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UUID' => '<string>',
    ],
]

Result Details

Members
StorageVirtualMachine
Type: StorageVirtualMachine structure

Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

StorageVirtualMachineNotFound:

No FSx for ONTAP SVMs were found based upon the supplied parameters.

UnsupportedOperation:

The requested operation is not supported for this resource or API.

UpdateVolume

$result = $client->updateVolume([/* ... */]);
$promise = $client->updateVolumeAsync([/* ... */]);

Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

Parameter Syntax

$result = $client->updateVolume([
    'ClientRequestToken' => '<string>',
    'Name' => '<string>',
    'OntapConfiguration' => [
        'CopyTagsToBackups' => true || false,
        'JunctionPath' => '<string>',
        'SecurityStyle' => 'UNIX|NTFS|MIXED',
        'SizeInBytes' => <integer>,
        'SizeInMegabytes' => <integer>,
        'SnaplockConfiguration' => [
            'AuditLogVolume' => true || false,
            'AutocommitPeriod' => [
                'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE', // REQUIRED
                'Value' => <integer>,
            ],
            'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
            'RetentionPeriod' => [
                'DefaultRetention' => [ // REQUIRED
                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED', // REQUIRED
                    'Value' => <integer>,
                ],
                'MaximumRetention' => [ // REQUIRED
                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED', // REQUIRED
                    'Value' => <integer>,
                ],
                'MinimumRetention' => [ // REQUIRED
                    'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED', // REQUIRED
                    'Value' => <integer>,
                ],
            ],
            'VolumeAppendModeEnabled' => true || false,
        ],
        'SnapshotPolicy' => '<string>',
        'StorageEfficiencyEnabled' => true || false,
        'TieringPolicy' => [
            'CoolingPeriod' => <integer>,
            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
        ],
    ],
    'OpenZFSConfiguration' => [
        'DataCompressionType' => 'NONE|ZSTD|LZ4',
        'NfsExports' => [
            [
                'ClientConfigurations' => [ // REQUIRED
                    [
                        'Clients' => '<string>', // REQUIRED
                        'Options' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'ReadOnly' => true || false,
        'RecordSizeKiB' => <integer>,
        'StorageCapacityQuotaGiB' => <integer>,
        'StorageCapacityReservationGiB' => <integer>,
        'UserAndGroupQuotas' => [
            [
                'Id' => <integer>, // REQUIRED
                'StorageCapacityQuotaGiB' => <integer>, // REQUIRED
                'Type' => 'USER|GROUP', // REQUIRED
            ],
            // ...
        ],
    ],
    'VolumeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

Name
Type: string

The name of the OpenZFS volume. OpenZFS root volumes are automatically named FSX. Child volume names must be unique among their parent volume's children. The name of the volume is part of the mount string for the OpenZFS volume.

OntapConfiguration

The configuration of the ONTAP volume that you are updating.

OpenZFSConfiguration

The configuration of the OpenZFS volume that you are updating.

VolumeId
Required: Yes
Type: string

The ID of the volume that you want to update, in the format fsvol-0123456789abcdef0.

Result Syntax

[
    'Volume' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE|THROUGHPUT_OPTIMIZATION|IOPS_OPTIMIZATION|STORAGE_TYPE_OPTIMIZATION|MISCONFIGURED_STATE_RECOVERY|VOLUME_UPDATE_WITH_SNAPSHOT|VOLUME_INITIALIZE_WITH_SNAPSHOT|DOWNLOAD_DATA_FROM_BACKUP',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RemainingTransferBytes' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING|OPTIMIZING',
                'TargetFileSystemValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'DNSName' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'FileSystemId' => '<string>',
                    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                    'FileSystemTypeVersion' => '<string>',
                    'KmsKeyId' => '<string>',
                    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                    'LustreConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DataCompressionType' => 'NONE|LZ4',
                        'DataRepositoryConfiguration' => [
                            'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                            'ExportPath' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'ImportPath' => '<string>',
                            'ImportedFileChunkSize' => <integer>,
                            'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                        ],
                        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                        'DriveCacheType' => 'NONE|READ',
                        'LogConfiguration' => [
                            'Destination' => '<string>',
                            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                        ],
                        'MetadataConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MountName' => '<string>',
                        'PerUnitStorageThroughput' => <integer>,
                        'RootSquashConfiguration' => [
                            'NoSquashNids' => ['<string>', ...],
                            'RootSquash' => '<string>',
                        ],
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'NetworkInterfaceIds' => ['<string>', ...],
                    'OntapConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2|MULTI_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddressRange' => '<string>',
                        'Endpoints' => [
                            'Intercluster' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                            'Management' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                        ],
                        'FsxAdminPassword' => '<string>',
                        'HAPairs' => <integer>,
                        'PreferredSubnetId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'ThroughputCapacityPerHAPair' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'CopyTagsToVolumes' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2|SINGLE_AZ_HA_1|SINGLE_AZ_HA_2|MULTI_AZ_1',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddress' => '<string>',
                        'EndpointIpAddressRange' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD',
                    'SubnetIds' => ['<string>', ...],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                    'WindowsConfiguration' => [
                        'ActiveDirectoryId' => '<string>',
                        'Aliases' => [
                            [
                                'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'AuditLogConfiguration' => [
                            'AuditLogDestination' => '<string>',
                            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        ],
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'MaintenanceOperationsInProgress' => ['<string>', ...],
                        'PreferredFileServerIp' => '<string>',
                        'PreferredSubnetId' => '<string>',
                        'RemoteAdministrationEndpoint' => '<string>',
                        'SelfManagedActiveDirectoryConfiguration' => [
                            'DnsIps' => ['<string>', ...],
                            'DomainName' => '<string>',
                            'FileSystemAdministratorsGroup' => '<string>',
                            'OrganizationalUnitDistinguishedName' => '<string>',
                            'UserName' => '<string>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                ],
                'TargetSnapshotValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'Lifecycle' => 'PENDING|CREATING|DELETING|AVAILABLE',
                    'LifecycleTransitionReason' => [
                        'Message' => '<string>',
                    ],
                    'Name' => '<string>',
                    'ResourceARN' => '<string>',
                    'SnapshotId' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VolumeId' => '<string>',
                ],
                'TargetVolumeValues' => [...], // RECURSIVE
                'TotalTransferBytes' => <integer>,
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'FileSystemId' => '<string>',
        'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
        'LifecycleTransitionReason' => [
            'Message' => '<string>',
        ],
        'Name' => '<string>',
        'OntapConfiguration' => [
            'AggregateConfiguration' => [
                'Aggregates' => ['<string>', ...],
                'TotalConstituents' => <integer>,
            ],
            'CopyTagsToBackups' => true || false,
            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
            'JunctionPath' => '<string>',
            'OntapVolumeType' => 'RW|DP|LS',
            'SecurityStyle' => 'UNIX|NTFS|MIXED',
            'SizeInBytes' => <integer>,
            'SizeInMegabytes' => <integer>,
            'SnaplockConfiguration' => [
                'AuditLogVolume' => true || false,
                'AutocommitPeriod' => [
                    'Type' => 'MINUTES|HOURS|DAYS|MONTHS|YEARS|NONE',
                    'Value' => <integer>,
                ],
                'PrivilegedDelete' => 'DISABLED|ENABLED|PERMANENTLY_DISABLED',
                'RetentionPeriod' => [
                    'DefaultRetention' => [
                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                        'Value' => <integer>,
                    ],
                    'MaximumRetention' => [
                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                        'Value' => <integer>,
                    ],
                    'MinimumRetention' => [
                        'Type' => 'SECONDS|MINUTES|HOURS|DAYS|MONTHS|YEARS|INFINITE|UNSPECIFIED',
                        'Value' => <integer>,
                    ],
                ],
                'SnaplockType' => 'COMPLIANCE|ENTERPRISE',
                'VolumeAppendModeEnabled' => true || false,
            ],
            'SnapshotPolicy' => '<string>',
            'StorageEfficiencyEnabled' => true || false,
            'StorageVirtualMachineId' => '<string>',
            'StorageVirtualMachineRoot' => true || false,
            'TieringPolicy' => [
                'CoolingPeriod' => <integer>,
                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
            ],
            'UUID' => '<string>',
            'VolumeStyle' => 'FLEXVOL|FLEXGROUP',
        ],
        'OpenZFSConfiguration' => [
            'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
            'CopyTagsToSnapshots' => true || false,
            'DataCompressionType' => 'NONE|ZSTD|LZ4',
            'DeleteClonedVolumes' => true || false,
            'DeleteIntermediateData' => true || false,
            'DeleteIntermediateSnaphots' => true || false,
            'DestinationSnapshot' => '<string>',
            'NfsExports' => [
                [
                    'ClientConfigurations' => [
                        [
                            'Clients' => '<string>',
                            'Options' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'OriginSnapshot' => [
                'CopyStrategy' => 'CLONE|FULL_COPY|INCREMENTAL_COPY',
                'SnapshotARN' => '<string>',
            ],
            'ParentVolumeId' => '<string>',
            'ReadOnly' => true || false,
            'RecordSizeKiB' => <integer>,
            'RestoreToSnapshot' => '<string>',
            'SourceSnapshotARN' => '<string>',
            'StorageCapacityQuotaGiB' => <integer>,
            'StorageCapacityReservationGiB' => <integer>,
            'UserAndGroupQuotas' => [
                [
                    'Id' => <integer>,
                    'StorageCapacityQuotaGiB' => <integer>,
                    'Type' => 'USER|GROUP',
                ],
                // ...
            ],
            'VolumePath' => '<string>',
        ],
        'ResourceARN' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VolumeId' => '<string>',
        'VolumeType' => 'ONTAP|OPENZFS',
    ],
]

Result Details

Members
Volume
Type: Volume structure

A description of the volume just updated. Returned after a successful UpdateVolume API operation.

Errors

BadRequest:

A generic error indicating a failure with a client request.

IncompatibleParameterError:

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError:

A generic error indicating a server-side failure.

MissingVolumeConfiguration:

A volume configuration is required for this operation.

VolumeNotFound:

No Amazon FSx volumes were found based upon the supplied parameters.

Shapes

ActiveDirectoryBackupAttributes

Description

The Microsoft Active Directory attributes of the Amazon FSx for Windows File Server file system.

Members
ActiveDirectoryId
Type: string

The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.

DomainName
Type: string

The fully qualified domain name of the self-managed Active Directory directory.

ResourceARN
Type: 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.

ActiveDirectoryError

Description

An Active Directory error.

Members
ActiveDirectoryId
Required: Yes
Type: string

The directory ID of the directory that an error pertains to.

Message
Type: string

A detailed error message.

Type
Type: string

The type of Active Directory error.

AdministrativeAction

Description

Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume.

Members
AdministrativeActionType
Type: string

Describes the type of administrative action, as follows:

  • FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

  • THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

    You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

  • STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

    • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

    • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

    You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

  • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

  • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

  • IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

    You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

  • STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

    You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

  • VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

  • VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

  • SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

  • RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

  • DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

  • VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

  • VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

FailureDetails

Provides information about a failed administrative action.

ProgressPercent
Type: int

The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

RemainingTransferBytes
Type: long (int|float)

The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

RequestTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the administrative action request was received.

Status
Type: string

The status of the administrative action, as follows:

  • FAILED - Amazon FSx failed to process the administrative action successfully.

  • IN_PROGRESS - Amazon FSx is processing the administrative action.

  • PENDING - Amazon FSx is waiting to process the administrative action.

  • COMPLETED - Amazon FSx has finished processing the administrative task.

    For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

  • UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

  • PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

  • IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

TargetFileSystemValues
Type: FileSystem structure

The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

TargetSnapshotValues
Type: Snapshot structure

A snapshot of an Amazon FSx for OpenZFS volume.

TargetVolumeValues
Type: Volume structure

Describes an Amazon FSx volume.

TotalTransferBytes
Type: long (int|float)

The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

AdministrativeActionFailureDetails

Description

Provides information about a failed administrative action.

Members
Message
Type: string

Error message providing details about the failed administrative action.

AggregateConfiguration

Description

Used to specify configuration options for a volume’s storage aggregate or aggregates.

Members
Aggregates
Type: Array of strings

The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

  • The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.

  • The value of Aggregates contains aggregates that are not present.

  • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.

TotalConstituents
Type: int

The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.

Alias

Description

A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.

Members
Lifecycle
Type: string

Describes the state of the DNS alias.

  • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

  • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

  • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

  • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

  • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

Name
Type: string

The name of the DNS alias. The alias name has to meet the following requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

  • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

  • Cannot start or end with a hyphen.

  • Can start with a numeric.

For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

AutoExportPolicy

Description

Describes a data repository association's automatic export policy. The AutoExportPolicy defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.

The AutoExportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

Members
Events
Type: Array of strings

The AutoExportPolicy can have the following event values:

  • NEW - New files and directories are automatically exported to the data repository as they are added to the file system.

  • CHANGED - Changes to files and directories on the file system are automatically exported to the data repository.

  • DELETED - Files and directories are automatically deleted on the data repository when they are deleted on the file system.

You can define any combination of event types for your AutoExportPolicy.

AutoImportPolicy

Description

Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.

The AutoImportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

Members
Events
Type: Array of strings

The AutoImportPolicy can have the following event values:

  • NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.

  • CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.

  • DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.

You can define any combination of event types for your AutoImportPolicy.

AutocommitPeriod

Description

Sets the autocommit period of files in an FSx for ONTAP SnapLock volume, which determines how long the files must remain unmodified before they're automatically transitioned to the write once, read many (WORM) state.

For more information, see Autocommit.

Members
Type
Required: Yes
Type: string

Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.

Value
Type: int

Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

  • Minutes: 5 - 65,535

  • Hours: 1 - 65,535

  • Days: 1 - 3,650

  • Months: 1 - 120

  • Years: 1 - 10

Backup

Description

A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

Members
BackupId
Required: Yes
Type: string

The ID of the backup.

CreationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when a particular backup was created.

DirectoryInformation

The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

FailureDetails
Type: BackupFailureDetails structure

Details explaining any failures that occurred when creating a backup.

FileSystem
Required: Yes
Type: FileSystem structure

The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

KmsKeyId
Type: string

The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

Lifecycle
Required: Yes
Type: string

The lifecycle status of the backup.

  • AVAILABLE - The backup is fully available.

  • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.

  • CREATING - Amazon FSx is creating the backup.

  • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.

  • COPYING - Amazon FSx is copying the backup.

  • DELETED - Amazon FSx deleted the backup and it's no longer available.

  • FAILED - Amazon FSx couldn't finish the backup.

OwnerId
Type: string

An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

ProgressPercent
Type: int

Displays the current percent of progress of an asynchronous task.

ResourceARN
Type: string

The Amazon Resource Name (ARN) for the backup resource.

ResourceType
Type: string

Specifies the resource type that's backed up.

SourceBackupId
Type: string

The ID of the source backup. Specifies the backup that you are copying.

SourceBackupRegion
Type: string

The source Region of the backup. Specifies the Region from where this backup is copied.

Tags
Type: Array of Tag structures

The tags associated with a particular file system.

Type
Required: Yes
Type: string

The type of the file-system backup.

Volume
Type: Volume structure

Describes an Amazon FSx volume.

BackupBeingCopied

Description

You can't delete a backup while it's being copied.

Members
BackupId
Type: string

The ID of the source backup. Specifies the backup that you are copying.

Message
Type: string

A detailed error message.

BackupFailureDetails

Description

If backup creation fails, this structure contains the details of that failure.

Members
Message
Type: string

A message describing the backup-creation failure.

BackupInProgress

Description

Another backup is already under way. Wait for completion before initiating additional backups of this file system.

Members
Message
Type: string

A detailed error message.

BackupNotFound

Description

No Amazon FSx backups were found based upon the supplied parameters.

Members
Message
Type: string

A detailed error message.

BackupRestoring

Description

You can't delete a backup while it's being used to restore a file system.

Members
FileSystemId
Type: string

The ID of a file system being restored from the backup.

Message
Type: string

A detailed error message.

BadRequest

Description

A generic error indicating a failure with a client request.

Members
Message
Type: string

A detailed error message.

CompletionReport

Description

Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

Members
Enabled
Required: Yes
Type: boolean

Set Enabled to True to generate a CompletionReport when the task completes. If set to true, then you need to provide a report Scope, Path, and Format. Set Enabled to False if you do not want a CompletionReport generated when the task completes.

Format
Type: string

Required if Enabled is set to true. Specifies the format of the CompletionReport. REPORT_CSV_20191124 is the only format currently supported. When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format, and is delivered to {path}/task-{id}/failures.csv.

Path
Type: string

Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path you provide must be located within the file system’s ExportPath. An example Path value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.

Scope
Type: string

Required if Enabled is set to true. Specifies the scope of the CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains information about files that the data repository task failed to process.

CreateAggregateConfiguration

Description

Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.

Members
Aggregates
Type: Array of strings

Used to specify the names of aggregates on which the volume will be created.

ConstituentsPerAggregate
Type: int

Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume.

CreateFileCacheLustreConfiguration

Description

The Amazon File Cache configuration for the cache that you are creating.

Members
DeploymentType
Required: Yes
Type: string

Specifies the cache deployment type, which must be CACHE_1.

MetadataConfiguration
Required: Yes
Type: FileCacheLustreMetadataConfiguration structure

The configuration for a Lustre MDT (Metadata Target) storage volume.

PerUnitStorageThroughput
Required: Yes
Type: int

Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.

WeeklyMaintenanceStartTime
Type: string

A recurring weekly time, in the format D:HH:MM.

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

CreateFileSystemLustreConfiguration

Description

The Lustre configuration for the file system being created.

The following parameters are not supported for file systems with a data repository association created with .

  • AutoImportPolicy

  • ExportPath

  • ImportedFileChunkSize

  • ImportPath

Members
AutoImportPolicy
Type: string

(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this parameter to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

  • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

For more information, see Automatically import updates from your S3 bucket.

This parameter is not supported for file systems with a data repository association.

AutomaticBackupRetentionDays
Type: int

The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

CopyTagsToBackups
Type: boolean

(Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If CopyTagsToBackups is set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If CopyTagsToBackups is set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

(Default = false)

For more information, see Working with backups in the Amazon FSx for Lustre User Guide.

DailyAutomaticBackupStartTime
Type: string

A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

DataCompressionType
Type: string

Sets the data compression configuration for the file system. DataCompressionType can have the following values:

  • NONE - (Default) Data compression is turned off when the file system is created.

  • LZ4 - Data compression is turned on with the LZ4 algorithm.

For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide.

DeploymentType
Type: string

(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

Choose PERSISTENT_1 for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all Amazon Web Services Regions in which FSx for Lustre is available.

Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2 supports SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). You can optionally specify a metadata configuration mode for PERSISTENT_2 which supports increasing metadata performance. PERSISTENT_2 is available in a limited number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2 is available, see File system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.

If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails.

Encryption of data in transit is automatically turned on when you access SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 file systems from Amazon EC2 instances that support automatic encryption in the Amazon Web Services Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide.

(Default = SCRATCH_1)

DriveCacheType
Type: string

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property to READ to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system.

This parameter is required when StorageType is set to HDD.

ExportPath
Type: string

(Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.

The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you specify only a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.

This parameter is not supported for file systems with a data repository association.

ImportPath
Type: string

(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

This parameter is not supported for file systems with a data repository association.

ImportedFileChunkSize
Type: int

(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

This parameter is not supported for file systems with a data repository association.

LogConfiguration

The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.

MetadataConfiguration

The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a PERSISTENT_2 deployment type.

PerUnitStorageThroughput
Type: int

Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.

Valid values:

  • For PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.

  • For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.

  • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.

RootSquashConfiguration

The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

WeeklyMaintenanceStartTime
Type: string

(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

CreateFileSystemLustreMetadataConfiguration

Description

The Lustre metadata performance configuration for the creation of an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. The configuration uses a Metadata IOPS value to set the maximum rate of metadata disk IOPS supported by the file system.

After creation, the file system supports increasing metadata performance. For more information on Metadata IOPS, see Lustre metadata performance configuration in the Amazon FSx for Lustre User Guide.

Members
Iops
Type: int

(USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision for the file system. This parameter sets the maximum rate of metadata disk IOPS supported by the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

Iops doesn’t have a default value. If you're using USER_PROVISIONED mode, you can choose to specify a valid value. If you're using AUTOMATIC mode, you cannot specify a value because FSx for Lustre automatically sets the value based on your file system storage capacity.

Mode
Required: Yes
Type: string

The metadata configuration mode for provisioning Metadata IOPS for an FSx for Lustre file system using a PERSISTENT_2 deployment type.

  • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS for your file system based on your file system storage capacity.

  • In USER_PROVISIONED mode, you specify the number of Metadata IOPS to provision for your file system.

CreateFileSystemOntapConfiguration

Description

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

Members
AutomaticBackupRetentionDays
Type: int

The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

DailyAutomaticBackupStartTime
Type: string

A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

DeploymentType
Required: Yes
Type: string

Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

  • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

  • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

  • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

  • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

DiskIopsConfiguration
Type: DiskIopsConfiguration structure

The SSD IOPS configuration for the FSx for ONTAP file system.

EndpointIpAddressRange
Type: string

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

FsxAdminPassword
Type: string

The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.

HAPairs
Type: int

Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

  • The value of HAPairs is less than 1 or greater than 12.

  • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

PreferredSubnetId
Type: string

Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2. This specifies the subnet in which you want the preferred file server to be located.

RouteTableIds
Type: Array of strings

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.

ThroughputCapacity
Type: int

Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

  • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

  • The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity.

ThroughputCapacityPerHAPair
Type: int

Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.

You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.

This field and ThroughputCapacity are the same for file systems powered by one HA pair.

  • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

  • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

  • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

  • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.

  • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

  • The value of ThroughputCapacityPerHAPair is not a valid value.

WeeklyMaintenanceStartTime
Type: string

A recurring weekly time, in the format D:HH:MM.

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

CreateFileSystemOpenZFSConfiguration

Description

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

Members
AutomaticBackupRetentionDays
Type: int

The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

CopyTagsToBackups
Type: boolean

A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

CopyTagsToVolumes
Type: boolean

A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false. If it's set to true, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

DailyAutomaticBackupStartTime
Type: string

A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

DeploymentType
Required: Yes
Type: string

Specifies the file system deployment type. Valid values are the following:

  • MULTI_AZ_1- Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same Amazon Web Services Region.

  • SINGLE_AZ_HA_2- Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.

  • SINGLE_AZ_HA_1- Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.

  • SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within a single Availability Zone.

  • SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.

For a list of which Amazon Web Services Regions each deployment type is available in, see Deployment type availability. For more information on the differences in performance between deployment types, see File system performance in the Amazon FSx for OpenZFS User Guide.

DiskIopsConfiguration
Type: DiskIopsConfiguration structure

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

EndpointIpAddressRange
Type: string

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

PreferredSubnetId
Type: string

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

RootVolumeConfiguration

The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.

RouteTableIds
Type: Array of strings

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

ThroughputCapacity
Required: Yes
Type: int

Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:

  • For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.

  • For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.

You pay for additional throughput capacity that you provision.

WeeklyMaintenanceStartTime
Type: string

A recurring weekly time, in the format D:HH:MM.

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

CreateFileSystemWindowsConfiguration

Description

The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.

Members
ActiveDirectoryId
Type: string

The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.

Aliases
Type: Array of strings

An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.

For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

An alias name has to meet the following requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

  • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

  • Cannot start or end with a hyphen.

  • Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

AuditLogConfiguration

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

AutomaticBackupRetentionDays
Type: int

The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

CopyTagsToBackups
Type: boolean

A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

DailyAutomaticBackupStartTime
Type: string

The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.

DeploymentType
Type: string

Specifies the file system deployment type, valid values are the following:

  • MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type

  • SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.

  • SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.

For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.

DiskIopsConfiguration
Type: DiskIopsConfiguration structure

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

PreferredSubnetId
Type: string

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.

SelfManagedActiveDirectoryConfiguration

The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs.

ThroughputCapacity
Required: Yes
Type: int

Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).

WeeklyMaintenanceStartTime
Type: string

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

CreateOntapVolumeConfiguration

Description

Specifies the configuration of the ONTAP volume that you are creating.

Members
AggregateConfiguration

Use to specify configuration options for a volume’s storage aggregate or aggregates.

CopyTagsToBackups
Type: boolean

A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

JunctionPath
Type: string

Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3.

OntapVolumeType
Type: string

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

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

  • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

SecurityStyle
Type: string

Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:

  • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.

  • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.

  • MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

For more information, see Volume security style in the FSx for ONTAP User Guide.

SizeInBytes
Type: long (int|float)

Specifies the configured size of the volume, in bytes.

SizeInMegabytes
Type: int

Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.

SnaplockConfiguration
Type: CreateSnaplockConfiguration structure

Specifies the SnapLock configuration for an FSx for ONTAP volume.

SnapshotPolicy
Type: string

Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

  • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

  • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.

  • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

StorageEfficiencyEnabled
Type: boolean

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

StorageEfficiencyEnabled is required when creating a RW volume (OntapVolumeType set to RW).

StorageVirtualMachineId
Required: Yes
Type: string

Specifies the ONTAP SVM in which to create the volume.

TieringPolicy
Type: TieringPolicy structure

Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:

  • SNAPSHOT_ONLY - (Default value) 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.

VolumeStyle
Type: string

Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.

CreateOpenZFSOriginSnapshotConfiguration

Description

The snapshot configuration to use when creating an Amazon FSx for OpenZFS volume from a snapshot.

Members
CopyStrategy
Required: Yes
Type: string

Specifies the strategy used when copying data from the snapshot to the new volume.

  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

  • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

SnapshotARN
Required: Yes
Type: 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.

CreateOpenZFSVolumeConfiguration

Description

Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

Members
CopyTagsToSnapshots
Type: boolean

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

DataCompressionType
Type: string

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

  • NONE - Doesn't compress the data on the volume. NONE is the default.

  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.

  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.

NfsExports
Type: Array of OpenZFSNfsExport structures

The configuration object for mounting a Network File System (NFS) file system.

OriginSnapshot

The configuration object that specifies the snapshot to use as the origin of the data for the volume.

ParentVolumeId
Required: Yes
Type: string

The ID of the volume to use as the parent volume of the volume that you are creating.

ReadOnly
Type: boolean

A Boolean value indicating whether the volume is read-only.

RecordSizeKiB
Type: int

Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide.

StorageCapacityQuotaGiB
Type: int

Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1.

For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

StorageCapacityReservationGiB
Type: int

Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

UserAndGroupQuotas
Type: Array of OpenZFSUserOrGroupQuota structures

Configures how much storage users and groups can use on the volume.

CreateSnaplockConfiguration

Description

Defines the SnapLock configuration when creating an FSx for ONTAP SnapLock volume.

Members
AuditLogVolume
Type: boolean

Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes.

AutocommitPeriod
Type: AutocommitPeriod structure

The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

PrivilegedDelete
Type: string

Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

For more information, see Privileged delete.

RetentionPeriod
Type: SnaplockRetentionPeriod structure

Specifies the retention period of an FSx for ONTAP SnapLock volume.

SnaplockType
Required: Yes
Type: string

Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

  • COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

  • ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

VolumeAppendModeEnabled
Type: boolean

Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

For more information, see Volume-append mode.

CreateSvmActiveDirectoryConfiguration

Description

The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.

Members
NetBiosName
Required: Yes
Type: string

The NetBIOS name of the Active Directory computer object that will be created for your SVM.

SelfManagedActiveDirectoryConfiguration

The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs.

DataRepositoryAssociation

Description

The configuration of a data repository association that links an Amazon FSx for Lustre file system to an Amazon S3 bucket or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system. The data repository association configuration object is returned in the response of the following operations:

  • CreateDataRepositoryAssociation

  • UpdateDataRepositoryAssociation

  • DescribeDataRepositoryAssociations

Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

Members
AssociationId
Type: string

The system-generated, unique ID of the data repository association.

BatchImportMetaDataOnCreate
Type: boolean

A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.

BatchImportMetaDataOnCreate is not supported for data repositories linked to an Amazon File Cache resource.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DataRepositoryPath
Type: string

The path to the data repository that will be linked to the cache or file system.

  • For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:

    • If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.

    • If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.

  • For Amazon File Cache, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

  • For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

DataRepositorySubdirectories
Type: Array of strings

For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association. All the subdirectories must be on a single NFS file system. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.

FailureDetails

Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

FileCacheId
Type: string

The globally unique ID of the Amazon File Cache resource.

FileCachePath
Type: string

A path on the Amazon File Cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the path is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.

This path specifies the directory in your cache where files will be exported from. This cache directory can be linked to only one data repository (S3 or NFS) and no other data repository can be linked to the directory.

The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.

The cache path cannot be set to root (/) for an S3 DRA.

FileSystemId
Type: string

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

FileSystemPath
Type: string

A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.

ImportedFileChunkSize
Type: int

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

Lifecycle
Type: string

Describes the state of a data repository association. The lifecycle can have the following values:

  • CREATING - The data repository association between the file system or cache and the data repository is being created. The data repository is unavailable.

  • AVAILABLE - The data repository association is available for use.

  • MISCONFIGURED - The data repository association is misconfigured. Until the configuration is corrected, automatic import and automatic export will not work (only for Amazon FSx for Lustre).

  • UPDATING - The data repository association is undergoing a customer initiated update that might affect its availability.

  • DELETING - The data repository association is undergoing a customer initiated deletion.

  • FAILED - The data repository association is in a terminal state that cannot be recovered.

NFS

The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association.

ResourceARN
Type: 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.

S3

The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.

Tags
Type: Array of Tag structures

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

DataRepositoryAssociationNotFound

Description

No data repository associations were found based upon the supplied parameters.

Members
Message
Type: string

A detailed error message.

DataRepositoryConfiguration

Description

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

Members
AutoImportPolicy
Type: string

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

  • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

ExportPath
Type: string

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

FailureDetails

Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

ImportPath
Type: string

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

ImportedFileChunkSize
Type: int

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

Lifecycle
Type: string

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

  • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

  • AVAILABLE - The data repository is available for use.

  • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

  • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

  • FAILED - The data repository is in a terminal state that cannot be recovered.

DataRepositoryFailureDetails

Description

Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

Members
Message
Type: string

A detailed error message.

DataRepositoryTask

Description

A description of the data repository task.

  • You use import and export data repository tasks to perform bulk transfer operations between an Amazon FSx for Lustre file system and a linked data repository.

  • You use release data repository tasks to release files that have been exported to a linked S3 bucket from your Amazon FSx for Lustre file system.

  • An Amazon File Cache resource uses a task to automatically release files from the cache.

To learn more about data repository tasks, see Data Repository Tasks.

Members
CapacityToRelease
Type: long (int|float)

Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

CreationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the system completed processing the task, populated after the task is complete.

FailureDetails

Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.

FileCacheId
Type: string

The system-generated, unique ID of the cache.

FileSystemId
Type: string

The globally unique ID of the file system.

Lifecycle
Required: Yes
Type: string

The lifecycle status of the data repository task, as follows:

  • PENDING - The task has not started.

  • EXECUTING - The task is in process.

  • FAILED - The task was not able to be completed. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.

  • SUCCEEDED - The task has completed successfully.

  • CANCELED - The task was canceled and it did not complete.

  • CANCELING - The task is in process of being canceled.

You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the PENDING or EXECUTING states. Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.

Paths
Type: Array of strings

An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.

(Default) If Paths is not specified, Amazon FSx uses the file system root directory.

ReleaseConfiguration
Type: ReleaseConfiguration structure

The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.

Report
Type: CompletionReport structure

Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

ResourceARN
Type: 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.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the system began processing the task.

Status
Type: DataRepositoryTaskStatus structure

Provides the status of the number of files that the task has processed successfully and failed to process.

Tags
Type: Array of Tag structures

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

TaskId
Required: Yes
Type: string

The system-generated, unique 17-digit ID of the data repository task.

Type
Required: Yes
Type: string

The type of data repository task.

  • EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.

  • IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.

  • RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.

  • AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

DataRepositoryTaskEnded

Description

The data repository task could not be canceled because the task has already ended.

Members
Message
Type: string

A detailed error message.

DataRepositoryTaskExecuting

Description

An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.

Members
Message
Type: string

A detailed error message.

DataRepositoryTaskFailureDetails

Description

Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.

Members
Message
Type: string

A detailed error message.

DataRepositoryTaskFilter

Description

(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.

Members
Name
Type: string

Name of the task property to use in filtering the tasks returned in the response.

  • Use file-system-id to retrieve data repository tasks for specific file systems.

  • Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.

Values
Type: Array of strings

Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.

DataRepositoryTaskNotFound

Description

The data repository task or tasks you specified could not be found.

Members
Message
Type: string

A detailed error message.

DataRepositoryTaskStatus

Description

Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.

Members
FailedCount
Type: long (int|float)

A running total of the number of files that the task failed to process.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the task status was last updated.

ReleasedCapacity
Type: long (int|float)

The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

SucceededCount
Type: long (int|float)

A running total of the number of files that the task has successfully processed.

TotalCount
Type: long (int|float)

The total number of files that the task will process. While a task is executing, the sum of SucceededCount plus FailedCount may not equal TotalCount. When the task is complete, TotalCount equals the sum of SucceededCount plus FailedCount.

DeleteFileSystemLustreConfiguration

Description

The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

Members
FinalBackupTags
Type: Array of Tag structures

Use if SkipFinalBackup is set to false, and you want to apply an array of tags to the final backup. If you have set the file system property CopyTagsToBackups to true, and you specify one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.

SkipFinalBackup
Type: boolean

Set SkipFinalBackup to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the DeleteFileSystem operation is invoked. (Default = true)

The fsx:CreateBackup permission is required if you set SkipFinalBackup to false in order to delete the file system and take a final backup.

DeleteFileSystemLustreResponse

Description

The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

Members
FinalBackupId
Type: string

The ID of the final backup for this file system.

FinalBackupTags
Type: Array of Tag structures

The set of tags applied to the final backup.

DeleteFileSystemOpenZFSConfiguration

Description

The configuration object for the Amazon FSx for OpenZFS file system used in the DeleteFileSystem operation.

Members
FinalBackupTags
Type: Array of Tag structures

A list of tags to apply to the file system's final backup.

Options
Type: Array of strings

To delete a file system if there are child volumes present below the root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. If your file system has child volumes and you don't use this option, the delete request will fail.

SkipFinalBackup
Type: boolean

By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip taking a final backup, set this value to true.

DeleteFileSystemOpenZFSResponse

Description

The response object for the Amazon FSx for OpenZFS file system that's being deleted in the DeleteFileSystem operation.

Members
FinalBackupId
Type: string

The ID of the source backup. Specifies the backup that you are copying.

FinalBackupTags
Type: Array of Tag structures

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

DeleteFileSystemWindowsConfiguration

Description

The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.

Members
FinalBackupTags
Type: Array of Tag structures

A set of tags for your final backup.

SkipFinalBackup
Type: boolean

By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so.

DeleteFileSystemWindowsResponse

Description

The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.

Members
FinalBackupId
Type: string

The ID of the final backup for this file system.

FinalBackupTags
Type: Array of Tag structures

The set of tags applied to the final backup.

DeleteVolumeOntapConfiguration

Descrip