Amplify / Client / list_webhooks

list_webhooks#

Amplify.Client.list_webhooks(**kwargs)#

Returns a list of webhooks for an Amplify app.

See also: AWS API Documentation

Request Syntax

response = client.list_webhooks(
    appId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • appId (string) –

    [REQUIRED]

    The unique ID for an Amplify app.

  • nextToken (string) – A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks.

  • maxResults (integer) – The maximum number of records to list in a single response.

Return type:

dict

Returns:

Response Syntax

{
    'webhooks': [
        {
            'webhookArn': 'string',
            'webhookId': 'string',
            'webhookUrl': 'string',
            'branchName': 'string',
            'description': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    The result structure for the list webhooks request.

    • webhooks (list) –

      A list of webhooks.

      • (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) –

          A timestamp of when Amplify created the webhook in your Git repository.

        • updateTime (datetime) –

          A timestamp of when Amplify updated the webhook in your Git repository.

    • nextToken (string) –

      A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

Exceptions