AWS API Changes

2018/05/02 - AWS CodePipeline - 5 new api methods

Changes Added support for webhooks with accompanying definitions as needed in the AWS CodePipeline API Guide.

ListWebhooks (new)

Gets a listing of all the webhooks in this region for this account. The output lists all webhooks and includes the webhook URL and ARN, as well the configuration for each webhook.

See also: AWS API Documentation

Request Syntax

client.list_webhooks(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

rtype

dict

returns

Response Syntax

{
    'webhooks': [
        {
            'definition': {
                'name': 'string',
                'targetPipeline': 'string',
                'targetAction': 'string',
                'filters': [
                    {
                        'jsonPath': 'string',
                        'matchEquals': 'string'
                    },
                ],
                'authentication': 'GITHUB_HMAC'|'IP'|'UNAUTHENTICATED',
                'authenticationConfiguration': {
                    'AllowedIPRange': 'string',
                    'SecretToken': 'string'
                }
            },
            'url': 'string',
            'errorMessage': 'string',
            'errorCode': 'string',
            'lastTriggered': datetime(2015, 1, 1),
            'arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- webhooks (list) --
  
  The JSON detail returned for each webhook in the list output for the ListWebhooks call.
  - (dict) --
    
    The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
    - definition (dict) --
      
      The detail returned for each webhook, such as the webhook authentication type and filter rules.
      - name (string) --
        
        The name of the webhook.
      - targetPipeline (string) --
        
        The name of the pipeline you want to connect to the webhook.
      - targetAction (string) --
        
        The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
      - filters (list) --
        
        A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
        
        (dict) --
        
        The event criteria that specify when a webhook notification is sent to your URL.
        
        jsonPath (string) --
        
        A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.
        
        matchEquals (string) --
        
        The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements.
      - authentication (string) --
        
        Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
        
        GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/
        
        IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.
        
        UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.
      - authenticationConfiguration (dict) --
        
        Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
        
        AllowedIPRange (string) --
        
        SecretToken (string) --
    - url (string) --
      
      A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook will make the old URL invalid and generate a new URL.
    - errorMessage (string) --
      
      The text of the error message about the webhook.
    - errorCode (string) --
      
      The number code of the error.
    - lastTriggered (datetime) --
      
      The date and time a webhook was last successfully triggered, in timestamp format.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the webhook.
- NextToken (string) --
  
  If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list.

RegisterWebhookWithThirdParty (new)

Link ¶

Configures a connection between the webhook that was created and the external tool with events to be detected.

See also: AWS API Documentation

Request Syntax

client.register_webhook_with_third_party(
    webhookName='string'
)

type webhookName

string

param webhookName

The name of an existing webhook created with PutWebhook to register with a supported third party.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DeregisterWebhookWithThirdParty (new)

Link ¶

Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently only supported for webhooks that target an action type of GitHub.

See also: AWS API Documentation

Request Syntax

client.deregister_webhook_with_third_party(
    webhookName='string'
)

type webhookName

string

param webhookName

The name of the webhook you want to deregister.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DeleteWebhook (new)

Link ¶

Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API will return successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.

See also: AWS API Documentation

Request Syntax

client.delete_webhook(
    name='string'
)

type name

string

param name

[REQUIRED]

The name of the webhook you want to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

PutWebhook (new)

Link ¶

Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.

See also: AWS API Documentation

Request Syntax

client.put_webhook(
    webhook={
        'name': 'string',
        'targetPipeline': 'string',
        'targetAction': 'string',
        'filters': [
            {
                'jsonPath': 'string',
                'matchEquals': 'string'
            },
        ],
        'authentication': 'GITHUB_HMAC'|'IP'|'UNAUTHENTICATED',
        'authenticationConfiguration': {
            'AllowedIPRange': 'string',
            'SecretToken': 'string'
        }
    }
)

type webhook

dict

param webhook

[REQUIRED]

The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name which identifies the webhook being defined. You may choose to name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.

name (string) -- [REQUIRED]

The name of the webhook.
targetPipeline (string) -- [REQUIRED]

The name of the pipeline you want to connect to the webhook.
targetAction (string) -- [REQUIRED]

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
filters (list) -- [REQUIRED]

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
- (dict) --
  
  The event criteria that specify when a webhook notification is sent to your URL.
  - jsonPath (string) -- [REQUIRED]
    
    A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.
  - matchEquals (string) --
    
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements.
authentication (string) -- [REQUIRED]

Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
- GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/
- IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.
- UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.
authenticationConfiguration (dict) -- [REQUIRED]

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
- AllowedIPRange (string) --
- SecretToken (string) --

rtype

dict

returns

Response Syntax

{
    'webhook': {
        'definition': {
            'name': 'string',
            'targetPipeline': 'string',
            'targetAction': 'string',
            'filters': [
                {
                    'jsonPath': 'string',
                    'matchEquals': 'string'
                },
            ],
            'authentication': 'GITHUB_HMAC'|'IP'|'UNAUTHENTICATED',
            'authenticationConfiguration': {
                'AllowedIPRange': 'string',
                'SecretToken': 'string'
            }
        },
        'url': 'string',
        'errorMessage': 'string',
        'errorCode': 'string',
        'lastTriggered': datetime(2015, 1, 1),
        'arn': 'string'
    }
}

Response Structure

(dict) --
- webhook (dict) --
  
  The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
  - definition (dict) --
    
    The detail returned for each webhook, such as the webhook authentication type and filter rules.
    - name (string) --
      
      The name of the webhook.
    - targetPipeline (string) --
      
      The name of the pipeline you want to connect to the webhook.
    - targetAction (string) --
      
      The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
    - filters (list) --
      
      A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
      - (dict) --
        
        The event criteria that specify when a webhook notification is sent to your URL.
        
        jsonPath (string) --
        
        A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.
        
        matchEquals (string) --
        
        The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements.
    - authentication (string) --
      
      Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
      - GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/
      - IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.
      - UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.
    - authenticationConfiguration (dict) --
      
      Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
      - AllowedIPRange (string) --
      - SecretToken (string) --
  - url (string) --
    
    A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook will make the old URL invalid and generate a new URL.
  - errorMessage (string) --
    
    The text of the error message about the webhook.
  - errorCode (string) --
    
    The number code of the error.
  - lastTriggered (datetime) --
    
    The date and time a webhook was last successfully triggered, in timestamp format.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the webhook.