MemoryDB / Client / describe_multi_region_clusters

describe_multi_region_clusters#

MemoryDB.Client.describe_multi_region_clusters(**kwargs)#

Returns details about one or more multi-Region clusters.

See also: AWS API Documentation

Request Syntax

response = client.describe_multi_region_clusters(
    MultiRegionClusterName='string',
    MaxResults=123,
    NextToken='string',
    ShowClusterDetails=True|False
)
Parameters:

  • MultiRegionClusterName (string) – The name of a specific multi-Region cluster to describe.

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – A token to specify where to start paginating.

  • ShowClusterDetails (boolean) – Details about the multi-Region cluster.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'MultiRegionClusters': [
        {
            'MultiRegionClusterName': 'string',
            'Description': 'string',
            'Status': 'string',
            'NodeType': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'NumberOfShards': 123,
            'Clusters': [
                {
                    'ClusterName': 'string',
                    'Region': 'string',
                    'Status': 'string',
                    'ARN': 'string'
                },
            ],
            'MultiRegionParameterGroupName': 'string',
            'TLSEnabled': True|False,
            'ARN': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      A token to use to retrieve the next page of results.

    • MultiRegionClusters (list) –

      A list of multi-Region clusters.

      • (dict) –

        Represents a multi-Region cluster.

        • MultiRegionClusterName (string) –

          The name of the multi-Region cluster.

        • Description (string) –

          The description of the multi-Region cluster.

        • Status (string) –

          The current status of the multi-Region cluster.

        • NodeType (string) –

          The node type used by the multi-Region cluster.

        • Engine (string) –

          The name of the engine used by the multi-Region cluster.

        • EngineVersion (string) –

          The version of the engine used by the multi-Region cluster.

        • NumberOfShards (integer) –

          The number of shards in the multi-Region cluster.

        • Clusters (list) –

          The clusters in this multi-Region cluster.

          • (dict) –

            Represents a Regional cluster

            • ClusterName (string) –

              The name of the Regional cluster

            • Region (string) –

              The Region the current Regional cluster is assigned to.

            • Status (string) –

              The status of the Regional cluster.

            • ARN (string) –

              The Amazon Resource Name (ARN) the Regional cluster

        • MultiRegionParameterGroupName (string) –

          The name of the multi-Region parameter group associated with the cluster.

        • TLSEnabled (boolean) –

          Indiciates if the multi-Region cluster is TLS enabled.

        • ARN (string) –

          The Amazon Resource Name (ARN) of the multi-Region cluster.

Exceptions

  • MemoryDB.Client.exceptions.ClusterNotFoundFault

  • MemoryDB.Client.exceptions.InvalidParameterCombinationException

  • MemoryDB.Client.exceptions.InvalidParameterValueException

  • MemoryDB.Client.exceptions.MultiRegionClusterNotFoundFault