[ aws . amplify ]

create-webhook

Description

Creates a new webhook on an Amplify app.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-webhook
--app-id <value>
--branch-name <value>
[--description <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The unique ID for an Amplify app.

--branch-name (string)

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

--description (string)

The description for a webhook.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

webhook -> (structure)

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 -> (timestamp)

The create date and time for a webhook.

updateTime -> (timestamp)

Updates the date and time for a webhook.