Amplify / Client / get_webhook

get_webhook#

Amplify.Client.get_webhook(**kwargs)#

Returns the webhook information that corresponds to a specified webhook ID.

See also: AWS API Documentation

Request Syntax

response = client.get_webhook(
    webhookId='string'
)
Parameters:

webhookId (string) –

[REQUIRED]

The unique ID 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 get webhook request.

    • webhook (dict) –

      Describes the structure of a webhook.

      • 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