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.
The request accepts the following data in JSON format.
- AssociationIds
-
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
-
A list of
Filterelements.Type: Array of Filter objects
Array Members: Maximum number of 10 items.
Required: No
- MaxResults
-
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
-
(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
NextTokenvalue 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
-
An array of one or more data repository association descriptions.
Type: Array of DataRepositoryAssociation objects
Array Members: Maximum number of 100 items.
- NextToken
-
(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
NextTokenvalue 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 Errors.
- BadRequest
-
A generic error indicating a failure with a client request.
HTTP Status Code: 400
- DataRepositoryAssociationNotFound
-
No data repository associations were found based upon the supplied parameters.
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
- InvalidDataRepositoryType
-
You have filtered the response to a data repository type that is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
