Neptune / Client / describe_db_parameter_groups

describe_db_parameter_groups#

Neptune.Client.describe_db_parameter_groups(**kwargs)#

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

See also: AWS API Documentation

Request Syntax

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

  • DBParameterGroupName (string) –

    The name of a specific DB 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 DescribeDBParameterGroups 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',
    'DBParameterGroups': [
        {
            'DBParameterGroupName': 'string',
            'DBParameterGroupFamily': 'string',
            'Description': 'string',
            'DBParameterGroupArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • 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.

    • DBParameterGroups (list) –

      A list of DBParameterGroup instances.

      • (dict) –

        Contains the details of an Amazon Neptune DB parameter group.

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

        • DBParameterGroupName (string) –

          Provides the name of the DB parameter group.

        • DBParameterGroupFamily (string) –

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

        • Description (string) –

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

        • DBParameterGroupArn (string) –

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

Exceptions