MemoryDB / Client / reset_parameter_group

reset_parameter_group#

MemoryDB.Client.reset_parameter_group(**kwargs)#

Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.

See also: AWS API Documentation

Request Syntax

response = client.reset_parameter_group(
    ParameterGroupName='string',
    AllParameters=True|False,
    ParameterNames=[
        'string',
    ]
)
Parameters:

  • ParameterGroupName (string) –

    [REQUIRED]

    The name of the parameter group to reset.

  • AllParameters (boolean) – If true, all parameters in the parameter group are reset to their default values. If false, only the parameters listed by ParameterNames are reset to their default values.

  • ParameterNames (list) –

    An array of parameter names to reset to their default values. If AllParameters is true, do not use ParameterNames. If AllParameters is false, you must specify the name of at least one parameter to reset.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ParameterGroup': {
        'Name': 'string',
        'Family': 'string',
        'Description': 'string',
        'ARN': 'string'
    }
}

Response Structure

  • (dict) –

    • ParameterGroup (dict) –

      The parameter group being reset.

      • Name (string) –

        The name of the parameter group

      • Family (string) –

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

      • Description (string) –

        A description of the parameter group

      • ARN (string) –

        The Amazon Resource Name (ARN) of the parameter group

Exceptions

  • MemoryDB.Client.exceptions.InvalidParameterGroupStateFault

  • MemoryDB.Client.exceptions.ParameterGroupNotFoundFault

  • MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • MemoryDB.Client.exceptions.InvalidParameterValueException

  • MemoryDB.Client.exceptions.InvalidParameterCombinationException