EFS / Client / describe_replication_configurations

describe_replication_configurations#

EFS.Client.describe_replication_configurations(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_configurations(
    FileSystemId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • FileSystemId (string) – You can retrieve the replication configuration for a specific file system by providing its file system ID.

  • NextToken (string) – NextToken is present if the response is paginated. You can use NextToken in a subsequent request to fetch the next page of output.

  • MaxResults (integer) – (Optional) To limit the number of objects returned in a response, you can specify the MaxItems parameter. The default value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'Replications': [
        {
            'SourceFileSystemId': 'string',
            'SourceFileSystemRegion': 'string',
            'SourceFileSystemArn': 'string',
            'OriginalSourceFileSystemArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'Destinations': [
                {
                    'Status': 'ENABLED'|'ENABLING'|'DELETING'|'ERROR'|'PAUSED'|'PAUSING',
                    'FileSystemId': 'string',
                    'Region': 'string',
                    'LastReplicatedTimestamp': datetime(2015, 1, 1)
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Replications (list) –

      The collection of replication configurations that is returned.

      • (dict) –

        • SourceFileSystemId (string) –

          The ID of the source Amazon EFS file system that is being replicated.

        • SourceFileSystemRegion (string) –

          The Amazon Web Services Region in which the source Amazon EFS file system is located.

        • SourceFileSystemArn (string) –

          The Amazon Resource Name (ARN) of the current source file system in the replication configuration.

        • OriginalSourceFileSystemArn (string) –

          The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.

        • CreationTime (datetime) –

          Describes when the replication configuration was created.

        • Destinations (list) –

          An array of destination objects. Only one destination object is supported.

          • (dict) –

            Describes the destination file system in the replication configuration.

            • Status (string) –

              Describes the status of the destination Amazon EFS file system.

              • The Paused state occurs as a result of opting out of the source or destination Region after the replication configuration was created. To resume replication for the file system, you need to again opt in to the Amazon Web Services Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Guide.

              • The Error state occurs when either the source or the destination file system (or both) is in a failed state and is unrecoverable. For more information, see Monitoring replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then restore the most recent backup of the failed file system (either the source or the destination) to a new file system.

            • FileSystemId (string) –

              The ID of the destination Amazon EFS file system.

            • Region (string) –

              The Amazon Web Services Region in which the destination file system is located.

            • LastReplicatedTimestamp (datetime) –

              The time when the most recent sync was successfully completed on the destination file system. Any changes to data on the source file system that occurred before this time have been successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.

    • NextToken (string) –

      You can use the NextToken from the previous response in a subsequent request to fetch the additional descriptions.

Exceptions

  • EFS.Client.exceptions.BadRequest

  • EFS.Client.exceptions.FileSystemNotFound

  • EFS.Client.exceptions.InternalServerError

  • EFS.Client.exceptions.ReplicationNotFound

  • EFS.Client.exceptions.ValidationException