CodeCommit / Client / put_repository_triggers

put_repository_triggers#

CodeCommit.Client.put_repository_triggers(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.put_repository_triggers(
    repositoryName='string',
    triggers=[
        {
            'name': 'string',
            'destinationArn': 'string',
            'customData': 'string',
            'branches': [
                'string',
            ],
            'events': [
                'all'|'updateReference'|'createReference'|'deleteReference',
            ]
        },
    ]
)
Parameters:

  • repositoryName (string) –

    [REQUIRED]

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

  • triggers (list) –

    [REQUIRED]

    The JSON block of configuration information for each trigger.

    • (dict) –

      Information about a trigger for a repository.

      Note

      If you want to receive notifications about repository events, consider using notifications instead of triggers. For more information, see Configuring notifications for repository events.

      • name (string) – [REQUIRED]

        The name of the trigger.

      • destinationArn (string) – [REQUIRED]

        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) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'configurationId': 'string'
}

Response Structure

  • (dict) –

    Represents the output of a put repository triggers operation.

    • configurationId (string) –

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

Exceptions