Deletes an existing option group.
Parameters:
-
option_group_name
(Optional[String], default:
None
)
–
The name of the option group to be deleted.
You can't delete default option groups.
Raises:
Examples:
To delete an option group
The following example deletes the specified option group.
>>> client.delete_option_group(option_group_name='myoptiongroup')
Source code in docs_src/capo_rds/_services/rds.py
| def delete_option_group(
self,
*,
config_overrides: Optional[RDSClientConfig] = None,
option_group_name: Optional["capo_rds.types.string.String"] = None,
) -> None:
"""<p>Deletes an existing option group.</p>
Args:
option_group_name: <p>The name of the option group to be deleted.</p> <note> <p>You can't delete default option groups.</p> </note>
Raises:
capo_rds.errors.invalid_option_group_state_fault.InvalidOptionGroupStateFault: <p>The option group isn't in the <i>available</i> state.</p>
capo_rds.errors.option_group_not_found_fault.OptionGroupNotFoundFault: <p>The specified option group could not be found.</p>
capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To delete an option group
The following example deletes the specified option group.
>>> client.delete_option_group(option_group_name='myoptiongroup')
"""
def _handler(
req: "OperationRequest[capo_rds.types.delete_option_group_message.DeleteOptionGroupMessage]",
) -> OperationResponse[None]:
import capo_rds._operations.amazon_rd_sv19.delete_option_group
output, http_response = (
capo_rds._operations.amazon_rd_sv19.delete_option_group.delete_option_group(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteOptionGroup")
)
input_: capo_rds.types.delete_option_group_message.DeleteOptionGroupMessage = {}
if option_group_name is not None:
input_["option_group_name"] = option_group_name
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|