"FileSystemId": "fs-0123456789abcdef0", "Type": "EXPORT_TO_REPOSITORY",
"Paths": ["path1", "path2/file1"], "Report": {
"Enabled":true,
"Path":"s3://myBucket/FSxLustre20191118T225838Z/myreports", "Format":"REPORT_CSV_20191124",
"Scope":"FAILED_FILES_ONLY"
}, }
Sample Response
HTTP/1.1 200 success
x-amzn-RequestId: c3616af3-33fa-40ad-ae0d-d3895a2c3a1f
See Also
{ "Task": {
"TaskId": "task-0123456789abcdef1", "TaskType": "EXPORT_TO_REPOSITORY", "Lifecycle": "PENDING",
"FileSystemId": "fs-0123456789abcdef0", "Paths": ["path1", "path2/file1"], "TaskReport": {
"Path":"s3://myBucket/FSxLustre20191118T225838Z/myreports", "Format":"REPORT_CSV_20191124",
"Enabled":true,
"Scope":"FAILED_FILES_ONLY"
},
"Tags": [],
"CreationTime": "2018-12-17T18:18:18.000Z", "ClientRequestToken": "10192019-drt-12",
"ResourceARN": "arn:aws:fsx:us-east-1:123456789012:task:task-123f8cd8e330c1321"
} }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateFileSystem
CreateFileSystem
Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:
• Amazon FSx for Lustre
• Amazon FSx for NetApp ONTAP
• Amazon FSx for OpenZFS
• Amazon FSx for Windows File Server
This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns
IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
• Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
• Returns the description of the file system.
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 a success message as long as the parameters are the same.
NoteThe 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.
Request Syntax
{ "ClientRequestToken": "string", "FileSystemType": "string",
"FileSystemTypeVersion": "string", "KmsKeyId": "string",
"LustreConfiguration": { "AutoImportPolicy": "string",
"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string",
"DeploymentType": "string",
Request Syntax
"DriveCacheType": "string", "ExportPath": "string",
"ImportedFileChunkSize": number, "ImportPath": "string",
"LogConfiguration": { "Destination": "string", "Level": "string"
},
"PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string"
},
"OntapConfiguration": {
"AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",
"DiskIopsConfiguration": { "Iops": number,
"Mode": "string"
},
"EndpointIpAddressRange": "string", "FsxAdminPassword": "string", "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
},
"OpenZFSConfiguration": {
"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,
"CopyTagsToVolumes": boolean,
"DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",
"DiskIopsConfiguration": { "Iops": number,
"Mode": "string"
},
"RootVolumeConfiguration": { "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "NfsExports": [
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
},
"SecurityGroupIds": [ "string" ], "StorageCapacity": number,
"StorageType": "string", "SubnetIds": [ "string" ],
Request Parameters
"Tags": [ {
"Key": "string", "Value": "string"
} ],
"WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ "string" ], "AuditLogConfiguration": {
"AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string"
},
"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",
"PreferredSubnetId": "string",
"SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ],
"DomainName": "string",
"FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "Password": "string",
"UserName": "string"
},
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
}}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 343).
The request accepts the following data in JSON format.
ClientRequestToken (p. 42)
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: [A-za-z0-9_.-]{0,63}$
Required: No FileSystemType (p. 42)
The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.
Type: String
Valid Values: WINDOWS | LUSTRE | ONTAP | OPENZFS Required: Yes
Request Parameters
FileSystemTypeVersion (p. 42)
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10 and 2.12:
• 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
• 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.
Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.
Note
If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: ^[0-9](.[0-9]*)*$
Required: No KmsKeyId (p. 42)
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 file systems at rest. If this ID isn't specified, the key managed by Amazon FSx is used. The Amazon FSx for Lustre SCRATCH_1 and SCRATCH_2 file systems are always encrypted at rest using Amazon FSx-managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^.{1,2048}$
Required: No
LustreConfiguration (p. 42)
The Lustre configuration for the file system being created.
NoteThe following parameters are not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.
• AutoImportPolicy
• ExportPath
• ImportedChunkSize
• ImportPath
Type: CreateFileSystemLustreConfiguration (p. 220) object Required: No
OntapConfiguration (p. 42)
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
Request Parameters
Type: CreateFileSystemOntapConfiguration (p. 225) object Required: No
OpenZFSConfiguration (p. 42)
The OpenZFS configuration for the file system that's being created.
Type: CreateFileSystemOpenZFSConfiguration (p. 228) object Required: No
SecurityGroupIds (p. 42)
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Minimum length of 11. Maximum length of 20.
Pattern: ^(sg-[0-9a-f]{8,})$
Required: No StorageCapacity (p. 42)
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType, as follows:
• For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
• For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
• For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).
FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:
• For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
• For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
Required: Yes StorageType (p. 42)
Sets the storage type for the file system that you're creating. Valid values are SSD and HDD.
• Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.
Response Syntax
• Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.
Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.
Type: String
Valid Values: SSD | HDD Required: No
SubnetIds (p. 42)
Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration >
PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Minimum length of 15. Maximum length of 24.
Pattern: ^(subnet-[0-9a-f]{8,})$
Required: Yes Tags (p. 42)
The tags to apply to the file system that's being created. The key value of the Name tag appears in the console as the file system name.
Type: Array of Tag (p. 315) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
WindowsConfiguration (p. 42)
The Microsoft Windows configuration for the file system that's being created.
Type: CreateFileSystemWindowsConfiguration (p. 231) object Required: No
Response Syntax
{ "FileSystem": {
"AdministrativeActions": [ {
"AdministrativeActionType": "string",
Response Syntax
Response Syntax
"FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string",
"Lifecycle": "string", "LustreConfiguration": {
"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string",
"DataRepositoryConfiguration": {
"PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string"
},
"NetworkInterfaceIds": [ "string" ],
Response Syntax
"OntapConfiguration": {
"AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",
"DiskIopsConfiguration": { "Iops": number,
"Mode": "string"
},
"EndpointIpAddressRange": "string", "Endpoints": {
"WeeklyMaintenanceStartTime": "string"
},
"OpenZFSConfiguration": {
"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,
"CopyTagsToVolumes": boolean,
"DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",
"WeeklyMaintenanceStartTime": "string"
},
"OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "FileShareAccessAuditLogLevel": "string"
},
"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string",
Response Elements
"DeploymentType": "string",
"MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string",
"PreferredSubnetId": "string",
"RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ],
"DomainName": "string",
"FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string"
},
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
} } }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
FileSystem (p. 47)
The configuration of the file system that was created.
Type: FileSystem (p. 264) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 345).
ActiveDirectoryError An Active Directory error.
HTTP Status Code: 400 BadRequest
A generic error indicating a failure with a client request.
HTTP Status Code: 400 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.
HTTP Status Code: 400 InternalServerError
A generic error indicating a server-side failure.
HTTP Status Code: 500 InvalidExportPath
The path provided for data repository export isn't valid.
See Also
HTTP Status Code: 400 InvalidImportPath
The path provided for data repository import isn't valid.
HTTP Status Code: 400 InvalidNetworkSettings
One or more network settings specified in the request are invalid.
HTTP Status Code: 400
InvalidPerUnitStorageThroughput
An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
HTTP Status Code: 400 MissingFileSystemConfiguration
A file system configuration is required for this operation.
HTTP Status Code: 400 ServiceLimitExceeded
An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateFileSystemFromBackup
CreateFileSystemFromBackup
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a file system with the specified client request token exists but the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
• Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
• Returns the description of the file system.
Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.
NoteThe 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.
Request Syntax
{ "BackupId": "string",
"ClientRequestToken": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string",
"LustreConfiguration": { "AutoImportPolicy": "string",
"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string",
"DeploymentType": "string", "DriveCacheType": "string", "ExportPath": "string",
"ImportedFileChunkSize": number, "ImportPath": "string",
"LogConfiguration": { "Destination": "string", "Level": "string"
},
"PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string"
},
"OpenZFSConfiguration": {
"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,
"CopyTagsToVolumes": boolean,
"DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",
Request Syntax
"DiskIopsConfiguration": { "Iops": number,
"Mode": "string"
},
"RootVolumeConfiguration": { "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "NfsExports": [
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
},
"SecurityGroupIds": [ "string" ], "StorageType": "string",
"SubnetIds": [ "string" ], "Tags": [
"WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ "string" ], "AuditLogConfiguration": {
"AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string"
},
"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",
"PreferredSubnetId": "string",
"SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ],
"DomainName": "string",
"FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "Password": "string",
"UserName": "string"
},
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
}}
Request Parameters
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 343).
The request accepts the following data in JSON format.
BackupId (p. 53)
The ID of the source backup. Specifies the backup that you are copying.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 128.
Pattern: ^(backup-[0-9a-f]{8,})$
Required: Yes
ClientRequestToken (p. 53)
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: [A-za-z0-9_.-]{0,63}$
Required: No
FileSystemTypeVersion (p. 53)
Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10 and 2.12.
You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: ^[0-9](.[0-9]*)*$
Required: No KmsKeyId (p. 53)
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 file systems at rest. If this ID isn't specified, the key managed by Amazon FSx is used. The Amazon FSx for Lustre SCRATCH_1 and SCRATCH_2 file systems are always encrypted at rest using Amazon FSx-managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Request Parameters
Pattern: ^.{1,2048}$
Required: No
LustreConfiguration (p. 53)
The Lustre configuration for the file system being created.
NoteThe following parameters are not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.
• AutoImportPolicy
• ExportPath
• ImportedChunkSize
• ImportPath
Type: CreateFileSystemLustreConfiguration (p. 220) object Required: No
OpenZFSConfiguration (p. 53)
The OpenZFS configuration for the file system that's being created.
Type: CreateFileSystemOpenZFSConfiguration (p. 228) object Required: No
SecurityGroupIds (p. 53)
A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.
Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Minimum length of 11. Maximum length of 20.
Pattern: ^(sg-[0-9a-f]{8,})$
Required: No StorageType (p. 53)
Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup.
Valid values are SSD and HDD.
• Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.
• Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.
The default value is SSD.
NoteHDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.
Response Syntax
Type: String
Valid Values: SSD | HDD Required: No
SubnetIds (p. 53)
Specifies the IDs of the subnets that the file system will be accessible from. For Windows
MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.
Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and
Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and