AuroraDSQL / Client / get_cluster

get_cluster#

AuroraDSQL.Client.get_cluster(**kwargs)#

Retrieves information about a cluster.

See also: AWS API Documentation

Request Syntax

response = client.get_cluster(
    identifier='string'
)
Parameters:

identifier (string) –

[REQUIRED]

The ID of the cluster to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'identifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
    'creationTime': datetime(2015, 1, 1),
    'deletionProtectionEnabled': True|False,
    'witnessRegion': 'string',
    'linkedClusterArns': [
        'string',
    ]
}

Response Structure

  • (dict) –

    Output Mixin

    • identifier (string) –

      The ID of the retrieved cluster.

    • arn (string) –

      The ARN of the retrieved cluster.

    • status (string) –

      The status of the retrieved cluster.

    • creationTime (datetime) –

      The time of when the cluster was created.

    • deletionProtectionEnabled (boolean) –

      Whether deletion protection is enabled in this cluster.

    • witnessRegion (string) –

      The witness Region of the cluster. Applicable only for multi-Region clusters.

    • linkedClusterArns (list) –

      The ARNs of the clusters linked to the retrieved cluster.

      • (string) –

        Cluster ARN

Exceptions