],
"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 (p. 146)
(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 (p. 146)
Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.
Type: Array of StorageVirtualMachine (p. 308) objects Array Members: Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 345).
BadRequest
A generic error indicating a failure with a client request.
HTTP Status Code: 400 InternalServerError
A generic error indicating a server-side failure.
HTTP Status Code: 500 StorageVirtualMachineNotFound
No FSx for ONTAP SVMs were found based upon the supplied parameters.
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.
See Also
{ "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
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeVolumes
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 (p. 343).
The request accepts the following data in JSON format.
Filters (p. 149)
Enter a filter Name and Values pair to view a select set of volumes.
Type: Array of VolumeFilter (p. 334) objects Array Members: Maximum number of 2 items.
Required: No MaxResults (p. 149)
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 (p. 149)
(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
VolumeIds (p. 149)
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,})$
Response Syntax
Response Syntax
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 (p. 150)
(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
Volumes (p. 150)
Returned after a successful DescribeVolumes operation, describing each volume.
Type: Array of Volume (p. 331) objects
Array Members: Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 345).
BadRequest
A generic error indicating a failure with a client request.
HTTP Status Code: 400 InternalServerError
A generic error indicating a server-side failure.
HTTP Status Code: 500 VolumeNotFound
No Amazon FSx volumes were found based upon the supplied parameters.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DisassociateFileSystemAliases
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 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 DescribeFileSystemAliases (p. 129) 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 (p. 343).
The request accepts the following data in JSON format.
Aliases (p. 155)
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 (p. 155)
(Optional) An idempotency token for resource creation, in a string of up to 64 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 (p. 155)
Specifies the file system from which to disassociate the DNS aliases.
Type: String
Response Syntax
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 (p. 156)
An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.
Type: Array of Alias (p. 210) objects
Array Members: Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 345).
BadRequest
A generic error indicating a failure with a client request.
HTTP Status Code: 400 FileSystemNotFound
No Amazon FSx file systems were found based upon supplied parameters.
HTTP Status Code: 400 InternalServerError
A generic error indicating a server-side failure.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListTagsForResource
ListTagsForResource
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.
Request Syntax
{
"MaxResults": number, "NextToken": "string", "ResourceARN": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 343).
The request accepts the following data in JSON format.
MaxResults (p. 158)
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 (p. 158)
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.
Response Syntax
Pattern: ^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$
Required: No ResourceARN (p. 158)
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].*(?<!-)):){4}
(?!/).{0,1024}$
Required: Yes
Response Syntax
{
"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 (p. 159)
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 (p. 159)
A list of tags on the resource.
Type: Array of Tag (p. 315) 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 Errors (p. 345).
See Also
BadRequest
A generic error indicating a failure with a client request.
HTTP Status Code: 400 InternalServerError
A generic error indicating a server-side failure.
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.
HTTP Status Code: 400 ResourceDoesNotSupportTagging
The resource specified does not support tagging.
HTTP Status Code: 400 ResourceNotFound
The resource specified by the Amazon Resource Name (ARN) 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
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3