Neptune / Client / describe_global_clusters

describe_global_clusters#

Neptune.Client.describe_global_clusters(**kwargs)#

Returns information about Neptune global database clusters. This API supports pagination.

See also: AWS API Documentation

Request Syntax

response = client.describe_global_clusters(
    GlobalClusterIdentifier='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • GlobalClusterIdentifier (string) –

    The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.

    Constraints: If supplied, must match an existing DB cluster identifier.

  • MaxRecords (integer) –

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination marker token is included in the response that you can use to retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • Marker (string) – (Optional) A pagination token returned by a previous call to DescribeGlobalClusters. If this parameter is specified, the response will only include records beyond the marker, up to the number specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'GlobalClusters': [
        {
            'GlobalClusterIdentifier': 'string',
            'GlobalClusterResourceId': 'string',
            'GlobalClusterArn': 'string',
            'Status': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'StorageEncrypted': True|False,
            'DeletionProtection': True|False,
            'GlobalClusterMembers': [
                {
                    'DBClusterArn': 'string',
                    'Readers': [
                        'string',
                    ],
                    'IsWriter': True|False
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      A pagination token. If this parameter is returned in the response, more records are available, which can be retrieved by one or more additional calls to DescribeGlobalClusters.

    • GlobalClusters (list) –

      The list of global clusters and instances returned by this request.

      • (dict) –

        Contains the details of an Amazon Neptune global database.

        This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

        • GlobalClusterIdentifier (string) –

          Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

        • GlobalClusterResourceId (string) –

          An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

        • GlobalClusterArn (string) –

          The Amazon Resource Name (ARN) for the global database.

        • Status (string) –

          Specifies the current state of this global database.

        • Engine (string) –

          The Neptune database engine used by the global database ( "neptune").

        • EngineVersion (string) –

          The Neptune engine version used by the global database.

        • StorageEncrypted (boolean) –

          The storage encryption setting for the global database.

        • DeletionProtection (boolean) –

          The deletion protection setting for the global database.

        • GlobalClusterMembers (list) –

          A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

          • (dict) –

            A data structure with information about any primary and secondary clusters associated with an Neptune global database.

            • DBClusterArn (string) –

              The Amazon Resource Name (ARN) for each Neptune cluster.

            • Readers (list) –

              The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.

              • (string) –

            • IsWriter (boolean) –

              Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.

Exceptions

  • Neptune.Client.exceptions.GlobalClusterNotFoundFault