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 and Walkthrough 5: Using DNS aliases to access your file system, 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 API operation to monitor the status of the aliases Amazon FSx is associating with the file system.
", "method": "post", "endpoint": "#X-Amz-Target=AWSSimbaAPIService_v20180301.AssociateFileSystemAliases", "responses": [ { "uuid": "e7d9e7d5-0df7-49a8-9e1b-babba435f894", "body": "{\n \"Aliases\": [\n {\n \"Name\": \"\",\n \"Lifecycle\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8228afe9-bb11-4b40-abae-a715b52a5548", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "BadRequest", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0c66d8fc-ce86-4e9c-b024-d5cef0b29ec3", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "FileSystemNotFound", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "60094042-b188-4955-b19d-58ed0d0a6de2", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InternalServerError", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "68dff5bf-e971-41e2-9b8f-9de9fa975a8f", "documentation": "Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a 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.
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services 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 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 Amazon Web Services partition.
You can also use backup copies to clone your file data set to another Region or within the same Region.
You can use the SourceRegion parameter to specify the Amazon Web Services 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 on creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide and Copying backups in the Amazon FSx for Lustre User Guide.
", "method": "post", "endpoint": "#X-Amz-Target=AWSSimbaAPIService_v20180301.CopyBackup", "responses": [ { "uuid": "35947ed5-83b3-4a72-a3e9-9d2c1b99dd08", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a04ea6dd-4f20-462d-8021-ea377143b5d1", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "BadRequest", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3519dd26-c251-456c-afa1-3466dcec9c92", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "BackupNotFound", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a9bc0a1d-f53b-4d09-b8b6-954ff0cd682e", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "ServiceLimitExceeded", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d7964547-a494-4d62-a978-197408cf42c8", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "UnsupportedOperation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5108f371-3f1b-46e1-9813-4abec9ada7fd", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "IncompatibleParameterError", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6ce96136-a7c6-4d61-9f4a-aaa25ab5c8cc", "body": "\"\"", "latency": 0, "statusCode": 485, "label": "InternalServerError", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "deeca6b8-04c9-4821-9cbf-73e183e4dd27", "body": "\"\"", "latency": 0, "statusCode": 486, "label": "InvalidSourceKmsKey", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d139c7cf-01be-4e26-92db-e6034472f160", "body": "\"\"", "latency": 0, "statusCode": 487, "label": "InvalidDestinationKmsKey", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "10ddbb13-4f67-4c20-b27f-93d41f99c9c7", "body": "\"\"", "latency": 0, "statusCode": 488, "label": "InvalidRegion", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b31883f2-e417-4104-8115-b0ad8f6d85ae", "body": "\"\"", "latency": 0, "statusCode": 489, "label": "SourceBackupUnavailable", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a076b6ce-3f06-409f-8ada-0f7d1f21b810", "body": "\"\"", "latency": 0, "statusCode": 490, "label": "IncompatibleRegionForMultiAZ", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "03d93691-6cf3-4b3c-b8ed-0f152ff0c346", "documentation": "Creates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume. Creating regular backups is a best practice, enabling you to 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 with the following configuration:
a Persistent deployment type
is 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.
For Amazon FSx for Windows, see Working with FSx for Windows backups.
For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.
The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.
CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.",
"method": "post",
"endpoint": "#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateDataRepositoryTask",
"responses": [
{
"uuid": "a99a30b2-5bf2-469c-a3bf-266eb0f06b0d",
"body": "{\n \"DataRepositoryTask\": {\n \"TaskId\": \"\",\n \"Lifecycle\": \"\",\n \"Type\": \"\",\n \"CreationTime\": \"{{faker 'date.recent' 365}}\",\n \"StartTime\": \"{{faker 'date.recent' 365}}\",\n \"EndTime\": \"{{faker 'date.recent' 365}}\",\n \"ResourceARN\": \"\",\n \"Tags\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ],\n \"FileSystemId\": \"\",\n \"Paths\": [\n \"\"\n ],\n \"FailureDetails\": {\n \"Message\": \"\"\n },\n \"Status\": {\n \"TotalCount\": {{faker 'number.int' max=99999}},\n \"SucceededCount\": {{faker 'number.int' max=99999}},\n \"FailedCount\": {{faker 'number.int' max=99999}},\n \"LastUpdatedTime\": \"{{faker 'date.recent' 365}}\"\n },\n \"Report\": {\n \"Enabled\": {{faker 'datatype.boolean'}},\n \"Path\": \"\",\n \"Format\": \"\",\n \"Scope\": \"\"\n }\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Success",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "67f4fd0d-95c1-413c-8215-527bee098a3b",
"body": "\"\"",
"latency": 0,
"statusCode": 480,
"label": "BadRequest",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "7d084f12-1cc3-405a-918e-a267b01feb15",
"body": "\"\"",
"latency": 0,
"statusCode": 481,
"label": "UnsupportedOperation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "cb603476-26c4-4303-8a49-9ba97042a00f",
"body": "\"\"",
"latency": 0,
"statusCode": 482,
"label": "FileSystemNotFound",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "a17c4920-824a-4e86-8d23-db14135242de",
"body": "\"\"",
"latency": 0,
"statusCode": 483,
"label": "IncompatibleParameterError",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "071ffb94-a7de-49ec-a792-aadb181d7e6c",
"body": "\"\"",
"latency": 0,
"statusCode": 484,
"label": "ServiceLimitExceeded",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "abf06203-90ce-4e7e-9067-8f958cd57cd9",
"body": "\"\"",
"latency": 0,
"statusCode": 485,
"label": "InternalServerError",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "5874c05b-9a97-429e-8ef0-ad4411d41239",
"body": "\"\"",
"latency": 0,
"statusCode": 486,
"label": "DataRepositoryTaskExecuting",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "f9089916-6caa-49ed-ba94-7418cf18f469",
"documentation": "Creates a new, empty Amazon FSx file system.
If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server 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 client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and SVMs on the file system. Then provide a FileSystemId value to the DeleFileSystem operation.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.
The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.
Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state.
The data in a deleted file system is also deleted and can't be recovered by any means.
fsx:TagResource permission in order to apply tags to the backup.",
"method": "post",
"endpoint": "#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteVolume",
"responses": [
{
"uuid": "b304a3e4-1798-4915-a773-2106ea422d14",
"body": "{\n \"VolumeId\": \"\",\n \"Lifecycle\": \"\",\n \"OntapResponse\": {\n \"FinalBackupId\": \"\",\n \"FinalBackupTags\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n}",
"latency": 0,
"statusCode": 200,
"label": "Success",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
},
{
"uuid": "6b896575-7b75-4c3a-b01f-ee3aa26b8310",
"body": "\"\"",
"latency": 0,
"statusCode": 480,
"label": "BadRequest",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "b9e68e2b-4878-41ea-87e5-ecbc192d76dd",
"body": "\"\"",
"latency": 0,
"statusCode": 481,
"label": "IncompatibleParameterError",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "3c2fa751-3365-4686-afc3-a1a7438a5815",
"body": "\"\"",
"latency": 0,
"statusCode": 482,
"label": "InternalServerError",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
},
{
"uuid": "83f51b7e-8426-4d30-a16e-84503dda5cee",
"body": "\"\"",
"latency": 0,
"statusCode": 483,
"label": "VolumeNotFound",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": false,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "1894cf32-d275-4741-9c6b-3b0b01bf5899",
"documentation": "Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults backup descriptions while still including a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
Returns the description of specific Amazon FSx for Lustre 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 tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services 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, 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.
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 Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
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 a 400 Bad Request. For more information, see Working with DNS Aliases.
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
", "method": "post", "endpoint": "#X-Amz-Target=AWSSimbaAPIService_v20180301.DisassociateFileSystemAliases", "responses": [ { "uuid": "42d825d3-a734-4a30-8047-0f3e11468a5c", "body": "{\n \"Aliases\": [\n {\n \"Name\": \"\",\n \"Lifecycle\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9bc66754-dae6-4439-b156-adab62d11ff5", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "BadRequest", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3701c239-a0db-43f6-a08c-db83ff1a55ea", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "FileSystemNotFound", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f8842d84-f834-4812-ba1f-749b381b4a55", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InternalServerError", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "66a8d353-5a60-4324-ae87-9cb56a0af6af", "documentation": "Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.
Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For Amazon FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
StorageCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for NetApp ONTAP file systems, you can update the following properties:
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
FsxAdminPassword
WeeklyMaintenanceStartTime