# Actions The following actions are supported: + [AssociateFileSystemAliases](API_AssociateFileSystemAliases.md) + [CancelDataRepositoryTask](API_CancelDataRepositoryTask.md) + [CopyBackup](API_CopyBackup.md) + [CopySnapshotAndUpdateVolume](API_CopySnapshotAndUpdateVolume.md) + [CreateAndAttachS3AccessPoint](API_CreateAndAttachS3AccessPoint.md) + [CreateBackup](API_CreateBackup.md) + [CreateDataRepositoryAssociation](API_CreateDataRepositoryAssociation.md) + [CreateDataRepositoryTask](API_CreateDataRepositoryTask.md) + [CreateFileCache](API_CreateFileCache.md) + [CreateFileSystem](API_CreateFileSystem.md) + [CreateFileSystemFromBackup](API_CreateFileSystemFromBackup.md) + [CreateSnapshot](API_CreateSnapshot.md) + [CreateStorageVirtualMachine](API_CreateStorageVirtualMachine.md) + [CreateVolume](API_CreateVolume.md) + [CreateVolumeFromBackup](API_CreateVolumeFromBackup.md) + [DeleteBackup](API_DeleteBackup.md) + [DeleteDataRepositoryAssociation](API_DeleteDataRepositoryAssociation.md) + [DeleteFileCache](API_DeleteFileCache.md) + [DeleteFileSystem](API_DeleteFileSystem.md) + [DeleteSnapshot](API_DeleteSnapshot.md) + [DeleteStorageVirtualMachine](API_DeleteStorageVirtualMachine.md) + [DeleteVolume](API_DeleteVolume.md) + [DescribeBackups](API_DescribeBackups.md) + [DescribeDataRepositoryAssociations](API_DescribeDataRepositoryAssociations.md) + [DescribeDataRepositoryTasks](API_DescribeDataRepositoryTasks.md) + [DescribeFileCaches](API_DescribeFileCaches.md) + [DescribeFileSystemAliases](API_DescribeFileSystemAliases.md) + [DescribeFileSystems](API_DescribeFileSystems.md) + [DescribeS3AccessPointAttachments](API_DescribeS3AccessPointAttachments.md) + [DescribeSharedVpcConfiguration](API_DescribeSharedVpcConfiguration.md) + [DescribeSnapshots](API_DescribeSnapshots.md) + [DescribeStorageVirtualMachines](API_DescribeStorageVirtualMachines.md) + [DescribeVolumes](API_DescribeVolumes.md) + [DetachAndDeleteS3AccessPoint](API_DetachAndDeleteS3AccessPoint.md) + [DisassociateFileSystemAliases](API_DisassociateFileSystemAliases.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ReleaseFileSystemNfsV3Locks](API_ReleaseFileSystemNfsV3Locks.md) + [RestoreVolumeFromSnapshot](API_RestoreVolumeFromSnapshot.md) + [StartMisconfiguredStateRecovery](API_StartMisconfiguredStateRecovery.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateDataRepositoryAssociation](API_UpdateDataRepositoryAssociation.md) + [UpdateFileCache](API_UpdateFileCache.md) + [UpdateFileSystem](API_UpdateFileSystem.md) + [UpdateSharedVpcConfiguration](API_UpdateSharedVpcConfiguration.md) + [UpdateSnapshot](API_UpdateSnapshot.md) + [UpdateStorageVirtualMachine](API_UpdateStorageVirtualMachine.md) + [UpdateVolume](API_UpdateVolume.md) # AssociateFileSystemAliases Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see [Working with DNS Aliases](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) and [Walkthrough 5: Using DNS aliases to access your file system](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html), including additional steps you must take to be able to access your file system using a DNS alias. The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the [DescribeFileSystemAliases](API_DescribeFileSystemAliases.md) API operation to monitor the status of the aliases Amazon FSx is associating with the file system. ## Request Syntax ``` { "Aliases": [ "string" ], "ClientRequestToken": "string", "FileSystemId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Aliases](#API_AssociateFileSystemAliases_RequestSyntax) ** An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements: + Formatted as a fully-qualified domain name (FQDN), * `hostname.domain` *, for example, `accounting.corp.example.com`. + Can contain alphanumeric characters and the hyphen (-). + Cannot start or end with a hyphen. + Can start with a numeric. For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 4. Maximum length of 253. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{4,253}$` Required: Yes ** [ClientRequestToken](#API_AssociateFileSystemAliases_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [FileSystemId](#API_AssociateFileSystemAliases_RequestSyntax) ** Specifies the file system with which you want to associate one or more DNS aliases. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ## Response Syntax ``` { "Aliases": [ { "Lifecycle": "string", "Name": "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. ** [Aliases](#API_AssociateFileSystemAliases_ResponseSyntax) ** An array of the DNS aliases that Amazon FSx is associating with the file system. Type: Array of [Alias](API_Alias.md) objects Array Members: Maximum number of 50 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/AssociateFileSystemAliases) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/AssociateFileSystemAliases) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/AssociateFileSystemAliases) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/AssociateFileSystemAliases) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/AssociateFileSystemAliases) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/AssociateFileSystemAliases) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/AssociateFileSystemAliases) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/AssociateFileSystemAliases) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/AssociateFileSystemAliases) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/AssociateFileSystemAliases) # CancelDataRepositoryTask Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the `PENDING` or `EXECUTING` state. When you cancel an export task, Amazon FSx does the following. + Any files that FSx has already exported are not reverted. + FSx continues to export any files that are in-flight when the cancel operation is received. + FSx does not export any files that have not yet been exported. For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state. ## Request Syntax ``` { "TaskId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [TaskId](#API_CancelDataRepositoryTask_RequestSyntax) ** Specifies the data repository task to cancel. Type: String Length Constraints: Minimum length of 12. Maximum length of 128. Pattern: `^(task-[0-9a-f]{17,})$` Required: Yes ## Response Syntax ``` { "Lifecycle": "string", "TaskId": "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. ** [Lifecycle](#API_CancelDataRepositoryTask_ResponseSyntax) ** The lifecycle status of the data repository task, as follows: + `PENDING` - Amazon FSx has not started the task. + `EXECUTING` - Amazon FSx is processing the task. + `FAILED` - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The [DataRepositoryTaskFailureDetails](API_DataRepositoryTaskFailureDetails.md) property provides more information about task failures. + `SUCCEEDED` - FSx completed the task successfully. + `CANCELED` - Amazon FSx canceled the task and it did not complete. + `CANCELING` - FSx is in process of canceling the task. Type: String Valid Values: `PENDING | EXECUTING | FAILED | SUCCEEDED | CANCELED | CANCELING` ** [TaskId](#API_CancelDataRepositoryTask_ResponseSyntax) ** The ID of the task being canceled. Type: String Length Constraints: Minimum length of 12. Maximum length of 128. Pattern: `^(task-[0-9a-f]{17,})$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** DataRepositoryTaskEnded ** The data repository task could not be canceled because the task has already ended. ** Message ** A detailed error message. HTTP Status Code: 400 ** DataRepositoryTaskNotFound ** The data repository task or tasks you specified could not be found. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. HTTP Status Code: 400 ## Examples ### Cancel a Data Repository Task The following request cancels a specific data repository task by using the TaskId request parameter. #### Sample Request ``` POST /2015-02-01/cancel-data-repository-task HTTP/1.1 { "TaskId": ["task-0123456789abcdef0"] } ``` #### Sample Response ``` HTTP/1.1 200 success x-amzn-RequestId: 12345678-1234-abcd-5678-0123456789abc { "Status": "CANCELING", "TaskId": "task-0123456789abcdef0" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CancelDataRepositoryTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CancelDataRepositoryTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CancelDataRepositoryTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CancelDataRepositoryTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CancelDataRepositoryTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CancelDataRepositoryTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CancelDataRepositoryTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CancelDataRepositoryTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CancelDataRepositoryTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CancelDataRepositoryTask) # CopyBackup Copies an existing backup within the same AWS account to another AWS Region (cross-Region copy) or within the same AWS Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account. You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your AWS partition. A partition is a grouping of Regions. AWS currently has three partitions: `aws` (Standard Regions), `aws-cn` (China Regions), and `aws-us-gov` (AWS GovCloud [US] Regions). You can also use backup copies to clone your file dataset to another Region or within the same Region. You can use the `SourceRegion` parameter to specify the AWS Region from which the backup will be copied. For example, if you make the call from the `us-west-1` Region and want to copy a backup from the `us-east-2` Region, you specify `us-east-2` in the `SourceRegion` parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy). For more information about creating backup copies, see [ Copying backups](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#copy-backups) in the *Amazon FSx for Windows User Guide*, [Copying backups](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html#copy-backups) in the *Amazon FSx for Lustre User Guide*, and [Copying backups](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html#copy-backups) in the *Amazon FSx for OpenZFS User Guide*. ## Request Syntax ``` { "ClientRequestToken": "string", "CopyTags": boolean, "KmsKeyId": "string", "SourceBackupId": "string", "SourceRegion": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_CopyBackup_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [CopyTags](#API_CopyBackup_RequestSyntax) ** A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to `false`. If you set `CopyTags` to `true` and the source backup has existing tags, you can use the `Tags` parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the `Tags` parameter take precedence. Type: Boolean Required: No ** [KmsKeyId](#API_CopyBackup_RequestSyntax) ** Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on Amazon FSx file systems, as follows: + Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment types only. `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon FSx service AWS KMS key for your account. + Amazon FSx for NetApp ONTAP + Amazon FSx for OpenZFS + Amazon FSx for Windows File Server If a `KmsKeyId` isn't specified, the Amazon FSx-managed AWS KMS key for your account is used. For more information, see [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) 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 ** [SourceBackupId](#API_CopyBackup_RequestSyntax) ** The ID of the source backup. Specifies the ID of the backup that's being copied. Type: String Length Constraints: Minimum length of 12. Maximum length of 128. Pattern: `^(backup-[0-9a-f]{8,})$` Required: Yes ** [SourceRegion](#API_CopyBackup_RequestSyntax) ** The source AWS Region of the backup. Specifies the AWS Region from which the backup is being copied. The source and destination Regions must be in the same AWS partition. If you don't specify a Region, `SourceRegion` defaults to the Region where the request is sent from (in-Region copy). Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: `^[a-z0-9-]{1,20}$` Required: No ** [Tags](#API_CopyBackup_RequestSyntax) ** A list of `Tag` values, with a maximum of 50 elements. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ## Response Syntax ``` { "Backup": { "BackupId": "string", "CreationTime": number, "DirectoryInformation": { "ActiveDirectoryId": "string", "DomainName": "string", "ResourceARN": "string" }, "FailureDetails": { "Message": "string" }, "FileSystem": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "KmsKeyId": "string", "Lifecycle": "string", "OwnerId": "string", "ProgressPercent": number, "ResourceARN": "string", "ResourceType": "string", "SizeInBytes": number, "SourceBackupId": "string", "SourceBackupRegion": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Volume": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": "Volume", "TotalTransferBytes": number } ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "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. ** [Backup](#API_CopyBackup_ResponseSyntax) ** A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. Type: [Backup](API_Backup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BackupNotFound ** No Amazon FSx backups were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** IncompatibleRegionForMultiAZ ** Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** InvalidDestinationKmsKey ** The AWS Key Management Service (AWS KMS) key of the destination backup is not valid. ** Message ** A detailed error message. HTTP Status Code: 400 ** InvalidRegion ** The Region provided for `SourceRegion` is not valid or is in a different AWS partition. ** Message ** A detailed error message. HTTP Status Code: 400 ** InvalidSourceKmsKey ** The AWS Key Management Service (AWS KMS) key of the source backup is not valid. ** Message ** A detailed error message. 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. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** SourceBackupUnavailable ** The request was rejected because the lifecycle status of the source backup isn't `AVAILABLE`. ** BackupId ** The ID of the source backup. Specifies the backup that you are copying. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CopyBackup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CopyBackup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CopyBackup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CopyBackup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CopyBackup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CopyBackup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CopyBackup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CopyBackup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CopyBackup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CopyBackup) # CopySnapshotAndUpdateVolume Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see [on-demand data replication](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/on-demand-replication.html) in the Amazon FSx for OpenZFS User Guide. ## Request Syntax ``` { "ClientRequestToken": "string", "CopyStrategy": "string", "Options": [ "string" ], "SourceSnapshotARN": "string", "VolumeId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_CopySnapshotAndUpdateVolume_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [CopyStrategy](#API_CopySnapshotAndUpdateVolume_RequestSyntax) ** Specifies the strategy to use when copying data from a snapshot to the volume. + `FULL_COPY` - Copies all data from the snapshot to the volume. + `INCREMENTAL_COPY` - Copies only the snapshot data that's changed since the previous replication. `CLONE` isn't a valid copy strategy option for the `CopySnapshotAndUpdateVolume` operation. Type: String Valid Values: `CLONE | FULL_COPY | INCREMENTAL_COPY` Required: No ** [Options](#API_CopySnapshotAndUpdateVolume_RequestSyntax) ** Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication. Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include `DELETE_INTERMEDIATE_SNAPSHOTS` and there are intermediate snapshots on the destination, you can’t copy the snapshot. + `DELETE_INTERMEDIATE_SNAPSHOTS` - Deletes snapshots on the destination volume that aren’t on the source volume. + `DELETE_CLONED_VOLUMES` - Deletes snapshot clones on the destination volume that aren't on the source volume. + `DELETE_INTERMEDIATE_DATA` - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying. Type: Array of strings Valid Values: `DELETE_INTERMEDIATE_SNAPSHOTS | DELETE_CLONED_VOLUMES | DELETE_INTERMEDIATE_DATA` Required: No ** [SourceSnapshotARN](#API_CopySnapshotAndUpdateVolume_RequestSyntax) ** The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*. Type: String Length Constraints: Minimum length of 8. Maximum length of 512. Pattern: `^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(? Specifies the ID of the volume that you are copying the snapshot to. Type: String Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` Required: Yes ## Response Syntax ``` { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "Lifecycle": "string", "VolumeId": "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. ** [AdministrativeActions](#API_CopySnapshotAndUpdateVolume_ResponseSyntax) ** A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. Type: Array of [AdministrativeAction](API_AdministrativeAction.md) objects Array Members: Maximum number of 50 items. ** [Lifecycle](#API_CopySnapshotAndUpdateVolume_ResponseSyntax) ** The lifecycle state of the destination volume. Type: String Valid Values: `CREATING | CREATED | DELETING | FAILED | MISCONFIGURED | PENDING | AVAILABLE` ** [VolumeId](#API_CopySnapshotAndUpdateVolume_ResponseSyntax) ** The ID of the volume that you copied the snapshot to. Type: String Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CopySnapshotAndUpdateVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CopySnapshotAndUpdateVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CopySnapshotAndUpdateVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CopySnapshotAndUpdateVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CopySnapshotAndUpdateVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CopySnapshotAndUpdateVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CopySnapshotAndUpdateVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CopySnapshotAndUpdateVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CopySnapshotAndUpdateVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CopySnapshotAndUpdateVolume) # CreateAndAttachS3AccessPoint Creates an S3 access point and attaches it to an Amazon FSx volume. For FSx for OpenZFS file systems, the volume must be hosted on a high-availability file system, either Single-AZ or Multi-AZ. For more information, see [Accessing your data using Amazon S3 access points](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/s3accesspoints-for-FSx.html). in the Amazon FSx for OpenZFS User Guide. The requester requires the following permissions to perform these actions: + `fsx:CreateAndAttachS3AccessPoint` + `s3:CreateAccessPoint` + `s3:GetAccessPoint` + `s3:PutAccessPointPolicy` + `s3:DeleteAccessPoint` The following actions are related to `CreateAndAttachS3AccessPoint`: + [DescribeS3AccessPointAttachments](API_DescribeS3AccessPointAttachments.md) + [DetachAndDeleteS3AccessPoint](API_DetachAndDeleteS3AccessPoint.md) ## Request Syntax ``` { "ClientRequestToken": "string", "Name": "string", "OntapConfiguration": { "FileSystemIdentity": { "Type": "string", "UnixUser": { "Name": "string" }, "WindowsUser": { "Name": "string" } }, "VolumeId": "string" }, "OpenZFSConfiguration": { "FileSystemIdentity": { "PosixUser": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Type": "string" }, "VolumeId": "string" }, "S3AccessPoint": { "Policy": "string", "VpcConfiguration": { "VpcId": "string" } }, "Type": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_CreateAndAttachS3AccessPoint_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [Name](#API_CreateAndAttachS3AccessPoint_RequestSyntax) ** The name you want to assign to this S3 access point. Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Pattern: `^(?=[a-z0-9])[a-z0-9-]{1,48}[a-z0-9]$` Required: Yes ** [OntapConfiguration](#API_CreateAndAttachS3AccessPoint_RequestSyntax) ** Specifies the FSx for ONTAP volume that the S3 access point will be attached to, and the file system user identity. Type: [CreateAndAttachS3AccessPointOntapConfiguration](API_CreateAndAttachS3AccessPointOntapConfiguration.md) object Required: No ** [OpenZFSConfiguration](#API_CreateAndAttachS3AccessPoint_RequestSyntax) ** Specifies the configuration to use when creating and attaching an S3 access point to an FSx for OpenZFS volume. Type: [CreateAndAttachS3AccessPointOpenZFSConfiguration](API_CreateAndAttachS3AccessPointOpenZFSConfiguration.md) object Required: No ** [S3AccessPoint](#API_CreateAndAttachS3AccessPoint_RequestSyntax) ** Specifies the virtual private cloud (VPC) configuration if you're creating an access point that is restricted to a VPC. For more information, see [Creating access points restricted to a virtual private cloud](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/access-points-vpc.html). Type: [CreateAndAttachS3AccessPointS3Configuration](API_CreateAndAttachS3AccessPointS3Configuration.md) object Required: No ** [Type](#API_CreateAndAttachS3AccessPoint_RequestSyntax) ** The type of S3 access point you want to create. Only `OpenZFS` is supported. Type: String Valid Values: `OPENZFS | ONTAP` Required: Yes ## Response Syntax ``` { "S3AccessPointAttachment": { "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "FileSystemIdentity": { "Type": "string", "UnixUser": { "Name": "string" }, "WindowsUser": { "Name": "string" } }, "VolumeId": "string" }, "OpenZFSConfiguration": { "FileSystemIdentity": { "PosixUser": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Type": "string" }, "VolumeId": "string" }, "S3AccessPoint": { "Alias": "string", "ResourceARN": "string", "VpcConfiguration": { "VpcId": "string" } }, "Type": "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. ** [S3AccessPointAttachment](#API_CreateAndAttachS3AccessPoint_ResponseSyntax) ** Describes the configuration of the S3 access point created. Type: [S3AccessPointAttachment](API_S3AccessPointAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessPointAlreadyOwnedByYou ** An access point with that name already exists in the AWS Region in your AWS account. ** ErrorCode ** An error code indicating that an access point with that name already exists in the AWS Region in your AWS account. ** Message ** A detailed error message. HTTP Status Code: 400 ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** InvalidAccessPoint ** The access point specified doesn't exist. ** ErrorCode ** An error code indicating that the access point specified doesn't exist. ** Message ** A detailed error message. HTTP Status Code: 400 ** InvalidRequest ** The action or operation requested is invalid. Verify that the action is typed correctly. ** ErrorCode ** An error code indicating that the action or operation requested is invalid. ** Message ** A detailed error message. HTTP Status Code: 400 ** TooManyAccessPoints ** You have reached the maximum number of S3 access points attachments allowed for your account in this AWS Region, or for the file system. For more information, or to request an increase, see [Service quotas on FSx resources](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/limits.html) in the FSx for OpenZFS User Guide. ** ErrorCode ** An error code indicating that you have reached the maximum number of S3 access points attachments allowed for your account in this AWS Region, or for the file system. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. HTTP Status Code: 400 ** VolumeNotFound ** No Amazon FSx volumes were found based upon the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateAndAttachS3AccessPoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateAndAttachS3AccessPoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateAndAttachS3AccessPoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateAndAttachS3AccessPoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateAndAttachS3AccessPoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateAndAttachS3AccessPoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateAndAttachS3AccessPoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateAndAttachS3AccessPoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateAndAttachS3AccessPoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateAndAttachS3AccessPoint) # CreateBackup Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume. For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration: + A Persistent deployment type + Are *not* linked to a data repository For more information about backups, see the following: + For Amazon FSx for Lustre, see [Working with FSx for Lustre backups](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html). + For Amazon FSx for Windows, see [Working with FSx for Windows backups](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html). + For Amazon FSx for NetApp ONTAP, see [Working with FSx for NetApp ONTAP backups](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/using-backups.html). + For Amazon FSx for OpenZFS, see [Working with FSx for OpenZFS backups](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html). If a backup with the specified client request token exists and the parameters match, this operation returns the description of the existing backup. If a backup with the specified client request token exists and the parameters don't match, this operation returns `IncompatibleParameterError`. If a backup with the specified client request token doesn't exist, `CreateBackup` does the following: + Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of `CREATING`. + Returns the description of the backup. By using the idempotent operation, you can retry a `CreateBackup` operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same. The `CreateBackup` operation returns while the backup's lifecycle state is still `CREATING`. You can check the backup creation status by calling the [DescribeBackups](https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeBackups.html) operation, which returns the backup state along with other information. ## Request Syntax ``` { "ClientRequestToken": "string", "FileSystemId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_CreateBackup_RequestSyntax) ** (Optional) A string of up to 63 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 ** [FileSystemId](#API_CreateBackup_RequestSyntax) ** The ID of the file system to back up. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: No ** [Tags](#API_CreateBackup_RequestSyntax) ** (Optional) 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. If you have set `CopyTagsToBackups` to `true`, and you specify one or more tags using the `CreateBackup` operation, no existing file system tags are copied from the file system to the backup. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ** [VolumeId](#API_CreateBackup_RequestSyntax) ** (Optional) The ID of the FSx for ONTAP volume to back up. Type: String Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` Required: No ## Response Syntax ``` { "Backup": { "BackupId": "string", "CreationTime": number, "DirectoryInformation": { "ActiveDirectoryId": "string", "DomainName": "string", "ResourceARN": "string" }, "FailureDetails": { "Message": "string" }, "FileSystem": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "KmsKeyId": "string", "Lifecycle": "string", "OwnerId": "string", "ProgressPercent": number, "ResourceARN": "string", "ResourceType": "string", "SizeInBytes": number, "SourceBackupId": "string", "SourceBackupRegion": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Volume": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": "Volume", "TotalTransferBytes": number } ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "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. ** [Backup](#API_CreateBackup_ResponseSyntax) ** A description of the backup. Type: [Backup](API_Backup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BackupInProgress ** Another backup is already under way. Wait for completion before initiating additional backups of this file system. ** Message ** A detailed error message. HTTP Status Code: 400 ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. HTTP Status Code: 400 ** VolumeNotFound ** No Amazon FSx volumes were found based upon the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateBackup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateBackup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateBackup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateBackup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateBackup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateBackup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateBackup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateBackup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateBackup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateBackup) # CreateDataRepositoryAssociation Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding `scratch_1` deployment type. Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html). **Note** `CreateDataRepositoryAssociation` isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the `CreateFileCache` operation. ## Request Syntax ``` { "BatchImportMetaDataOnCreate": boolean, "ClientRequestToken": "string", "DataRepositoryPath": "string", "FileSystemId": "string", "FileSystemPath": "string", "ImportedFileChunkSize": number, "S3": { "AutoExportPolicy": { "Events": [ "string" ] }, "AutoImportPolicy": { "Events": [ "string" ] } }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [BatchImportMetaDataOnCreate](#API_CreateDataRepositoryAssociation_RequestSyntax) ** Set to `true` to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is `false`. Type: Boolean Required: No ** [ClientRequestToken](#API_CreateDataRepositoryAssociation_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [DataRepositoryPath](#API_CreateDataRepositoryAssociation_RequestSyntax) ** The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format `s3://bucket-name/prefix/` (where `prefix` is optional). This path specifies where in the S3 data repository files will be imported from or exported to. Type: String Length Constraints: Minimum length of 3. Maximum length of 4357. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{3,4357}$` Required: Yes ** [FileSystemId](#API_CreateDataRepositoryAssociation_RequestSyntax) ** The globally unique ID of the file system, assigned by Amazon FSx. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ** [FileSystemPath](#API_CreateDataRepositoryAssociation_RequestSyntax) ** A path on the file system that points to a high-level directory (such as `/ns1/`) or subdirectory (such as `/ns1/subdir/`) that will be mapped 1-1 with `DataRepositoryPath`. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path `/ns1/`, then you cannot link another data repository with file system path `/ns1/ns2`. This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory. If you specify only a forward slash (`/`) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system. Type: String Length Constraints: Minimum length of 1. Maximum length of 4096. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{1,4096}$` Required: No ** [ImportedFileChunkSize](#API_CreateDataRepositoryAssociation_RequestSyntax) ** 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 512000. Required: No ** [S3](#API_CreateDataRepositoryAssociation_RequestSyntax) ** The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository. Type: [S3DataRepositoryConfiguration](API_S3DataRepositoryConfiguration.md) object Required: No ** [Tags](#API_CreateDataRepositoryAssociation_RequestSyntax) ** A list of `Tag` values, with a maximum of 50 elements. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ## Response Syntax ``` { "Association": { "AssociationId": "string", "BatchImportMetaDataOnCreate": boolean, "CreationTime": number, "DataRepositoryPath": "string", "DataRepositorySubdirectories": [ "string" ], "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileCachePath": "string", "FileSystemId": "string", "FileSystemPath": "string", "ImportedFileChunkSize": number, "Lifecycle": "string", "NFS": { "AutoExportPolicy": { "Events": [ "string" ] }, "DnsIps": [ "string" ], "Version": "string" }, "ResourceARN": "string", "S3": { "AutoExportPolicy": { "Events": [ "string" ] }, "AutoImportPolicy": { "Events": [ "string" ] } }, "Tags": [ { "Key": "string", "Value": "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. ** [Association](#API_CreateDataRepositoryAssociation_ResponseSyntax) ** The response object returned after the data repository association is created. Type: [DataRepositoryAssociation](API_DataRepositoryAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateDataRepositoryAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateDataRepositoryAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateDataRepositoryAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateDataRepositoryAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateDataRepositoryAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateDataRepositoryAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateDataRepositoryAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateDataRepositoryAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateDataRepositoryAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateDataRepositoryAssociation) # CreateDataRepositoryTask Creates an Amazon FSx for Lustre data repository task. A `CreateDataRepositoryTask` operation will fail if a data repository is not linked to the FSx file system. You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository. You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre file system. To learn more about data repository tasks, see [Data Repository Tasks](https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html). To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html). ## Request Syntax ``` { "CapacityToRelease": number, "ClientRequestToken": "string", "FileSystemId": "string", "Paths": [ "string" ], "ReleaseConfiguration": { "DurationSinceLastAccess": { "Unit": "string", "Value": number } }, "Report": { "Enabled": boolean, "Format": "string", "Path": "string", "Scope": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [CapacityToRelease](#API_CreateDataRepositoryTask_RequestSyntax) ** Specifies the amount of data to release, in GiB, by an Amazon File Cache `AUTO_RELEASE_DATA` task that automatically releases files from the cache. Type: Long Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [ClientRequestToken](#API_CreateDataRepositoryTask_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [FileSystemId](#API_CreateDataRepositoryTask_RequestSyntax) ** The globally unique ID of the file system, assigned by Amazon FSx. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ** [Paths](#API_CreateDataRepositoryTask_RequestSyntax) ** A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks). + For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is `/mnt/fsx` and `/mnt/fsx/path1` is a directory or file on the file system you want to export, then the path to provide is `path1`. + For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format `s3://bucket-name/prefix` (where `prefix` is optional). + For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path. **Note** A file must also meet the last accessed time criteria specified in [ReleaseConfiguration](API_ReleaseConfiguration.md) for the file to be released. Type: Array of strings Array Members: Maximum number of 100 items. Length Constraints: Minimum length of 0. Maximum length of 4096. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{0,4096}$` Required: No ** [ReleaseConfiguration](#API_CreateDataRepositoryTask_RequestSyntax) ** The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system. Type: [ReleaseConfiguration](API_ReleaseConfiguration.md) object Required: No ** [Report](#API_CreateDataRepositoryTask_RequestSyntax) ** Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the `Scope` parameter. For more information, see [Working with Task Completion Reports](https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html). Type: [CompletionReport](API_CompletionReport.md) object Required: Yes ** [Tags](#API_CreateDataRepositoryTask_RequestSyntax) ** A list of `Tag` values, with a maximum of 50 elements. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ** [Type](#API_CreateDataRepositoryTask_RequestSyntax) ** Specifies the type of data repository task to create. + `EXPORT_TO_REPOSITORY` tasks export from your Amazon FSx for Lustre file system to a linked data repository. + `IMPORT_METADATA_FROM_REPOSITORY` tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system. + `RELEASE_DATA_FROM_FILESYSTEM` tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria. + `AUTO_RELEASE_DATA` tasks automatically release files from an Amazon File Cache resource. Type: String Valid Values: `EXPORT_TO_REPOSITORY | IMPORT_METADATA_FROM_REPOSITORY | RELEASE_DATA_FROM_FILESYSTEM | AUTO_RELEASE_DATA` Required: Yes ## Response Syntax ``` { "DataRepositoryTask": { "CapacityToRelease": number, "CreationTime": number, "EndTime": number, "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileSystemId": "string", "Lifecycle": "string", "Paths": [ "string" ], "ReleaseConfiguration": { "DurationSinceLastAccess": { "Unit": "string", "Value": number } }, "Report": { "Enabled": boolean, "Format": "string", "Path": "string", "Scope": "string" }, "ResourceARN": "string", "StartTime": number, "Status": { "FailedCount": number, "LastUpdatedTime": number, "ReleasedCapacity": number, "SucceededCount": number, "TotalCount": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "TaskId": "string", "Type": "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. ** [DataRepositoryTask](#API_CreateDataRepositoryTask_ResponseSyntax) ** The description of the data repository task that you just created. Type: [DataRepositoryTask](API_DataRepositoryTask.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** DataRepositoryTaskExecuting ** An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. HTTP Status Code: 400 ## Examples ### Create a Data Repository Task The following request creates an `EXPORT_TO_REPOSITORY` data repository task for the specified file system. #### Sample Request ``` POST /2015-02-01/create-data-repository-task HTTP/1.1 Host: fsx.us-east-1.amazonaws.com x-amz-date: 20140620T221118Z Authorization: <...> Content-Type: application/json Content-Length: 160 { "FileSystemId": "fs-0123456789abcdef0", "Type": "EXPORT_TO_REPOSITORY", "Paths": ["path1", "path2/file1"], "Report": { "Enabled":true, "Path":"s3://amzn-s3-demo-bucket/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 { "Task": { "TaskId": "task-0123456789abcdef1", "TaskType": "EXPORT_TO_REPOSITORY", "Lifecycle": "PENDING", "FileSystemId": "fs-0123456789abcdef0", "Paths": ["path1", "path2/file1"], "TaskReport": { "Path":"s3://amzn-s3-demo-bucket/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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateDataRepositoryTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateDataRepositoryTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateDataRepositoryTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateDataRepositoryTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateDataRepositoryTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateDataRepositoryTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateDataRepositoryTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateDataRepositoryTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateDataRepositoryTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateDataRepositoryTask) # CreateFileCache Creates a new Amazon File Cache resource. You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, `CreateFileCache` returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns `IncompatibleParameterError`. If a file cache with the specified client request token doesn't exist, `CreateFileCache` does the following: + Creates a new, empty Amazon File Cache resource with an assigned ID, and an initial lifecycle state of `CREATING`. + Returns the description of the cache in JSON format. **Note** The `CreateFileCache` call returns while the cache's lifecycle state is still `CREATING`. You can check the cache creation status by calling the [DescribeFileCaches](https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html) operation, which returns the cache state along with other information. ## Request Syntax ``` { "ClientRequestToken": "string", "CopyTagsToDataRepositoryAssociations": boolean, "DataRepositoryAssociations": [ { "DataRepositoryPath": "string", "DataRepositorySubdirectories": [ "string" ], "FileCachePath": "string", "NFS": { "DnsIps": [ "string" ], "Version": "string" } } ], "FileCacheType": "string", "FileCacheTypeVersion": "string", "KmsKeyId": "string", "LustreConfiguration": { "DeploymentType": "string", "MetadataConfiguration": { "StorageCapacity": number }, "PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string" }, "SecurityGroupIds": [ "string" ], "StorageCapacity": number, "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_CreateFileCache_RequestSyntax) ** An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. By using the idempotent operation, you can retry a `CreateFileCache` operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache 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 cache, the client receives success as long as the parameters are the same. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[A-za-z0-9_.-]{0,63}$` Required: No ** [CopyTagsToDataRepositoryAssociations](#API_CreateFileCache_RequestSyntax) ** A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false. Type: Boolean Required: No ** [DataRepositoryAssociations](#API_CreateFileCache_RequestSyntax) ** A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: + All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. + An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported. Type: Array of [FileCacheDataRepositoryAssociation](API_FileCacheDataRepositoryAssociation.md) objects Array Members: Maximum number of 8 items. Required: No ** [FileCacheType](#API_CreateFileCache_RequestSyntax) ** The type of cache that you're creating, which must be `LUSTRE`. Type: String Valid Values: `LUSTRE` Required: Yes ** [FileCacheTypeVersion](#API_CreateFileCache_RequestSyntax) ** Sets the Lustre version for the cache that you're creating, which must be `2.12`. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: `^[0-9](.[0-9]*)*$` Required: Yes ** [KmsKeyId](#API_CreateFileCache_RequestSyntax) ** Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a `KmsKeyId` isn't specified, the Amazon FSx-managed AWS KMS key for your account is used. For more information, see [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) 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](#API_CreateFileCache_RequestSyntax) ** The configuration for the Amazon File Cache resource being created. Type: [CreateFileCacheLustreConfiguration](API_CreateFileCacheLustreConfiguration.md) object Required: No ** [SecurityGroupIds](#API_CreateFileCache_RequestSyntax) ** A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache. 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](#API_CreateFileCache_RequestSyntax) ** The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. Required: Yes ** [SubnetIds](#API_CreateFileCache_RequestSyntax) ** A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the `CreateFileCache` operation. 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](#API_CreateFileCache_RequestSyntax) ** A list of `Tag` values, with a maximum of 50 elements. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ## Response Syntax ``` { "FileCache": { "CopyTagsToDataRepositoryAssociations": boolean, "CreationTime": number, "DataRepositoryAssociationIds": [ "string" ], "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileCacheType": "string", "FileCacheTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "DeploymentType": "string", "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "StorageCapacity": number }, "MountName": "string", "PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "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. ** [FileCache](#API_CreateFileCache_ResponseSyntax) ** A description of the cache that was created. Type: [FileCacheCreating](API_FileCacheCreating.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** InvalidNetworkSettings ** One or more network settings specified in the request are invalid. ** InvalidRouteTableId ** The route table ID is either invalid or not part of the VPC specified. ** InvalidSecurityGroupId ** The security group ID is either invalid or not part of the VPC specified. ** InvalidSubnetId ** The subnet ID that is either invalid or not part of the VPC specified. ** Message ** Error message explaining what's wrong with network settings. HTTP Status Code: 400 ** InvalidPerUnitStorageThroughput ** An invalid value for `PerUnitStorageThroughput` was provided. Please create your file system again, using a valid value. ** Message ** A detailed error message. HTTP Status Code: 400 ** MissingFileCacheConfiguration ** A cache configuration is required for this operation. ** Message ** A detailed error message. 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. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateFileCache) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateFileCache) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateFileCache) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateFileCache) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateFileCache) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateFileCache) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateFileCache) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateFileCache) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateFileCache) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateFileCache) # 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 in JSON format. **Note** 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](https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) 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", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "ExportPath": "string", "ImportedFileChunkSize": number, "ImportPath": "string", "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeConfiguration": { "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "ReadOnly": boolean, "RecordSizeKiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ] }, "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "SecurityGroupIds": [ "string" ], "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "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", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "PreferredSubnetId": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "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](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_CreateFileSystem_RequestSyntax) ** A string of up to 63 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](#API_CreateFileSystem_RequestSyntax) ** 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 ** [FileSystemTypeVersion](#API_CreateFileSystem_RequestSyntax) ** For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are `2.10`, `2.12`, and `2.15`: + `2.10` is supported by the Scratch and Persistent\$11 Lustre deployment types. + `2.12` is supported by all Lustre deployment types, except for `PERSISTENT_2` with a metadata configuration mode. + `2.15` is supported by all Lustre deployment types and is recommended for all new file systems. Default value is `2.10`, except for the following deployments: + Default value is `2.12` when `DeploymentType` is set to `PERSISTENT_2` without a metadata configuration mode. + Default value is `2.15` when `DeploymentType` is set to `PERSISTENT_2` with a metadata configuration mode. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: `^[0-9](.[0-9]*)*$` Required: No ** [KmsKeyId](#API_CreateFileSystem_RequestSyntax) ** Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on Amazon FSx file systems, as follows: + Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment types only. `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon FSx service AWS KMS key for your account. + Amazon FSx for NetApp ONTAP + Amazon FSx for OpenZFS + Amazon FSx for Windows File Server If a `KmsKeyId` isn't specified, the Amazon FSx-managed AWS KMS key for your account is used. For more information, see [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) 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](#API_CreateFileSystem_RequestSyntax) ** The Lustre configuration for the file system being created. The following parameters are not supported for file systems with a data repository association created with [CreateDataRepositoryAssociation](API_CreateDataRepositoryAssociation.md). + `AutoImportPolicy` + `ExportPath` + `ImportedFileChunkSize` + `ImportPath` Type: [CreateFileSystemLustreConfiguration](API_CreateFileSystemLustreConfiguration.md) object Required: No ** [NetworkType](#API_CreateFileSystem_RequestSyntax) ** The network type of the Amazon FSx file system that you are creating. Valid values are `IPV4` (which supports IPv4 only) and `DUAL` (for dual-stack mode, which supports both IPv4 and IPv6). The default is `IPV4`. Supported for FSx for OpenZFS, FSx for ONTAP, and FSx for Windows File Server file systems. Type: String Valid Values: `IPV4 | DUAL` Required: No ** [OntapConfiguration](#API_CreateFileSystem_RequestSyntax) ** The ONTAP configuration properties of the FSx for ONTAP file system that you are creating. Type: [CreateFileSystemOntapConfiguration](API_CreateFileSystemOntapConfiguration.md) object Required: No ** [OpenZFSConfiguration](#API_CreateFileSystem_RequestSyntax) ** The OpenZFS configuration for the file system that's being created. Type: [CreateFileSystemOpenZFSConfiguration](API_CreateFileSystemOpenZFSConfiguration.md) object Required: No ** [SecurityGroupIds](#API_CreateFileSystem_RequestSyntax) ** 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. You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you. 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](#API_CreateFileSystem_RequestSyntax) ** 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 depends on the value of the `HAPairs` property. The minimum value is calculated as 1,024 \$1 `HAPairs` and the maximum is calculated as 524,288 \$1 `HAPairs`. **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: No ** [StorageType](#API_CreateFileSystem_RequestSyntax) ** Sets the storage class for the file system that you're creating. Valid values are `SSD`, `HDD`, and `INTELLIGENT_TIERING`. + Set to `SSD` to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. + Set to `HDD` to use hard disk drive storage, which is supported on `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types, and on `PERSISTENT_1` Lustre file system deployment types. + Set to `INTELLIGENT_TIERING` to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type and for Lustre file systems with the Persistent\$12 deployment type. Default value is `SSD`. For more information, see [ Storage type options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) in the *FSx for Windows File Server User Guide*, [FSx for Lustre storage classes](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-storage-classes) in the *FSx for Lustre User Guide*, and [Working with Intelligent-Tiering](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance-intelligent-tiering) in the *Amazon FSx for OpenZFS User Guide*. Type: String Valid Values: `SSD | HDD | INTELLIGENT_TIERING` Required: No ** [SubnetIds](#API_CreateFileSystem_RequestSyntax) ** 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](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html) in the *Amazon FSx for Windows User Guide* and [ Availability and durability](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html) 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](#API_CreateFileSystem_RequestSyntax) ** 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](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ** [WindowsConfiguration](#API_CreateFileSystem_RequestSyntax) ** The Microsoft Windows configuration for the file system that's being created. Type: [CreateFileSystemWindowsConfiguration](API_CreateFileSystemWindowsConfiguration.md) object Required: No ## Response Syntax ``` { "FileSystem": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "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](#API_CreateFileSystem_ResponseSyntax) ** The configuration of the file system that was created. Type: [FileSystem](API_FileSystem.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ActiveDirectoryError ** An Active Directory error. ** ActiveDirectoryId ** The directory ID of the directory that an error pertains to. ** Message ** A detailed error message. ** Type ** The type of Active Directory error. HTTP Status Code: 400 ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** InvalidExportPath ** The path provided for data repository export isn't valid. ** Message ** A detailed error message. HTTP Status Code: 400 ** InvalidImportPath ** The path provided for data repository import isn't valid. ** Message ** A detailed error message. HTTP Status Code: 400 ** InvalidNetworkSettings ** One or more network settings specified in the request are invalid. ** InvalidRouteTableId ** The route table ID is either invalid or not part of the VPC specified. ** InvalidSecurityGroupId ** The security group ID is either invalid or not part of the VPC specified. ** InvalidSubnetId ** The subnet ID that is either invalid or not part of the VPC specified. ** Message ** Error message explaining what's wrong with network settings. HTTP Status Code: 400 ** InvalidPerUnitStorageThroughput ** An invalid value for `PerUnitStorageThroughput` was provided. Please create your file system again, using a valid value. ** Message ** A detailed error message. HTTP Status Code: 400 ** MissingFileSystemConfiguration ** A file system configuration is required for this operation. ** Message ** A detailed error message. 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. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateFileSystem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateFileSystem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateFileSystem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateFileSystem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateFileSystem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateFileSystem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateFileSystem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateFileSystem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateFileSystem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateFileSystem) # 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. **Note** 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](https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) 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", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "ExportPath": "string", "ImportedFileChunkSize": number, "ImportPath": "string", "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkType": "string", "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeConfiguration": { "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "ReadOnly": boolean, "RecordSizeKiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ] }, "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "SecurityGroupIds": [ "string" ], "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "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", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "PreferredSubnetId": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "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](CommonParameters.md). The request accepts the following data in JSON format. ** [BackupId](#API_CreateFileSystemFromBackup_RequestSyntax) ** 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](#API_CreateFileSystemFromBackup_RequestSyntax) ** A string of up to 63 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](#API_CreateFileSystemFromBackup_RequestSyntax) ** Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are `2.10`, `2.12`, and `2.15`. You can enter a Lustre version that is newer than the backup's `FileSystemTypeVersion` setting. If you don't enter a newer Lustre version, it defaults to the backup's setting. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: `^[0-9](.[0-9]*)*$` Required: No ** [KmsKeyId](#API_CreateFileSystemFromBackup_RequestSyntax) ** Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on Amazon FSx file systems, as follows: + Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment types only. `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon FSx service AWS KMS key for your account. + Amazon FSx for NetApp ONTAP + Amazon FSx for OpenZFS + Amazon FSx for Windows File Server If a `KmsKeyId` isn't specified, the Amazon FSx-managed AWS KMS key for your account is used. For more information, see [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) 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](#API_CreateFileSystemFromBackup_RequestSyntax) ** The Lustre configuration for the file system being created. The following parameters are not supported for file systems with a data repository association created with [CreateDataRepositoryAssociation](API_CreateDataRepositoryAssociation.md). + `AutoImportPolicy` + `ExportPath` + `ImportedFileChunkSize` + `ImportPath` Type: [CreateFileSystemLustreConfiguration](API_CreateFileSystemLustreConfiguration.md) object Required: No ** [NetworkType](#API_CreateFileSystemFromBackup_RequestSyntax) ** Sets the network type for the Amazon FSx for OpenZFS file system that you're creating from a backup. Type: String Valid Values: `IPV4 | DUAL` Required: No ** [OpenZFSConfiguration](#API_CreateFileSystemFromBackup_RequestSyntax) ** The OpenZFS configuration for the file system that's being created. Type: [CreateFileSystemOpenZFSConfiguration](API_CreateFileSystemOpenZFSConfiguration.md) object Required: No ** [SecurityGroupIds](#API_CreateFileSystemFromBackup_RequestSyntax) ** 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 ** [StorageCapacity](#API_CreateFileSystemFromBackup_RequestSyntax) ** Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the `StorageCapacity` parameter, the default is the backup's `StorageCapacity` value. If used to create a file system other than OpenZFS, you must provide a value that matches the backup's `StorageCapacity` value. If you provide any other value, Amazon FSx responds with an HTTP status code 400 Bad Request. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. Required: No ** [StorageType](#API_CreateFileSystemFromBackup_RequestSyntax) ** Sets the storage type for the Windows, OpenZFS, or Lustre file system that you're creating from a backup. Valid values are `SSD`, `HDD`, and `INTELLIGENT_TIERING`. + 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. + Set to `INTELLIGENT_TIERING` to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type and for Lustre file systems with the Persistent\$12 deployment type. The default value is `SSD`. HDD 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. Type: String Valid Values: `SSD | HDD | INTELLIGENT_TIERING` Required: No ** [SubnetIds](#API_CreateFileSystemFromBackup_RequestSyntax) ** 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 OpenZFS file systems 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](#API_CreateFileSystemFromBackup_RequestSyntax) ** 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ** [WindowsConfiguration](#API_CreateFileSystemFromBackup_RequestSyntax) ** The configuration for this Microsoft Windows file system. Type: [CreateFileSystemWindowsConfiguration](API_CreateFileSystemWindowsConfiguration.md) object Required: No ## Response Syntax ``` { "FileSystem": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "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](#API_CreateFileSystemFromBackup_ResponseSyntax) ** A description of the file system. Type: [FileSystem](API_FileSystem.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ActiveDirectoryError ** An Active Directory error. ** ActiveDirectoryId ** The directory ID of the directory that an error pertains to. ** Message ** A detailed error message. ** Type ** The type of Active Directory error. HTTP Status Code: 400 ** BackupNotFound ** No Amazon FSx backups were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** InvalidNetworkSettings ** One or more network settings specified in the request are invalid. ** InvalidRouteTableId ** The route table ID is either invalid or not part of the VPC specified. ** InvalidSecurityGroupId ** The security group ID is either invalid or not part of the VPC specified. ** InvalidSubnetId ** The subnet ID that is either invalid or not part of the VPC specified. ** Message ** Error message explaining what's wrong with network settings. HTTP Status Code: 400 ** InvalidPerUnitStorageThroughput ** An invalid value for `PerUnitStorageThroughput` was provided. Please create your file system again, using a valid value. ** Message ** A detailed error message. HTTP Status Code: 400 ** MissingFileSystemConfiguration ** A file system configuration is required for this operation. ** Message ** A detailed error message. 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. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateFileSystemFromBackup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateFileSystemFromBackup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateFileSystemFromBackup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateFileSystemFromBackup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateFileSystemFromBackup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateFileSystemFromBackup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateFileSystemFromBackup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateFileSystemFromBackup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateFileSystemFromBackup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateFileSystemFromBackup) # CreateSnapshot Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version. If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns `IncompatibleParameterError`. If a snapshot with the specified client request token doesn't exist, `CreateSnapshot` does the following: + Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of `CREATING`. + Returns the description of the snapshot. By using the idempotent operation, you can retry a `CreateSnapshot` operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same. The `CreateSnapshot` operation returns while the snapshot's lifecycle state is still `CREATING`. You can check the snapshot creation status by calling the [DescribeSnapshots](https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html) operation, which returns the snapshot state along with other information. ## Request Syntax ``` { "ClientRequestToken": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_CreateSnapshot_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [Name](#API_CreateSnapshot_RequestSyntax) ** The name of the snapshot. Type: String Length Constraints: Minimum length of 1. Maximum length of 203. Pattern: `^[a-zA-Z0-9_:.-]{1,203}$` Required: Yes ** [Tags](#API_CreateSnapshot_RequestSyntax) ** A list of `Tag` values, with a maximum of 50 elements. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ** [VolumeId](#API_CreateSnapshot_RequestSyntax) ** The ID of the volume that you are taking a snapshot of. Type: String Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` Required: Yes ## Response Syntax ``` { "Snapshot": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": "Snapshot", "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "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. ** [Snapshot](#API_CreateSnapshot_ResponseSyntax) ** A description of the snapshot. Type: [Snapshot](API_Snapshot.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** VolumeNotFound ** No Amazon FSx volumes were found based upon the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateSnapshot) # CreateStorageVirtualMachine Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system. ## Request Syntax ``` { "ActiveDirectoryConfiguration": { "NetBiosName": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "Password": "string", "UserName": "string" } }, "ClientRequestToken": "string", "FileSystemId": "string", "Name": "string", "RootVolumeSecurityStyle": "string", "SvmAdminPassword": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ActiveDirectoryConfiguration](#API_CreateStorageVirtualMachine_RequestSyntax) ** Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system. Type: [CreateSvmActiveDirectoryConfiguration](API_CreateSvmActiveDirectoryConfiguration.md) object Required: No ** [ClientRequestToken](#API_CreateStorageVirtualMachine_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [FileSystemId](#API_CreateStorageVirtualMachine_RequestSyntax) ** The globally unique ID of the file system, assigned by Amazon FSx. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ** [Name](#API_CreateStorageVirtualMachine_RequestSyntax) ** The name of the SVM. Type: String Length Constraints: Minimum length of 1. Maximum length of 47. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{1,47}$` Required: Yes ** [RootVolumeSecurityStyle](#API_CreateStorageVirtualMachine_RequestSyntax) ** The security style of the root volume of the SVM. Specify one of the following values: + `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. + `NTFS` if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account. + `MIXED` This is an advanced setting. For more information, see [Volume security style](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html) in the Amazon FSx for NetApp ONTAP User Guide. Type: String Valid Values: `UNIX | NTFS | MIXED` Required: No ** [SvmAdminPassword](#API_CreateStorageVirtualMachine_RequestSyntax) ** The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's `fsxadmin` user to manage the SVM. Type: String Length Constraints: Minimum length of 8. Maximum length of 50. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{8,50}$` Required: No ** [Tags](#API_CreateStorageVirtualMachine_RequestSyntax) ** A list of `Tag` values, with a maximum of 50 elements. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ## Response Syntax ``` { "StorageVirtualMachine": { "ActiveDirectoryConfiguration": { "NetBiosName": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" } }, "CreationTime": number, "Endpoints": { "Iscsi": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Nfs": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Smb": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "RootVolumeSecurityStyle": "string", "StorageVirtualMachineId": "string", "Subtype": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UUID": "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. ** [StorageVirtualMachine](#API_CreateStorageVirtualMachine_ResponseSyntax) ** Returned after a successful `CreateStorageVirtualMachine` operation; describes the SVM just created. Type: [StorageVirtualMachine](API_StorageVirtualMachine.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ActiveDirectoryError ** An Active Directory error. ** ActiveDirectoryId ** The directory ID of the directory that an error pertains to. ** Message ** A detailed error message. ** Type ** The type of Active Directory error. HTTP Status Code: 400 ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateStorageVirtualMachine) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateStorageVirtualMachine) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateStorageVirtualMachine) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateStorageVirtualMachine) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateStorageVirtualMachine) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateStorageVirtualMachine) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateStorageVirtualMachine) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateStorageVirtualMachine) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateStorageVirtualMachine) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateStorageVirtualMachine) # CreateVolume Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume. ## Request Syntax ``` { "ClientRequestToken": "string", "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "ConstituentsPerAggregate": number }, "CopyTagsToBackups": boolean, "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeType": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_CreateVolume_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [Name](#API_CreateVolume_RequestSyntax) ** Specifies the name of the volume that you're creating. Type: String Length Constraints: Minimum length of 1. Maximum length of 203. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{1,203}$` Required: Yes ** [OntapConfiguration](#API_CreateVolume_RequestSyntax) ** Specifies the configuration to use when creating the ONTAP volume. Type: [CreateOntapVolumeConfiguration](API_CreateOntapVolumeConfiguration.md) object Required: No ** [OpenZFSConfiguration](#API_CreateVolume_RequestSyntax) ** Specifies the configuration to use when creating the OpenZFS volume. Type: [CreateOpenZFSVolumeConfiguration](API_CreateOpenZFSVolumeConfiguration.md) object Required: No ** [Tags](#API_CreateVolume_RequestSyntax) ** A list of `Tag` values, with a maximum of 50 elements. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ** [VolumeType](#API_CreateVolume_RequestSyntax) ** Specifies the type of volume to create; `ONTAP` and `OPENZFS` are the only valid volume types. Type: String Valid Values: `ONTAP | OPENZFS` Required: Yes ## Response Syntax ``` { "Volume": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": "Volume", "TotalTransferBytes": number } ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "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. ** [Volume](#API_CreateVolume_ResponseSyntax) ** Returned after a successful `CreateVolume` API operation, describing the volume just created. Type: [Volume](API_Volume.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** MissingVolumeConfiguration ** A volume configuration is required for this operation. ** Message ** A detailed error message. 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. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** StorageVirtualMachineNotFound ** No FSx for ONTAP SVMs were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. HTTP Status Code: 400 ## Examples ### Create an FSx for ONTAP storage volume The following example creates a 100-GB storage volume with storage efficiency enabled, and a storage-tiering configuration with a 60-day cooling period with tiering of snapshots only. ``` { "Name": "finance-volume1" "OntapConfiguration": { "JunctionPath": "/finance/vol1", "SizeInMegabytes": 102400, "StorageEfficiencyEnabled": true, "StorageVirtualMachineId": "svm-0123456789abcdef0", "TieringPolicy": { "CoolingPeriod": 60, "Name": "SNAPSHOT_ONLY" } }, "VolumeType": "ONTAP" } ``` ### Create an Amazon FSx for OpenZFS storage volume. The following example creates a 100-GB storage volume with storage efficiency enabled, and a storage-tiering configuration with a 60-day cooling period with tiering of snapshots only. ``` { "Name": "sales-vol1" "OpenZFSConfiguration": { "CopyTagsToSnapshots": true, "DataCompressionType": "LZ4", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "*", "Options": [ "rw","root_squash","crossmnt" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "CLONE", "SnapshotARN": "arn:aws:fsx:us-east-2:111122223333:snapshot/fsvol-0123456789abcdef0/fsvolsnap-1234567890abcdef0" }, "ParentVolumeId": "fsvol-abcdef01234567890", "ReadOnly": false, "RecordSizeKiB": 1024, "StorageCapacityQuotaGiB": 10000, "StorageCapacityReservationGiB": -1, "UserAndGroupQuotas": [ { "Id": 1004, "StorageCapacityQuotaGiB": 2000, "Type": "GROUP" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateVolume) # CreateVolumeFromBackup Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup. ## Request Syntax ``` { "BackupId": "string", "ClientRequestToken": "string", "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "ConstituentsPerAggregate": number }, "CopyTagsToBackups": boolean, "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "VolumeStyle": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [BackupId](#API_CreateVolumeFromBackup_RequestSyntax) ** 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](#API_CreateVolumeFromBackup_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [Name](#API_CreateVolumeFromBackup_RequestSyntax) ** The name of the new volume you're creating. Type: String Length Constraints: Minimum length of 1. Maximum length of 203. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{1,203}$` Required: Yes ** [OntapConfiguration](#API_CreateVolumeFromBackup_RequestSyntax) ** Specifies the configuration of the ONTAP volume that you are creating. Type: [CreateOntapVolumeConfiguration](API_CreateOntapVolumeConfiguration.md) object Required: No ** [Tags](#API_CreateVolumeFromBackup_RequestSyntax) ** A list of `Tag` values, with a maximum of 50 elements. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ## Response Syntax ``` { "Volume": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": "Volume", "TotalTransferBytes": number } ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "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. ** [Volume](#API_CreateVolumeFromBackup_ResponseSyntax) ** Returned after a successful `CreateVolumeFromBackup` API operation, describing the volume just created. Type: [Volume](API_Volume.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BackupNotFound ** No Amazon FSx backups were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** MissingVolumeConfiguration ** A volume configuration is required for this operation. ** Message ** A detailed error message. 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. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** StorageVirtualMachineNotFound ** No FSx for ONTAP SVMs were found based upon the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateVolumeFromBackup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateVolumeFromBackup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateVolumeFromBackup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateVolumeFromBackup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateVolumeFromBackup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateVolumeFromBackup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateVolumeFromBackup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateVolumeFromBackup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateVolumeFromBackup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateVolumeFromBackup) # DeleteBackup Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone. The `DeleteBackup` call returns instantly. The backup won't show up in later `DescribeBackups` calls. **Important** The data in a deleted backup is also deleted and can't be recovered by any means. ## Request Syntax ``` { "BackupId": "string", "ClientRequestToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [BackupId](#API_DeleteBackup_RequestSyntax) ** The ID of the backup that you want to delete. Type: String Length Constraints: Minimum length of 12. Maximum length of 128. Pattern: `^(backup-[0-9a-f]{8,})$` Required: Yes ** [ClientRequestToken](#API_DeleteBackup_RequestSyntax) ** A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the AWS CLI or SDK. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[A-za-z0-9_.-]{0,63}$` Required: No ## Response Syntax ``` { "BackupId": "string", "Lifecycle": "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. ** [BackupId](#API_DeleteBackup_ResponseSyntax) ** The ID of the backup that was deleted. Type: String Length Constraints: Minimum length of 12. Maximum length of 128. Pattern: `^(backup-[0-9a-f]{8,})$` ** [Lifecycle](#API_DeleteBackup_ResponseSyntax) ** The lifecycle status of the backup. If the `DeleteBackup` operation is successful, the status is `DELETED`. Type: String Valid Values: `AVAILABLE | CREATING | TRANSFERRING | DELETED | FAILED | PENDING | COPYING` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BackupBeingCopied ** You can't delete a backup while it's being copied. ** BackupId ** The ID of the source backup. Specifies the backup that you are copying. ** Message ** A detailed error message. HTTP Status Code: 400 ** BackupInProgress ** Another backup is already under way. Wait for completion before initiating additional backups of this file system. ** Message ** A detailed error message. HTTP Status Code: 400 ** BackupNotFound ** No Amazon FSx backups were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** BackupRestoring ** You can't delete a backup while it's being used to restore a file system. ** FileSystemId ** The ID of a file system being restored from the backup. ** Message ** A detailed error message. HTTP Status Code: 400 ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DeleteBackup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DeleteBackup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DeleteBackup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DeleteBackup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DeleteBackup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DeleteBackup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DeleteBackup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DeleteBackup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DeleteBackup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DeleteBackup) # DeleteDataRepositoryAssociation Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding `scratch_1` deployment type. ## Request Syntax ``` { "AssociationId": "string", "ClientRequestToken": "string", "DeleteDataInFileSystem": boolean } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AssociationId](#API_DeleteDataRepositoryAssociation_RequestSyntax) ** The ID of the data repository association that you want to delete. Type: String Length Constraints: Minimum length of 13. Maximum length of 23. Pattern: `^(dra-[0-9a-f]{8,})$` Required: Yes ** [ClientRequestToken](#API_DeleteDataRepositoryAssociation_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [DeleteDataInFileSystem](#API_DeleteDataRepositoryAssociation_RequestSyntax) ** Set to `true` to delete the data in the file system that corresponds to the data repository association. Type: Boolean Required: No ## Response Syntax ``` { "AssociationId": "string", "DeleteDataInFileSystem": boolean, "Lifecycle": "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. ** [AssociationId](#API_DeleteDataRepositoryAssociation_ResponseSyntax) ** The ID of the data repository association being deleted. Type: String Length Constraints: Minimum length of 13. Maximum length of 23. Pattern: `^(dra-[0-9a-f]{8,})$` ** [DeleteDataInFileSystem](#API_DeleteDataRepositoryAssociation_ResponseSyntax) ** Indicates whether data in the file system that corresponds to the data repository association is being deleted. Default is `false`. Type: Boolean ** [Lifecycle](#API_DeleteDataRepositoryAssociation_ResponseSyntax) ** Describes the lifecycle state of the data repository association being deleted. Type: String Valid Values: `CREATING | AVAILABLE | MISCONFIGURED | UPDATING | DELETING | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** DataRepositoryAssociationNotFound ** No data repository associations were found based upon the supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DeleteDataRepositoryAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DeleteDataRepositoryAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DeleteDataRepositoryAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DeleteDataRepositoryAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DeleteDataRepositoryAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DeleteDataRepositoryAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DeleteDataRepositoryAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DeleteDataRepositoryAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DeleteDataRepositoryAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DeleteDataRepositoryAssociation) # DeleteFileCache Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone. The `DeleteFileCache` operation returns while the cache has the `DELETING` status. You can check the cache deletion status by calling the [DescribeFileCaches](https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html) operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the `DescribeFileCaches` operation returns a `FileCacheNotFound` error. **Important** The data in a deleted cache is also deleted and can't be recovered by any means. ## Request Syntax ``` { "ClientRequestToken": "string", "FileCacheId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_DeleteFileCache_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [FileCacheId](#API_DeleteFileCache_RequestSyntax) ** The ID of the cache that's being deleted. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fc-[0-9a-f]{8,})$` Required: Yes ## Response Syntax ``` { "FileCacheId": "string", "Lifecycle": "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. ** [FileCacheId](#API_DeleteFileCache_ResponseSyntax) ** The ID of the cache that's being deleted. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fc-[0-9a-f]{8,})$` ** [Lifecycle](#API_DeleteFileCache_ResponseSyntax) ** The cache lifecycle for the deletion request. If the `DeleteFileCache` operation is successful, this status is `DELETING`. Type: String Valid Values: `AVAILABLE | CREATING | DELETING | UPDATING | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileCacheNotFound ** No caches were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DeleteFileCache) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DeleteFileCache) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DeleteFileCache) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DeleteFileCache) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DeleteFileCache) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DeleteFileCache) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DeleteFileCache) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DeleteFileCache) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DeleteFileCache) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DeleteFileCache) # DeleteFileSystem Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted. To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a `FileSystemId` value to the `DeleteFileSystem` operation. Before deleting an Amazon FSx for OpenZFS file system, make sure that there aren't any Amazon S3 access points attached to any volume. For more information on how to list S3 access points that are attached to volumes, see [Listing S3 access point attachments](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/access-points-list.html). For more information on how to delete S3 access points, see [Deleting an S3 access point attachment](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/delete-access-point.html). By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted. To delete an Amazon FSx for Lustre file system, first [unmount](https://docs.aws.amazon.com/fsx/latest/LustreGuide/unmounting-fs.html) it from every connected Amazon EC2 instance, then provide a `FileSystemId` value to the `DeleteFileSystem` operation. By default, Amazon FSx will not take a final backup when the `DeleteFileSystem` operation is invoked. On file systems not linked to an Amazon S3 bucket, set `SkipFinalBackup` to `false` to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the [AgeOfOldestQueuedMessage](https://docs.aws.amazon.com/fsx/latest/LustreGuide/monitoring-cloudwatch.html#auto-import-export-metrics) metric to be zero (if using automatic export) or you can run an [export data repository task](https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repo-task-dra.html). If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task. The `DeleteFileSystem` operation returns while the file system has the `DELETING` status. You can check the file system deletion status by calling the [DescribeFileSystems](https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the `DescribeFileSystems` operation returns a `FileSystemNotFound` error. **Note** If a data repository task is in a `PENDING` or `EXECUTING` state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request). **Important** The data in a deleted file system is also deleted and can't be recovered by any means. ## Request Syntax ``` { "ClientRequestToken": "string", "FileSystemId": "string", "LustreConfiguration": { "FinalBackupTags": [ { "Key": "string", "Value": "string" } ], "SkipFinalBackup": boolean }, "OpenZFSConfiguration": { "FinalBackupTags": [ { "Key": "string", "Value": "string" } ], "Options": [ "string" ], "SkipFinalBackup": boolean }, "WindowsConfiguration": { "FinalBackupTags": [ { "Key": "string", "Value": "string" } ], "SkipFinalBackup": boolean } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_DeleteFileSystem_RequestSyntax) ** A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using 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 ** [FileSystemId](#API_DeleteFileSystem_RequestSyntax) ** The ID of the file system that you want to delete. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ** [LustreConfiguration](#API_DeleteFileSystem_RequestSyntax) ** The configuration object for the Amazon FSx for Lustre file system being deleted in the `DeleteFileSystem` operation. Type: [DeleteFileSystemLustreConfiguration](API_DeleteFileSystemLustreConfiguration.md) object Required: No ** [OpenZFSConfiguration](#API_DeleteFileSystem_RequestSyntax) ** The configuration object for the OpenZFS file system used in the `DeleteFileSystem` operation. Type: [DeleteFileSystemOpenZFSConfiguration](API_DeleteFileSystemOpenZFSConfiguration.md) object Required: No ** [WindowsConfiguration](#API_DeleteFileSystem_RequestSyntax) ** The configuration object for the Microsoft Windows file system used in the `DeleteFileSystem` operation. Type: [DeleteFileSystemWindowsConfiguration](API_DeleteFileSystemWindowsConfiguration.md) object Required: No ## Response Syntax ``` { "FileSystemId": "string", "Lifecycle": "string", "LustreResponse": { "FinalBackupId": "string", "FinalBackupTags": [ { "Key": "string", "Value": "string" } ] }, "OpenZFSResponse": { "FinalBackupId": "string", "FinalBackupTags": [ { "Key": "string", "Value": "string" } ] }, "WindowsResponse": { "FinalBackupId": "string", "FinalBackupTags": [ { "Key": "string", "Value": "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. ** [FileSystemId](#API_DeleteFileSystem_ResponseSyntax) ** The ID of the file system that's being deleted. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` ** [Lifecycle](#API_DeleteFileSystem_ResponseSyntax) ** The file system lifecycle for the deletion request. If the `DeleteFileSystem` operation is successful, this status is `DELETING`. Type: String Valid Values: `AVAILABLE | CREATING | FAILED | DELETING | MISCONFIGURED | UPDATING | MISCONFIGURED_UNAVAILABLE` ** [LustreResponse](#API_DeleteFileSystem_ResponseSyntax) ** The response object for the Amazon FSx for Lustre file system being deleted in the `DeleteFileSystem` operation. Type: [DeleteFileSystemLustreResponse](API_DeleteFileSystemLustreResponse.md) object ** [OpenZFSResponse](#API_DeleteFileSystem_ResponseSyntax) ** The response object for the OpenZFS file system that's being deleted in the `DeleteFileSystem` operation. Type: [DeleteFileSystemOpenZFSResponse](API_DeleteFileSystemOpenZFSResponse.md) object ** [WindowsResponse](#API_DeleteFileSystem_ResponseSyntax) ** The response object for the Microsoft Windows file system used in the `DeleteFileSystem` operation. Type: [DeleteFileSystemWindowsResponse](API_DeleteFileSystemWindowsResponse.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DeleteFileSystem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DeleteFileSystem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DeleteFileSystem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DeleteFileSystem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DeleteFileSystem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DeleteFileSystem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DeleteFileSystem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DeleteFileSystem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DeleteFileSystem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DeleteFileSystem) # DeleteSnapshot Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup. The `DeleteSnapshot` operation returns instantly. The snapshot appears with the lifecycle status of `DELETING` until the deletion is complete. ## Request Syntax ``` { "ClientRequestToken": "string", "SnapshotId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_DeleteSnapshot_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [SnapshotId](#API_DeleteSnapshot_RequestSyntax) ** The ID of the snapshot that you want to delete. Type: String Length Constraints: Minimum length of 11. Maximum length of 28. Pattern: `^((fs)?volsnap-[0-9a-f]{8,})$` Required: Yes ## Response Syntax ``` { "Lifecycle": "string", "SnapshotId": "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. ** [Lifecycle](#API_DeleteSnapshot_ResponseSyntax) ** The lifecycle status of the snapshot. If the `DeleteSnapshot` operation is successful, this status is `DELETING`. Type: String Valid Values: `PENDING | CREATING | DELETING | AVAILABLE` ** [SnapshotId](#API_DeleteSnapshot_ResponseSyntax) ** The ID of the deleted snapshot. Type: String Length Constraints: Minimum length of 11. Maximum length of 28. Pattern: `^((fs)?volsnap-[0-9a-f]{8,})$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** SnapshotNotFound ** No Amazon FSx snapshots were found based on the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DeleteSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DeleteSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DeleteSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DeleteSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DeleteSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DeleteSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DeleteSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DeleteSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DeleteSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DeleteSnapshot) # DeleteStorageVirtualMachine Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail. ## Request Syntax ``` { "ClientRequestToken": "string", "StorageVirtualMachineId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_DeleteStorageVirtualMachine_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [StorageVirtualMachineId](#API_DeleteStorageVirtualMachine_RequestSyntax) ** The ID of the SVM that you want to delete. Type: String Length Constraints: Fixed length of 21. Pattern: `^(svm-[0-9a-f]{17,})$` Required: Yes ## Response Syntax ``` { "Lifecycle": "string", "StorageVirtualMachineId": "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. ** [Lifecycle](#API_DeleteStorageVirtualMachine_ResponseSyntax) ** Describes the lifecycle state of the SVM being deleted. Type: String Valid Values: `CREATED | CREATING | DELETING | FAILED | MISCONFIGURED | PENDING` ** [StorageVirtualMachineId](#API_DeleteStorageVirtualMachine_ResponseSyntax) ** The ID of the SVM Amazon FSx is deleting. Type: String Length Constraints: Fixed length of 21. Pattern: `^(svm-[0-9a-f]{17,})$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** StorageVirtualMachineNotFound ** No FSx for ONTAP SVMs were found based upon the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DeleteStorageVirtualMachine) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DeleteStorageVirtualMachine) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DeleteStorageVirtualMachine) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DeleteStorageVirtualMachine) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DeleteStorageVirtualMachine) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DeleteStorageVirtualMachine) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DeleteStorageVirtualMachine) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DeleteStorageVirtualMachine) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DeleteStorageVirtualMachine) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DeleteStorageVirtualMachine) # DeleteVolume Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. ## Request Syntax ``` { "ClientRequestToken": "string", "OntapConfiguration": { "BypassSnaplockEnterpriseRetention": boolean, "FinalBackupTags": [ { "Key": "string", "Value": "string" } ], "SkipFinalBackup": boolean }, "OpenZFSConfiguration": { "Options": [ "string" ] }, "VolumeId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_DeleteVolume_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [OntapConfiguration](#API_DeleteVolume_RequestSyntax) ** For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the `fsx:TagResource` permission. Type: [DeleteVolumeOntapConfiguration](API_DeleteVolumeOntapConfiguration.md) object Required: No ** [OpenZFSConfiguration](#API_DeleteVolume_RequestSyntax) ** For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots. Type: [DeleteVolumeOpenZFSConfiguration](API_DeleteVolumeOpenZFSConfiguration.md) object Required: No ** [VolumeId](#API_DeleteVolume_RequestSyntax) ** The ID of the volume that you are deleting. Type: String Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` Required: Yes ## Response Syntax ``` { "Lifecycle": "string", "OntapResponse": { "FinalBackupId": "string", "FinalBackupTags": [ { "Key": "string", "Value": "string" } ] }, "VolumeId": "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. ** [Lifecycle](#API_DeleteVolume_ResponseSyntax) ** The lifecycle state of the volume being deleted. If the `DeleteVolume` operation is successful, this value is `DELETING`. Type: String Valid Values: `CREATING | CREATED | DELETING | FAILED | MISCONFIGURED | PENDING | AVAILABLE` ** [OntapResponse](#API_DeleteVolume_ResponseSyntax) ** Returned after a `DeleteVolume` request, showing the status of the delete request. Type: [DeleteVolumeOntapResponse](API_DeleteVolumeOntapResponse.md) object ** [VolumeId](#API_DeleteVolume_ResponseSyntax) ** The ID of the volume that's being deleted. Type: String Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** VolumeNotFound ** No Amazon FSx volumes were found based upon the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DeleteVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DeleteVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DeleteVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DeleteVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DeleteVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DeleteVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DeleteVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DeleteVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DeleteVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DeleteVolume) # DescribeBackups Returns the description of a specific Amazon FSx backup, if a `BackupIds` value is provided for that backup. Otherwise, it returns all backups owned by your 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 the `NextToken` value from the last response. This operation is used in an iterative process to retrieve a list of your backups. `DescribeBackups` is called first without a `NextToken` value. Then the operation continues to be called with the `NextToken` parameter set to the value of the last `NextToken` value until a response has no `NextToken` value. When using this operation, keep the following in mind: + The operation might return fewer than the `MaxResults` value of backup descriptions while still including a `NextToken` value. + The order of the backups returned in the response of one `DescribeBackups` call and the order of the backups returned across the responses of a multi-call iteration is unspecified. ## Request Syntax ``` { "BackupIds": [ "string" ], "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [BackupIds](#API_DescribeBackups_RequestSyntax) ** The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a `BackupNotFound` error occurs. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 12. Maximum length of 128. Pattern: `^(backup-[0-9a-f]{8,})$` Required: No ** [Filters](#API_DescribeBackups_RequestSyntax) ** The filters structure. The supported names are `file-system-id`, `backup-type`, `file-system-type`, and `volume-id`. Type: Array of [Filter](API_Filter.md) objects Array Members: Maximum number of 10 items. Required: No ** [MaxResults](#API_DescribeBackups_RequestSyntax) ** Maximum number of backups to return in the response. 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [NextToken](#API_DescribeBackups_RequestSyntax) ** An opaque pagination token returned from a previous `DescribeBackups` operation. If a token is present, the operation continues the list from where the returning call left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ## Response Syntax ``` { "Backups": [ { "BackupId": "string", "CreationTime": number, "DirectoryInformation": { "ActiveDirectoryId": "string", "DomainName": "string", "ResourceARN": "string" }, "FailureDetails": { "Message": "string" }, "FileSystem": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "KmsKeyId": "string", "Lifecycle": "string", "OwnerId": "string", "ProgressPercent": number, "ResourceARN": "string", "ResourceType": "string", "SizeInBytes": number, "SourceBackupId": "string", "SourceBackupRegion": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Volume": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": "Volume", "TotalTransferBytes": number } ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" } } ], "NextToken": "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. ** [Backups](#API_DescribeBackups_ResponseSyntax) ** An array of backups. Type: Array of [Backup](API_Backup.md) objects Array Members: Maximum number of 50 items. ** [NextToken](#API_DescribeBackups_ResponseSyntax) ** A `NextToken` value is present if there are more backups than returned in the response. You can use the `NextToken` value in the subsequent request to fetch the backups. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BackupNotFound ** No Amazon FSx backups were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** VolumeNotFound ** No Amazon FSx volumes were found based upon the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeBackups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeBackups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeBackups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeBackups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeBackups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeBackups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeBackups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeBackups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeBackups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeBackups) # DescribeDataRepositoryAssociations Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more `AssociationIds` values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding `scratch_1` deployment type. You can use filters to narrow the response to include just data repository associations for specific file systems (use the `file-system-id` filter with the ID of the file system) or caches (use the `file-cache-id` filter with the ID of the cache), or data repository associations for a specific repository type (use the `data-repository-type` filter with a value of `S3` or `NFS`). If you don't use filters, the response returns all data repository associations owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all data repository associations, you can paginate the response by using the optional `MaxResults` parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a `NextToken` value is returned in the response. In this case, send a later request with the `NextToken` request parameter set to the value of `NextToken` from the last response. ## Request Syntax ``` { "AssociationIds": [ "string" ], "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AssociationIds](#API_DescribeDataRepositoryAssociations_RequestSyntax) ** IDs of the data repository associations whose descriptions you want to retrieve (String). Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 13. Maximum length of 23. Pattern: `^(dra-[0-9a-f]{8,})$` Required: No ** [Filters](#API_DescribeDataRepositoryAssociations_RequestSyntax) ** A list of `Filter` elements. Type: Array of [Filter](API_Filter.md) objects Array Members: Maximum number of 10 items. Required: No ** [MaxResults](#API_DescribeDataRepositoryAssociations_RequestSyntax) ** The maximum number of resources to return in the response. This value must be an integer greater than zero. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeDataRepositoryAssociations_RequestSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ## Response Syntax ``` { "Associations": [ { "AssociationId": "string", "BatchImportMetaDataOnCreate": boolean, "CreationTime": number, "DataRepositoryPath": "string", "DataRepositorySubdirectories": [ "string" ], "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileCachePath": "string", "FileSystemId": "string", "FileSystemPath": "string", "ImportedFileChunkSize": number, "Lifecycle": "string", "NFS": { "AutoExportPolicy": { "Events": [ "string" ] }, "DnsIps": [ "string" ], "Version": "string" }, "ResourceARN": "string", "S3": { "AutoExportPolicy": { "Events": [ "string" ] }, "AutoImportPolicy": { "Events": [ "string" ] } }, "Tags": [ { "Key": "string", "Value": "string" } ] } ], "NextToken": "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. ** [Associations](#API_DescribeDataRepositoryAssociations_ResponseSyntax) ** An array of one or more data repository association descriptions. Type: Array of [DataRepositoryAssociation](API_DataRepositoryAssociation.md) objects Array Members: Maximum number of 100 items. ** [NextToken](#API_DescribeDataRepositoryAssociations_ResponseSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** DataRepositoryAssociationNotFound ** No data repository associations were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** InvalidDataRepositoryType ** You have filtered the response to a data repository type that is not supported. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeDataRepositoryAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeDataRepositoryAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeDataRepositoryAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeDataRepositoryAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeDataRepositoryAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeDataRepositoryAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeDataRepositoryAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeDataRepositoryAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeDataRepositoryAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeDataRepositoryAssociations) # DescribeDataRepositoryTasks Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more `TaskIds` values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all tasks, you can paginate the response by using the optional `MaxResults` parameter to limit the number of tasks returned in a response. If more tasks remain, a `NextToken` value is returned in the response. In this case, send a later request with the `NextToken` request parameter set to the value of `NextToken` from the last response. ## Request Syntax ``` { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "TaskIds": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_DescribeDataRepositoryTasks_RequestSyntax) ** (Optional) You can use filters to narrow the `DescribeDataRepositoryTasks` response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Type: Array of [DataRepositoryTaskFilter](API_DataRepositoryTaskFilter.md) objects Array Members: Maximum number of 3 items. Required: No ** [MaxResults](#API_DescribeDataRepositoryTasks_RequestSyntax) ** The maximum number of resources to return in the response. This value must be an integer greater than zero. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [NextToken](#API_DescribeDataRepositoryTasks_RequestSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ** [TaskIds](#API_DescribeDataRepositoryTasks_RequestSyntax) ** (Optional) IDs of the tasks whose descriptions you want to retrieve (String). Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 12. Maximum length of 128. Pattern: `^(task-[0-9a-f]{17,})$` Required: No ## Response Syntax ``` { "DataRepositoryTasks": [ { "CapacityToRelease": number, "CreationTime": number, "EndTime": number, "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileSystemId": "string", "Lifecycle": "string", "Paths": [ "string" ], "ReleaseConfiguration": { "DurationSinceLastAccess": { "Unit": "string", "Value": number } }, "Report": { "Enabled": boolean, "Format": "string", "Path": "string", "Scope": "string" }, "ResourceARN": "string", "StartTime": number, "Status": { "FailedCount": number, "LastUpdatedTime": number, "ReleasedCapacity": number, "SucceededCount": number, "TotalCount": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "TaskId": "string", "Type": "string" } ], "NextToken": "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. ** [DataRepositoryTasks](#API_DescribeDataRepositoryTasks_ResponseSyntax) ** The collection of data repository task descriptions returned. Type: Array of [DataRepositoryTask](API_DataRepositoryTask.md) objects Array Members: Maximum number of 50 items. ** [NextToken](#API_DescribeDataRepositoryTasks_ResponseSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** DataRepositoryTaskNotFound ** The data repository task or tasks you specified could not be found. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## Examples ### Retrieve Specific Data Repository Task Descriptions The following request retrieves the descriptions of a specific data repository task by using the TaskIDs request parameter. #### Sample Request ``` GET /2015-02-01/describe-data-repository-task HTTP/1.1 Host: fsx.us-east-1.amazonaws.com x-amz-date: 20140620T221118Z Authorization: <...> Content-Type: application/json Content-Length: 160 { "TaskIds": ["task-0123456789abcdef0"] } ``` #### Sample Response ``` HTTP/1.1 200 success x-amzn-RequestId: c3616af3-33fa-40ad-ae0d-d3895a2c3a1f { "DataRepositoryTasks": [ { "TaskId": "task-0123456789abcdef0", "TaskType": "EXPORT_TO_REPOSITORY", "Lifecycle": "PENDING", "FileSystemId": "fs-0123456789abcdef1", "Paths": ["/path1", "/path2/file1"], "CreationTime": "2019-07-17T18:18:18.000Z", "TaskReport": { "Path":"s3://amzn-s3-demo-bucket/FSxLustre20191118T225838Z/myreports", "Format":"REPORT_CSV_20191124", "Enabled":true, "Scope":"FAILED_FILES_ONLY" }, "Status": { "TotalCount": 100, "SucceededCount": 0, "FailedCount": 0, "LastUpdated": "2019-07-17T18:19:05.003Z" }, "Tags": [{"Key": "MyKey"}, {"Value": "MyValue"}], "ClientRequestToken": "1234", "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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeDataRepositoryTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeDataRepositoryTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeDataRepositoryTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeDataRepositoryTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeDataRepositoryTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeDataRepositoryTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeDataRepositoryTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeDataRepositoryTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeDataRepositoryTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeDataRepositoryTasks) # DescribeFileCaches Returns the description of a specific Amazon File Cache resource, if a `FileCacheIds` value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all cache descriptions, you can optionally specify the `MaxResults` parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a `NextToken` value in the response. In this case, send a later request with the `NextToken` request parameter set to the value of `NextToken` from the last response. This operation is used in an iterative process to retrieve a list of your cache descriptions. `DescribeFileCaches` is called first without a `NextToken`value. Then the operation continues to be called with the `NextToken` parameter set to the value of the last `NextToken` value until a response has no `NextToken`. When using this operation, keep the following in mind: + The implementation might return fewer than `MaxResults` cache descriptions while still including a `NextToken` value. + The order of caches returned in the response of one `DescribeFileCaches` call and the order of caches returned across the responses of a multicall iteration is unspecified. ## Request Syntax ``` { "FileCacheIds": [ "string" ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [FileCacheIds](#API_DescribeFileCaches_RequestSyntax) ** IDs of the caches whose descriptions you want to retrieve (String). Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fc-[0-9a-f]{8,})$` Required: No ** [MaxResults](#API_DescribeFileCaches_RequestSyntax) ** The maximum number of resources to return in the response. This value must be an integer greater than zero. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [NextToken](#API_DescribeFileCaches_RequestSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ## Response Syntax ``` { "FileCaches": [ { "CreationTime": number, "DataRepositoryAssociationIds": [ "string" ], "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileCacheType": "string", "FileCacheTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "DeploymentType": "string", "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "StorageCapacity": number }, "MountName": "string", "PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "SubnetIds": [ "string" ], "VpcId": "string" } ], "NextToken": "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. ** [FileCaches](#API_DescribeFileCaches_ResponseSyntax) ** The response object for the `DescribeFileCaches` operation. Type: Array of [FileCache](API_FileCache.md) objects Array Members: Maximum number of 50 items. ** [NextToken](#API_DescribeFileCaches_ResponseSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileCacheNotFound ** No caches were found based upon supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeFileCaches) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeFileCaches) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeFileCaches) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeFileCaches) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeFileCaches) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeFileCaches) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeFileCaches) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeFileCaches) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeFileCaches) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeFileCaches) # DescribeFileSystemAliases Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of [AdministrativeAction](API_AdministrativeAction.md) provided in the [DescribeFileSystems](API_DescribeFileSystems.md) operation response. ## Request Syntax ``` { "ClientRequestToken": "string", "FileSystemId": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_DescribeFileSystemAliases_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [FileSystemId](#API_DescribeFileSystemAliases_RequestSyntax) ** The ID of the file system to return the associated DNS aliases for (String). Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ** [MaxResults](#API_DescribeFileSystemAliases_RequestSyntax) ** Maximum number of DNS aliases 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [NextToken](#API_DescribeFileSystemAliases_RequestSyntax) ** Opaque pagination token returned from a previous `DescribeFileSystemAliases` operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ## Response Syntax ``` { "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "NextToken": "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. ** [Aliases](#API_DescribeFileSystemAliases_ResponseSyntax) ** An array of one or more DNS aliases currently associated with the specified file system. Type: Array of [Alias](API_Alias.md) objects Array Members: Maximum number of 50 items. ** [NextToken](#API_DescribeFileSystemAliases_ResponseSyntax) ** Present if there are more DNS aliases than returned in the response (String). You can use the `NextToken` value in a later request to fetch additional descriptions. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeFileSystemAliases) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeFileSystemAliases) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeFileSystemAliases) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeFileSystemAliases) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeFileSystemAliases) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeFileSystemAliases) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeFileSystemAliases) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeFileSystemAliases) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeFileSystemAliases) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeFileSystemAliases) # DescribeFileSystems 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 operation is used in an iterative process to retrieve a list of your file system descriptions. `DescribeFileSystems` is called first without a `NextToken`value. Then the operation continues to be called with the `NextToken` parameter set to the value of the last `NextToken` value until a response has no `NextToken`. When using this operation, keep the following in mind: + The implementation might return fewer than `MaxResults` file system descriptions while still including a `NextToken` value. + The order of file systems returned in the response of one `DescribeFileSystems` call and the order of file systems returned across the responses of a multicall iteration is unspecified. ## Request Syntax ``` { "FileSystemIds": [ "string" ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [FileSystemIds](#API_DescribeFileSystems_RequestSyntax) ** IDs of the file systems whose descriptions you want to retrieve (String). Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: No ** [MaxResults](#API_DescribeFileSystems_RequestSyntax) ** 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [NextToken](#API_DescribeFileSystems_RequestSyntax) ** Opaque pagination token returned from a previous `DescribeFileSystems` operation (String). If a token present, the operation continues the list from where the returning call left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ## Response Syntax ``` { "FileSystems": [ { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } } ], "NextToken": "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. ** [FileSystems](#API_DescribeFileSystems_ResponseSyntax) ** An array of file system descriptions. Type: Array of [FileSystem](API_FileSystem.md) objects Array Members: Maximum number of 50 items. ** [NextToken](#API_DescribeFileSystems_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeFileSystems) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeFileSystems) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeFileSystems) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeFileSystems) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeFileSystems) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeFileSystems) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeFileSystems) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeFileSystems) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeFileSystems) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeFileSystems) # DescribeS3AccessPointAttachments Describes one or more S3 access points attached to Amazon FSx volumes. The requester requires the following permission to perform this action: + `fsx:DescribeS3AccessPointAttachments` ## Request Syntax ``` { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "Names": [ "string" ], "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_DescribeS3AccessPointAttachments_RequestSyntax) ** Enter a filter Name and Values pair to view a select set of S3 access point attachments. Type: Array of [S3AccessPointAttachmentsFilter](API_S3AccessPointAttachmentsFilter.md) objects Array Members: Maximum number of 2 items. Required: No ** [MaxResults](#API_DescribeS3AccessPointAttachments_RequestSyntax) ** The maximum number of resources to return in the response. This value must be an integer greater than zero. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [Names](#API_DescribeS3AccessPointAttachments_RequestSyntax) ** The names of the S3 access point attachments whose descriptions you want to retrieve. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 3. Maximum length of 50. Pattern: `^(?=[a-z0-9])[a-z0-9-]{1,48}[a-z0-9]$` Required: No ** [NextToken](#API_DescribeS3AccessPointAttachments_RequestSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ## Response Syntax ``` { "NextToken": "string", "S3AccessPointAttachments": [ { "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "FileSystemIdentity": { "Type": "string", "UnixUser": { "Name": "string" }, "WindowsUser": { "Name": "string" } }, "VolumeId": "string" }, "OpenZFSConfiguration": { "FileSystemIdentity": { "PosixUser": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Type": "string" }, "VolumeId": "string" }, "S3AccessPoint": { "Alias": "string", "ResourceARN": "string", "VpcConfiguration": { "VpcId": "string" } }, "Type": "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. ** [NextToken](#API_DescribeS3AccessPointAttachments_ResponseSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ** [S3AccessPointAttachments](#API_DescribeS3AccessPointAttachments_ResponseSyntax) ** Array of S3 access point attachments returned after a successful `DescribeS3AccessPointAttachments` operation. Type: Array of [S3AccessPointAttachment](API_S3AccessPointAttachment.md) objects Array Members: Maximum number of 1000 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** S3AccessPointAttachmentNotFound ** The access point specified was not found. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeS3AccessPointAttachments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeS3AccessPointAttachments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeS3AccessPointAttachments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeS3AccessPointAttachments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeS3AccessPointAttachments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeS3AccessPointAttachments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeS3AccessPointAttachments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeS3AccessPointAttachments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeS3AccessPointAttachments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeS3AccessPointAttachments) # DescribeSharedVpcConfiguration Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see [Creating FSx for ONTAP file systems in shared subnets](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/creating-file-systems.html#fsxn-vpc-shared-subnets). ## Response Syntax ``` { "EnableFsxRouteTableUpdatesFromParticipantAccounts": "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. ** [EnableFsxRouteTableUpdatesFromParticipantAccounts](#API_DescribeSharedVpcConfiguration_ResponseSyntax) ** Indicates whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets. Type: String Length Constraints: Minimum length of 4. Maximum length of 5. Pattern: `^(?i)(true|false)$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeSharedVpcConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeSharedVpcConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeSharedVpcConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeSharedVpcConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeSharedVpcConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeSharedVpcConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeSharedVpcConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeSharedVpcConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeSharedVpcConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeSharedVpcConfiguration) # DescribeSnapshots Returns the description of specific Amazon FSx for OpenZFS snapshots, if a `SnapshotIds` value is provided. Otherwise, this operation returns all snapshots owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all snapshots, you can optionally specify the `MaxResults` parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a `NextToken` value in the response. In this case, send a later request with the `NextToken` request parameter set to the value of `NextToken` from the last response. Use this operation in an iterative process to retrieve a list of your snapshots. `DescribeSnapshots` is called first without a `NextToken` value. Then the operation continues to be called with the `NextToken` parameter set to the value of the last `NextToken` value until a response has no `NextToken` value. When using this operation, keep the following in mind: + The operation might return fewer than the `MaxResults` value of snapshot descriptions while still including a `NextToken` value. + The order of snapshots returned in the response of one `DescribeSnapshots` call and the order of backups returned across the responses of a multi-call iteration is unspecified. ## Request Syntax ``` { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "IncludeShared": boolean, "MaxResults": number, "NextToken": "string", "SnapshotIds": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_DescribeSnapshots_RequestSyntax) ** The filters structure. The supported names are `file-system-id` or `volume-id`. Type: Array of [SnapshotFilter](API_SnapshotFilter.md) objects Array Members: Maximum number of 2 items. Required: No ** [IncludeShared](#API_DescribeSnapshots_RequestSyntax) ** Set to `false` (default) if you want to only see the snapshots owned by your AWS account. Set to `true` if you want to see the snapshots in your account and the ones shared with you from another account. Type: Boolean Required: No ** [MaxResults](#API_DescribeSnapshots_RequestSyntax) ** The maximum number of resources to return in the response. This value must be an integer greater than zero. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [NextToken](#API_DescribeSnapshots_RequestSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ** [SnapshotIds](#API_DescribeSnapshots_RequestSyntax) ** The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a `SnapshotNotFound` error occurs. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 11. Maximum length of 28. Pattern: `^((fs)?volsnap-[0-9a-f]{8,})$` Required: No ## Response Syntax ``` { "NextToken": "string", "Snapshots": [ { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": "Snapshot", "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "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. ** [NextToken](#API_DescribeSnapshots_ResponseSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ** [Snapshots](#API_DescribeSnapshots_ResponseSyntax) ** An array of snapshots. Type: Array of [Snapshot](API_Snapshot.md) objects Array Members: Maximum number of 50 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** SnapshotNotFound ** No Amazon FSx snapshots were found based on the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeSnapshots) # DescribeStorageVirtualMachines Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). ## Request Syntax ``` { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "StorageVirtualMachineIds": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_DescribeStorageVirtualMachines_RequestSyntax) ** Enter a filter name:value pair to view a select set of SVMs. Type: Array of [StorageVirtualMachineFilter](API_StorageVirtualMachineFilter.md) objects Array Members: Maximum number of 1 item. Required: No ** [MaxResults](#API_DescribeStorageVirtualMachines_RequestSyntax) ** The maximum number of resources to return in the response. This value must be an integer greater than zero. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [NextToken](#API_DescribeStorageVirtualMachines_RequestSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ** [StorageVirtualMachineIds](#API_DescribeStorageVirtualMachines_RequestSyntax) ** Enter the ID of one or more SVMs that you want to view. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Fixed length of 21. Pattern: `^(svm-[0-9a-f]{17,})$` Required: No ## Response Syntax ``` { "NextToken": "string", "StorageVirtualMachines": [ { "ActiveDirectoryConfiguration": { "NetBiosName": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" } }, "CreationTime": number, "Endpoints": { "Iscsi": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Nfs": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Smb": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "RootVolumeSecurityStyle": "string", "StorageVirtualMachineId": "string", "Subtype": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UUID": "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. ** [NextToken](#API_DescribeStorageVirtualMachines_ResponseSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ** [StorageVirtualMachines](#API_DescribeStorageVirtualMachines_ResponseSyntax) ** Returned after a successful `DescribeStorageVirtualMachines` operation, describing each SVM. Type: Array of [StorageVirtualMachine](API_StorageVirtualMachine.md) objects Array Members: Maximum number of 50 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** StorageVirtualMachineNotFound ** No FSx for ONTAP SVMs were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ## Examples ### View SVMs The following example will return the SVMs for a specific Amazon FSx for ONTAP file system, showing 5 SVMs per page in the response. ``` { "Filters": [ { "Name": "fsx-ontap-fs-id", "Values": [ "fs-0123456789abcdef5" ] } ], "MaxResults": 5 } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeStorageVirtualMachines) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeStorageVirtualMachines) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeStorageVirtualMachines) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeStorageVirtualMachines) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeStorageVirtualMachines) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeStorageVirtualMachines) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeStorageVirtualMachines) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeStorageVirtualMachines) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeStorageVirtualMachines) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeStorageVirtualMachines) # DescribeVolumes Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. ## Request Syntax ``` { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "VolumeIds": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_DescribeVolumes_RequestSyntax) ** Enter a filter `Name` and `Values` pair to view a select set of volumes. Type: Array of [VolumeFilter](API_VolumeFilter.md) objects Array Members: Maximum number of 2 items. Required: No ** [MaxResults](#API_DescribeVolumes_RequestSyntax) ** The maximum number of resources to return in the response. This value must be an integer greater than zero. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [NextToken](#API_DescribeVolumes_RequestSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ** [VolumeIds](#API_DescribeVolumes_RequestSyntax) ** The IDs of the volumes whose descriptions you want to retrieve. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` Required: No ## Response Syntax ``` { "NextToken": "string", "Volumes": [ { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": "Volume", "TotalTransferBytes": number } ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "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. ** [NextToken](#API_DescribeVolumes_ResponseSyntax) ** (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ** [Volumes](#API_DescribeVolumes_ResponseSyntax) ** Returned after a successful `DescribeVolumes` operation, describing each volume. Type: Array of [Volume](API_Volume.md) objects Array Members: Maximum number of 50 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** VolumeNotFound ** No Amazon FSx volumes were found based upon the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DescribeVolumes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DescribeVolumes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DescribeVolumes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DescribeVolumes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DescribeVolumes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DescribeVolumes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DescribeVolumes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DescribeVolumes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DescribeVolumes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DescribeVolumes) # DetachAndDeleteS3AccessPoint Detaches an S3 access point from an Amazon FSx volume and deletes the S3 access point. The requester requires the following permission to perform this action: + `fsx:DetachAndDeleteS3AccessPoint` + `s3:DeleteAccessPoint` ## Request Syntax ``` { "ClientRequestToken": "string", "Name": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_DetachAndDeleteS3AccessPoint_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [Name](#API_DetachAndDeleteS3AccessPoint_RequestSyntax) ** The name of the S3 access point attachment that you want to delete. Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Pattern: `^(?=[a-z0-9])[a-z0-9-]{1,48}[a-z0-9]$` Required: Yes ## Response Syntax ``` { "Lifecycle": "string", "Name": "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. ** [Lifecycle](#API_DetachAndDeleteS3AccessPoint_ResponseSyntax) ** The lifecycle status of the S3 access point attachment. Type: String Valid Values: `AVAILABLE | CREATING | DELETING | UPDATING | FAILED | MISCONFIGURED` ** [Name](#API_DetachAndDeleteS3AccessPoint_ResponseSyntax) ** The name of the S3 access point attachment being deleted. Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Pattern: `^(?=[a-z0-9])[a-z0-9-]{1,48}[a-z0-9]$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** S3AccessPointAttachmentNotFound ** The access point specified was not found. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DetachAndDeleteS3AccessPoint) # DisassociateFileSystemAliases Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with an HTTP status code 400 (Bad Request). For more information, see [Working with DNS Aliases](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html). The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the [DescribeFileSystemAliases](API_DescribeFileSystemAliases.md) API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system. ## Request Syntax ``` { "Aliases": [ "string" ], "ClientRequestToken": "string", "FileSystemId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Aliases](#API_DisassociateFileSystemAliases_RequestSyntax) ** An array of one or more DNS alias names to disassociate, or remove, from the file system. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Minimum length of 4. Maximum length of 253. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{4,253}$` Required: Yes ** [ClientRequestToken](#API_DisassociateFileSystemAliases_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [FileSystemId](#API_DisassociateFileSystemAliases_RequestSyntax) ** Specifies the file system from which to disassociate the DNS aliases. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ## Response Syntax ``` { "Aliases": [ { "Lifecycle": "string", "Name": "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. ** [Aliases](#API_DisassociateFileSystemAliases_ResponseSyntax) ** An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system. Type: Array of [Alias](API_Alias.md) objects Array Members: Maximum number of 50 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/DisassociateFileSystemAliases) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/DisassociateFileSystemAliases) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/DisassociateFileSystemAliases) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/DisassociateFileSystemAliases) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/DisassociateFileSystemAliases) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/DisassociateFileSystemAliases) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/DisassociateFileSystemAliases) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/DisassociateFileSystemAliases) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/DisassociateFileSystemAliases) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/DisassociateFileSystemAliases) # ListTagsForResource Lists tags for Amazon FSx resources. When retrieving all tags, you can optionally specify the `MaxResults` parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a `NextToken` value in the response. In this case, send a later request with the `NextToken` request parameter set to the value of `NextToken` from the last response. This action is used in an iterative process to retrieve a list of your tags. `ListTagsForResource` is called first without a `NextToken`value. 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. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "ResourceARN": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListTagsForResource_RequestSyntax) ** 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2147483647. Required: No ** [NextToken](#API_ListTagsForResource_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` Required: No ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) ** The ARN of the Amazon FSx resource that will have its tags listed. Type: String Length Constraints: Minimum length of 8. Maximum length of 512. Pattern: `^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(? ``` { "NextToken": "string", "Tags": [ { "Key": "string", "Value": "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. ** [NextToken](#API_ListTagsForResource_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$` ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** A list of tags on the resource. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** 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. ** Message ** A detailed error message. ** ResourceARN ** The Amazon Resource Name (ARN) of the non-Amazon FSx resource. HTTP Status Code: 400 ** ResourceDoesNotSupportTagging ** The resource specified does not support tagging. ** Message ** A detailed error message. ** ResourceARN ** The Amazon Resource Name (ARN) of the resource that doesn't support tagging. HTTP Status Code: 400 ** ResourceNotFound ** The resource specified by the Amazon Resource Name (ARN) can't be found. ** Message ** A detailed error message. ** ResourceARN ** The resource ARN of the resource that can't be found. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/ListTagsForResource) # ReleaseFileSystemNfsV3Locks Releases the file system lock from an Amazon FSx for OpenZFS file system. ## Request Syntax ``` { "ClientRequestToken": "string", "FileSystemId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_ReleaseFileSystemNfsV3Locks_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [FileSystemId](#API_ReleaseFileSystemNfsV3Locks_RequestSyntax) ** The globally unique ID of the file system, assigned by Amazon FSx. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ## Response Syntax ``` { "FileSystem": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "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](#API_ReleaseFileSystemNfsV3Locks_ResponseSyntax) ** A description of a specific Amazon FSx file system. Type: [FileSystem](API_FileSystem.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/ReleaseFileSystemNfsV3Locks) # RestoreVolumeFromSnapshot Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot. ## Request Syntax ``` { "ClientRequestToken": "string", "Options": [ "string" ], "SnapshotId": "string", "VolumeId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_RestoreVolumeFromSnapshot_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [Options](#API_RestoreVolumeFromSnapshot_RequestSyntax) ** The settings used when restoring the specified volume from snapshot. + `DELETE_INTERMEDIATE_SNAPSHOTS` - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, `RestoreVolumeFromSnapshot` fails. + `DELETE_CLONED_VOLUMES` - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, `RestoreVolumeFromSnapshot` fails. Type: Array of strings Array Members: Maximum number of 2 items. Valid Values: `DELETE_INTERMEDIATE_SNAPSHOTS | DELETE_CLONED_VOLUMES` Required: No ** [SnapshotId](#API_RestoreVolumeFromSnapshot_RequestSyntax) ** The ID of the source snapshot. Specifies the snapshot that you are restoring from. Type: String Length Constraints: Minimum length of 11. Maximum length of 28. Pattern: `^((fs)?volsnap-[0-9a-f]{8,})$` Required: Yes ** [VolumeId](#API_RestoreVolumeFromSnapshot_RequestSyntax) ** The ID of the volume that you are restoring. Type: String Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` Required: Yes ## Response Syntax ``` { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "Lifecycle": "string", "VolumeId": "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. ** [AdministrativeActions](#API_RestoreVolumeFromSnapshot_ResponseSyntax) ** A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. Type: Array of [AdministrativeAction](API_AdministrativeAction.md) objects Array Members: Maximum number of 50 items. ** [Lifecycle](#API_RestoreVolumeFromSnapshot_ResponseSyntax) ** The lifecycle state of the volume being restored. Type: String Valid Values: `CREATING | CREATED | DELETING | FAILED | MISCONFIGURED | PENDING | AVAILABLE` ** [VolumeId](#API_RestoreVolumeFromSnapshot_ResponseSyntax) ** The ID of the volume that you restored. Type: String Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** VolumeNotFound ** No Amazon FSx volumes were found based upon the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/RestoreVolumeFromSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/RestoreVolumeFromSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/RestoreVolumeFromSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/RestoreVolumeFromSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/RestoreVolumeFromSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/RestoreVolumeFromSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/RestoreVolumeFromSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/RestoreVolumeFromSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/RestoreVolumeFromSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/RestoreVolumeFromSnapshot) # StartMisconfiguredStateRecovery After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system. ## Request Syntax ``` { "ClientRequestToken": "string", "FileSystemId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_StartMisconfiguredStateRecovery_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [FileSystemId](#API_StartMisconfiguredStateRecovery_RequestSyntax) ** The globally unique ID of the file system, assigned by Amazon FSx. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ## Response Syntax ``` { "FileSystem": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "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](#API_StartMisconfiguredStateRecovery_ResponseSyntax) ** A description of a specific Amazon FSx file system. Type: [FileSystem](API_FileSystem.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/StartMisconfiguredStateRecovery) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/StartMisconfiguredStateRecovery) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/StartMisconfiguredStateRecovery) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/StartMisconfiguredStateRecovery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/StartMisconfiguredStateRecovery) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/StartMisconfiguredStateRecovery) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/StartMisconfiguredStateRecovery) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/StartMisconfiguredStateRecovery) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/StartMisconfiguredStateRecovery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/StartMisconfiguredStateRecovery) # TagResource Tags an Amazon FSx resource. ## Request Syntax ``` { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceARN](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag. Type: String Length Constraints: Minimum length of 8. Maximum length of 512. Pattern: `^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(? 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** 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. ** Message ** A detailed error message. ** ResourceARN ** The Amazon Resource Name (ARN) of the non-Amazon FSx resource. HTTP Status Code: 400 ** ResourceDoesNotSupportTagging ** The resource specified does not support tagging. ** Message ** A detailed error message. ** ResourceARN ** The Amazon Resource Name (ARN) of the resource that doesn't support tagging. HTTP Status Code: 400 ** ResourceNotFound ** The resource specified by the Amazon Resource Name (ARN) can't be found. ** Message ** A detailed error message. ** ResourceARN ** The resource ARN of the resource that can't be found. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/TagResource) # UntagResource This action removes a tag from an Amazon FSx resource. ## Request Syntax ``` { "ResourceARN": "string", "TagKeys": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceARN](#API_UntagResource_RequestSyntax) ** The ARN of the Amazon FSx resource to untag. Type: String Length Constraints: Minimum length of 8. Maximum length of 512. Pattern: `^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(? 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. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** 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. ** Message ** A detailed error message. ** ResourceARN ** The Amazon Resource Name (ARN) of the non-Amazon FSx resource. HTTP Status Code: 400 ** ResourceDoesNotSupportTagging ** The resource specified does not support tagging. ** Message ** A detailed error message. ** ResourceARN ** The Amazon Resource Name (ARN) of the resource that doesn't support tagging. HTTP Status Code: 400 ** ResourceNotFound ** The resource specified by the Amazon Resource Name (ARN) can't be found. ** Message ** A detailed error message. ** ResourceARN ** The resource ARN of the resource that can't be found. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/UntagResource) # UpdateDataRepositoryAssociation Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding `scratch_1` deployment type. ## Request Syntax ``` { "AssociationId": "string", "ClientRequestToken": "string", "ImportedFileChunkSize": number, "S3": { "AutoExportPolicy": { "Events": [ "string" ] }, "AutoImportPolicy": { "Events": [ "string" ] } } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AssociationId](#API_UpdateDataRepositoryAssociation_RequestSyntax) ** The ID of the data repository association that you are updating. Type: String Length Constraints: Minimum length of 13. Maximum length of 23. Pattern: `^(dra-[0-9a-f]{8,})$` Required: Yes ** [ClientRequestToken](#API_UpdateDataRepositoryAssociation_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [ImportedFileChunkSize](#API_UpdateDataRepositoryAssociation_RequestSyntax) ** 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 512000. Required: No ** [S3](#API_UpdateDataRepositoryAssociation_RequestSyntax) ** The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository. Type: [S3DataRepositoryConfiguration](API_S3DataRepositoryConfiguration.md) object Required: No ## Response Syntax ``` { "Association": { "AssociationId": "string", "BatchImportMetaDataOnCreate": boolean, "CreationTime": number, "DataRepositoryPath": "string", "DataRepositorySubdirectories": [ "string" ], "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileCachePath": "string", "FileSystemId": "string", "FileSystemPath": "string", "ImportedFileChunkSize": number, "Lifecycle": "string", "NFS": { "AutoExportPolicy": { "Events": [ "string" ] }, "DnsIps": [ "string" ], "Version": "string" }, "ResourceARN": "string", "S3": { "AutoExportPolicy": { "Events": [ "string" ] }, "AutoImportPolicy": { "Events": [ "string" ] } }, "Tags": [ { "Key": "string", "Value": "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. ** [Association](#API_UpdateDataRepositoryAssociation_ResponseSyntax) ** The response object returned after the data repository association is updated. Type: [DataRepositoryAssociation](API_DataRepositoryAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** DataRepositoryAssociationNotFound ** No data repository associations were found based upon the supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** ServiceLimitExceeded ** An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/UpdateDataRepositoryAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/UpdateDataRepositoryAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/UpdateDataRepositoryAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/UpdateDataRepositoryAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/UpdateDataRepositoryAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/UpdateDataRepositoryAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/UpdateDataRepositoryAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/UpdateDataRepositoryAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/UpdateDataRepositoryAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/UpdateDataRepositoryAssociation) # UpdateFileCache Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request. ## Request Syntax ``` { "ClientRequestToken": "string", "FileCacheId": "string", "LustreConfiguration": { "WeeklyMaintenanceStartTime": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_UpdateFileCache_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [FileCacheId](#API_UpdateFileCache_RequestSyntax) ** The ID of the cache that you are updating. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fc-[0-9a-f]{8,})$` Required: Yes ** [LustreConfiguration](#API_UpdateFileCache_RequestSyntax) ** The configuration updates for an Amazon File Cache resource. Type: [UpdateFileCacheLustreConfiguration](API_UpdateFileCacheLustreConfiguration.md) object Required: No ## Response Syntax ``` { "FileCache": { "CreationTime": number, "DataRepositoryAssociationIds": [ "string" ], "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileCacheType": "string", "FileCacheTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "DeploymentType": "string", "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "StorageCapacity": number }, "MountName": "string", "PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "SubnetIds": [ "string" ], "VpcId": "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. ** [FileCache](#API_UpdateFileCache_ResponseSyntax) ** A description of the cache that was updated. Type: [FileCache](API_FileCache.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileCacheNotFound ** No caches were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** MissingFileCacheConfiguration ** A cache configuration is required for this operation. ** Message ** A detailed error message. 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. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/UpdateFileCache) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/UpdateFileCache) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/UpdateFileCache) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/UpdateFileCache) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/UpdateFileCache) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/UpdateFileCache) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/UpdateFileCache) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/UpdateFileCache) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/UpdateFileCache) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/UpdateFileCache) # UpdateFileSystem Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For FSx for Windows File Server file systems, you can update the following properties: + `AuditLogConfiguration` + `AutomaticBackupRetentionDays` + `DailyAutomaticBackupStartTime` + `DiskIopsConfiguration` + `SelfManagedActiveDirectoryConfiguration` + `StorageCapacity` + `StorageType` + `ThroughputCapacity` + `WeeklyMaintenanceStartTime` For FSx for Lustre file systems, you can update the following properties: + `AutoImportPolicy` + `AutomaticBackupRetentionDays` + `DailyAutomaticBackupStartTime` + `DataCompressionType` + `FileSystemTypeVersion` + `LogConfiguration` + `LustreReadCacheConfiguration` + `LustreRootSquashConfiguration` + `MetadataConfiguration` + `PerUnitStorageThroughput` + `StorageCapacity` + `ThroughputCapacity` + `WeeklyMaintenanceStartTime` For FSx for ONTAP file systems, you can update the following properties: + `AddRouteTableIds` + `AutomaticBackupRetentionDays` + `DailyAutomaticBackupStartTime` + `DiskIopsConfiguration` + `EndpointIpv6AddressRange` + `FsxAdminPassword` + `HAPairs` + `RemoveRouteTableIds` + `StorageCapacity` + `ThroughputCapacity` + `ThroughputCapacityPerHAPair` + `WeeklyMaintenanceStartTime` For FSx for OpenZFS file systems, you can update the following properties: + `AddRouteTableIds` + `AutomaticBackupRetentionDays` + `CopyTagsToBackups` + `CopyTagsToVolumes` + `DailyAutomaticBackupStartTime` + `DiskIopsConfiguration` + `EndpointIpv6AddressRange` + `ReadCacheConfiguration` + `RemoveRouteTableIds` + `StorageCapacity` + `ThroughputCapacity` + `WeeklyMaintenanceStartTime` ## Request Syntax ``` { "ClientRequestToken": "string", "FileSystemId": "string", "FileSystemTypeVersion": "string", "LustreConfiguration": { "AutoImportPolicy": "string", "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkType": "string", "OntapConfiguration": { "AddRouteTableIds": [ "string" ], "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpv6AddressRange": "string", "FsxAdminPassword": "string", "HAPairs": number, "RemoveRouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AddRouteTableIds": [ "string" ], "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpv6AddressRange": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RemoveRouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "StorageCapacity": number, "StorageType": "string", "WindowsConfiguration": { "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "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](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_UpdateFileSystem_RequestSyntax) ** A string of up to 63 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[A-za-z0-9_.-]{0,63}$` Required: No ** [FileSystemId](#API_UpdateFileSystem_RequestSyntax) ** The ID of the file system that you are updating. Type: String Length Constraints: Minimum length of 11. Maximum length of 21. Pattern: `^(fs-[0-9a-f]{8,})$` Required: Yes ** [FileSystemTypeVersion](#API_UpdateFileSystem_RequestSyntax) ** The Lustre version you are updating an FSx for Lustre file system to. Valid values are `2.12` and `2.15`. The value you choose must be newer than the file system's current Lustre version. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: `^[0-9](.[0-9]*)*$` Required: No ** [LustreConfiguration](#API_UpdateFileSystem_RequestSyntax) ** The configuration object for Amazon FSx for Lustre file systems used in the `UpdateFileSystem` operation. Type: [UpdateFileSystemLustreConfiguration](API_UpdateFileSystemLustreConfiguration.md) object Required: No ** [NetworkType](#API_UpdateFileSystem_RequestSyntax) ** Changes the network type of an FSx for OpenZFS file system. Type: String Valid Values: `IPV4 | DUAL` Required: No ** [OntapConfiguration](#API_UpdateFileSystem_RequestSyntax) ** The configuration updates for an Amazon FSx for NetApp ONTAP file system. Type: [UpdateFileSystemOntapConfiguration](API_UpdateFileSystemOntapConfiguration.md) object Required: No ** [OpenZFSConfiguration](#API_UpdateFileSystem_RequestSyntax) ** The configuration updates for an FSx for OpenZFS file system. Type: [UpdateFileSystemOpenZFSConfiguration](API_UpdateFileSystemOpenZFSConfiguration.md) object Required: No ** [StorageCapacity](#API_UpdateFileSystem_RequestSyntax) ** Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. For second-generation FSx for ONTAP file systems, you can also decrease the storage capacity. Specifies the storage capacity target value, in GiB, for the file system that you're updating. You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress. For Lustre file systems, the storage capacity target value can be the following: + For `SCRATCH_2`, `PERSISTENT_1`, and `PERSISTENT_2 SSD` deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity. + For `PERSISTENT HDD` file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity. + For `SCRATCH_1` file systems, you can't increase the storage capacity. For more information, see [Managing storage and throughput capacity](https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html) in the *FSx for Lustre User Guide*. For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see [Managing storage capacity](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html) in the *FSx for OpenZFS User Guide*. For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see [Managing storage capacity](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html) in the *Amazon FSxfor Windows File Server User Guide*. For ONTAP file systems, when increasing storage capacity, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. When decreasing storage capacity on second-generation file systems, the target value must be at least 9 percent smaller than the current SSD storage capacity. For more information, see [File system storage capacity and IOPS](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/storage-capacity-and-IOPS.html) in the Amazon FSx for NetApp ONTAP User Guide. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. Required: No ** [StorageType](#API_UpdateFileSystem_RequestSyntax) ** Specifies the file system's storage type. Type: String Valid Values: `SSD | HDD | INTELLIGENT_TIERING` Required: No ** [WindowsConfiguration](#API_UpdateFileSystem_RequestSyntax) ** The configuration updates for an Amazon FSx for Windows File Server file system. Type: [UpdateFileSystemWindowsConfiguration](API_UpdateFileSystemWindowsConfiguration.md) object Required: No ## Response Syntax ``` { "FileSystem": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "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](#API_UpdateFileSystem_ResponseSyntax) ** A description of the file system that was updated. Type: [FileSystem](API_FileSystem.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** FileSystemNotFound ** No Amazon FSx file systems were found based upon supplied parameters. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** InvalidNetworkSettings ** One or more network settings specified in the request are invalid. ** InvalidRouteTableId ** The route table ID is either invalid or not part of the VPC specified. ** InvalidSecurityGroupId ** The security group ID is either invalid or not part of the VPC specified. ** InvalidSubnetId ** The subnet ID that is either invalid or not part of the VPC specified. ** Message ** Error message explaining what's wrong with network settings. HTTP Status Code: 400 ** MissingFileSystemConfiguration ** A file system configuration is required for this operation. ** Message ** A detailed error message. 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. ** Limit ** Enumeration of the service limit that was exceeded. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/UpdateFileSystem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/UpdateFileSystem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/UpdateFileSystem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/UpdateFileSystem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/UpdateFileSystem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/UpdateFileSystem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/UpdateFileSystem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/UpdateFileSystem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/UpdateFileSystem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/UpdateFileSystem) # UpdateSharedVpcConfiguration Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the [Amazon FSx for NetApp ONTAP User Guide](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html). **Note** We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a `MISCONFIGURED` state and behave like Single-AZ file systems. For more information, see [Important considerations before disabling shared VPC support for Multi-AZ file systems](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html#disabling-maz-vpc-sharing). ## Request Syntax ``` { "ClientRequestToken": "string", "EnableFsxRouteTableUpdatesFromParticipantAccounts": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_UpdateSharedVpcConfiguration_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [EnableFsxRouteTableUpdatesFromParticipantAccounts](#API_UpdateSharedVpcConfiguration_RequestSyntax) ** Specifies whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets. Set to `true` to enable or `false` to disable. Type: String Length Constraints: Minimum length of 4. Maximum length of 5. Pattern: `^(?i)(true|false)$` Required: No ## Response Syntax ``` { "EnableFsxRouteTableUpdatesFromParticipantAccounts": "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. ** [EnableFsxRouteTableUpdatesFromParticipantAccounts](#API_UpdateSharedVpcConfiguration_ResponseSyntax) ** Indicates whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets. Type: String Length Constraints: Minimum length of 4. Maximum length of 5. Pattern: `^(?i)(true|false)$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/UpdateSharedVpcConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/UpdateSharedVpcConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/UpdateSharedVpcConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/UpdateSharedVpcConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/UpdateSharedVpcConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/UpdateSharedVpcConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/UpdateSharedVpcConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/UpdateSharedVpcConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/UpdateSharedVpcConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/UpdateSharedVpcConfiguration) # UpdateSnapshot Updates the name of an Amazon FSx for OpenZFS snapshot. ## Request Syntax ``` { "ClientRequestToken": "string", "Name": "string", "SnapshotId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_UpdateSnapshot_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [Name](#API_UpdateSnapshot_RequestSyntax) ** The name of the snapshot to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 203. Pattern: `^[a-zA-Z0-9_:.-]{1,203}$` Required: Yes ** [SnapshotId](#API_UpdateSnapshot_RequestSyntax) ** The ID of the snapshot that you want to update, in the format `fsvolsnap-0123456789abcdef0`. Type: String Length Constraints: Minimum length of 11. Maximum length of 28. Pattern: `^((fs)?volsnap-[0-9a-f]{8,})$` Required: Yes ## Response Syntax ``` { "Snapshot": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": "Snapshot", "TargetVolumeValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "string" }, "TotalTransferBytes": number } ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "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. ** [Snapshot](#API_UpdateSnapshot_ResponseSyntax) ** Returned after a successful `UpdateSnapshot` operation, describing the snapshot that you updated. Type: [Snapshot](API_Snapshot.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** SnapshotNotFound ** No Amazon FSx snapshots were found based on the supplied parameters. ** Message ** A detailed error message. 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 V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/UpdateSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/UpdateSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/UpdateSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/UpdateSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/UpdateSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/UpdateSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/UpdateSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/UpdateSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/UpdateSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/UpdateSnapshot) # UpdateStorageVirtualMachine Updates an FSx for ONTAP storage virtual machine (SVM). ## Request Syntax ``` { "ActiveDirectoryConfiguration": { "NetBiosName": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "Password": "string", "UserName": "string" } }, "ClientRequestToken": "string", "StorageVirtualMachineId": "string", "SvmAdminPassword": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ActiveDirectoryConfiguration](#API_UpdateStorageVirtualMachine_RequestSyntax) ** Specifies updates to an SVM's Microsoft Active Directory (AD) configuration. Type: [UpdateSvmActiveDirectoryConfiguration](API_UpdateSvmActiveDirectoryConfiguration.md) object Required: No ** [ClientRequestToken](#API_UpdateStorageVirtualMachine_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [StorageVirtualMachineId](#API_UpdateStorageVirtualMachine_RequestSyntax) ** The ID of the SVM that you want to update, in the format `svm-0123456789abcdef0`. Type: String Length Constraints: Fixed length of 21. Pattern: `^(svm-[0-9a-f]{17,})$` Required: Yes ** [SvmAdminPassword](#API_UpdateStorageVirtualMachine_RequestSyntax) ** Specifies a new SvmAdminPassword. Type: String Length Constraints: Minimum length of 8. Maximum length of 50. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{8,50}$` Required: No ## Response Syntax ``` { "StorageVirtualMachine": { "ActiveDirectoryConfiguration": { "NetBiosName": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" } }, "CreationTime": number, "Endpoints": { "Iscsi": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Nfs": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Smb": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "RootVolumeSecurityStyle": "string", "StorageVirtualMachineId": "string", "Subtype": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UUID": "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. ** [StorageVirtualMachine](#API_UpdateStorageVirtualMachine_ResponseSyntax) ** Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration. Type: [StorageVirtualMachine](API_StorageVirtualMachine.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** StorageVirtualMachineNotFound ** No FSx for ONTAP SVMs were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ** UnsupportedOperation ** The requested operation is not supported for this resource or API. ** Message ** A detailed error message. HTTP Status Code: 400 ## Examples ### Update an FSx for ONTAP SVM This example updates the Microsoft Active Directory user credentials of an existing SVM that is joined to a AD. ``` { "ActiveDirectoryConfiguration": { "SelfManagedActiveDirectoryConfiguration": { "UserName": "admin_user" "Password": "new_password", } }, "StorageVirtualMachineId": "svm-0123456789abcdef3" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/UpdateStorageVirtualMachine) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/UpdateStorageVirtualMachine) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/UpdateStorageVirtualMachine) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/UpdateStorageVirtualMachine) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/UpdateStorageVirtualMachine) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/UpdateStorageVirtualMachine) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/UpdateStorageVirtualMachine) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/UpdateStorageVirtualMachine) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/UpdateStorageVirtualMachine) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/UpdateStorageVirtualMachine) # UpdateVolume Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. ## Request Syntax ``` { "ClientRequestToken": "string", "Name": "string", "OntapConfiguration": { "CopyTagsToBackups": boolean, "JunctionPath": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" } }, "OpenZFSConfiguration": { "DataCompressionType": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "ReadOnly": boolean, "RecordSizeKiB": number, "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ] }, "VolumeId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientRequestToken](#API_UpdateVolume_RequestSyntax) ** (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token 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 ** [Name](#API_UpdateVolume_RequestSyntax) ** The name of the OpenZFS volume. OpenZFS root volumes are automatically named `FSX`. Child volume names must be unique among their parent volume's children. The name of the volume is part of the mount string for the OpenZFS volume. Type: String Length Constraints: Minimum length of 1. Maximum length of 203. Pattern: `^[^\u0000\u0085\u2028\u2029\r\n]{1,203}$` Required: No ** [OntapConfiguration](#API_UpdateVolume_RequestSyntax) ** The configuration of the ONTAP volume that you are updating. Type: [UpdateOntapVolumeConfiguration](API_UpdateOntapVolumeConfiguration.md) object Required: No ** [OpenZFSConfiguration](#API_UpdateVolume_RequestSyntax) ** The configuration of the OpenZFS volume that you are updating. Type: [UpdateOpenZFSVolumeConfiguration](API_UpdateOpenZFSVolumeConfiguration.md) object Required: No ** [VolumeId](#API_UpdateVolume_RequestSyntax) ** The ID of the volume that you want to update, in the format `fsvol-0123456789abcdef0`. Type: String Length Constraints: Fixed length of 23. Pattern: `^(fsvol-[0-9a-f]{17,})$` Required: Yes ## Response Syntax ``` { "Volume": { "AdministrativeActions": [ { "AdministrativeActionType": "string", "FailureDetails": { "Message": "string" }, "Message": "string", "ProgressPercent": number, "RemainingTransferBytes": number, "RequestTime": number, "Status": "string", "TargetFileSystemValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string", "DataReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "DataRepositoryConfiguration": { "AutoImportPolicy": "string", "ExportPath": "string", "FailureDetails": { "Message": "string" }, "ImportedFileChunkSize": number, "ImportPath": "string", "Lifecycle": "string" }, "DeploymentType": "string", "DriveCacheType": "string", "EfaEnabled": boolean, "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "Iops": number, "Mode": "string" }, "MountName": "string", "PerUnitStorageThroughput": number, "RootSquashConfiguration": { "NoSquashNids": [ "string" ], "RootSquash": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "NetworkType": "string", "OntapConfiguration": { "AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddressRange": "string", "EndpointIpv6AddressRange": "string", "Endpoints": { "Intercluster": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] }, "Management": { "DNSName": "string", "IpAddresses": [ "string" ], "Ipv6Addresses": [ "string" ] } }, "FsxAdminPassword": "string", "HAPairs": number, "PreferredSubnetId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "ThroughputCapacityPerHAPair": number, "WeeklyMaintenanceStartTime": "string" }, "OpenZFSConfiguration": { "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "CopyTagsToVolumes": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "EndpointIpAddress": "string", "EndpointIpAddressRange": "string", "EndpointIpv6Address": "string", "EndpointIpv6AddressRange": "string", "PreferredSubnetId": "string", "ReadCacheConfiguration": { "SizeGiB": number, "SizingMode": "string" }, "RootVolumeId": "string", "RouteTableIds": [ "string" ], "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" }, "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string", "WindowsConfiguration": { "ActiveDirectoryId": "string", "Aliases": [ { "Lifecycle": "string", "Name": "string" } ], "AuditLogConfiguration": { "AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string" }, "AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string", "DiskIopsConfiguration": { "Iops": number, "Mode": "string" }, "FsrmConfiguration": { "EventLogDestination": "string", "FsrmServiceEnabled": boolean }, "MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string", "PreferredFileServerIpv6": "string", "PreferredSubnetId": "string", "RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ], "DomainJoinServiceAccountSecret": "string", "DomainName": "string", "FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string" }, "ThroughputCapacity": number, "WeeklyMaintenanceStartTime": "string" } }, "TargetSnapshotValues": { "AdministrativeActions": [ "AdministrativeAction" ], "CreationTime": number, "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string" }, "TargetVolumeValues": "Volume", "TotalTransferBytes": number } ], "CreationTime": number, "FileSystemId": "string", "Lifecycle": "string", "LifecycleTransitionReason": { "Message": "string" }, "Name": "string", "OntapConfiguration": { "AggregateConfiguration": { "Aggregates": [ "string" ], "TotalConstituents": number }, "CopyTagsToBackups": boolean, "FlexCacheEndpointType": "string", "JunctionPath": "string", "OntapVolumeType": "string", "SecurityStyle": "string", "SizeInBytes": number, "SizeInMegabytes": number, "SnaplockConfiguration": { "AuditLogVolume": boolean, "AutocommitPeriod": { "Type": "string", "Value": number }, "PrivilegedDelete": "string", "RetentionPeriod": { "DefaultRetention": { "Type": "string", "Value": number }, "MaximumRetention": { "Type": "string", "Value": number }, "MinimumRetention": { "Type": "string", "Value": number } }, "SnaplockType": "string", "VolumeAppendModeEnabled": boolean }, "SnapshotPolicy": "string", "StorageEfficiencyEnabled": boolean, "StorageVirtualMachineId": "string", "StorageVirtualMachineRoot": boolean, "TieringPolicy": { "CoolingPeriod": number, "Name": "string" }, "UUID": "string", "VolumeStyle": "string" }, "OpenZFSConfiguration": { "CopyStrategy": "string", "CopyTagsToSnapshots": boolean, "DataCompressionType": "string", "DeleteClonedVolumes": boolean, "DeleteIntermediateData": boolean, "DeleteIntermediateSnaphots": boolean, "DestinationSnapshot": "string", "NfsExports": [ { "ClientConfigurations": [ { "Clients": "string", "Options": [ "string" ] } ] } ], "OriginSnapshot": { "CopyStrategy": "string", "SnapshotARN": "string" }, "ParentVolumeId": "string", "ReadOnly": boolean, "RecordSizeKiB": number, "RestoreToSnapshot": "string", "SourceSnapshotARN": "string", "StorageCapacityQuotaGiB": number, "StorageCapacityReservationGiB": number, "UserAndGroupQuotas": [ { "Id": number, "StorageCapacityQuotaGiB": number, "Type": "string" } ], "VolumePath": "string" }, "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeId": "string", "VolumeType": "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. ** [Volume](#API_UpdateVolume_ResponseSyntax) ** A description of the volume just updated. Returned after a successful `UpdateVolume` API operation. Type: [Volume](API_Volume.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequest ** A generic error indicating a failure with a client request. ** Message ** A detailed error message. 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. ** Message ** A detailed error message. ** Parameter ** A parameter that is incompatible with the earlier request. HTTP Status Code: 400 ** InternalServerError ** A generic error indicating a server-side failure. ** Message ** A detailed error message. HTTP Status Code: 500 ** MissingVolumeConfiguration ** A volume configuration is required for this operation. ** Message ** A detailed error message. HTTP Status Code: 400 ** VolumeNotFound ** No Amazon FSx volumes were found based upon the supplied parameters. ** Message ** A detailed error message. HTTP Status Code: 400 ## Examples ### Update an existing ONTAP volume The following example updates the specified volume's `JunctionPath`, `SizeInMegabytes`, and `CoolingPeriod` properties. ``` { "OntapConfiguration": { "JunctionPath": "/new_junction_path/dir2", "SizeInMegabytes": 204800, "TieringPolicy": { "CoolingPeriod": 120 } }, "VolumeId": "fsvol-0123456789abcef2" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/UpdateVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/UpdateVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/UpdateVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/UpdateVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/UpdateVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/UpdateVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/UpdateVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/UpdateVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/UpdateVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/UpdateVolume)