describe_db_cluster_parameter_groups

describe_db_cluster_parameter_groups(**kwargs)

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

See also: AWS API Documentation

Request Syntax

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

Parameters

• DBClusterParameterGroupName (string) --

  The name of a specific DB cluster parameter group to return details for.

  Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.
• Filters (list) --

  This parameter is not currently supported.

  • (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 DescribeDBClusterParameterGroups 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',
    'DBClusterParameterGroups': [
        {
            'DBClusterParameterGroupName': 'string',
            'DBParameterGroupFamily': 'string',
            'Description': 'string',
            'DBClusterParameterGroupArn': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • Marker (string) --

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

  • DBClusterParameterGroups (list) --

    A list of DB cluster parameter groups.

    • (dict) --

      Contains the details of an Amazon Neptune DB cluster parameter group.

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

      • DBClusterParameterGroupName (string) --

        Provides the name of the DB cluster parameter group.

      • DBParameterGroupFamily (string) --

        Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

      • Description (string) --

        Provides the customer-specified description for this DB cluster parameter group.

      • DBClusterParameterGroupArn (string) --

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

Exceptions

• Neptune.Client.exceptions.DBParameterGroupNotFoundFault