Skip to content

delete_alert_manager_definition

delete_alert_manager_definition(
    workspace_id: WorkspaceId,
    *,
    config_overrides: Optional[ampClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
) -> None

Deletes the alert manager definition from a workspace.

Parameters:

  • workspace_id (WorkspaceId) –

    The ID of the workspace to delete the alert manager definition from.

  • client_token (Optional[IdempotencyToken], default: None ) –

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

Raises:

Source code in docs_src/capo_amp/_services/amp.py
def delete_alert_manager_definition(
    self,
    workspace_id: "capo_amp.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[ampClientConfig] = None,
    client_token: Optional[
        "capo_amp.types.idempotency_token.IdempotencyToken"
    ] = None,
) -> None:
    """<p>Deletes the alert manager definition from a workspace.</p>

    Args:
        workspace_id: <p>The ID of the workspace to delete the alert manager definition from.</p>
        client_token: <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>

    Raises:
        capo_amp.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_amp.errors.conflict_exception.ConflictException: <p>The request would cause an inconsistent state.</p>
        capo_amp.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_amp.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resources that doesn't exist.</p>
        capo_amp.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_amp.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_amp.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amp.types.delete_alert_manager_definition_request.DeleteAlertManagerDefinitionRequest]",
    ) -> OperationResponse[None]:
        import capo_amp._operations.amazon_prometheus_service.delete_alert_manager_definition

        output, http_response = (
            capo_amp._operations.amazon_prometheus_service.delete_alert_manager_definition.delete_alert_manager_definition(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteAlertManagerDefinition")
    )
    input_: capo_amp.types.delete_alert_manager_definition_request.DeleteAlertManagerDefinitionRequest = {
        "workspace_id": workspace_id
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output