DescribeReplicationConfigurations
Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved.
Request Syntax
GET /2015-02-01/file-systems/replication-configurations?FileSystemId=FileSystemId
&MaxResults=MaxResults
&NextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- FileSystemId
-
You can retrieve the replication configuration for a specific file system by providing its file system ID.
Length Constraints: Maximum length of 128.
Pattern:
^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$
- MaxResults
-
(Optional) To limit the number of objects returned in a response, you can specify the
MaxItems
parameter. The default value is 100.Valid Range: Minimum value of 1.
- NextToken
-
NextToken
is present if the response is paginated. You can useNextToken
in a subsequent request to fetch the next page of output.Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.+
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Replications": [
{
"CreationTime": number,
"Destinations": [
{
"FileSystemId": "string",
"LastReplicatedTimestamp": number,
"Region": "string",
"Status": "string"
}
],
"OriginalSourceFileSystemArn": "string",
"SourceFileSystemArn": "string",
"SourceFileSystemId": "string",
"SourceFileSystemRegion": "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
-
You can use the
NextToken
from the previous response in a subsequent request to fetch the additional descriptions.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.+
- Replications
-
The collection of replication configurations that is returned.
Type: Array of ReplicationConfigurationDescription objects
Errors
- BadRequest
-
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
HTTP Status Code: 400
- FileSystemNotFound
-
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.HTTP Status Code: 404
- InternalServerError
-
Returned if an error occurred on the server side.
HTTP Status Code: 500
- ReplicationNotFound
-
Returned if the specified file system does not have a replication configuration.
HTTP Status Code: 404
- ValidationException
-
Returned if the Amazon Backup service is not available in the Amazon Web Services Region in which the request was made.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: