[ aws . codecommit ]

put-repository-triggers

Description

Replaces all triggers for a repository. Used to create or delete triggers.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-repository-triggers
--repository-name <value>
--triggers <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--repository-name (string)

The name of the repository where you want to create or update the trigger.

--triggers (list)

The JSON block of configuration information for each trigger.

(structure)

Information about a trigger for a repository.

name -> (string)

The name of the trigger.

destinationArn -> (string)

The ARN of the resource that is the target for a trigger (for example, the ARN of a topic in Amazon SNS).

customData -> (string)

Any custom data associated with the trigger to be included in the information sent to the target of the trigger.

branches -> (list)

The branches to be included in the trigger configuration. If you specify an empty array, the trigger applies to all branches.

Note

Although no content is required in the array, you must include the array itself.

(string)

events -> (list)

The repository events that cause the trigger to run actions in another service, such as sending a notification through Amazon SNS.

Note

The valid value “all” cannot be used with any other values.

(string)

Shorthand Syntax:

name=string,destinationArn=string,customData=string,branches=string,string,events=string,string ...

JSON Syntax:

[
  {
    "name": "string",
    "destinationArn": "string",
    "customData": "string",
    "branches": ["string", ...],
    "events": ["all"|"updateReference"|"createReference"|"deleteReference", ...]
  }
  ...
]

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To add or update a trigger in a repository

This example demonstrates how to update triggers named ‘MyFirstTrigger’ and ‘MySecondTrigger’ using an already-created JSON file (here named MyTriggers.json) that contains the structure of all the triggers for a repository named MyDemoRepo. To learn how to get the JSON for existing triggers, see the get-repository-triggers command.

Command:

aws codecommit put-repository-triggers --repository-name MyDemoRepo file://MyTriggers.json

JSON file sample contents:
{
  "repositoryName": "MyDemoRepo",
  "triggers": [
      {
          "destinationArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MyCodeCommitTopic",
          "branches": [
              "master",
              "preprod"
          ],
          "name": "MyFirstTrigger",
          "customData": "",
          "events": [
              "all"
          ]
      },
              {
          "destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction",
          "branches": [],
          "name": "MySecondTrigger",
          "customData": "EXAMPLE",
          "events": [
              "all"
          ]
      }
  ]
}

Output:

{
  "configurationId": "6fa51cd8-35c1-EXAMPLE"
}

Output

configurationId -> (string)

The system-generated unique ID for the create or update operation.