AWS SDK for PHP 3.x

Service ID: fsx

Version: 2018-03-01

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

Operation Summary

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

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

CreateBackup ( array $params = [] )
Creates a backup of an existing Amazon FSx for Windows File Server file system.
CreateFileSystem ( array $params = [] )
Creates a new, empty Amazon FSx file system.
CreateFileSystemFromBackup ( array $params = [] )
Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
DeleteBackup ( array $params = [] )
Deletes an Amazon FSx for Windows File Server backup, deleting its contents.
DeleteFileSystem ( array $params = [] )
Deletes a file system, deleting its contents.
DescribeBackups ( array $params = [] )
Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup.
DescribeFileSystems ( array $params = [] )
Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system.
ListTagsForResource ( array $params = [] )
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
TagResource ( array $params = [] )
Tags an Amazon FSx resource.
UntagResource ( array $params = [] )
This action removes a tag from an Amazon FSx resource.
UpdateFileSystem ( array $params = [] )
Updates a file system configuration.

Paginators

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

DescribeBackups
DescribeFileSystems

Operations

CreateBackup

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

Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.

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

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

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

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

Parameter Syntax

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

Parameter Details

Members

ClientRequestToken

Type: string

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

FileSystemId

Required: Yes
Type: string

The ID of the file system to back up.

Tags

Type: Array of Tag structures

The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name.

Result Syntax

[
    'Backup' => [
        'BackupId' => '<string>',
        'CreationTime' => <DateTime>,
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystem' => [
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING',
            'LustreConfiguration' => [
                'DataRepositoryConfiguration' => [
                    'ExportPath' => '<string>',
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                ],
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'SubnetIds' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => '<string>',
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'MaintenanceOperationsInProgress' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
        ],
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|DELETED|FAILED',
        'ProgressPercent' => <integer>,
        'ResourceARN' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'AUTOMATIC|USER_INITIATED',
    ],
]

Result Details

Members

Backup

Type: Backup structure

A description of the backup.

Errors

BadRequest:
A generic error indicating a failure with a client request.
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',
    ],
]

CreateFileSystem

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

Creates a new, empty Amazon FSx file system.

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

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

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

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

Parameter Syntax

