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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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',
                'DataReadCacheConfiguration' => [
                    'SizeGiB' => <integer>,
                    'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                ],
                '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',
                'EfaEnabled' => true || false,
                '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>',
                ],
                'ThroughputCapacity' => <integer>,
                '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>',
                'ReadCacheConfiguration' => [
                    'SizeGiB' => <integer>,
                    'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                ],
                'RootVolumeId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
            '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',
        'SizeInBytes' => <integer>,
        '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',
                            'DataReadCacheConfiguration' => [
                                'SizeGiB' => <integer>,
                                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                            ],
                            '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',
                            'EfaEnabled' => true || false,
                            '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>',
                            ],
                            'ThroughputCapacity' => <integer>,
                            '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>',
                            'ReadCacheConfiguration' => [
                                'SizeGiB' => <integer>,
                                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                            ],
                            'RootVolumeId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                        '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

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

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

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',
                    'DataReadCacheConfiguration' => [
                        'SizeGiB' => <integer>,
                        'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                    ],
                    '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',
                    'EfaEnabled' => true || false,
                    '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>',
                    ],
                    'ThroughputCapacity' => <integer>,
                    '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>',
                    'ReadCacheConfiguration' => [
                        'SizeGiB' => <integer>,
                        'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                    ],
                    'RootVolumeId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OwnerId' => '<string>',
                'ResourceARN' => '<string>',
                'StorageCapacity' => <integer>,
                'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                '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

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

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:

• For Amazon FSx for Lustre, see Working with FSx for Lustre backups.

• For Amazon FSx for Windows, see Working with FSx for Windows backups.

• For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.

• For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups.

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

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',
                'DataReadCacheConfiguration' => [
                    'SizeGiB' => <integer>,
                    'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                ],
                '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',
                'EfaEnabled' => true || false,
                '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>',
                ],
                'ThroughputCapacity' => <integer>,
                '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>',
                'ReadCacheConfiguration' => [
                    'SizeGiB' => <integer>,
                    'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                ],
                'RootVolumeId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
            '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',
        'SizeInBytes' => <integer>,
        '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',
                            'DataReadCacheConfiguration' => [
                                'SizeGiB' => <integer>,
                                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                            ],
                            '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',
                            'EfaEnabled' => true || false,
                            '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>',
                            ],
                            'ThroughputCapacity' => <integer>,
                            '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>',
                            'ReadCacheConfiguration' => [
                                'SizeGiB' => <integer>,
                                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                            ],
                            'RootVolumeId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                        '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

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

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.

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

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

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

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

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

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

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 resource with an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the cache in JSON format.

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

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

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

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.

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',
        'DataReadCacheConfiguration' => [
            'SizeGiB' => <integer>,
            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
        ],
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
        'DriveCacheType' => 'NONE|READ',
        'EfaEnabled' => true || false,
        '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>',
        ],
        'ThroughputCapacity' => <integer>,
        '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>',
        'ReadCacheConfiguration' => [
            'SizeGiB' => <integer>,
            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
        ],
        '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|INTELLIGENT_TIERING',
    '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

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',
            'DataReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            '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',
            'EfaEnabled' => true || false,
            '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>',
            ],
            'ThroughputCapacity' => <integer>,
            '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>',
            'ReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
        '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

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

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.

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',
        'DataReadCacheConfiguration' => [
            'SizeGiB' => <integer>,
            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
        ],
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
        'DriveCacheType' => 'NONE|READ',
        'EfaEnabled' => true || false,
        '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>',
        ],
        'ThroughputCapacity' => <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>',
        'ReadCacheConfiguration' => [
            'SizeGiB' => <integer>,
            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
        ],
        '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|INTELLIGENT_TIERING',
    '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

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',
            'DataReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            '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',
            'EfaEnabled' => true || false,
            '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>',
            ],
            'ThroughputCapacity' => <integer>,
            '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>',
            'ReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
        '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

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

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

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',
                        'DataReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        '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',
                        'EfaEnabled' => true || false,
                        '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>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        '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>',
                        'ReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                    '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

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

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

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

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

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

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',
                        'DataReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        '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',
                        'EfaEnabled' => true || false,
                        '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>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        '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>',
                        'ReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                    '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

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

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

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',
                        'DataReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        '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',
                        'EfaEnabled' => true || false,
                        '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>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        '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>',
                        'ReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                    '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

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

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.

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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',
                    'DataReadCacheConfiguration' => [
                        'SizeGiB' => <integer>,
                        'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                    ],
                    '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',
                    'EfaEnabled' => true || false,
                    '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>',
                    ],
                    'ThroughputCapacity' => <integer>,
                    '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>',
                    'ReadCacheConfiguration' => [
                        'SizeGiB' => <integer>,
                        'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                    ],
                    'RootVolumeId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OwnerId' => '<string>',
                'ResourceARN' => '<string>',
                'StorageCapacity' => <integer>,
                'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                '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',
            'SizeInBytes' => <integer>,
            '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',
                                'DataReadCacheConfiguration' => [
                                    'SizeGiB' => <integer>,
                                    'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                                ],
                                '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',
                                'EfaEnabled' => true || false,
                                '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>',
                                ],
                                'ThroughputCapacity' => <integer>,
                                '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>',
                                'ReadCacheConfiguration' => [
                                    'SizeGiB' => <integer>,
                                    'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                                ],
                                'RootVolumeId' => '<string>',
                                'RouteTableIds' => ['<string>', ...],
                                'ThroughputCapacity' => <integer>,
                                'WeeklyMaintenanceStartTime' => '<string>',
                            ],
                            'OwnerId' => '<string>',
                            'ResourceARN' => '<string>',
                            'StorageCapacity' => <integer>,
                            'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                            '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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

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',
                'DataReadCacheConfiguration' => [
                    'SizeGiB' => <integer>,
                    'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                ],
                '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',
                'EfaEnabled' => true || false,
                '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>',
                ],
                'ThroughputCapacity' => <integer>,
                '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>',
                'ReadCacheConfiguration' => [
                    'SizeGiB' => <integer>,
                    'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                ],
                'RootVolumeId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
            '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

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

Result Syntax

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

Result Details

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

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',
                            'DataReadCacheConfiguration' => [
                                'SizeGiB' => <integer>,
                                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                            ],
                            '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',
                            'EfaEnabled' => true || false,
                            '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>',
                            ],
                            'ThroughputCapacity' => <integer>,
                            '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>',
                            'ReadCacheConfiguration' => [
                                'SizeGiB' => <integer>,
                                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                            ],
                            'RootVolumeId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                        '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

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

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

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

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',
                            'DataReadCacheConfiguration' => [
                                'SizeGiB' => <integer>,
                                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                            ],
                            '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',
                            'EfaEnabled' => true || false,
                            '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>',
                            ],
                            'ThroughputCapacity' => <integer>,
                            '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>',
                            'ReadCacheConfiguration' => [
                                'SizeGiB' => <integer>,
                                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                            ],
                            'RootVolumeId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                        '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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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',
            'DataReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            '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',
            'EfaEnabled' => true || false,
            '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>',
            ],
            'ThroughputCapacity' => <integer>,
            '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>',
            'ReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
        '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

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

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

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',
                    'DataReadCacheConfiguration' => [
                        'SizeGiB' => <integer>,
                        'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                    ],
                    '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',
                    'EfaEnabled' => true || false,
                    '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>',
                    ],
                    'ThroughputCapacity' => <integer>,
                    '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>',
                    'ReadCacheConfiguration' => [
                        'SizeGiB' => <integer>,
                        'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                    ],
                    'RootVolumeId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OwnerId' => '<string>',
                'ResourceARN' => '<string>',
                'StorageCapacity' => <integer>,
                'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                '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

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

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',
            'DataReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            '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',
            'EfaEnabled' => true || false,
            '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>',
            ],
            'ThroughputCapacity' => <integer>,
            '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>',
            'ReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
        '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

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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

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

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

