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.

CreateBackup

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Backup' => [
        'BackupId' => '<string>',
        'CreationTime' => <DateTime>,
        'DirectoryInformation' => [
            'ActiveDirectoryId' => '<string>',
            'DomainName' => '<string>',
        ],
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystem' => [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                    'TargetFileSystemValues' => [...], // RECURSIVE
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DataRepositoryConfiguration' => [
                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                    'ExportPath' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
                ],
                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
                'DriveCacheType' => 'NONE|READ',
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<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>',
                    ],
                    // ...
                ],
                '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',
        'ProgressPercent' => <integer>,
        'ResourceARN' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
    ],
]

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.

• 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 AWS 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',
    ],
]

CreateDataRepositoryTask

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

Parameter Syntax

$result = $client->createDataRepositoryTask([
    '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', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DataRepositoryTask' => [
        'CreationTime' => <DateTime>,
        'EndTime' => <DateTime>,
        'FailureDetails' => [
            'Message' => '<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>,
            'SucceededCount' => <integer>,
            'TotalCount' => <integer>,
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TaskId' => '<string>',
        'Type' => 'EXPORT_TO_REPOSITORY',
    ],
]

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

CreateFileSystem

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

Parameter Syntax

$result = $client->createFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemType' => 'WINDOWS|LUSTRE', // REQUIRED
    'KmsKeyId' => '<string>',
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
        'DriveCacheType' => 'NONE|READ',
        'ExportPath' => '<string>',
        'ImportPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'PerUnitStorageThroughput' => <integer>,
        '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>', ...],
        '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',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
            'DriveCacheType' => 'NONE|READ',
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<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>',
                ],
                // ...
            ],
            '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. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.

• 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 AWS 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>',
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
        'DriveCacheType' => 'NONE|READ',
        'ExportPath' => '<string>',
        'ImportPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'PerUnitStorageThroughput' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'StorageType' => 'SSD|HDD',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => '<string>',
        'Aliases' => ['<string>', ...],
        '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',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
            'DriveCacheType' => 'NONE|READ',
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<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>',
                ],
                // ...
            ],
            '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. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.

• 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 AWS 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',
        ],
    ],
]

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

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.

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

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,
    ],
    'WindowsConfiguration' => [
        'FinalBackupTags' => [
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'SkipFinalBackup' => true || false,
    ],
]);

Parameter Details

Result Syntax

[
    'FileSystemId' => '<string>',
    'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
    'LustreResponse' => [
        '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 AWS 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',
]

DescribeBackups

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Backups' => [
        [
            'BackupId' => '<string>',
            'CreationTime' => <DateTime>,
            'DirectoryInformation' => [
                'ActiveDirectoryId' => '<string>',
                'DomainName' => '<string>',
            ],
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystem' => [
                'AdministrativeActions' => [
                    [
                        'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ProgressPercent' => <integer>,
                        'RequestTime' => <DateTime>,
                        'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                        'TargetFileSystemValues' => [...], // RECURSIVE
                    ],
                    // ...
                ],
                'CreationTime' => <DateTime>,
                'DNSName' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'FileSystemId' => '<string>',
                'FileSystemType' => 'WINDOWS|LUSTRE',
                'KmsKeyId' => '<string>',
                'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
                'LustreConfiguration' => [
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'DataRepositoryConfiguration' => [
                        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                        'ExportPath' => '<string>',
                        'FailureDetails' => [
                            'Message' => '<string>',
                        ],
                        'ImportPath' => '<string>',
                        'ImportedFileChunkSize' => <integer>,
                        'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
                    ],
                    'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
                    'DriveCacheType' => 'NONE|READ',
                    'MountName' => '<string>',
                    'PerUnitStorageThroughput' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'NetworkInterfaceIds' => ['<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>',
                        ],
                        // ...
                    ],
                    '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',
            'ProgressPercent' => <integer>,
            'ResourceARN' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Type' => 'AUTOMATIC|USER_INITIATED|AWS_BACKUP',
        ],
        // ...
    ],
    '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.

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

DescribeDataRepositoryTasks

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DataRepositoryTasks' => [
        [
            'CreationTime' => <DateTime>,
            'EndTime' => <DateTime>,
            'FailureDetails' => [
                'Message' => '<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>,
                'SucceededCount' => <integer>,
                'TotalCount' => <integer>,
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TaskId' => '<string>',
            'Type' => 'EXPORT_TO_REPOSITORY',
        ],
        // ...
    ],
    '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.

