Amazon FSx 2018-03-01

AssociateFileSystemAliases

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

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([/* ... */]);

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([/* ... */]);

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',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_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' => [
                            'CopyTagsToBackups' => true || false,
                            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                            'JunctionPath' => '<string>',
                            'OntapVolumeType' => 'RW|DP|LS',
                            'SecurityStyle' => 'UNIX|NTFS|MIXED',
                            'SizeInMegabytes' => <integer>,
                            'SnapshotPolicy' => '<string>',
                            'StorageEfficiencyEnabled' => true || false,
                            'StorageVirtualMachineId' => '<string>',
                            'StorageVirtualMachineRoot' => true || false,
                            'TieringPolicy' => [
                                'CoolingPeriod' => <integer>,
                                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                            ],
                            'UUID' => '<string>',
                        ],
                        'OpenZFSConfiguration' => [
                            'CopyTagsToSnapshots' => true || false,
                            'DataCompressionType' => 'NONE|ZSTD|LZ4',
                            'DeleteClonedVolumes' => true || false,
                            'DeleteIntermediateSnaphots' => true || false,
                            'NfsExports' => [
                                [
                                    'ClientConfigurations' => [
                                        [
                                            'Clients' => '<string>',
                                            'Options' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OriginSnapshot' => [
                                'CopyStrategy' => 'CLONE|FULL_COPY',
                                'SnapshotARN' => '<string>',
                            ],
                            'ParentVolumeId' => '<string>',
                            'ReadOnly' => true || false,
                            'RecordSizeKiB' => <integer>,
                            'RestoreToSnapshot' => '<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',
                    ],
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
            'FileSystemTypeVersion' => '<string>',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DataCompressionType' => 'NONE|LZ4',
                'DataRepositoryConfiguration' => [
                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                    'ExportPath' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                ],
                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                'DriveCacheType' => 'NONE|READ',
                'LogConfiguration' => [
                    'Destination' => '<string>',
                    'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                ],
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'RootSquashConfiguration' => [
                    'NoSquashNids' => ['<string>', ...],
                    'RootSquash' => '<string>',
                ],
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OntapConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'EndpointIpAddressRange' => '<string>',
                'Endpoints' => [
                    'Intercluster' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                    'Management' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                ],
                'PreferredSubnetId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OpenZFSConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'CopyTagsToVolumes' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'RootVolumeId' => '<string>',
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD',
            'SubnetIds' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => '<string>',
                'Aliases' => [
                    [
                        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'AuditLogConfiguration' => [
                    'AuditLogDestination' => '<string>',
                    'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                    'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                ],
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                'MaintenanceOperationsInProgress' => ['<string>', ...],
                'PreferredFileServerIp' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RemoteAdministrationEndpoint' => '<string>',
                'SelfManagedActiveDirectoryConfiguration' => [
                    'DnsIps' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'FileSystemAdministratorsGroup' => '<string>',
                    'OrganizationalUnitDistinguishedName' => '<string>',
                    'UserName' => '<string>',
                ],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
        ],
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING|COPYING',
        'OwnerId' => '<string>',
        'ProgressPercent' => <integer>,
        'ResourceARN' => '<string>',
        'ResourceType' => 'FILE_SYSTEM|VOLUME',
        'SourceBackupId' => '<string>',
        'SourceBackupRegion' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
        'Volume' => [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                    'TargetFileSystemValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'DNSName' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'FileSystemId' => '<string>',
                        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                        'FileSystemTypeVersion' => '<string>',
                        'KmsKeyId' => '<string>',
                        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                        'LustreConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DataCompressionType' => 'NONE|LZ4',
                            'DataRepositoryConfiguration' => [
                                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                                'ExportPath' => '<string>',
                                'FailureDetails' => [
                                    'Message' => '<string>',
                                ],
                                'ImportPath' => '<string>',
                                'ImportedFileChunkSize' => <integer>,
                                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                            ],
                            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                            'DriveCacheType' => 'NONE|READ',
                            'LogConfiguration' => [
                                'Destination' => '<string>',
                                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                            ],
                            'MountName' => '<string>',
                            'PerUnitStorageThroughput' => <integer>,
                            'RootSquashConfiguration' => [
                                'NoSquashNids' => ['<string>', ...],
                                'RootSquash' => '<string>',
                            ],
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'NetworkInterfaceIds' => ['<string>', ...],
                        'OntapConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddressRange' => '<string>',
                            'Endpoints' => [
                                'Intercluster' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                                'Management' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                            ],
                            'PreferredSubnetId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OpenZFSConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'CopyTagsToVolumes' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'RootVolumeId' => '<string>',
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD',
                        'SubnetIds' => ['<string>', ...],
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VpcId' => '<string>',
                        'WindowsConfiguration' => [
                            'ActiveDirectoryId' => '<string>',
                            'Aliases' => [
                                [
                                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'AuditLogConfiguration' => [
                                'AuditLogDestination' => '<string>',
                                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            ],
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                            '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
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'FileSystemId' => '<string>',
            'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
            'LifecycleTransitionReason' => [
                'Message' => '<string>',
            ],
            'Name' => '<string>',
            'OntapConfiguration' => [
                'CopyTagsToBackups' => true || false,
                'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                'JunctionPath' => '<string>',
                'OntapVolumeType' => 'RW|DP|LS',
                'SecurityStyle' => 'UNIX|NTFS|MIXED',
                'SizeInMegabytes' => <integer>,
                'SnapshotPolicy' => '<string>',
                'StorageEfficiencyEnabled' => true || false,
                'StorageVirtualMachineId' => '<string>',
                'StorageVirtualMachineRoot' => true || false,
                'TieringPolicy' => [
                    'CoolingPeriod' => <integer>,
                    'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                ],
                'UUID' => '<string>',
            ],
            'OpenZFSConfiguration' => [
                'CopyTagsToSnapshots' => true || false,
                'DataCompressionType' => 'NONE|ZSTD|LZ4',
                'DeleteClonedVolumes' => true || false,
                'DeleteIntermediateSnaphots' => true || false,
                'NfsExports' => [
                    [
                        'ClientConfigurations' => [
                            [
                                'Clients' => '<string>',
                                'Options' => ['<string>', ...],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'OriginSnapshot' => [
                    'CopyStrategy' => 'CLONE|FULL_COPY',
                    'SnapshotARN' => '<string>',
                ],
                'ParentVolumeId' => '<string>',
                'ReadOnly' => true || false,
                'RecordSizeKiB' => <integer>,
                'RestoreToSnapshot' => '<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 Services Support.

• UnsupportedOperation:

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

• IncompatibleParameterError:

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

• InternalServerError:

  A generic error indicating a server-side failure.

• InvalidSourceKmsKey:

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

• InvalidDestinationKmsKey:

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

• InvalidRegion:

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

• SourceBackupUnavailable:

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

• IncompatibleRegionForMultiAZ:

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

Examples

Example 1: To copy a backup

This operation copies an Amazon FSx backup.

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

Result syntax:

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

CreateBackup

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

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',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_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' => [
                            'CopyTagsToBackups' => true || false,
                            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                            'JunctionPath' => '<string>',
                            'OntapVolumeType' => 'RW|DP|LS',
                            'SecurityStyle' => 'UNIX|NTFS|MIXED',
                            'SizeInMegabytes' => <integer>,
                            'SnapshotPolicy' => '<string>',
                            'StorageEfficiencyEnabled' => true || false,
                            'StorageVirtualMachineId' => '<string>',
                            'StorageVirtualMachineRoot' => true || false,
                            'TieringPolicy' => [
                                'CoolingPeriod' => <integer>,
                                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                            ],
                            'UUID' => '<string>',
                        ],
                        'OpenZFSConfiguration' => [
                            'CopyTagsToSnapshots' => true || false,
                            'DataCompressionType' => 'NONE|ZSTD|LZ4',
                            'DeleteClonedVolumes' => true || false,
                            'DeleteIntermediateSnaphots' => true || false,
                            'NfsExports' => [
                                [
                                    'ClientConfigurations' => [
                                        [
                                            'Clients' => '<string>',
                                            'Options' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                            'OriginSnapshot' => [
                                'CopyStrategy' => 'CLONE|FULL_COPY',
                                'SnapshotARN' => '<string>',
                            ],
                            'ParentVolumeId' => '<string>',
                            'ReadOnly' => true || false,
                            'RecordSizeKiB' => <integer>,
                            'RestoreToSnapshot' => '<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',
                    ],
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
            'FileSystemTypeVersion' => '<string>',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DataCompressionType' => 'NONE|LZ4',
                'DataRepositoryConfiguration' => [
                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                    'ExportPath' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                ],
                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                'DriveCacheType' => 'NONE|READ',
                'LogConfiguration' => [
                    'Destination' => '<string>',
                    'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                ],
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'RootSquashConfiguration' => [
                    'NoSquashNids' => ['<string>', ...],
                    'RootSquash' => '<string>',
                ],
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OntapConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'EndpointIpAddressRange' => '<string>',
                'Endpoints' => [
                    'Intercluster' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                    'Management' => [
                        'DNSName' => '<string>',
                        'IpAddresses' => ['<string>', ...],
                    ],
                ],
                'PreferredSubnetId' => '<string>',
                'RouteTableIds' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OpenZFSConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'CopyTagsToVolumes' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
                'DiskIopsConfiguration' => [
                    'Iops' => <integer>,
                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                ],
                'RootVolumeId' => '<string>',
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'StorageType' => 'SSD|HDD',
            'SubnetIds' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => '<string>',
                'Aliases' => [
                    [
                        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                        'Name' => '<string>',
                    ],
                    // ...
                ],
                'AuditLogConfiguration' => [
                    'AuditLogDestination' => '<string>',
                    'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                    'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                ],
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                'MaintenanceOperationsInProgress' => ['<string>', ...],
                'PreferredFileServerIp' => '<string>',
                'PreferredSubnetId' => '<string>',
                'RemoteAdministrationEndpoint' => '<string>',
                'SelfManagedActiveDirectoryConfiguration' => [
                    'DnsIps' => ['<string>', ...],
                    'DomainName' => '<string>',
                    'FileSystemAdministratorsGroup' => '<string>',
                    'OrganizationalUnitDistinguishedName' => '<string>',
                    'UserName' => '<string>',
                ],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
        ],
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING|COPYING',
        'OwnerId' => '<string>',
        'ProgressPercent' => <integer>,
        'ResourceARN' => '<string>',
        'ResourceType' => 'FILE_SYSTEM|VOLUME',
        'SourceBackupId' => '<string>',
        'SourceBackupRegion' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
        'Volume' => [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                    'TargetFileSystemValues' => [
                        'AdministrativeActions' => [...], // RECURSIVE
                        'CreationTime' => <DateTime>,
                        'DNSName' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'FileSystemId' => '<string>',
                        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                        'FileSystemTypeVersion' => '<string>',
                        'KmsKeyId' => '<string>',
                        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                        'LustreConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DataCompressionType' => 'NONE|LZ4',
                            'DataRepositoryConfiguration' => [
                                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                                'ExportPath' => '<string>',
                                'FailureDetails' => [
                                    'Message' => '<string>',
                                ],
                                'ImportPath' => '<string>',
                                'ImportedFileChunkSize' => <integer>,
                                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                            ],
                            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                            'DriveCacheType' => 'NONE|READ',
                            'LogConfiguration' => [
                                'Destination' => '<string>',
                                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                            ],
                            'MountName' => '<string>',
                            'PerUnitStorageThroughput' => <integer>,
                            'RootSquashConfiguration' => [
                                'NoSquashNids' => ['<string>', ...],
                                'RootSquash' => '<string>',
                            ],
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'NetworkInterfaceIds' => ['<string>', ...],
                        'OntapConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'EndpointIpAddressRange' => '<string>',
                            'Endpoints' => [
                                'Intercluster' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                                'Management' => [
                                    'DNSName' => '<string>',
                                    'IpAddresses' => ['<string>', ...],
                                ],
                            ],
                            'PreferredSubnetId' => '<string>',
                            'RouteTableIds' => ['<string>', ...],
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OpenZFSConfiguration' => [
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'CopyTagsToVolumes' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
                            'DiskIopsConfiguration' => [
                                'Iops' => <integer>,
                                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                            ],
                            'RootVolumeId' => '<string>',
                            'ThroughputCapacity' => <integer>,
                            'WeeklyMaintenanceStartTime' => '<string>',
                        ],
                        'OwnerId' => '<string>',
                        'ResourceARN' => '<string>',
                        'StorageCapacity' => <integer>,
                        'StorageType' => 'SSD|HDD',
                        'SubnetIds' => ['<string>', ...],
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'VpcId' => '<string>',
                        'WindowsConfiguration' => [
                            'ActiveDirectoryId' => '<string>',
                            'Aliases' => [
                                [
                                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'AuditLogConfiguration' => [
                                'AuditLogDestination' => '<string>',
                                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            ],
                            'AutomaticBackupRetentionDays' => <integer>,
                            'CopyTagsToBackups' => true || false,
                            'DailyAutomaticBackupStartTime' => '<string>',
                            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                            '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
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'FileSystemId' => '<string>',
            'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
            'LifecycleTransitionReason' => [
                'Message' => '<string>',
            ],
            'Name' => '<string>',
            'OntapConfiguration' => [
                'CopyTagsToBackups' => true || false,
                'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                'JunctionPath' => '<string>',
                'OntapVolumeType' => 'RW|DP|LS',
                'SecurityStyle' => 'UNIX|NTFS|MIXED',
                'SizeInMegabytes' => <integer>,
                'SnapshotPolicy' => '<string>',
                'StorageEfficiencyEnabled' => true || false,
                'StorageVirtualMachineId' => '<string>',
                'StorageVirtualMachineRoot' => true || false,
                'TieringPolicy' => [
                    'CoolingPeriod' => <integer>,
                    'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                ],
                'UUID' => '<string>',
            ],
            'OpenZFSConfiguration' => [
                'CopyTagsToSnapshots' => true || false,
                'DataCompressionType' => 'NONE|ZSTD|LZ4',
                'DeleteClonedVolumes' => true || false,
                'DeleteIntermediateSnaphots' => true || false,
                'NfsExports' => [
                    [
                        'ClientConfigurations' => [
                            [
                                'Clients' => '<string>',
                                'Options' => ['<string>', ...],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'OriginSnapshot' => [
                    'CopyStrategy' => 'CLONE|FULL_COPY',
                    'SnapshotARN' => '<string>',
                ],
                'ParentVolumeId' => '<string>',
                'ReadOnly' => true || false,
                'RecordSizeKiB' => <integer>,
                'RestoreToSnapshot' => '<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 Services Support.

• InternalServerError:

  A generic error indicating a server-side failure.

Examples

Example 1: To create a new backup

This operation creates a new backup.

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

Result syntax:

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

CreateDataRepositoryAssociation

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

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

• InternalServerError:

  A generic error indicating a server-side failure.

CreateDataRepositoryTask

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

Parameter Syntax

$result = $client->createDataRepositoryTask([
    'CapacityToRelease' => <integer>,
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'Paths' => ['<string>', ...],
    '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>', ...],
        '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 Services Support.

• InternalServerError:

  A generic error indicating a server-side failure.

• DataRepositoryTaskExecuting:

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

CreateFileCache

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

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

• InternalServerError:

  A generic error indicating a server-side failure.

• MissingFileCacheConfiguration:

  A cache configuration is required for this operation.

CreateFileSystem

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

Parameter Syntax

$result = $client->createFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS', // REQUIRED
    'FileSystemTypeVersion' => '<string>',
    'KmsKeyId' => '<string>',
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DataCompressionType' => 'NONE|LZ4',
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
        'DriveCacheType' => 'NONE|READ',
        'ExportPath' => '<string>',
        'ImportPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'LogConfiguration' => [
            'Destination' => '<string>',
            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR', // REQUIRED
        ],
        'PerUnitStorageThroughput' => <integer>,
        'RootSquashConfiguration' => [
            'NoSquashNids' => ['<string>', ...],
            'RootSquash' => '<string>',
        ],
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'OntapConfiguration' => [
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1', // REQUIRED
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        'EndpointIpAddressRange' => '<string>',
        'FsxAdminPassword' => '<string>',
        'PreferredSubnetId' => '<string>',
        'RouteTableIds' => ['<string>', ...],
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'OpenZFSConfiguration' => [
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'CopyTagsToVolumes' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2', // REQUIRED
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        '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
                ],
                // ...
            ],
        ],
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'StorageCapacity' => <integer>, // REQUIRED
    'StorageType' => 'SSD|HDD',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => '<string>',
        'Aliases' => ['<string>', ...],
        'AuditLogConfiguration' => [
            'AuditLogDestination' => '<string>',
            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
        ],
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
        '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',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_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' => [
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInMegabytes' => <integer>,
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<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',
                ],
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
        'FileSystemTypeVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataCompressionType' => 'NONE|LZ4',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
            'DriveCacheType' => 'NONE|READ',
            'LogConfiguration' => [
                'Destination' => '<string>',
                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
            ],
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'RootSquashConfiguration' => [
                'NoSquashNids' => ['<string>', ...],
                'RootSquash' => '<string>',
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OntapConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddressRange' => '<string>',
            'Endpoints' => [
                'Intercluster' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Management' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
            ],
            'PreferredSubnetId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OpenZFSConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'CopyTagsToVolumes' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'RootVolumeId' => '<string>',
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AuditLogConfiguration' => [
                'AuditLogDestination' => '<string>',
                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            '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 Services Support.

• InternalServerError:

  A generic error indicating a server-side failure.

• MissingFileSystemConfiguration:

  A file system configuration is required for this operation.

Examples

Example 1: To create a new file system

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

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

Result syntax:

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

CreateFileSystemFromBackup

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

Parameter Syntax

$result = $client->createFileSystemFromBackup([
    'BackupId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'FileSystemTypeVersion' => '<string>',
    'KmsKeyId' => '<string>',
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DataCompressionType' => 'NONE|LZ4',
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
        'DriveCacheType' => 'NONE|READ',
        'ExportPath' => '<string>',
        'ImportPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'LogConfiguration' => [
            'Destination' => '<string>',
            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR', // REQUIRED
        ],
        'PerUnitStorageThroughput' => <integer>,
        'RootSquashConfiguration' => [
            'NoSquashNids' => ['<string>', ...],
            'RootSquash' => '<string>',
        ],
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'OpenZFSConfiguration' => [
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'CopyTagsToVolumes' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2', // REQUIRED
        'DiskIopsConfiguration' => [
            'Iops' => <integer>,
            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
        ],
        '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
                ],
                // ...
            ],
        ],
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'StorageCapacity' => <integer>,
    'StorageType' => 'SSD|HDD',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => '<string>',
        'Aliases' => ['<string>', ...],
        'AuditLogConfiguration' => [
            'AuditLogDestination' => '<string>',
            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE', // REQUIRED
        ],
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
        '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',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_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' => [
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInMegabytes' => <integer>,
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<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',
                ],
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
        'FileSystemTypeVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataCompressionType' => 'NONE|LZ4',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
            'DriveCacheType' => 'NONE|READ',
            'LogConfiguration' => [
                'Destination' => '<string>',
                'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
            ],
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'RootSquashConfiguration' => [
                'NoSquashNids' => ['<string>', ...],
                'RootSquash' => '<string>',
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OntapConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'EndpointIpAddressRange' => '<string>',
            'Endpoints' => [
                'Intercluster' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
                'Management' => [
                    'DNSName' => '<string>',
                    'IpAddresses' => ['<string>', ...],
                ],
            ],
            'PreferredSubnetId' => '<string>',
            'RouteTableIds' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OpenZFSConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'CopyTagsToVolumes' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
            'DiskIopsConfiguration' => [
                'Iops' => <integer>,
                'Mode' => 'AUTOMATIC|USER_PROVISIONED',
            ],
            'RootVolumeId' => '<string>',
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'StorageType' => 'SSD|HDD',
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'Aliases' => [
                [
                    'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                    'Name' => '<string>',
                ],
                // ...
            ],
            'AuditLogConfiguration' => [
                'AuditLogDestination' => '<string>',
                'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
            ],
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
            '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 Services Support.

• BackupNotFound:

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

• InternalServerError:

  A generic error indicating a server-side failure.

• MissingFileSystemConfiguration:

  A file system configuration is required for this operation.

Examples

Example 1: To create a new file system from backup

This operation creates a new file system from backup.

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

Result syntax:

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

CreateSnapshot

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

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',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                'TargetFileSystemValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'DNSName' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'FileSystemId' => '<string>',
                    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                    'FileSystemTypeVersion' => '<string>',
                    'KmsKeyId' => '<string>',
                    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                    'LustreConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DataCompressionType' => 'NONE|LZ4',
                        'DataRepositoryConfiguration' => [
                            'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                            'ExportPath' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'ImportPath' => '<string>',
                            'ImportedFileChunkSize' => <integer>,
                            'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                        ],
                        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                        'DriveCacheType' => 'NONE|READ',
                        'LogConfiguration' => [
                            'Destination' => '<string>',
                            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                        ],
                        'MountName' => '<string>',
                        'PerUnitStorageThroughput' => <integer>,
                        'RootSquashConfiguration' => [
                            'NoSquashNids' => ['<string>', ...],
                            'RootSquash' => '<string>',
                        ],
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'NetworkInterfaceIds' => ['<string>', ...],
                    'OntapConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddressRange' => '<string>',
                        'Endpoints' => [
                            'Intercluster' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                            'Management' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                        ],
                        'PreferredSubnetId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'CopyTagsToVolumes' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'RootVolumeId' => '<string>',
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD',
                    'SubnetIds' => ['<string>', ...],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                    'WindowsConfiguration' => [
                        'ActiveDirectoryId' => '<string>',
                        'Aliases' => [
                            [
                                'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'AuditLogConfiguration' => [
                            'AuditLogDestination' => '<string>',
                            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        ],
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                        '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' => [
                        'CopyTagsToBackups' => true || false,
                        'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                        'JunctionPath' => '<string>',
                        'OntapVolumeType' => 'RW|DP|LS',
                        'SecurityStyle' => 'UNIX|NTFS|MIXED',
                        'SizeInMegabytes' => <integer>,
                        'SnapshotPolicy' => '<string>',
                        'StorageEfficiencyEnabled' => true || false,
                        'StorageVirtualMachineId' => '<string>',
                        'StorageVirtualMachineRoot' => true || false,
                        'TieringPolicy' => [
                            'CoolingPeriod' => <integer>,
                            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                        ],
                        'UUID' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'CopyTagsToSnapshots' => true || false,
                        'DataCompressionType' => 'NONE|ZSTD|LZ4',
                        'DeleteClonedVolumes' => true || false,
                        'DeleteIntermediateSnaphots' => true || false,
                        'NfsExports' => [
                            [
                                'ClientConfigurations' => [
                                    [
                                        'Clients' => '<string>',
                                        'Options' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'OriginSnapshot' => [
                            'CopyStrategy' => 'CLONE|FULL_COPY',
                            'SnapshotARN' => '<string>',
                        ],
                        'ParentVolumeId' => '<string>',
                        'ReadOnly' => true || false,
                        'RecordSizeKiB' => <integer>,
                        'RestoreToSnapshot' => '<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',
                ],
            ],
            // ...
        ],
        '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 Services Support.

• InternalServerError:

  A generic error indicating a server-side failure.

CreateStorageVirtualMachine

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

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

• UnsupportedOperation:

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

CreateVolume

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

Parameter Syntax

$result = $client->createVolume([
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'OntapConfiguration' => [
        'CopyTagsToBackups' => true || false,
        'JunctionPath' => '<string>',
        'OntapVolumeType' => 'RW|DP',
        'SecurityStyle' => 'UNIX|NTFS|MIXED',
        'SizeInMegabytes' => <integer>, // REQUIRED
        'SnapshotPolicy' => '<string>',
        'StorageEfficiencyEnabled' => true || false,
        'StorageVirtualMachineId' => '<string>', // REQUIRED
        'TieringPolicy' => [
            'CoolingPeriod' => <integer>,
            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
        ],
    ],
    'OpenZFSConfiguration' => [
        'CopyTagsToSnapshots' => true || false,
        'DataCompressionType' => 'NONE|ZSTD|LZ4',
        'NfsExports' => [
            [
                'ClientConfigurations' => [ // REQUIRED
                    [
                        'Clients' => '<string>', // REQUIRED
                        'Options' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'OriginSnapshot' => [
            'CopyStrategy' => 'CLONE|FULL_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',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                'TargetFileSystemValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'DNSName' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'FileSystemId' => '<string>',
                    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                    'FileSystemTypeVersion' => '<string>',
                    'KmsKeyId' => '<string>',
                    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                    'LustreConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DataCompressionType' => 'NONE|LZ4',
                        'DataRepositoryConfiguration' => [
                            'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                            'ExportPath' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'ImportPath' => '<string>',
                            'ImportedFileChunkSize' => <integer>,
                            'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                        ],
                        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                        'DriveCacheType' => 'NONE|READ',
                        'LogConfiguration' => [
                            'Destination' => '<string>',
                            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                        ],
                        'MountName' => '<string>',
                        'PerUnitStorageThroughput' => <integer>,
                        'RootSquashConfiguration' => [
                            'NoSquashNids' => ['<string>', ...],
                            'RootSquash' => '<string>',
                        ],
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'NetworkInterfaceIds' => ['<string>', ...],
                    'OntapConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddressRange' => '<string>',
                        'Endpoints' => [
                            'Intercluster' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                            'Management' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                        ],
                        'PreferredSubnetId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'CopyTagsToVolumes' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'RootVolumeId' => '<string>',
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD',
                    'SubnetIds' => ['<string>', ...],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                    'WindowsConfiguration' => [
                        'ActiveDirectoryId' => '<string>',
                        'Aliases' => [
                            [
                                'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'AuditLogConfiguration' => [
                            'AuditLogDestination' => '<string>',
                            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        ],
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                        '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
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'FileSystemId' => '<string>',
        'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
        'LifecycleTransitionReason' => [
            'Message' => '<string>',
        ],
        'Name' => '<string>',
        'OntapConfiguration' => [
            'CopyTagsToBackups' => true || false,
            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
            'JunctionPath' => '<string>',
            'OntapVolumeType' => 'RW|DP|LS',
            'SecurityStyle' => 'UNIX|NTFS|MIXED',
            'SizeInMegabytes' => <integer>,
            'SnapshotPolicy' => '<string>',
            'StorageEfficiencyEnabled' => true || false,
            'StorageVirtualMachineId' => '<string>',
            'StorageVirtualMachineRoot' => true || false,
            'TieringPolicy' => [
                'CoolingPeriod' => <integer>,
                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
            ],
            'UUID' => '<string>',
        ],
        'OpenZFSConfiguration' => [
            'CopyTagsToSnapshots' => true || false,
            'DataCompressionType' => 'NONE|ZSTD|LZ4',
            'DeleteClonedVolumes' => true || false,
            'DeleteIntermediateSnaphots' => true || false,
            'NfsExports' => [
                [
                    'ClientConfigurations' => [
                        [
                            'Clients' => '<string>',
                            'Options' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'OriginSnapshot' => [
                'CopyStrategy' => 'CLONE|FULL_COPY',
                'SnapshotARN' => '<string>',
            ],
            'ParentVolumeId' => '<string>',
            'ReadOnly' => true || false,
            'RecordSizeKiB' => <integer>,
            'RestoreToSnapshot' => '<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 Services Support.

• StorageVirtualMachineNotFound:

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

• UnsupportedOperation:

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

CreateVolumeFromBackup

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

Parameter Syntax

$result = $client->createVolumeFromBackup([
    'BackupId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
    'OntapConfiguration' => [
        'CopyTagsToBackups' => true || false,
        'JunctionPath' => '<string>',
        'OntapVolumeType' => 'RW|DP',
        'SecurityStyle' => 'UNIX|NTFS|MIXED',
        'SizeInMegabytes' => <integer>, // REQUIRED
        'SnapshotPolicy' => '<string>',
        'StorageEfficiencyEnabled' => true || false,
        'StorageVirtualMachineId' => '<string>', // REQUIRED
        'TieringPolicy' => [
            'CoolingPeriod' => <integer>,
            'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
        ],
    ],
    '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',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                'TargetFileSystemValues' => [
                    'AdministrativeActions' => [...], // RECURSIVE
                    'CreationTime' => <DateTime>,
                    'DNSName' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'FileSystemId' => '<string>',
                    'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                    'FileSystemTypeVersion' => '<string>',
                    'KmsKeyId' => '<string>',
                    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                    'LustreConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DataCompressionType' => 'NONE|LZ4',
                        'DataRepositoryConfiguration' => [
                            'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                            'ExportPath' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'ImportPath' => '<string>',
                            'ImportedFileChunkSize' => <integer>,
                            'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                        ],
                        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                        'DriveCacheType' => 'NONE|READ',
                        'LogConfiguration' => [
                            'Destination' => '<string>',
                            'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                        ],
                        'MountName' => '<string>',
                        'PerUnitStorageThroughput' => <integer>,
                        'RootSquashConfiguration' => [
                            'NoSquashNids' => ['<string>', ...],
                            'RootSquash' => '<string>',
                        ],
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'NetworkInterfaceIds' => ['<string>', ...],
                    'OntapConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'EndpointIpAddressRange' => '<string>',
                        'Endpoints' => [
                            'Intercluster' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                            'Management' => [
                                'DNSName' => '<string>',
                                'IpAddresses' => ['<string>', ...],
                            ],
                        ],
                        'PreferredSubnetId' => '<string>',
                        'RouteTableIds' => ['<string>', ...],
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OpenZFSConfiguration' => [
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'CopyTagsToVolumes' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
                        'DiskIopsConfiguration' => [
                            'Iops' => <integer>,
                            'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                        ],
                        'RootVolumeId' => '<string>',
                        'ThroughputCapacity' => <integer>,
                        'WeeklyMaintenanceStartTime' => '<string>',
                    ],
                    'OwnerId' => '<string>',
                    'ResourceARN' => '<string>',
                    'StorageCapacity' => <integer>,
                    'StorageType' => 'SSD|HDD',
                    'SubnetIds' => ['<string>', ...],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                    'WindowsConfiguration' => [
                        'ActiveDirectoryId' => '<string>',
                        'Aliases' => [
                            [
                                'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'AuditLogConfiguration' => [
                            'AuditLogDestination' => '<string>',
                            'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                            'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        ],
                        'AutomaticBackupRetentionDays' => <integer>,
                        'CopyTagsToBackups' => true || false,
                        'DailyAutomaticBackupStartTime' => '<string>',
                        'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                        '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
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'FileSystemId' => '<string>',
        'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
        'LifecycleTransitionReason' => [
            'Message' => '<string>',
        ],
        'Name' => '<string>',
        'OntapConfiguration' => [
            'CopyTagsToBackups' => true || false,
            'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
            'JunctionPath' => '<string>',
            'OntapVolumeType' => 'RW|DP|LS',
            'SecurityStyle' => 'UNIX|NTFS|MIXED',
            'SizeInMegabytes' => <integer>,
            'SnapshotPolicy' => '<string>',
            'StorageEfficiencyEnabled' => true || false,
            'StorageVirtualMachineId' => '<string>',
            'StorageVirtualMachineRoot' => true || false,
            'TieringPolicy' => [
                'CoolingPeriod' => <integer>,
                'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
            ],
            'UUID' => '<string>',
        ],
        'OpenZFSConfiguration' => [
            'CopyTagsToSnapshots' => true || false,
            'DataCompressionType' => 'NONE|ZSTD|LZ4',
            'DeleteClonedVolumes' => true || false,
            'DeleteIntermediateSnaphots' => true || false,
            'NfsExports' => [
                [
                    'ClientConfigurations' => [
                        [
                            'Clients' => '<string>',
                            'Options' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'OriginSnapshot' => [
                'CopyStrategy' => 'CLONE|FULL_COPY',
                'SnapshotARN' => '<string>',
            ],
            'ParentVolumeId' => '<string>',
            'ReadOnly' => true || false,
            'RecordSizeKiB' => <integer>,
            'RestoreToSnapshot' => '<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 Services Support.

• StorageVirtualMachineNotFound:

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

DeleteBackup

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

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([/* ... */]);

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

• InternalServerError:

  A generic error indicating a server-side failure.

DeleteFileCache

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

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

• InternalServerError:

  A generic error indicating a server-side failure.

DeleteFileSystem

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

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

• InternalServerError:

  A generic error indicating a server-side failure.

Examples

Example 1: To delete a file system

This operation deletes an Amazon FSx file system.

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

Result syntax:

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

DeleteSnapshot

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

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([/* ... */]);

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([/* ... */]);

Parameter Syntax

$result = $client->deleteVolume([
    'ClientRequestToken' => '<string>',
    'OntapConfiguration' => [
        '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.

DescribeBackups

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

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',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ProgressPercent' => <integer>,
                        'RequestTime' => <DateTime>,
                        'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_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' => [
                                'CopyTagsToBackups' => true || false,
                                'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                                'JunctionPath' => '<string>',
                                'OntapVolumeType' => 'RW|DP|LS',
                                'SecurityStyle' => 'UNIX|NTFS|MIXED',
                                'SizeInMegabytes' => <integer>,
                                'SnapshotPolicy' => '<string>',
                                'StorageEfficiencyEnabled' => true || false,
                                'StorageVirtualMachineId' => '<string>',
                                'StorageVirtualMachineRoot' => true || false,
                                'TieringPolicy' => [
                                    'CoolingPeriod' => <integer>,
                                    'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                                ],
                                'UUID' => '<string>',
                            ],
                            'OpenZFSConfiguration' => [
                                'CopyTagsToSnapshots' => true || false,
                                'DataCompressionType' => 'NONE|ZSTD|LZ4',
                                'DeleteClonedVolumes' => true || false,
                                'DeleteIntermediateSnaphots' => true || false,
                                'NfsExports' => [
                                    [
                                        'ClientConfigurations' => [
                                            [
                                                'Clients' => '<string>',
                                                'Options' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                    ],
                                    // ...
                                ],
                                'OriginSnapshot' => [
                                    'CopyStrategy' => 'CLONE|FULL_COPY',
                                    'SnapshotARN' => '<string>',
                                ],
                                'ParentVolumeId' => '<string>',
                                'ReadOnly' => true || false,
                                'RecordSizeKiB' => <integer>,
                                'RestoreToSnapshot' => '<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',
                        ],
                    ],
                    // ...
                ],
                'CreationTime' => <DateTime>,
                'DNSName' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'FileSystemId' => '<string>',
                'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                'FileSystemTypeVersion' => '<string>',
                'KmsKeyId' => '<string>',
                'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                'LustreConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DataCompressionType' => 'NONE|LZ4',
                    'DataRepositoryConfiguration' => [
                        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                        'ExportPath' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ImportPath' => '<string>',
                        'ImportedFileChunkSize' => <integer>,
                        'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                    ],
                    'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                    'DriveCacheType' => 'NONE|READ',
                    'LogConfiguration' => [
                        'Destination' => '<string>',
                        'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                    ],
                    'MountName' => '<string>',
                    'PerUnitStorageThroughput' => <integer>,
                    'RootSquashConfiguration' => [
                        'NoSquashNids' => ['<string>', ...],
                        'RootSquash' => '<string>',
                    ],
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'NetworkInterfaceIds' => ['<string>', ...],
                'OntapConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'EndpointIpAddressRange' => '<string>',
                    'Endpoints' => [
                        'Intercluster' => [
                            'DNSName' => '<string>',
                            'IpAddresses' => ['<string>', ...],
                        ],
                        'Management' => [
                            'DNSName' => '<string>',
                            'IpAddresses' => ['<string>', ...],
                        ],
                    ],
                    'PreferredSubnetId' => '<string>',
                    'RouteTableIds' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OpenZFSConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'CopyTagsToVolumes' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
                    'DiskIopsConfiguration' => [
                        'Iops' => <integer>,
                        'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                    ],
                    'RootVolumeId' => '<string>',
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'OwnerId' => '<string>',
                'ResourceARN' => '<string>',
                'StorageCapacity' => <integer>,
                'StorageType' => 'SSD|HDD',
                'SubnetIds' => ['<string>', ...],
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VpcId' => '<string>',
                'WindowsConfiguration' => [
                    'ActiveDirectoryId' => '<string>',
                    'Aliases' => [
                        [
                            'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                    'AuditLogConfiguration' => [
                        'AuditLogDestination' => '<string>',
                        'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                        'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                    ],
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                    'MaintenanceOperationsInProgress' => ['<string>', ...],
                    'PreferredFileServerIp' => '<string>',
                    'PreferredSubnetId' => '<string>',
                    'RemoteAdministrationEndpoint' => '<string>',
                    'SelfManagedActiveDirectoryConfiguration' => [
                        'DnsIps' => ['<string>', ...],
                        'DomainName' => '<string>',
                        'FileSystemAdministratorsGroup' => '<string>',
                        'OrganizationalUnitDistinguishedName' => '<string>',
                        'UserName' => '<string>',
                    ],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
            ],
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|TRANSFERRING|DELETED|FAILED|PENDING|COPYING',
            'OwnerId' => '<string>',
            'ProgressPercent' => <integer>,
            'ResourceARN' => '<string>',
            'ResourceType' => 'FILE_SYSTEM|VOLUME',
            'SourceBackupId' => '<string>',
            'SourceBackupRegion' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
            'Volume' => [
                'AdministrativeActions' => [
                    [
                        'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION|VOLUME_UPDATE|SNAPSHOT_UPDATE|RELEASE_NFS_V3_LOCKS|VOLUME_RESTORE',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ProgressPercent' => <integer>,
                        'RequestTime' => <DateTime>,
                        'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                        'TargetFileSystemValues' => [
                            'AdministrativeActions' => [...], // RECURSIVE
                            'CreationTime' => <DateTime>,
                            'DNSName' => '<string>',
                            'FailureDetails' => [
                                'Message' => '<string>',
                            ],
                            'FileSystemId' => '<string>',
                            'FileSystemType' => 'WINDOWS|LUSTRE|ONTAP|OPENZFS',
                            'FileSystemTypeVersion' => '<string>',
                            'KmsKeyId' => '<string>',
                            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING|MISCONFIGURED_UNAVAILABLE',
                            'LustreConfiguration' => [
                                'AutomaticBackupRetentionDays' => <integer>,
                                'CopyTagsToBackups' => true || false,
                                'DailyAutomaticBackupStartTime' => '<string>',
                                'DataCompressionType' => 'NONE|LZ4',
                                'DataRepositoryConfiguration' => [
                                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED|NEW_CHANGED_DELETED',
                                    'ExportPath' => '<string>',
                                    'FailureDetails' => [
                                        'Message' => '<string>',
                                    ],
                                    'ImportPath' => '<string>',
                                    'ImportedFileChunkSize' => <integer>,
                                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING|FAILED',
                                ],
                                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1|PERSISTENT_2',
                                'DriveCacheType' => 'NONE|READ',
                                'LogConfiguration' => [
                                    'Destination' => '<string>',
                                    'Level' => 'DISABLED|WARN_ONLY|ERROR_ONLY|WARN_ERROR',
                                ],
                                'MountName' => '<string>',
                                'PerUnitStorageThroughput' => <integer>,
                                'RootSquashConfiguration' => [
                                    'NoSquashNids' => ['<string>', ...],
                                    'RootSquash' => '<string>',
                                ],
                                'WeeklyMaintenanceStartTime' => '<string>',
                            ],
                            'NetworkInterfaceIds' => ['<string>', ...],
                            'OntapConfiguration' => [
                                'AutomaticBackupRetentionDays' => <integer>,
                                'DailyAutomaticBackupStartTime' => '<string>',
                                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1',
                                'DiskIopsConfiguration' => [
                                    'Iops' => <integer>,
                                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                                ],
                                'EndpointIpAddressRange' => '<string>',
                                'Endpoints' => [
                                    'Intercluster' => [
                                        'DNSName' => '<string>',
                                        'IpAddresses' => ['<string>', ...],
                                    ],
                                    'Management' => [
                                        'DNSName' => '<string>',
                                        'IpAddresses' => ['<string>', ...],
                                    ],
                                ],
                                'PreferredSubnetId' => '<string>',
                                'RouteTableIds' => ['<string>', ...],
                                'ThroughputCapacity' => <integer>,
                                'WeeklyMaintenanceStartTime' => '<string>',
                            ],
                            'OpenZFSConfiguration' => [
                                'AutomaticBackupRetentionDays' => <integer>,
                                'CopyTagsToBackups' => true || false,
                                'CopyTagsToVolumes' => true || false,
                                'DailyAutomaticBackupStartTime' => '<string>',
                                'DeploymentType' => 'SINGLE_AZ_1|SINGLE_AZ_2',
                                'DiskIopsConfiguration' => [
                                    'Iops' => <integer>,
                                    'Mode' => 'AUTOMATIC|USER_PROVISIONED',
                                ],
                                'RootVolumeId' => '<string>',
                                'ThroughputCapacity' => <integer>,
                                'WeeklyMaintenanceStartTime' => '<string>',
                            ],
                            'OwnerId' => '<string>',
                            'ResourceARN' => '<string>',
                            'StorageCapacity' => <integer>,
                            'StorageType' => 'SSD|HDD',
                            'SubnetIds' => ['<string>', ...],
                            'Tags' => [
                                [
                                    'Key' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'VpcId' => '<string>',
                            'WindowsConfiguration' => [
                                'ActiveDirectoryId' => '<string>',
                                'Aliases' => [
                                    [
                                        'Lifecycle' => 'AVAILABLE|CREATING|DELETING|CREATE_FAILED|DELETE_FAILED',
                                        'Name' => '<string>',
                                    ],
                                    // ...
                                ],
                                'AuditLogConfiguration' => [
                                    'AuditLogDestination' => '<string>',
                                    'FileAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                    'FileShareAccessAuditLogLevel' => 'DISABLED|SUCCESS_ONLY|FAILURE_ONLY|SUCCESS_AND_FAILURE',
                                ],
                                'AutomaticBackupRetentionDays' => <integer>,
                                'CopyTagsToBackups' => true || false,
                                'DailyAutomaticBackupStartTime' => '<string>',
                                'DeploymentType' => 'MULTI_AZ_1|SINGLE_AZ_1|SINGLE_AZ_2',
                                '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
                    ],
                    // ...
                ],
                'CreationTime' => <DateTime>,
                'FileSystemId' => '<string>',
                'Lifecycle' => 'CREATING|CREATED|DELETING|FAILED|MISCONFIGURED|PENDING|AVAILABLE',
                'LifecycleTransitionReason' => [
                    'Message' => '<string>',
                ],
                'Name' => '<string>',
                'OntapConfiguration' => [
                    'CopyTagsToBackups' => true || false,
                    'FlexCacheEndpointType' => 'NONE|ORIGIN|CACHE',
                    'JunctionPath' => '<string>',
                    'OntapVolumeType' => 'RW|DP|LS',
                    'SecurityStyle' => 'UNIX|NTFS|MIXED',
                    'SizeInMegabytes' => <integer>,
                    'SnapshotPolicy' => '<string>',
                    'StorageEfficiencyEnabled' => true || false,
                    'StorageVirtualMachineId' => '<string>',
                    'StorageVirtualMachineRoot' => true || false,
                    'TieringPolicy' => [
                        'CoolingPeriod' => <integer>,
                        'Name' => 'SNAPSHOT_ONLY|AUTO|ALL|NONE',
                    ],
                    'UUID' => '<string>',
                ],
                'OpenZFSConfiguration' => [
                    'CopyTagsToSnapshots' => true || false,
                    'DataCompressionType' => 'NONE|ZSTD|LZ4',
                    'DeleteClonedVolumes' => true || false,
                    'DeleteIntermediateSnaphots' => true || false,
                    'NfsExports' => [
                        [
                            'ClientConfigurations' => [
                                [
                                    'Clients' => '<string>',
                                    'Options' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'OriginSnapshot' => [
                        'CopyStrategy' => 'CLONE|FULL_COPY',
                        'SnapshotARN' => '<string>',
                    ],
                    'ParentVolumeId' => '<string>',
                    'ReadOnly' => true || false,
                    'RecordSizeKiB' => <integer>,
                    'RestoreToSnapshot' => '<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([/* ... */]);

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([/* ... */]);

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>', ...],
            '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.