update_webhook

Amplify.Client.update_webhook(**kwargs)

Updates a webhook.

See also: AWS API Documentation

Request Syntax

response = client.update_webhook(
    webhookId='string',
    branchName='string',
    description='string'
)

Parameters

• webhookId (string) --

  [REQUIRED]

  The unique ID for a webhook.

• branchName (string) -- The name for a branch that is part of an Amplify app.
• description (string) -- The description for a webhook.

Return type

dict

Returns

Response Syntax

{
    'webhook': {
        'webhookArn': 'string',
        'webhookId': 'string',
        'webhookUrl': 'string',
        'branchName': 'string',
        'description': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  The result structure for the update webhook request.

  • webhook (dict) --

    Describes a webhook that connects repository events to an Amplify app.

    • webhookArn (string) --

      The Amazon Resource Name (ARN) for the webhook.

    • webhookId (string) --

      The ID of the webhook.

    • webhookUrl (string) --

      The URL of the webhook.

    • branchName (string) --

      The name for a branch that is part of an Amplify app.

    • description (string) --

      The description for a webhook.

    • createTime (datetime) --

      The create date and time for a webhook.

    • updateTime (datetime) --

      Updates the date and time for a webhook.

Exceptions

• Amplify.Client.exceptions.BadRequestException
• Amplify.Client.exceptions.UnauthorizedException
• Amplify.Client.exceptions.NotFoundException
• Amplify.Client.exceptions.InternalFailureException
• Amplify.Client.exceptions.DependentServiceFailureException