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.
Parameters:
-
parameter_group_name
(String)
–
The name of the parameter group to reset.
-
all_parameters
(Optional[Boolean], default:
None
)
–
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.
-
parameter_names
(Optional[ParameterNameList], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_memorydb/_services/memory_db.py
| def reset_parameter_group(
self,
parameter_group_name: "capo_memorydb.types.string.String",
*,
config_overrides: Optional[MemoryDBClientConfig] = None,
all_parameters: Optional["capo_memorydb.types.boolean.Boolean"] = None,
parameter_names: Optional[
"capo_memorydb.types.parameter_name_list.ParameterNameList"
] = None,
) -> (
"capo_memorydb.types.reset_parameter_group_response.ResetParameterGroupResponse"
):
"""<p>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.</p>
Args:
parameter_group_name: <p>The name of the parameter group to reset.</p>
all_parameters: <p>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.</p>
parameter_names: <p>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.</p>
Raises:
capo_memorydb.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>The specified parameter combination is not valid.</p>
capo_memorydb.errors.invalid_parameter_group_state_fault.InvalidParameterGroupStateFault: <p>The parameter group is not in a valid state for the requested operation.</p>
capo_memorydb.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The specified parameter value is not valid.</p>
capo_memorydb.errors.parameter_group_not_found_fault.ParameterGroupNotFoundFault: <p>The specified parameter group does not exist.</p>
capo_memorydb.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The required service-linked role was not found.</p>
capo_memorydb.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_memorydb.types.reset_parameter_group_request.ResetParameterGroupRequest]",
) -> OperationResponse[
"capo_memorydb.types.reset_parameter_group_response.ResetParameterGroupResponse"
]:
import capo_memorydb._operations.amazon_memory_db.reset_parameter_group
output, http_response = (
capo_memorydb._operations.amazon_memory_db.reset_parameter_group.reset_parameter_group(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ResetParameterGroup")
)
input_: capo_memorydb.types.reset_parameter_group_request.ResetParameterGroupRequest = {
"parameter_group_name": parameter_group_name
}
if all_parameters is not None:
input_["all_parameters"] = all_parameters
if parameter_names is not None:
input_["parameter_names"] = parameter_names
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|