"documentation":"<p>Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.</p>"
"documentation":"<p>Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.</p> <important> <p>To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.</p> </important>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Returns information about a job. Only used for custom actions.</p> <important> <p>When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.</p> </important>"
"documentation":"<p>Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>.</p>"
"documentation":"<p>Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.</p>"
"documentation":"<p>Requests the details of a job for a third party action. Only used for partner actions.</p> <important> <p>When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.</p> </important>"
"documentation":"<p>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.</p>"
"documentation":"<p>Returns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid for action types with \"Custom\" in the owner field. If the action type contains \"AWS\" or \"ThirdParty\" in the owner field, the PollForJobs action returns an error.</p> <important> <p>When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.</p> </important>"
"documentation":"<p>Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.</p> <important> <p>When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.</p> </important>"
"documentation":"<p>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.</p>"
"documentation":"<p>Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.</p>"
"documentation":"<p>Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.</p>"
"documentation":"<p>Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.</p>",
"documentation":"<p>A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the <a>PollForJobs</a> request that returned this job.</p>"
"documentation":"<p>A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a <a>GetThirdPartyJobDetails</a> request.</p>"
"documentation":"<p>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</p>"
"documentation":"<p>The name of the action configuration property.</p>"
},
"required":{
"shape":"Boolean",
"documentation":"<p>Whether the configuration property is a required value.</p>"
},
"key":{
"shape":"Boolean",
"documentation":"<p>Whether the configuration property is a key.</p>"
},
"secret":{
"shape":"Boolean",
"documentation":"<p>Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.</p> <p>When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.</p>"
"documentation":"<p>Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.</p> <p>If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.</p>"
"documentation":"<p>The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command and is used to validate that the approval request corresponding to this token is still valid.</p>"
},
"lastUpdatedBy":{
"shape":"LastUpdatedBy",
"documentation":"<p>The ARN of the user who last changed the pipeline.</p>"
"documentation":"<p>A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.</p>"
"documentation":"<p>The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.</p>"
"documentation":"<p>The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.</p>"
"documentation":"<p>The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.</p>"
},
"executionUrlTemplate":{
"shape":"UrlTemplate",
"documentation":"<p>The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.</p>"
},
"revisionUrlTemplate":{
"shape":"UrlTemplate",
"documentation":"<p>The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.</p>"
"documentation":"<p>The name of an artifact. This name might be system-generated, such as \"MyApp\", or might be defined by the user when an action is created.</p>"
},
"revisionId":{
"shape":"Revision",
"documentation":"<p>The revision ID of the artifact.</p>"
},
"revisionChangeIdentifier":{
"shape":"RevisionChangeIdentifier",
"documentation":"<p>An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.</p>"
},
"revisionSummary":{
"shape":"RevisionSummary",
"documentation":"<p>Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a <code>codepipeline-artifact-revision-summary</code> key specified in the object metadata.</p>"
},
"created":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the most recent revision of the artifact was created, in timestamp format.</p>"
},
"revisionUrl":{
"shape":"Url",
"documentation":"<p>The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.</p>"
}
},
"documentation":"<p>Represents revision details of an artifact. </p>"
"documentation":"<p>The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.</p>"
"documentation":"<p>The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.</p>"
"documentation":"<p>The category of the custom action, such as a build action or a test action.</p> <note> <p>Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.</p> </note>"
"documentation":"<p>The configuration properties for the custom action.</p> <note> <p>You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see <a href=\"http://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html\">Create a Custom Action for a Pipeline</a>.</p> </note>"
"documentation":"<p>Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).</p>"
},
"reason":{
"shape":"DisabledReason",
"documentation":"<p>The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.</p>"
"documentation":"<p>The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.</p>"
},
"stageName":{
"shape":"StageName",
"documentation":"<p>The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).</p>"
},
"transitionType":{
"shape":"StageTransitionType",
"documentation":"<p>Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound).</p>"
"documentation":"<p>The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.</p>"
"documentation":"<p>Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.</p>"
"documentation":"<p>The system ID or error number code of the error.</p>"
},
"message":{
"shape":"Message",
"documentation":"<p>The text of the error message.</p>"
}
},
"documentation":"<p>Represents information about an error in AWS CodePipeline.</p>"
},
"ExecutionDetails":{
"type":"structure",
"members":{
"summary":{
"shape":"ExecutionSummary",
"documentation":"<p>The summary of the current status of the actions.</p>"
},
"externalExecutionId":{
"shape":"ExecutionId",
"documentation":"<p>The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.</p>"
},
"percentComplete":{
"shape":"Percentage",
"documentation":"<p>The percentage of work completed on the action, represented on a scale of zero to one hundred percent.</p>"
}
},
"documentation":"<p>The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.</p>"
"documentation":"<p>The details of the job.</p> <note> <p>If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.</p> </note>"
"documentation":"<p>The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</p>"
},
"version":{
"shape":"PipelineVersion",
"documentation":"<p>The version number of the pipeline. If you do not specify a version, defaults to the most current version.</p>"
"documentation":"<p>The version number of the pipeline.</p> <note> <p>A newly-created pipeline is always assigned a version number of <code>1</code>.</p> </note>"
"documentation":"<p>A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.</p>"
"documentation":"<p>The unique system-generated ID used for identifying the job.</p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</p>"
"documentation":"<p>The name of the artifact to be worked on, for example, \"My App\".</p> <p>The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.</p>"
}
},
"documentation":"<p>Represents information about an artifact to be worked on, such as a test or build artifact.</p>"
"documentation":"<p>The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.</p>",
"documentation":"<p>A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an <a>AcknowledgeJob</a> request.</p>"
"documentation":"<p>Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.</p>"
"documentation":"<p>A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.</p>"
"documentation":"<p>Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. </p>"
"documentation":"<p>Filters the list of action types to those created by a specified entity.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.</p>"
"documentation":"<p>Provides details of the action types.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list action types call to return the next set of action types in the list.</p>"
"documentation":"<p>The name of the pipeline for which you want to get execution summary information.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. The available pipeline execution history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.</p>"
"documentation":"<p>The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.</p>"
"documentation":"<p>A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.</p>"
"documentation":"<p>An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list.</p>"
"documentation":"<p>If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list pipelines call to return the next set of pipelines in the list.</p>"
"documentation":"<p>The detail returned for each webhook, such as the webhook authentication type and filter rules.</p>"
},
"url":{
"shape":"WebhookUrl",
"documentation":"<p>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.</p>"
},
"errorMessage":{
"shape":"WebhookErrorMessage",
"documentation":"<p>The text of the error message about the webhook.</p>"
},
"errorCode":{
"shape":"WebhookErrorCode",
"documentation":"<p>The number code of the error.</p>"
},
"lastTriggered":{
"shape":"WebhookLastTriggered",
"documentation":"<p>The date and time a webhook was last successfully triggered, in timestamp format.</p>"
},
"arn":{
"shape":"WebhookArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the webhook.</p>"
}
},
"documentation":"<p>The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.</p>"
},
"ListWebhooksInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.</p>"
}
}
},
"ListWebhooksOutput":{
"type":"structure",
"members":{
"webhooks":{
"shape":"WebhookList",
"documentation":"<p>The JSON detail returned for each webhook in the list output for the ListWebhooks call.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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. </p>"
"documentation":"<p>The name of the output of an artifact, such as \"My App\".</p> <p>The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.</p> <p>Output artifact names must be unique within a pipeline.</p>"
"documentation":"<p>The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.</p>"
},
"stage":{
"shape":"StageContext",
"documentation":"<p>The stage of the pipeline.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.</p>"
"documentation":"<p>A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both.</p> <p>If you create a cross-region action in your pipeline, you must use artifactStores.</p>"
"documentation":"<p>The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.</p>"
"documentation":"<p>The status of the pipeline execution.</p> <ul> <li> <p>InProgress: The pipeline execution is currently running.</p> </li> <li> <p>Succeeded: The pipeline execution was completed successfully. </p> </li> <li> <p>Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. </p> </li> <li> <p>Failed: The pipeline execution was not completed successfully.</p> </li> </ul>"
"documentation":"<p>The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline. </p>",
"documentation":"<p>The status of the pipeline execution.</p> <ul> <li> <p>InProgress: The pipeline execution is currently running.</p> </li> <li> <p>Succeeded: The pipeline execution was completed successfully. </p> </li> <li> <p>Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. </p> </li> <li> <p>Failed: The pipeline execution was not completed successfully.</p> </li> </ul>"
"documentation":"<p>The maximum number of jobs to return in a poll for jobs call.</p>"
},
"queryParam":{
"shape":"QueryParamMap",
"documentation":"<p>A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.</p>"
"documentation":"<p>The name of the pipeline that contains the action. </p>"
},
"stageName":{
"shape":"StageName",
"documentation":"<p>The name of the stage that contains the action.</p>"
},
"actionName":{
"shape":"ActionName",
"documentation":"<p>The name of the action for which approval is requested.</p>"
},
"result":{
"shape":"ApprovalResult",
"documentation":"<p>Represents information about the result of the approval request.</p>"
},
"token":{
"shape":"ApprovalToken",
"documentation":"<p>The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the <a>GetPipelineState</a> action and is used to validate that the approval request corresponding to this token is still valid.</p>"
"documentation":"<p>A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the custom action. When the action is complete, no continuation token should be supplied.</p>"
"documentation":"<p>The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.</p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</p>"
"documentation":"<p>The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.</p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</p>"
"documentation":"<p>A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the partner action. When the action is complete, no continuation token should be supplied.</p>"
"documentation":"<p>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.</p>"
}
}
},
"PutWebhookOutput":{
"type":"structure",
"members":{
"webhook":{
"shape":"ListWebhookItem",
"documentation":"<p>The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.</p>"
"documentation":"<p>The name of the pipeline that contains the failed stage.</p>"
},
"stageName":{
"shape":"StageName",
"documentation":"<p>The name of the failed stage to be retried.</p>"
},
"pipelineExecutionId":{
"shape":"PipelineExecutionId",
"documentation":"<p>The ID of the pipeline execution in the failed stage to be retried. Use the <a>GetPipelineState</a> action to retrieve the current pipelineExecutionId of the failed stage</p>"
},
"retryMode":{
"shape":"StageRetryMode",
"documentation":"<p>The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.</p>"
"documentation":"<p>The name of the action that processed the revision to the source artifact.</p>"
},
"revisionId":{
"shape":"Revision",
"documentation":"<p>The system-generated unique ID that identifies the revision number of the artifact.</p>"
},
"revisionSummary":{
"shape":"RevisionSummary",
"documentation":"<p>Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a <code>codepipeline-artifact-revision-summary</code> key specified in the object metadata.</p>"
},
"revisionUrl":{
"shape":"Url",
"documentation":"<p>The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.</p>"
}
},
"documentation":"<p>Information about the version (or revision) of a source artifact that initiated a pipeline execution.</p>"
"documentation":"<p>The specified stage was specified in an invalid format or cannot be found.</p>",
"exception":true
},
"StageNotRetryableException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified stage can't be retried because the pipeline structure or stage state changed after the stage was not completed; the stage contains no failed actions; one or more actions are still in progress; or another retry attempt is already in progress. </p>",
"documentation":"<p>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</p>"
},
"jobId":{
"shape":"JobId",
"documentation":"<p>The identifier used to identify the job in AWS CodePipeline.</p>"
}
},
"documentation":"<p>A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked upon by a partner action.</p>"
"documentation":"<p>The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as \"MyApp\", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.</p>"
},
"outputArtifacts":{
"shape":"ArtifactList",
"documentation":"<p>The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as \"MyBuiltApp\", or might be defined by the user when the action is created.</p>"
"documentation":"<p>Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline. </p>"
"documentation":"<p>A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.</p>"
"documentation":"<p>The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.</p>"
"documentation":"<p>A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an <a>AcknowledgeThirdPartyJob</a> request.</p>"
"documentation":"<p>The property used to configure acceptance of webhooks within a specific IP range. For IP, only the AllowedIPRange property must be set, and this property must be set to a valid CIDR range.</p>"
},
"SecretToken":{
"shape":"WebhookAuthConfigurationSecretToken",
"documentation":"<p>The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.</p>"
}
},
"documentation":"<p>The authentication applied to incoming webhook trigger requests.</p>"
"documentation":"<p>The name of the pipeline you want to connect to the webhook.</p>"
},
"targetAction":{
"shape":"ActionName",
"documentation":"<p>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.</p>"
},
"filters":{
"shape":"WebhookFilters",
"documentation":"<p>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.</p>"
},
"authentication":{
"shape":"WebhookAuthenticationType",
"documentation":"<p>Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.</p> <ul> <li> <p> GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/</p> </li> <li> <p> IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.</p> </li> <li> <p> UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.</p> </li> </ul>"
},
"authenticationConfiguration":{
"shape":"WebhookAuthConfiguration",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>Represents information about a webhook and its definition.</p>"
},
"WebhookErrorCode":{"type":"string"},
"WebhookErrorMessage":{"type":"string"},
"WebhookFilterRule":{
"type":"structure",
"required":["jsonPath"],
"members":{
"jsonPath":{
"shape":"JsonPath",
"documentation":"<p>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.</p>"
},
"matchEquals":{
"shape":"MatchEquals",
"documentation":"<p>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: <a href=\"http://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements\">Pipeline Structure Reference Action Requirements</a>.</p>"
}
},
"documentation":"<p>The event criteria that specify when a webhook notification is sent to your URL.</p>"
},
"WebhookFilters":{
"type":"list",
"member":{"shape":"WebhookFilterRule"},
"max":5
},
"WebhookLastTriggered":{"type":"timestamp"},
"WebhookList":{
"type":"list",
"member":{"shape":"ListWebhookItem"}
},
"WebhookName":{
"type":"string",
"max":100,
"min":1,
"pattern":"[A-Za-z0-9.@\\-_]+"
},
"WebhookNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified webhook was entered in an invalid format or cannot be found.</p>",
"documentation":"<fullname>AWS CodePipeline</fullname> <p> <b>Overview</b> </p> <p>This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the <a href=\"http://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html\">AWS CodePipeline User Guide</a>.</p> <p>You can use the AWS CodePipeline API to work with pipelines, stages, actions, and transitions, as described below.</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>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 the most recent revision of an artifact 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 will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run 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, also refer to the <a href=\"http://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html\">AWSCodePipelinePipelineStructureReference</a>.</p><p>Pipelinestagesinclude<i>actions</i>,whicharecategorizedintocategoriessuchassourceorbuildactionsperformedwithinastageofapipeline.Forexample,youcanuseasourceactiontoimportartifactsintoapipelinefromasourcesuchasAmazonS3.Likestages,youdonotworkwithactionsdirectlyinmostcases,butyoudodefineandinteractwithactionswhenworkingwithpipelineoperationssuchas<a>CreatePipeline</a>and<a>GetPipelineState</a>.Validactioncategoriesare:</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>Pipelinesalsoinclude<i>transitions</i>,whichallowthetransitionofartifactsfromonestagetothenextinapipelineaftertheactionsinonestagecomplete.</p><p>Youcanworkwithtransitionsbycalling:</p><ul><li><p><a>DisableStageTransition</a>,whichpreventsartifactsfromtransitioningtothenextstageinapipeline.</p></li><li><p><a>EnableStageTransition</a>,whichenablestransitionofartifactsbetweenstagesinapipeline.</p></li></ul><p><b>UsingtheAPItointegratewithAWSCodePipeline</b></p><p>Forthird-partyintegratorsordeveloperswhowanttocreatetheirownintegrationswithAWSCodePipeline,theexpectedsequencevariesfromthestandardAPIuser.Inorder