DocDB / Client / describe_db_clusters

describe_db_clusters

DocDB.Client.describe_db_clusters(**kwargs)

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.

See also: AWS API Documentation

Request Syntax

response = client.describe_db_clusters(
    DBClusterIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

• DBClusterIdentifier (string) –

  The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn’t case sensitive.

  Constraints:

  • If provided, must match an existing DBClusterIdentifier.

• Filters (list) –

  A filter that specifies one or more clusters to describe.

  Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

  • (dict) –

    A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

    Wildcards are not supported in filters.

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Filter values are case sensitive.

      • (string) –

• MaxRecords (integer) –

  The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• Marker (string) – An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'DBClusters': [
        {
            'AvailabilityZones': [
                'string',
            ],
            'BackupRetentionPeriod': 123,
            'DBClusterIdentifier': 'string',
            'DBClusterParameterGroup': 'string',
            'DBSubnetGroup': 'string',
            'Status': 'string',
            'PercentProgress': 'string',
            'EarliestRestorableTime': datetime(2015, 1, 1),
            'Endpoint': 'string',
            'ReaderEndpoint': 'string',
            'MultiAZ': True|False,
            'Engine': 'string',
            'EngineVersion': 'string',
            'LatestRestorableTime': datetime(2015, 1, 1),
            'Port': 123,
            'MasterUsername': 'string',
            'PreferredBackupWindow': 'string',
            'PreferredMaintenanceWindow': 'string',
            'ReplicationSourceIdentifier': 'string',
            'ReadReplicaIdentifiers': [
                'string',
            ],
            'DBClusterMembers': [
                {
                    'DBInstanceIdentifier': 'string',
                    'IsClusterWriter': True|False,
                    'DBClusterParameterGroupStatus': 'string',
                    'PromotionTier': 123
                },
            ],
            'VpcSecurityGroups': [
                {
                    'VpcSecurityGroupId': 'string',
                    'Status': 'string'
                },
            ],
            'HostedZoneId': 'string',
            'StorageEncrypted': True|False,
            'KmsKeyId': 'string',
            'DbClusterResourceId': 'string',
            'DBClusterArn': 'string',
            'AssociatedRoles': [
                {
                    'RoleArn': 'string',
                    'Status': 'string'
                },
            ],
            'CloneGroupId': 'string',
            'ClusterCreateTime': datetime(2015, 1, 1),
            'EnabledCloudwatchLogsExports': [
                'string',
            ],
            'DeletionProtection': True|False,
            'StorageType': 'string'
        },
    ]
}

Response Structure

• (dict) –

  Represents the output of DescribeDBClusters.

  • Marker (string) –

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • DBClusters (list) –

    A list of clusters.

    • (dict) –

      Detailed information about a cluster.

      • AvailabilityZones (list) –

        Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • (string) –

      • BackupRetentionPeriod (integer) –

        Specifies the number of days for which automatic snapshots are retained.

      • DBClusterIdentifier (string) –

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

      • DBClusterParameterGroup (string) –

        Specifies the name of the cluster parameter group for the cluster.

      • DBSubnetGroup (string) –

        Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

      • Status (string) –

        Specifies the current state of this cluster.

      • PercentProgress (string) –

        Specifies the progress of the operation as a percentage.

      • EarliestRestorableTime (datetime) –

        The earliest time to which a database can be restored with point-in-time restore.

      • Endpoint (string) –

        Specifies the connection endpoint for the primary instance of the cluster.

      • ReaderEndpoint (string) –

        The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

        If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

      • MultiAZ (boolean) –

        Specifies whether the cluster has instances in multiple Availability Zones.

      • Engine (string) –

        Provides the name of the database engine to be used for this cluster.

      • EngineVersion (string) –

        Indicates the database engine version.

      • LatestRestorableTime (datetime) –

        Specifies the latest time to which a database can be restored with point-in-time restore.

      • Port (integer) –

        Specifies the port that the database engine is listening on.

      • MasterUsername (string) –

        Contains the master user name for the cluster.

      • PreferredBackupWindow (string) –

        Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

      • PreferredMaintenanceWindow (string) –

        Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      • ReplicationSourceIdentifier (string) –

        Contains the identifier of the source cluster if this cluster is a secondary cluster.

      • ReadReplicaIdentifiers (list) –

        Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • (string) –

      • DBClusterMembers (list) –

        Provides the list of instances that make up the cluster.

        • (dict) –

          Contains information about an instance that is part of a cluster.

          • DBInstanceIdentifier (string) –

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter (boolean) –

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus (string) –

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier (integer) –

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

      • VpcSecurityGroups (list) –

        Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

        • (dict) –

          Used as a response element for queries on virtual private cloud (VPC) security group membership.

          • VpcSecurityGroupId (string) –

            The name of the VPC security group.

          • Status (string) –

            The status of the VPC security group.

      • HostedZoneId (string) –

        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

      • StorageEncrypted (boolean) –

        Specifies whether the cluster is encrypted.

      • KmsKeyId (string) –

        If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

      • DbClusterResourceId (string) –

        The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

      • DBClusterArn (string) –

        The Amazon Resource Name (ARN) for the cluster.

      • AssociatedRoles (list) –

        Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

        • (dict) –

          Describes an Identity and Access Management (IAM) role that is associated with a cluster.

          • RoleArn (string) –

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status (string) –

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

      • CloneGroupId (string) –

        Identifies the clone group to which the DB cluster is associated.

      • ClusterCreateTime (datetime) –

        Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

      • EnabledCloudwatchLogsExports (list) –

        A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • (string) –

      • DeletionProtection (boolean) –

        Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

      • StorageType (string) –

        Storage type associated with your cluster

        Storage type associated with your cluster

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

Exceptions

• DocDB.Client.exceptions.DBClusterNotFoundFault