EFS / Paginator / DescribeReplicationConfigurations

DescribeReplicationConfigurations

class EFS.Paginator.DescribeReplicationConfigurations

paginator = client.get_paginator('describe_replication_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EFS.Client.describe_replication_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FileSystemId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• FileSystemId (string) – You can retrieve the replication configuration for a specific file system by providing its file system ID. For cross-account,cross-region replication, an account can only describe the replication configuration for a file system in its own Region.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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),
                    'OwnerId': 'string',
                    'StatusMessage': 'string',
                    'RoleArn': 'string'
                },
            ],
            'SourceFileSystemOwnerId': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Replications (list) –

    The collection of replication configurations that is returned.

    • (dict) –

      Describes the replication configuration for a specific file system.

      • 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 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 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 replication configuration. For more information about replication status, see Viewing replication details in the Amazon EFS User Guide.

          • 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.

          • OwnerId (string) –

            ID of the Amazon Web Services account in which the destination file system resides.

          • StatusMessage (string) –

            Message that provides details about the PAUSED or ERRROR state of the replication destination configuration. For more information about replication status messages, see Viewing replication details in the Amazon EFS User Guide.

          • RoleArn (string) –

            Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS to perform replication on its behalf. This is optional for same-account replication and required for cross-account replication.

      • SourceFileSystemOwnerId (string) –

        ID of the Amazon Web Services account in which the source file system resides.