$result = $client->createFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemType' => 'WINDOWS|LUSTRE', // REQUIRED
    'KmsKeyId' => '<string>',
    'LustreConfiguration' => [
        'ImportPath' => '<string>',
        'ImportedFileChunkSize' => <integer>,
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'StorageCapacity' => <integer>, // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => '<string>',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

FileSystemType

Required: Yes
Type: string

The type of file system.

KmsKeyId

Type: string

The ID of your AWS Key Management Service (AWS KMS) key. This ID is used to encrypt the data in your file system at rest. For more information, see Encrypt in the AWS Key Management Service API Reference.

LustreConfiguration

Type: CreateFileSystemLustreConfiguration structure

The configuration object for Lustre file systems used in the CreateFileSystem operation.

SecurityGroupIds

Type: Array of strings

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

StorageCapacity

Required: Yes
Type: int

The storage capacity of the file system.

For Windows file systems, the storage capacity has a minimum of 300 GiB, and a maximum of 65,536 GiB.

For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storage capacity is provisioned in increments of 3,600 GiB.

SubnetIds

Required: Yes
Type: Array of strings

A list of IDs for the subnets that the file system will be accessible from. File systems support only one subnet. The file server is also launched in that subnet's Availability Zone.

Tags

Type: Array of Tag structures

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

WindowsConfiguration

Type: CreateFileSystemWindowsConfiguration structure

The configuration for this Microsoft Windows file system.

Result Syntax

[
    'FileSystem' => [
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING',
        'LustreConfiguration' => [
            'DataRepositoryConfiguration' => [
                'ExportPath' => '<string>',
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members

FileSystem

Type: FileSystem structure

A description of the file system.

Errors

BadRequest:
A generic error indicating a failure with a client request.
ActiveDirectoryError:
An Active Directory error.
IncompatibleParameterError:
The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InvalidImportPath:
The path provided for data repository import 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.
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:
File system configuration is required for this operation.

Examples

Example 1: To create a new file system

This operation creates a new file system.

$result = $client->createFileSystem([
    'ClientRequestToken' => 'a8ca07e4-61ec-4399-99f4-19853801bcd5',
    'FileSystemType' => 'WINDOWS',
    'KmsKeyId' => 'arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6',
    'SecurityGroupIds' => [
        'sg-edcd9784',
    ],
    'StorageCapacity' => 300,
    'SubnetIds' => [
        'subnet-1234abcd',
    ],
    'Tags' => [
        [
            'Key' => 'Name',
            'Value' => 'MyFileSystem',
        ],
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => 'd-1234abcd12',
        'AutomaticBackupRetentionDays' => 30,
        'DailyAutomaticBackupStartTime' => '05:00',
        'ThroughputCapacity' => 8,
        'WeeklyMaintenanceStartTime' => '1:05: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' => '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',
        ],
    ],
]

CreateFileSystemFromBackup

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

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

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

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

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

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

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

Parameter Syntax

$result = $client->createFileSystemFromBackup([
    'BackupId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'SecurityGroupIds' => ['<string>', ...],
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'WindowsConfiguration' => [
        'ActiveDirectoryId' => '<string>',
        'AutomaticBackupRetentionDays' => <integer>,
        'CopyTagsToBackups' => true || false,
        'DailyAutomaticBackupStartTime' => '<string>',
        'ThroughputCapacity' => <integer>, // REQUIRED
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members

BackupId

Required: Yes
Type: string

The ID of the backup.

ClientRequestToken

Type: string

SecurityGroupIds

Type: Array of strings

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

SubnetIds

Required: Yes
Type: Array of strings

A list of IDs for the subnets that the file system will be accessible from. Currently, you can specify only one subnet. The file server is also launched in that subnet's Availability Zone.

Tags

Type: Array of Tag structures

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

WindowsConfiguration

Type: CreateFileSystemWindowsConfiguration structure

The configuration for this Microsoft Windows file system.

Result Syntax

[
    'FileSystem' => [
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING',
        'LustreConfiguration' => [
            'DataRepositoryConfiguration' => [
                'ExportPath' => '<string>',
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members

FileSystem

Type: FileSystem structure

A description of the file system.

Errors

BadRequest:
A generic error indicating a failure with a client request.
ActiveDirectoryError:
An Active Directory error.
IncompatibleParameterError:
The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InvalidNetworkSettings:
One or more network settings specified in the request are invalid. 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.
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:
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([/* ... */]);

Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.

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

Parameter Syntax

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

Parameter Details

Members

BackupId

Required: Yes
Type: string

The ID of the backup you want to delete.

ClientRequestToken

Type: string

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

Result Syntax

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

Result Details

Members

BackupId

Type: string

The ID of the backup deleted.

Lifecycle

Type: string

The lifecycle of the backup. Should be DELETED.

Errors

BadRequest:
A generic error indicating a failure with a client request.
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([/* ... */]);

Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.

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

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

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

Parameter Syntax

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

Parameter Details

Members

ClientRequestToken

Type: string

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

FileSystemId

Required: Yes
Type: string

The ID of the file system you want to delete.

WindowsConfiguration

Type: DeleteFileSystemWindowsConfiguration structure

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

Result Syntax

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

Result Details

Members

FileSystemId

Type: string

The ID of the file system being deleted.

Lifecycle

Type: string

The file system lifecycle for the deletion request. Should be DELETING.

WindowsResponse

Type: DeleteFileSystemWindowsResponse structure

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

Errors

BadRequest:
A generic error indicating a failure with a client request.
IncompatibleParameterError:
The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
FileSystemNotFound:
No Amazon FSx file systems were found based upon supplied parameters.
ServiceLimitExceeded:
An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting 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([/* ... */]);

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

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

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

When using this action, keep the following in mind:

The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

Parameter Syntax

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

Parameter Details

Members

BackupIds

Type: Array of strings

(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Filters

Type: Array of Filter structures

(Optional) Filters structure. Supported names are file-system-id and backup-type.

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'Backups' => [
        [
            'BackupId' => '<string>',
            'CreationTime' => <DateTime>,
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystem' => [
                'CreationTime' => <DateTime>,
                'DNSName' => '<string>',
                'FailureDetails' => [
                    'Message' => '<string>',
                ],
                'FileSystemId' => '<string>',
                'FileSystemType' => 'WINDOWS|LUSTRE',
                'KmsKeyId' => '<string>',
                'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING',
                'LustreConfiguration' => [
                    'DataRepositoryConfiguration' => [
                        'ExportPath' => '<string>',
                        'ImportPath' => '<string>',
                        'ImportedFileChunkSize' => <integer>,
                    ],
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
                'NetworkInterfaceIds' => ['<string>', ...],
                'OwnerId' => '<string>',
                'ResourceARN' => '<string>',
                'StorageCapacity' => <integer>,
                'SubnetIds' => ['<string>', ...],
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'VpcId' => '<string>',
                'WindowsConfiguration' => [
                    'ActiveDirectoryId' => '<string>',
                    'AutomaticBackupRetentionDays' => <integer>,
                    'CopyTagsToBackups' => true || false,
                    'DailyAutomaticBackupStartTime' => '<string>',
                    'MaintenanceOperationsInProgress' => ['<string>', ...],
                    'ThroughputCapacity' => <integer>,
                    'WeeklyMaintenanceStartTime' => '<string>',
                ],
            ],
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|DELETED|FAILED',
            'ProgressPercent' => <integer>,
            'ResourceARN' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Type' => 'AUTOMATIC|USER_INITIATED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Backups

Type: Array of Backup structures

Any array of backups.

NextToken

Type: string

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

Errors

BadRequest:
A generic error indicating a failure with a client request.
FileSystemNotFound:
No Amazon FSx file systems were found based upon supplied parameters.
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',
        ],
    ],
]

DescribeFileSystems

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

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

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

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

When using this action, keep the following in mind:

The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

Parameter Syntax

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

Parameter Details

Members

FileSystemIds

Type: Array of strings

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

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'FileSystems' => [
        [
            'CreationTime' => <DateTime>,
            'DNSName' => '<string>',
            'FailureDetails' => [
                'Message' => '<string>',
            ],
            'FileSystemId' => '<string>',
            'FileSystemType' => 'WINDOWS|LUSTRE',
            'KmsKeyId' => '<string>',
            'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING',
            'LustreConfiguration' => [
                'DataRepositoryConfiguration' => [
                    'ExportPath' => '<string>',
                    'ImportPath' => '<string>',
                    'ImportedFileChunkSize' => <integer>,
                ],
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
            'NetworkInterfaceIds' => ['<string>', ...],
            'OwnerId' => '<string>',
            'ResourceARN' => '<string>',
            'StorageCapacity' => <integer>,
            'SubnetIds' => ['<string>', ...],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
            'WindowsConfiguration' => [
                'ActiveDirectoryId' => '<string>',
                'AutomaticBackupRetentionDays' => <integer>,
                'CopyTagsToBackups' => true || false,
                'DailyAutomaticBackupStartTime' => '<string>',
                'MaintenanceOperationsInProgress' => ['<string>', ...],
                'ThroughputCapacity' => <integer>,
                'WeeklyMaintenanceStartTime' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

FileSystems

Type: Array of FileSystem structures

An array of file system descriptions.

NextToken

Type: string

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

Errors

BadRequest:
A generic error indicating a failure with a client request.
FileSystemNotFound:
No Amazon FSx file systems were found based upon supplied parameters.
InternalServerError:
A generic error indicating a server-side failure.

Examples

Example 1: To describe an Amazon FSx file system

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

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

Result syntax:

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

ListTagsForResource

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

Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.

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

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

When using this action, keep the following in mind:

The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

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

NextToken

Type: string

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

ResourceARN

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

NextToken

Type: string

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

Tags

Type: Array of Tag structures

A list of tags on the resource.

Errors

BadRequest:
A generic error indicating a failure with a client request.
InternalServerError:
A generic error indicating a server-side failure.
ResourceNotFound:
The resource specified by the Amazon Resource Name (ARN) can't be found.
NotServiceResourceError:
The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
ResourceDoesNotSupportTagging:
The resource specified does not support tagging.

Examples

Example 1: To list tags for a resource

This operation lists tags for an Amazon FSx resource.

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

Result syntax:

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

TagResource

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

Tags an Amazon FSx resource.

Parameter Syntax

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

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

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

Tags

Required: Yes
Type: Array of Tag structures

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequest:
A generic error indicating a failure with a client request.
InternalServerError:
A generic error indicating a server-side failure.
ResourceNotFound:
The resource specified by the Amazon Resource Name (ARN) can't be found.
NotServiceResourceError:
The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
ResourceDoesNotSupportTagging:
The resource specified does not support tagging.

Examples

Example 1: To tag a resource

This operation tags an Amazon FSx resource.

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

UntagResource

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

This action removes a tag from an Amazon FSx resource.

Parameter Syntax

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

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The ARN of the Amazon FSx resource to untag.

TagKeys

Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequest:
A generic error indicating a failure with a client request.
InternalServerError:
A generic error indicating a server-side failure.
ResourceNotFound:
The resource specified by the Amazon Resource Name (ARN) can't be found.
NotServiceResourceError:
The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
ResourceDoesNotSupportTagging:
The resource specified does not support tagging.

Examples

Example 1: To untag a resource

This operation untags an Amazon FSx resource.

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

UpdateFileSystem

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

Updates a file system configuration.

Parameter Syntax

$result = $client->updateFileSystem([
    'ClientRequestToken' => '<string>',
    'FileSystemId' => '<string>', // REQUIRED
    'LustreConfiguration' => [
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
    'WindowsConfiguration' => [
        'AutomaticBackupRetentionDays' => <integer>,
        'DailyAutomaticBackupStartTime' => '<string>',
        'WeeklyMaintenanceStartTime' => '<string>',
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

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

FileSystemId

Required: Yes
Type: string

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

LustreConfiguration

Type: UpdateFileSystemLustreConfiguration structure

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

WindowsConfiguration

Type: UpdateFileSystemWindowsConfiguration structure

The configuration for this Microsoft Windows file system. The only supported options are for backup and maintenance.

Result Syntax

[
    'FileSystem' => [
        'CreationTime' => <DateTime>,
        'DNSName' => '<string>',
        'FailureDetails' => [
            'Message' => '<string>',
        ],
        'FileSystemId' => '<string>',
        'FileSystemType' => 'WINDOWS|LUSTRE',
        'KmsKeyId' => '<string>',
        'Lifecycle' => 'AVAILABLE|CREATING|FAILED|DELETING',
        'LustreConfiguration' => [
            'DataRepositoryConfiguration' => [
                'ExportPath' => '<string>',
                'ImportPath' => '<string>',
                'ImportedFileChunkSize' => <integer>,
            ],
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
        'NetworkInterfaceIds' => ['<string>', ...],
        'OwnerId' => '<string>',
        'ResourceARN' => '<string>',
        'StorageCapacity' => <integer>,
        'SubnetIds' => ['<string>', ...],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
        'WindowsConfiguration' => [
            'ActiveDirectoryId' => '<string>',
            'AutomaticBackupRetentionDays' => <integer>,
            'CopyTagsToBackups' => true || false,
            'DailyAutomaticBackupStartTime' => '<string>',
            'MaintenanceOperationsInProgress' => ['<string>', ...],
            'ThroughputCapacity' => <integer>,
            'WeeklyMaintenanceStartTime' => '<string>',
        ],
    ],
]

Result Details

Members

FileSystem

Type: FileSystem structure

A description of the file system.

Errors

BadRequest:
A generic error indicating a failure with a client request.
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:
File system configuration is required for this operation.

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

Shapes

ActiveDirectoryError

Description

An Active Directory error.

Members

ActiveDirectoryId

Required: Yes
Type: string

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

Message

Type: string

A detailed error message.

Type

Type: string

The type of Active Directory error.

Backup

Description

A backup of an Amazon FSx for Windows File Server file system. You can create a new file system from a backup to protect against data loss.

Members

BackupId

Required: Yes
Type: string

The ID of the backup.

CreationTime

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

The time when a particular backup was created.

FailureDetails

Type: BackupFailureDetails structure

Details explaining any failures that occur when creating a backup.

FileSystem

Required: Yes
Type: FileSystem structure

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

KmsKeyId

Type: string

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.

Lifecycle

Required: Yes
Type: string

The lifecycle status of the backup.

ProgressPercent

Type: int

The current percent of progress of an asynchronous task.

ResourceARN

Type: string

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

Tags

Type: Array of Tag structures

Tags associated with a particular file system.

Type

Required: Yes
Type: string

The type of the backup.

BackupFailureDetails

Description

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

Members

Message

Type: string

A message describing the backup creation failure.

BackupInProgress

Description

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

Members

Message

Type: string

A detailed error message.

BackupNotFound

Description

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

Members

Message

Type: string

A detailed error message.

BackupRestoring

Description

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

Members

FileSystemId

Type: string

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

Message

Type: string

A detailed error message.

BadRequest

Description

A generic error indicating a failure with a client request.

Members

Message

Type: string

A detailed error message.

CreateFileSystemLustreConfiguration

Description

The configuration object for Lustre file systems used in the CreateFileSystem operation.

Members

ImportPath

Type: string

(Optional) The path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

ImportedFileChunkSize

Type: int

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

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

WeeklyMaintenanceStartTime

Type: string

The preferred time to perform weekly maintenance, in the UTC time zone.

CreateFileSystemWindowsConfiguration

Description

The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.

Members

ActiveDirectoryId

Type: string

The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.

AutomaticBackupRetentionDays

Type: int

The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 35 days.

CopyTagsToBackups

Type: boolean

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups.

DailyAutomaticBackupStartTime

Type: string

The preferred time to take daily automatic backups, in the UTC time zone.

ThroughputCapacity

Required: Yes
Type: int

The throughput of an Amazon FSx file system, measured in megabytes per second.

WeeklyMaintenanceStartTime

Type: string

The preferred start time to perform weekly maintenance, in the UTC time zone.

DataRepositoryConfiguration

Description

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

Members

ExportPath

Type: string

The Amazon S3 commit path to use for storing new and changed Lustre file system files as part of the archive operation from the file system to Amazon S3. The value is s3://import-bucket/FSxLustre[creationtimestamp]. The timestamp is presented in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z. Files are archived to a different prefix in the Amazon S3 bucket, preventing input data from being overwritten.

ImportPath

Type: string

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

ImportedFileChunkSize

Type: int

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

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

DeleteFileSystemWindowsConfiguration

Description

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

Members

FinalBackupTags

Type: Array of Tag structures

A set of tags for your final backup.

SkipFinalBackup

Type: boolean

By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so.

DeleteFileSystemWindowsResponse

Description

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

Members

FinalBackupId

Type: string

The ID of the final backup for this file system.

FinalBackupTags

Type: Array of Tag structures

The set of tags applied to the final backup.

FileSystem

Description

A description of a specific Amazon FSx file system.

Members

CreationTime

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

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

DNSName

Type: string

The DNS name for the file system.

FailureDetails

Type: FileSystemFailureDetails structure

Structure providing details of any failures that occur when creating the file system has failed.

FileSystemId

Type: string

The eight-digit ID of the file system that was automatically assigned by Amazon FSx.

FileSystemType

Type: string

Type of file system. Currently the only supported type is WINDOWS.

KmsKeyId

Type: string

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

Lifecycle

Type: string

The lifecycle status of the file system.

LustreConfiguration

Type: LustreFileSystemConfiguration structure

The configuration for the Amazon FSx for Lustre file system.

NetworkInterfaceIds

Type: Array of strings

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface Id. For an Amazon FSx for Lustre file system, you can have more than one.

OwnerId

Type: string

The AWS account that created the file system. If the file system was created by an IAM user, the AWS account to which the IAM user belongs is the owner.

ResourceARN

Type: string

The resource ARN of the file system.

StorageCapacity

Type: int

The storage capacity of the file system in gigabytes.

SubnetIds

Type: Array of strings

The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

Tags

Type: Array of Tag structures

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

VpcId

Type: string

The ID of the primary VPC for the file system.

WindowsConfiguration

Type: WindowsFileSystemConfiguration structure

The configuration for this Microsoft Windows file system.

FileSystemFailureDetails

Description

Structure providing details of any failures that occur when creating the file system has failed.

Members

Message

Type: string

Message describing the failures that occurred during file system creation.

FileSystemNotFound

Description

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

Members

Message

Type: string

A detailed error message.

Filter

Description

A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.

Members

Name

Type: string

The name for this filter.

Values

Type: Array of strings

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

IncompatibleParameterError

Description

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.

Members

Message

Type: string

A detailed error message.

Parameter

Required: Yes
Type: string

A parameter that is incompatible with the earlier request.

InternalServerError

Description

A generic error indicating a server-side failure.

Members

Message

Type: string

A detailed error message.

InvalidImportPath

Description

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

Members

Message

Type: string

A detailed error message.

InvalidNetworkSettings

Description

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.

Members

InvalidSecurityGroupId

Type: string

The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security Groups for Linux Instances in the Amazon EC2 User Guide.

InvalidSubnetId

Type: string

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

Message

Type: string

A detailed error message.

LustreFileSystemConfiguration

Description

The configuration for the Amazon FSx for Lustre file system.

Members

DataRepositoryConfiguration

Type: DataRepositoryConfiguration structure

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

WeeklyMaintenanceStartTime

Type: string

The UTC time that you want to begin your weekly maintenance window.

MissingFileSystemConfiguration

Description

File system configuration is required for this operation.

Members

Message

Type: string

A detailed error message.

NotServiceResourceError

Description

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.

Members

Message

Type: string

A detailed error message.

ResourceARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the non-Amazon FSx resource.

ResourceDoesNotSupportTagging

Description

The resource specified does not support tagging.

Members

Message

Type: string

A detailed error message.

ResourceARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource that doesn't support tagging.

ResourceNotFound

Description

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

Members

Message

Type: string

A detailed error message.

ResourceARN

Required: Yes
Type: string

The resource ARN of the resource that can't be found.

ServiceLimitExceeded

Description

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

Members

Limit

Required: Yes
Type: string

Enumeration of the service limit that was exceeded.

Message

Type: string

A detailed error message.

Tag

Description

Specifies a key-value pair for a resource tag.

Members

Key

Type: string

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

Value

Type: string

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

UpdateFileSystemLustreConfiguration

Description

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

Members

WeeklyMaintenanceStartTime

Type: string

The preferred time to perform weekly maintenance, in the UTC time zone.

UpdateFileSystemWindowsConfiguration

Description

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

Members

AutomaticBackupRetentionDays

Type: int

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

DailyAutomaticBackupStartTime

Type: string

The preferred time to take daily automatic backups, in the UTC time zone.

WeeklyMaintenanceStartTime

Type: string

The preferred time to perform weekly maintenance, in the UTC time zone.

WindowsFileSystemConfiguration

Description

The configuration for this Microsoft Windows file system.

Members

ActiveDirectoryId

Type: string

The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.

AutomaticBackupRetentionDays

Type: int

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

CopyTagsToBackups

Type: boolean

DailyAutomaticBackupStartTime

Type: string

The preferred time to take daily automatic backups, in the UTC time zone.

MaintenanceOperationsInProgress

Type: Array of strings

The list of maintenance operations in progress for this file system.

ThroughputCapacity

Type: int

The throughput of an Amazon FSx file system, measured in megabytes per second.

WeeklyMaintenanceStartTime

Type: string

The preferred time to perform weekly maintenance, in the UTC time zone.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon FSx 2018-03-01

Operation Summary

Paginators

Operations

CreateBackup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a new backup

CreateFileSystem

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a new file system

CreateFileSystemFromBackup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a new file system from backup

DeleteBackup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To delete a backup

DeleteFileSystem

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To delete a file system

DescribeBackups

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To describe Amazon FSx backups

DescribeFileSystems

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To describe an Amazon FSx file system