• DiskIopsConfiguration

• SelfManagedActiveDirectoryConfiguration

• StorageCapacity

• StorageType

• ThroughputCapacity

• WeeklyMaintenanceStartTime

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

• AutoImportPolicy

• AutomaticBackupRetentionDays

• DailyAutomaticBackupStartTime

• DataCompressionType

• FileSystemTypeVersion

• LogConfiguration

• LustreReadCacheConfiguration

• LustreRootSquashConfiguration

• MetadataConfiguration

• PerUnitStorageThroughput

• StorageCapacity

• ThroughputCapacity

• 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

• ReadCacheConfiguration

• RemoveRouteTableIds

• StorageCapacity

• ThroughputCapacity

• WeeklyMaintenanceStartTime

Parameter Syntax

$result = $client->updateFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'FileSystemTypeVersion' => '<string>',
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DataCompressionType' => 'NONE|LZ4',
        'DataReadCacheConfiguration' => [
            'SizeGiB' => <integer>,
            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
        ],
        '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>',
        ],
        'ThroughputCapacity' => <integer>,
        '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',
        ],
        'ReadCacheConfiguration' => [
            'SizeGiB' => <integer>,
            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
        ],
        'RemoveRouteTableIds' => ['<string>', ...],
        'ThroughputCapacity' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'StorageCapacity' => <integer>,
    'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
    '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

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',
            'DataReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            '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',
            'EfaEnabled' => true || false,
            '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>',
            ],
            'ThroughputCapacity' => <integer>,
            '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>',
            'ReadCacheConfiguration' => [
                'SizeGiB' => <integer>,
                'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
            ],
            'RootVolumeId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
        '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

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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

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',
                        'DataReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        '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',
                        'EfaEnabled' => true || false,
                        '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>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        '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>',
                        'ReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                    '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

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

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

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

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',
                        'DataReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        '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',
                        'EfaEnabled' => true || false,
                        '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>',
                        ],
                        'ThroughputCapacity' => <integer>,
                        '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>',
                        'ReadCacheConfiguration' => [
                            'SizeGiB' => <integer>,
                            'SizingMode' => 'NO_CACHE|USER_PROVISIONED|PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                        ],
                        'RootVolumeId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD|INTELLIGENT_TIERING',
                    '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

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.