update_webhook `async` ¶

update_webhook(
    webhook_id: WebhookId,
    *,
    config_overrides: Optional[AsyncAmplifyClientConfig] = None,
    branch_name: Optional[BranchName] = None,
    description: Optional[Description] = None,
) -> UpdateWebhookResult

Updates a webhook.

Parameters:

webhook_id (WebhookId) –

The unique ID for a webhook.
branch_name (Optional[BranchName], default: None ) –

The name for a branch that is part of an Amplify app.
description (Optional[Description], default: None ) –

The description for a webhook.

Raises:

BadRequestException –

A request contains unexpected data.
DependentServiceFailureException –

An operation failed because a dependent service threw an exception.
InternalFailureException –

The service failed to perform an operation due to an internal issue.
NotFoundException –

An entity was not found during an operation.
UnauthorizedException –

An operation failed due to a lack of access.
UnknownServiceError –

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

Source code in docs_src/capo_amplify/_services/async_amplify.py

async def update_webhook(
    self,
    webhook_id: "capo_amplify.types.webhook_id.WebhookId",
    *,
    config_overrides: Optional[AsyncAmplifyClientConfig] = None,
    branch_name: Optional["capo_amplify.types.branch_name.BranchName"] = None,
    description: Optional["capo_amplify.types.description.Description"] = None,
) -> "capo_amplify.types.update_webhook_result.UpdateWebhookResult":
    """<p>Updates a webhook. </p>

    Args:
        webhook_id: <p>The unique ID for a webhook. </p>
        branch_name: <p>The name for a branch that is part of an Amplify app. </p>
        description: <p>The description for a webhook. </p>

    Raises:
        capo_amplify.errors.bad_request_exception.BadRequestException: <p>A request contains unexpected data. </p>
        capo_amplify.errors.dependent_service_failure_exception.DependentServiceFailureException: <p>An operation failed because a dependent service threw an exception. </p>
        capo_amplify.errors.internal_failure_exception.InternalFailureException: <p>The service failed to perform an operation due to an internal issue. </p>
        capo_amplify.errors.not_found_exception.NotFoundException: <p>An entity was not found during an operation. </p>
        capo_amplify.errors.unauthorized_exception.UnauthorizedException: <p>An operation failed due to a lack of access. </p>
        capo_amplify.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_amplify.types.update_webhook_request.UpdateWebhookRequest]",
    ) -> AsyncOperationResponse[
        "capo_amplify.types.update_webhook_result.UpdateWebhookResult"
    ]:
        import capo_amplify._operations.amplify.update_webhook

        (
            output,
            http_response,
        ) = await capo_amplify._operations.amplify.update_webhook.async_update_webhook(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateWebhook")
    )
    input_: capo_amplify.types.update_webhook_request.UpdateWebhookRequest = {
        "webhook_id": webhook_id
    }
    if branch_name is not None:
        input_["branch_name"] = branch_name
    if description is not None:
        input_["description"] = description

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

update_webhook async ¶

update_webhook `async` ¶