Neptune / Client / describe_db_clusters

describe_db_clusters

Neptune.Client.describe_db_clusters(**kwargs)

Returns information about provisioned DB clusters, and supports pagination.

Note

This operation can also return information for Amazon RDS clusters and Amazon DocDB 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-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn’t case-sensitive.

  Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

• Filters (list) –

  A filter that specifies one or more DB clusters to describe.

  Supported filters:

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

  • engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

  For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

  • (dict) –

    This type is not currently supported.

    • Name (string) – [REQUIRED]

      This parameter is not currently supported.

    • Values (list) – [REQUIRED]

      This parameter is not currently supported.

      • (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 called a 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 DescribeDBClusters 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': [
        {
            'AllocatedStorage': 123,
            'AvailabilityZones': [
                'string',
            ],
            'BackupRetentionPeriod': 123,
            'CharacterSetName': 'string',
            'DatabaseName': 'string',
            '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',
            'DBClusterOptionGroupMemberships': [
                {
                    'DBClusterOptionGroupName': 'string',
                    'Status': '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',
                    'FeatureName': 'string'
                },
            ],
            'IAMDatabaseAuthenticationEnabled': True|False,
            'CloneGroupId': 'string',
            'ClusterCreateTime': datetime(2015, 1, 1),
            'CopyTagsToSnapshot': True|False,
            'EnabledCloudwatchLogsExports': [
                'string',
            ],
            'PendingModifiedValues': {
                'PendingCloudwatchLogsExports': {
                    'LogTypesToEnable': [
                        'string',
                    ],
                    'LogTypesToDisable': [
                        'string',
                    ]
                },
                'DBClusterIdentifier': 'string',
                'IAMDatabaseAuthenticationEnabled': True|False,
                'EngineVersion': 'string',
                'BackupRetentionPeriod': 123,
                'AllocatedStorage': 123,
                'Iops': 123
            },
            'DeletionProtection': True|False,
            'CrossAccountClone': True|False,
            'AutomaticRestartTime': datetime(2015, 1, 1),
            'ServerlessV2ScalingConfiguration': {
                'MinCapacity': 123.0,
                'MaxCapacity': 123.0
            },
            'GlobalClusterIdentifier': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Marker (string) –

    A pagination token that can be used in a subsequent DescribeDBClusters request.

  • DBClusters (list) –

    Contains a list of DB clusters for the user.

    • (dict) –

      Contains the details of an Amazon Neptune DB cluster.

      This data type is used as a response element in the DescribeDBClusters action.

      • AllocatedStorage (integer) –

        AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

      • AvailabilityZones (list) –

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

        • (string) –

      • BackupRetentionPeriod (integer) –

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

      • CharacterSetName (string) –

        Not supported by Neptune.

      • DatabaseName (string) –

        Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

      • DBClusterIdentifier (string) –

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

      • DBClusterParameterGroup (string) –

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

      • DBSubnetGroup (string) –

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

      • Status (string) –

        Specifies the current state of this DB cluster.

      • PercentProgress (string) –

        Specifies the progress of the operation as a percentage.

      • EarliestRestorableTime (datetime) –

        Specifies 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 DB cluster.

      • ReaderEndpoint (string) –

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

        If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

      • MultiAZ (boolean) –

        Specifies whether the DB cluster has instances in multiple Availability Zones.

      • Engine (string) –

        Provides the name of the database engine to be used for this DB 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) –

        Not supported by Neptune.

      • DBClusterOptionGroupMemberships (list) –

        Not supported by Neptune.

        • (dict) –

          Not supported by Neptune.

          • DBClusterOptionGroupName (string) –

            Not supported by Neptune.

          • Status (string) –

            Not supported by Neptune.

      • 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) –

        Not supported by Neptune.

      • ReadReplicaIdentifiers (list) –

        Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • (string) –

      • DBClusterMembers (list) –

        Provides the list of instances that make up the DB cluster.

        • (dict) –

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

          • DBInstanceIdentifier (string) –

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter (boolean) –

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus (string) –

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

          • PromotionTier (integer) –

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

      • VpcSecurityGroups (list) –

        Provides a list of VPC security groups that the DB cluster belongs to.

        • (dict) –

          This data type is used as a response element for queries on 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 DB cluster is encrypted.

      • KmsKeyId (string) –

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

      • DbClusterResourceId (string) –

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

      • DBClusterArn (string) –

        The Amazon Resource Name (ARN) for the DB cluster.

      • AssociatedRoles (list) –

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

        • (dict) –

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

          • RoleArn (string) –

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

          • Status (string) –

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

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

          • FeatureName (string) –

            The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

      • IAMDatabaseAuthenticationEnabled (boolean) –

        True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      • CloneGroupId (string) –

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

      • ClusterCreateTime (datetime) –

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

      • CopyTagsToSnapshot (boolean) –

        If set to true, tags are copied to any snapshot of the DB cluster that is created.

      • EnabledCloudwatchLogsExports (list) –

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

        • (string) –

      • PendingModifiedValues (dict) –

        This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

        • PendingCloudwatchLogsExports (dict) –

          This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

          • LogTypesToEnable (list) –

            Log types that are in the process of being deactivated. After they are deactivated, these log types aren’t exported to CloudWatch Logs.

            • (string) –

          • LogTypesToDisable (list) –

            Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

            • (string) –

        • DBClusterIdentifier (string) –

          The DBClusterIdentifier value for the DB cluster.

        • IAMDatabaseAuthenticationEnabled (boolean) –

          A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • EngineVersion (string) –

          The database engine version.

        • BackupRetentionPeriod (integer) –

          The number of days for which automatic DB snapshots are retained.

        • AllocatedStorage (integer) –

          The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn’t fixed, but instead automatically adjusts as needed.

        • Iops (integer) –

          The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

      • DeletionProtection (boolean) –

        Indicates whether or not the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.

      • CrossAccountClone (boolean) –

        If set to true, the DB cluster can be cloned across accounts.

      • AutomaticRestartTime (datetime) –

        Time at which the DB cluster will be automatically restarted.

      • ServerlessV2ScalingConfiguration (dict) –

        Shows the scaling configuration for a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

        • MinCapacity (float) –

          The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

        • MaxCapacity (float) –

          The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

      • GlobalClusterIdentifier (string) –

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

Exceptions

• Neptune.Client.exceptions.DBClusterNotFoundFault