delete_option_group `async` ¶

delete_option_group(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    option_group_name: Optional[String] = None,
) -> None

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:

InvalidOptionGroupStateFault –

The option group isn't in the available state.
OptionGroupNotFoundFault –

The specified option group could not be found.
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.

>>> await client.delete_option_group(option_group_name='myoptiongroup')

Source code in docs_src/capo_rds/_services/async_rds.py

async def delete_option_group(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = 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.

        >>> await client.delete_option_group(option_group_name='myoptiongroup')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.delete_option_group_message.DeleteOptionGroupMessage]",
    ) -> AsyncOperationResponse[None]:
        import capo_rds._operations.amazon_rd_sv19.delete_option_group

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.delete_option_group.async_delete_option_group(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_option_group async ¶

delete_option_group `async` ¶