DescribeFileSystemAliases

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequest:

  A generic error indicating a failure with a client request.

• FileSystemNotFound:

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

• InternalServerError:

  A generic error indicating a server-side failure.

DescribeFileSystems

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'FileSystems' => [
        [
            'AdministrativeActions' => [
                [
                    'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ProgressPercent' => <integer>,
                    'RequestTime' => <DateTime>,
                    'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                    'TargetFileSystemValues' => [...], // RECURSIVE
                ],
                // ...
            ],
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
            'LustreConfiguration' => [
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'DataRepositoryConfiguration' => [
                    'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                    'ExportPath' => '<string>',
                    'FailureDetails' => [
                        'Message' => '<string>',
                    ],
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                    'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
                ],
                'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
                'DriveCacheType' => 'NONE|READ',
                'MountName' => '<string>',
                'PerUnitStorageThroughput' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<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>',
                    ],
                    // ...
                ],
                '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>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• BadRequest:

  A generic error indicating a failure with a client request.

• FileSystemNotFound:

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

• InternalServerError:

  A generic error indicating a server-side failure.

Examples

Example 1: To describe an Amazon FSx file system

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

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

Result syntax:

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

DisassociateFileSystemAliases

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequest:

  A generic error indicating a failure with a client request.

• FileSystemNotFound:

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

• InternalServerError:

  A generic error indicating a server-side failure.

ListTagsForResource

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequest:

  A generic error indicating a failure with a client request.

• InternalServerError:

  A generic error indicating a server-side failure.

• ResourceNotFound:

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

• NotServiceResourceError:

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

• ResourceDoesNotSupportTagging:

  The resource specified does not support tagging.

Examples

Example 1: To list tags for a resource

This operation lists tags for an Amazon FSx resource.

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

Result syntax:

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

TagResource

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequest:

  A generic error indicating a failure with a client request.

• InternalServerError:

  A generic error indicating a server-side failure.

• ResourceNotFound:

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

• NotServiceResourceError:

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

• ResourceDoesNotSupportTagging:

  The resource specified does not support tagging.

Examples

Example 1: To tag a resource

This operation tags an Amazon FSx resource.

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

UntagResource

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequest:

  A generic error indicating a failure with a client request.

• InternalServerError:

  A generic error indicating a server-side failure.

• ResourceNotFound:

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

• NotServiceResourceError:

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

• ResourceDoesNotSupportTagging:

  The resource specified does not support tagging.

Examples

Example 1: To untag a resource

This operation untags an Amazon FSx resource.

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

UpdateFileSystem

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

Parameter Syntax

$result = $client->updateFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'LustreConfiguration' => [
        'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'StorageCapacity' => <integer>,
    'WindowsConfiguration' => [
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'SelfManagedActiveDirectoryConfiguration' => [
            'DnsIps' => ['<string>', ...],
            'Password' => '<string>',
            'UserName' => '<string>',
        ],
        'ThroughputCapacity' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'FileSystem' => [
        'AdministrativeActions' => [
            [
                'AdministrativeActionType' => 'FILE_SYSTEM_UPDATE|STORAGE_OPTIMIZATION|FILE_SYSTEM_ALIAS_ASSOCIATION|FILE_SYSTEM_ALIAS_DISASSOCIATION',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ProgressPercent' => <integer>,
                'RequestTime' => <DateTime>,
                'Status' => 'FAILED|IN_PROGRESS|PENDING|COMPLETED|UPDATED_OPTIMIZING',
                'TargetFileSystemValues' => [...], // RECURSIVE
            ],
            // ...
        ],
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING|MISCONFIGURED|UPDATING',
        'LustreConfiguration' => [
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'DataRepositoryConfiguration' => [
                'AutoImportPolicy' => 'NONE|NEW|NEW_CHANGED',
                'ExportPath' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
                'Lifecycle' => 'CREATING|AVAILABLE|MISCONFIGURED|UPDATING|DELETING',
            ],
            'DeploymentType' => 'SCRATCH_1|SCRATCH_2|PERSISTENT_1',
            'DriveCacheType' => 'NONE|READ',
            'MountName' => '<string>',
            'PerUnitStorageThroughput' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<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>',
                ],
                // ...
            ],
            '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.

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

• FileSystemNotFound:

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

• MissingFileSystemConfiguration:

  A file system configuration is required for this operation.

• ServiceLimitExceeded:

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

Examples

Example 1: To update an existing file system

This operation updates an existing file system.

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

Result syntax:

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