delete_db_parameter_group `async` ¶

delete_db_parameter_group(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    db_parameter_group_name: Optional[String] = None,
) -> None

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

Parameters:

db_parameter_group_name (Optional[String], default: None ) –
The name of the DB parameter group.

Constraints:
- Must be the name of an existing DB parameter group
- You can't delete a default DB parameter group
- Can't be associated with any DB instances

Raises:

DBParameterGroupNotFoundFault –

DBParameterGroupName doesn't refer to an existing DB parameter group.
InvalidDBParameterGroupStateFault –

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To delete a DB parameter group The following example deletes a DB parameter group.

>>> await client.delete_db_parameter_group(db_parameter_group_name='mydbparametergroup')

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

async def delete_db_parameter_group(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    db_parameter_group_name: Optional["capo_rds.types.string.String"] = None,
) -> None:
    """<p>Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.</p>

    Args:
        db_parameter_group_name: <p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be the name of an existing DB parameter group</p> </li> <li> <p>You can't delete a default DB parameter group</p> </li> <li> <p>Can't be associated with any DB instances</p> </li> </ul>

    Raises:
        capo_rds.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group.</p>
        capo_rds.errors.invalid_db_parameter_group_state_fault.InvalidDBParameterGroupStateFault: <p>The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To delete a DB parameter group
        The following example deletes a DB parameter group.

        >>> await client.delete_db_parameter_group(db_parameter_group_name='mydbparametergroup')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.delete_db_parameter_group_message.DeleteDBParameterGroupMessage]",
    ) -> AsyncOperationResponse[None]:
        import capo_rds._operations.amazon_rd_sv19.delete_db_parameter_group

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.delete_db_parameter_group.async_delete_db_parameter_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDBParameterGroup")
    )
    input_: capo_rds.types.delete_db_parameter_group_message.DeleteDBParameterGroupMessage = {}
    if db_parameter_group_name is not None:
        input_["db_parameter_group_name"] = db_parameter_group_name

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_db_parameter_group async ¶

delete_db_parameter_group `async` ¶