Amazon CodePipeline #X Amz Target=CodePipeline 20150709.PutWebhook API

openapi: 3.0.0
info:
  version: '2015-07-09'
  x-release: v4
  title: 'AWS CodePipeline Executions #X Amz Target=CodePipeline 20150709.PutWebhook API'
  description: <fullname>CodePipeline</fullname> <p> <b>Overview</b> </p> <p>This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">CodePipeline User Guide</a>.</p> <p>You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.</p> <p> <i>Pipelines</i> are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions. </p> <p>You can work with pipelines by calling:</p> <ul> <li> <p> <a>CreatePipeline</a>, which creates a uniquely named pipeline.</p> </li> <li> <p> <a>DeletePipeline</a>, which deletes the specified pipeline.</p> </li> <li> <p> <a>GetPipeline</a>, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).</p> </li> <li> <p> <a>GetPipelineExecution</a>, which returns information about a specific execution of a pipeline.</p> </li> <li> <p> <a>GetPipelineState</a>, which returns information about the current state of the stages and actions of a pipeline.</p> </li> <li> <p> <a>ListActionExecutions</a>, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.</p> </li> <li> <p> <a>ListPipelines</a>, which gets a summary of all of the pipelines associated with your account.</p> </li> <li> <p> <a>ListPipelineExecutions</a>, which gets a summary of the most recent executions for a pipeline.</p> </li> <li> <p> <a>StartPipelineExecution</a>, which runs the most recent revision of an artifact through the pipeline.</p> </li> <li> <p> <a>StopPipelineExecution</a>, which stops the specified pipeline execution from continuing through the pipeline.</p> </li> <li> <p> <a>UpdatePipeline</a>, which updates a pipeline with edits or changes to the structure of the pipeline.</p> </li> </ul> <p>Pipelines include <i>stages</i>. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call <a>GetPipelineState</a>, which displays the status of a pipeline, including the status of stages in the pipeline, or <a>GetPipeline</a>, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">CodePipeline Pipeline Structure Reference</a>.</p> <p>Pipeline stages include <i>actions</i> that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as <a>CreatePipeline</a> and <a>GetPipelineState</a>. Valid action categories are:</p> <ul> <li> <p>Source</p> </li> <li> <p>Build</p> </li> <li> <p>Test</p> </li> <li> <p>Deploy</p> </li> <li> <p>Approval</p> </li> <li> <p>Invoke</p> </li> </ul> <p>Pipelines also include <i>transitions</i>, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.</p> <p>You can work with transitions by calling:</p> <ul> <li> <p> <a>DisableStageTransition</a>, which prevents artifacts from transitioning to the next stage in a pipeline.</p> </li> <li> <p> <a>EnableStageTransition</a>, which enables transition of artifacts between stages in a pipeline. </p> </li> </ul> <p> <b>Using the API to integrate with CodePipeline</b> </p> <p>For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:</p> <p> <b>Jobs</b>, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source. </p> <p>You can work with jobs by calling:</p> <ul> <li> <p> <a>AcknowledgeJob</a>, which confirms whether a job worker has received the specified job.</p> </li> <li> <p> <a>GetJobDetails</a>, which returns the details of a job.</p> </li> <li> <p> <a>PollForJobs</a>, which determines whether there are any jobs to act on.</p> </li> <li> <p> <a>PutJobFailureResult</a>, which provides details of a job failure. </p> </li> <li> <p> <a>PutJobSuccessResult</a>, which provides details of a job success.</p> </li> </ul> <p> <b>Third party jobs</b>, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.</p> <p>You can work with third party jobs by calling:</p> <ul> <li> <p> <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker has received the specified job.</p> </li> <li> <p> <a>GetThirdPartyJobDetails</a>, which requests the details of a job for a partner action.</p> </li> <li> <p> <a>PollForThirdPartyJobs</a>, which determines whether there are any jobs to act on. </p> </li> <li> <p> <a>PutThirdPartyJobFailureResult</a>, which provides details of a job failure.</p> </li> <li> <p> <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job success.</p> </li> </ul>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: codepipeline
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codepipeline-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://codepipeline.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The CodePipeline multi-region endpoint
- url: https://codepipeline.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The CodePipeline multi-region endpoint
- url: http://codepipeline.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The CodePipeline endpoint for China (Beijing) and China (Ningxia)
- url: https://codepipeline.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The CodePipeline endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodePipeline 20150709.PutWebhook'
paths:
  /#X-Amz-Target=CodePipeline_20150709.PutWebhook:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: PutWebhook
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutWebhookOutput'
              examples:
                PutWebhook200Example:
                  summary: Default PutWebhook 200 response
                  x-microcks-default: true
                  value:
                    webhook: example-value
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                PutWebhook480Example:
                  summary: Default PutWebhook 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
              examples:
                PutWebhook481Example:
                  summary: Default PutWebhook 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InvalidWebhookFilterPatternException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidWebhookFilterPatternException'
              examples:
                PutWebhook482Example:
                  summary: Default PutWebhook 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: InvalidWebhookAuthenticationParametersException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidWebhookAuthenticationParametersException'
              examples:
                PutWebhook483Example:
                  summary: Default PutWebhook 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: PipelineNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineNotFoundException'
              examples:
                PutWebhook484Example:
                  summary: Default PutWebhook 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: TooManyTagsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyTagsException'
              examples:
                PutWebhook485Example:
                  summary: Default PutWebhook 485 response
                  x-microcks-default: true
                  value: example-value
        '486':
          description: InvalidTagsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidTagsException'
              examples:
                PutWebhook486Example:
                  summary: Default PutWebhook 486 response
                  x-microcks-default: true
                  value: example-value
        '487':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
              examples:
                PutWebhook487Example:
                  summary: Default PutWebhook 487 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutWebhookInput'
            examples:
              PutWebhookRequestExample:
                summary: Default PutWebhook request
                x-microcks-default: true
                value:
                  webhook: example-value
                  tags: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodePipeline_20150709.PutWebhook
      summary: Amazon CodePipeline Put Webhook
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodePipeline 20150709.PutWebhook'
components:
  schemas:
    WebhookAuthenticationType:
      type: string
      enum:
      - GITHUB_HMAC
      - IP
      - UNAUTHENTICATED
    Tag:
      type: object
      required:
      - key
      - value
      properties:
        key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - description: The tag's key.
        value:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: The tag's value.
      description: A tag is a key-value pair that is used to manage the resource.
    LimitExceededException: {}
    ActionName:
      type: string
      pattern: '[A-Za-z0-9.@\-_]+'
      minLength: 1
      maxLength: 100
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
    WebhookArn:
      type: string
    JsonPath:
      type: string
      minLength: 1
      maxLength: 150
    WebhookAuthConfiguration:
      type: object
      properties:
        AllowedIPRange:
          allOf:
          - $ref: '#/components/schemas/WebhookAuthConfigurationAllowedIPRange'
          - description: The property used to configure acceptance of webhooks in an IP address range. For IP, only the <code>AllowedIPRange</code> property must be set. This property must be set to a valid CIDR range.
        SecretToken:
          allOf:
          - $ref: '#/components/schemas/WebhookAuthConfigurationSecretToken'
          - description: The property used to configure GitHub authentication. For GITHUB_HMAC, only the <code>SecretToken</code> property must be set.
      description: The authentication applied to incoming webhook trigger requests.
    WebhookDefinition:
      type: object
      required:
      - name
      - targetPipeline
      - targetAction
      - filters
      - authentication
      - authenticationConfiguration
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/WebhookName'
          - description: The name of the webhook.
        targetPipeline:
          allOf:
          - $ref: '#/components/schemas/PipelineName'
          - description: The name of the pipeline you want to connect to the webhook.
        targetAction:
          allOf:
          - $ref: '#/components/schemas/ActionName'
          - description: 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:
          allOf:
          - $ref: '#/components/schemas/WebhookFilters'
          - description: 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.
        authentication:
          allOf:
          - $ref: '#/components/schemas/WebhookAuthenticationType'
          - description: <p>Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.</p> <ul> <li> <p>For information about the authentication scheme implemented by GITHUB_HMAC, see <a href="https://developer.github.com/webhooks/securing/">Securing your webhooks</a> on the GitHub Developer website.</p> </li> <li> <p> IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.</p> </li> <li> <p> UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.</p> </li> </ul>
        authenticationConfiguration:
          allOf:
          - $ref: '#/components/schemas/WebhookAuthConfiguration'
          - description: Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the <code>SecretToken </code>property must be set. For IP, only the <code>AllowedIPRange </code>property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
      description: Represents information about a webhook and its definition.
    ValidationException: {}
    PutWebhookOutput:
      type: object
      properties:
        webhook:
          allOf:
          - $ref: '#/components/schemas/ListWebhookItem'
          - description: The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
    ListWebhookItem:
      type: object
      required:
      - definition
      - url
      properties:
        definition:
          allOf:
          - $ref: '#/components/schemas/WebhookDefinition'
          - description: The detail returned for each webhook, such as the webhook authentication type and filter rules.
        url:
          allOf:
          - $ref: '#/components/schemas/WebhookUrl'
          - description: 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 makes the old URL invalid and generates a new one.
        errorMessage:
          allOf:
          - $ref: '#/components/schemas/WebhookErrorMessage'
          - description: The text of the error message about the webhook.
        errorCode:
          allOf:
          - $ref: '#/components/schemas/WebhookErrorCode'
          - description: The number code of the error.
        lastTriggered:
          allOf:
          - $ref: '#/components/schemas/WebhookLastTriggered'
          - description: The date and time a webhook was last successfully triggered, in timestamp format.
        arn:
          allOf:
          - $ref: '#/components/schemas/WebhookArn'
          - description: The Amazon Resource Name (ARN) of the webhook.
        tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: Specifies the tags applied to the webhook.
      description: The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
    InvalidWebhookFilterPatternException: {}
    TagKey:
      type: string
      minLength: 1
      maxLength: 128
    MatchEquals:
      type: string
      minLength: 1
      maxLength: 150
    PipelineName:
      type: string
      pattern: '[A-Za-z0-9.@\-_]+'
      minLength: 1
      maxLength: 100
    ConcurrentModificationException: {}
    InvalidTagsException: {}
    WebhookFilters:
      type: array
      items:
        $ref: '#/components/schemas/WebhookFilterRule'
      maxItems: 5
    WebhookErrorCode:
      type: string
    InvalidWebhookAuthenticationParametersException: {}
    PutWebhookInput:
      type: object
      required:
      - webhook
      title: PutWebhookInput
      properties:
        webhook:
          allOf:
          - $ref: '#/components/schemas/WebhookDefinition'
          - description: 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 that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.
        tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: The tags for the webhook.
    TooManyTagsException: {}
    PipelineNotFoundException: {}
    WebhookAuthConfigurationSecretToken:
      type: string
      minLength: 1
      maxLength: 100
    WebhookAuthConfigurationAllowedIPRange:
      type: string
      minLength: 1
      maxLength: 100
    WebhookUrl:
      type: string
      minLength: 1
      maxLength: 1000
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    WebhookLastTriggered:
      type: string
      format: date-time
    WebhookErrorMessage:
      type: string
    WebhookFilterRule:
      type: object
      required:
      - jsonPath
      properties:
        jsonPath:
          allOf:
          - $ref: '#/components/schemas/JsonPath'
          - description: A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the <code>MatchEquals</code> field. Otherwise, the request is ignored. For more information, see <a href="https://github.com/json-path/JsonPath">Java JsonPath implementation</a> in GitHub.
        matchEquals:
          allOf:
          - $ref: '#/components/schemas/MatchEquals'
          - description: The value selected by the <code>JsonPath</code> expression must match what is supplied in the <code>MatchEquals</code> field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. 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 "main", the <code>MatchEquals</code> value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements">Pipeline Structure Reference Action Requirements</a>.
      description: The event criteria that specify when a webhook notification is sent to your URL.
    WebhookName:
      type: string
      pattern: '[A-Za-z0-9.@\-_]+'
      minLength: 1
      maxLength: 100
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/codepipeline/
x-hasEquivalentPaths: true