Overview
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 CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, 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.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. 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 GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, 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 CodePipeline Pipeline Structure Reference.
Pipeline stages include actions 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 CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
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:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, 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.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
Creates a pipeline.
In the pipeline structure, you must include either artifactStore or artifactStores in your pipeline, but you cannot use
both. If you create a cross-region action in your pipeline, you must use artifactStores.
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.
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.
Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId and revisionUrl fields
indicate the source revision information, such as the commit ID, for the current state.
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only 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.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution
is in a Stopped state.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopPipelineExecutionOutput'
examples:
StopPipelineExecution200Example:
summary: Default StopPipelineExecution 200 response
x-microcks-default: true
value:
pipelineExecutionId: '500123'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StopPipelineExecution480Example:
summary: Default StopPipelineExecution 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
StopPipelineExecution481Example:
summary: Default StopPipelineExecution 481 response
x-microcks-default: true
value: example-value
'482':
description: PipelineNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineNotFoundException'
examples:
StopPipelineExecution482Example:
summary: Default StopPipelineExecution 482 response
x-microcks-default: true
value: example-value
'483':
description: PipelineExecutionNotStoppableException
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineExecutionNotStoppableException'
examples:
StopPipelineExecution483Example:
summary: Default StopPipelineExecution 483 response
x-microcks-default: true
value: example-value
'484':
description: DuplicatedStopRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/DuplicatedStopRequestException'
examples:
StopPipelineExecution484Example:
summary: Default StopPipelineExecution 484 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopPipelineExecutionInput'
examples:
StopPipelineExecutionRequestExample:
summary: Default StopPipelineExecution request
x-microcks-default: true
value:
pipelineName: example-resource
pipelineExecutionId: '500123'
abandon: example-value
reason: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodePipeline_20150709.StopPipelineExecution
summary: Amazon CodePipeline Stop Pipeline Execution
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodePipeline_20150709.TagResource:
post:
operationId: TagResource
description: 'Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceOutput'
examples:
TagResource200Example:
summary: Default TagResource 200 response
x-microcks-default: true
value: {}
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
TagResource480Example:
summary: Default TagResource 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
TagResource481Example:
summary: Default TagResource 481 response
x-microcks-default: true
value: example-value
'482':
description: InvalidArnException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArnException'
examples:
TagResource482Example:
summary: Default TagResource 482 response
x-microcks-default: true
value: example-value
'483':
description: TooManyTagsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyTagsException'
examples:
TagResource483Example:
summary: Default TagResource 483 response
x-microcks-default: true
value: example-value
'484':
description: InvalidTagsException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTagsException'
examples:
TagResource484Example:
summary: Default TagResource 484 response
x-microcks-default: true
value: example-value
'485':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
TagResource485Example:
summary: Default TagResource 485 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceInput'
examples:
TagResourceRequestExample:
summary: Default TagResource request
x-microcks-default: true
value:
resourceArn: arn:aws:service:us-east-1:123456789012:resource/example
tags: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodePipeline_20150709.TagResource
summary: Amazon CodePipeline Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodePipeline_20150709.UntagResource:
post:
operationId: UntagResource
description: Removes tags from an Amazon Web Services resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceOutput'
examples:
UntagResource200Example:
summary: Default UntagResource 200 response
x-microcks-default: true
value: {}
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UntagResource480Example:
summary: Default UntagResource 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
UntagResource481Example:
summary: Default UntagResource 481 response
x-microcks-default: true
value: example-value
'482':
description: InvalidArnException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArnException'
examples:
UntagResource482Example:
summary: Default UntagResource 482 response
x-microcks-default: true
value: example-value
'483':
description: InvalidTagsException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTagsException'
examples:
UntagResource483Example:
summary: Default UntagResource 483 response
x-microcks-default: true
value: example-value
'484':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
examples:
UntagResource484Example:
summary: Default UntagResource 484 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceInput'
examples:
UntagResourceRequestExample:
summary: Default UntagResource request
x-microcks-default: true
value:
resourceArn: arn:aws:service:us-east-1:123456789012:resource/example
tagKeys: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodePipeline_20150709.UntagResource
summary: Amazon CodePipeline Untag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodePipeline_20150709.UpdateActionType:
post:
operationId: UpdateActionType
description: 'Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action
definition and UpdateActionType to provide the full structure.'
responses:
'200':
description: Success
'480':
description: RequestFailedException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestFailedException'
examples:
UpdateActionType480Example:
summary: Default UpdateActionType 480 response
x-microcks-default: true
value: STANDARD
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdateActionType481Example:
summary: Default UpdateActionType 481 response
x-microcks-default: true
value: STANDARD
'482':
description: ActionTypeNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ActionTypeNotFoundException'
examples:
UpdateActionType482Example:
summary: Default UpdateActionType 482 response
x-microcks-default: true
value: STANDARD
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateActionTypeInput'
examples:
UpdateActionTypeRequestExample:
summary: Default UpdateActionType request
x-microcks-default: true
value:
actionType: STANDARD
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodePipeline_20150709.UpdateActionType
summary: Amazon CodePipeline Update Action Type
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodePipeline_20150709.UpdatePipeline:
post:
operationId: UpdatePipeline
description: Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the
pipeline. Updating the pipeline increases the version number of the pipeline by 1.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePipelineOutput'
examples:
UpdatePipeline200Example:
summary: Default UpdatePipeline 200 response
x-microcks-default: true
value:
pipeline: example-value
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdatePipeline480Example:
summary: Default UpdatePipeline 480 response
x-microcks-default: true
value: example-value
'481':
description: InvalidStageDeclarationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidStageDeclarationException'
examples:
UpdatePipeline481Example:
summary: Default UpdatePipeline 481 response
x-microcks-default: true
value: example-value
'482':
description: InvalidActionDeclarationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidActionDeclarationException'
examples:
UpdatePipeline482Example:
summary: Default UpdatePipeline 482 response
x-microcks-default: true
value: example-value
'483':
description: InvalidBlockerDeclarationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidBlockerDeclarationException'
examples:
UpdatePipeline483Example:
summary: Default UpdatePipeline 483 response
x-microcks-default: true
value: example-value
'484':
description: InvalidStructureException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidStructureException'
examples:
UpdatePipeline484Example:
summary: Default UpdatePipeline 484 response
x-microcks-default: true
value: example-value
'485':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
examples:
UpdatePipeline485Example:
summary: Default UpdatePipeline 485 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePipelineInput'
examples:
UpdatePipelineRequestExample:
summary: Default UpdatePipeline request
x-microcks-default: true
value:
pipeline: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodePipeline_20150709.UpdatePipeline
summary: Amazon CodePipeline Update Pipeline
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
components:
parameters:
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-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
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-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
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
schemas:
AcknowledgeJobOutput:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: Whether the job worker has received the specified job.
description: Represents the output of an AcknowledgeJob action.
AcknowledgeJobInput:
type: object
required:
- jobId
- nonce
title: AcknowledgeJobInput
properties:
jobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The unique system-generated ID of the job for which you want to confirm receipt.
nonce:
allOf:
- $ref: '#/components/schemas/Nonce'
- description: A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the
PollForJobs request that returned this job.
description: Represents the input of an AcknowledgeJob action.
ValidationException: {}
InvalidNonceException: {}
JobNotFoundException: {}
AcknowledgeThirdPartyJobOutput:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: 'The status information for the third party job, if any.'
description: Represents the output of an AcknowledgeThirdPartyJob action.
AcknowledgeThirdPartyJobInput:
type: object
required:
- jobId
- nonce
- clientToken
title: AcknowledgeThirdPartyJobInput
properties:
jobId:
allOf:
- $ref: '#/components/schemas/ThirdPartyJobId'
- description: The unique system-generated ID of the job.
nonce:
allOf:
- $ref: '#/components/schemas/Nonce'
- description: A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a
GetThirdPartyJobDetails request.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 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.
description: Represents the input of an AcknowledgeThirdPartyJob action.
InvalidClientTokenException: {}
CreateCustomActionTypeOutput:
type: object
required:
- actionType
properties:
actionType:
allOf:
- $ref: '#/components/schemas/ActionType'
- description: Returns information about the details of an action type.
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: Specifies the tags applied to the custom action.
description: Represents the output of a CreateCustomActionType operation.
CreateCustomActionTypeInput:
type: object
required:
- category
- provider
- version
- inputArtifactDetails
- outputArtifactDetails
title: CreateCustomActionTypeInput
properties:
category:
allOf:
- $ref: '#/components/schemas/ActionCategory'
- description: 'The category of the custom action, such as a build action or a test action.'
provider:
allOf:
- $ref: '#/components/schemas/ActionProvider'
- description: 'The provider of the service used in the custom action, such as CodeDeploy.'
version:
allOf:
- $ref: '#/components/schemas/Version'
- description: The version identifier of the custom action.
settings:
allOf:
- $ref: '#/components/schemas/ActionTypeSettings'
- description: URLs that provide users information about this custom action.
configurationProperties:
allOf:
- $ref: '#/components/schemas/ActionConfigurationPropertyList'
- description: 'The configuration properties for the custom action.
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 Create a Custom Action for a Pipeline.
CreatePipeline action.
CreatePipelineInput:
type: object
required:
- pipeline
title: CreatePipelineInput
properties:
pipeline:
allOf:
- $ref: '#/components/schemas/PipelineDeclaration'
- description: 'Represents the structure of actions and stages to be performed in the pipeline. '
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags for the pipeline.
description: Represents the input of a CreatePipeline action.
PipelineNameInUseException: {}
InvalidStageDeclarationException: {}
InvalidActionDeclarationException: {}
InvalidBlockerDeclarationException: {}
InvalidStructureException: {}
DeleteCustomActionTypeInput:
type: object
required:
- category
- provider
- version
title: DeleteCustomActionTypeInput
properties:
category:
allOf:
- $ref: '#/components/schemas/ActionCategory'
- description: 'The category of the custom action that you want to delete, such as source or deploy.'
provider:
allOf:
- $ref: '#/components/schemas/ActionProvider'
- description: 'The provider of the service used in the custom action, such as CodeDeploy.'
version:
allOf:
- $ref: '#/components/schemas/Version'
- description: The version of the custom action to delete.
description: Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.
DeletePipelineInput:
type: object
required:
- name
title: DeletePipelineInput
properties:
name:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline to be deleted.
description: Represents the input of a DeletePipeline action.
DeleteWebhookOutput:
type: object
properties: {}
DeleteWebhookInput:
type: object
required:
- name
title: DeleteWebhookInput
properties:
name:
allOf:
- $ref: '#/components/schemas/WebhookName'
- description: The name of the webhook you want to delete.
DeregisterWebhookWithThirdPartyOutput:
type: object
properties: {}
DeregisterWebhookWithThirdPartyInput:
type: object
title: DeregisterWebhookWithThirdPartyInput
properties:
webhookName:
allOf:
- $ref: '#/components/schemas/WebhookName'
- description: The name of the webhook you want to deregister.
WebhookNotFoundException: {}
DisableStageTransitionInput:
type: object
required:
- pipelineName
- stageName
- transitionType
- reason
title: DisableStageTransitionInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
stageName:
allOf:
- $ref: '#/components/schemas/StageName'
- description: The name of the stage where you want to disable the inbound or outbound transition of artifacts.
transitionType:
allOf:
- $ref: '#/components/schemas/StageTransitionType'
- description: 'Specifies whether artifacts are 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).'
reason:
allOf:
- $ref: '#/components/schemas/DisabledReason'
- description: 'The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.'
description: Represents the input of a DisableStageTransition action.
PipelineNotFoundException: {}
StageNotFoundException: {}
EnableStageTransitionInput:
type: object
required:
- pipelineName
- stageName
- transitionType
title: EnableStageTransitionInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
stageName:
allOf:
- $ref: '#/components/schemas/StageName'
- description: '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).'
transitionType:
allOf:
- $ref: '#/components/schemas/StageTransitionType'
- description: Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to
transition to the next stage (outbound).
description: Represents the input of an EnableStageTransition action.
GetActionTypeOutput:
type: object
properties:
actionType:
allOf:
- $ref: '#/components/schemas/ActionTypeDeclaration'
- description: 'The action type information for the requested action type, such as the action type ID.'
GetActionTypeInput:
type: object
required:
- category
- owner
- provider
- version
title: GetActionTypeInput
properties:
category:
allOf:
- $ref: '#/components/schemas/ActionCategory'
- description: 'Defines what kind of action can be taken in the stage. The following are the valid values:
Source
Build
Test
Deploy
Approval
Invoke
AWS and ThirdParty.'
provider:
allOf:
- $ref: '#/components/schemas/ActionProvider'
- description: The provider of the action type being called. The provider name is specified when the action type is created.
version:
allOf:
- $ref: '#/components/schemas/Version'
- description: A string that describes the action type version.
ActionTypeNotFoundException: {}
GetJobDetailsOutput:
type: object
properties:
jobDetails:
allOf:
- $ref: '#/components/schemas/JobDetails'
- description: 'The details of the job.
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
GetJobDetails action.
GetJobDetailsInput:
type: object
required:
- jobId
title: GetJobDetailsInput
properties:
jobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The unique system-generated ID for the job.
description: Represents the input of a GetJobDetails action.
GetPipelineOutput:
type: object
properties:
pipeline:
allOf:
- $ref: '#/components/schemas/PipelineDeclaration'
- description: 'Represents the structure of actions and stages to be performed in the pipeline. '
metadata:
allOf:
- $ref: '#/components/schemas/PipelineMetadata'
- description: Represents the pipeline metadata information returned as part of the output of a GetPipeline action.
description: Represents the output of a GetPipeline action.
GetPipelineInput:
type: object
required:
- name
title: GetPipelineInput
properties:
name:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.
version:
allOf:
- $ref: '#/components/schemas/PipelineVersion'
- description: 'The version number of the pipeline. If you do not specify a version, defaults to the current version.'
description: Represents the input of a GetPipeline action.
PipelineVersionNotFoundException: {}
GetPipelineExecutionOutput:
type: object
properties:
pipelineExecution:
allOf:
- $ref: '#/components/schemas/PipelineExecution'
- description: Represents information about the execution of a pipeline.
description: Represents the output of a GetPipelineExecution action.
GetPipelineExecutionInput:
type: object
required:
- pipelineName
- pipelineExecutionId
title: GetPipelineExecutionInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline about which you want to get execution details.
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The ID of the pipeline execution about which you want to get execution details.
description: Represents the input of a GetPipelineExecution action.
PipelineExecutionNotFoundException: {}
GetPipelineStateOutput:
type: object
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline for which you want to get the state.
pipelineVersion:
allOf:
- $ref: '#/components/schemas/PipelineVersion'
- description: The version number of the pipeline.
A newly created pipeline is always assigned a version number of 1.
GetPipelineState action.
GetPipelineStateInput:
type: object
required:
- name
title: GetPipelineStateInput
properties:
name:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline about which you want to get information.
description: Represents the input of a GetPipelineState action.
GetThirdPartyJobDetailsOutput:
type: object
properties:
jobDetails:
allOf:
- $ref: '#/components/schemas/ThirdPartyJobDetails'
- description: 'The details of the job, including any protected values defined for the job.'
description: Represents the output of a GetThirdPartyJobDetails action.
GetThirdPartyJobDetailsInput:
type: object
required:
- jobId
- clientToken
title: GetThirdPartyJobDetailsInput
properties:
jobId:
allOf:
- $ref: '#/components/schemas/ThirdPartyJobId'
- description: The unique system-generated ID used for identifying the job.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 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.
description: Represents the input of a GetThirdPartyJobDetails action.
InvalidJobException: {}
ListActionExecutionsOutput:
type: object
properties:
actionExecutionDetails:
allOf:
- $ref: '#/components/schemas/ActionExecutionDetailList'
- description: 'The details for a list of recent executions, such as action execution ID.'
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the
next set of action executions in the list.'
ListActionExecutionsInput:
type: object
required:
- pipelineName
title: ListActionExecutionsInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: ' The name of the pipeline for which you want to list action execution history.'
filter:
allOf:
- $ref: '#/components/schemas/ActionExecutionFilter'
- description: Input information used to filter action execution history.
maxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100.
Detailed execution history is available for executions run on or after February 21, 2019.
ListActionExecutions call, which can be used to return the next set of action executions in the list.'
InvalidNextTokenException: {}
ListActionTypesOutput:
type: object
required:
- actionTypes
properties:
actionTypes:
allOf:
- $ref: '#/components/schemas/ActionTypeList'
- description: Provides details of the action types.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list action types call to return the next set of action
types in the list.'
description: Represents the output of a ListActionTypes action.
ListActionTypesInput:
type: object
title: ListActionTypesInput
properties:
actionOwnerFilter:
allOf:
- $ref: '#/components/schemas/ActionOwner'
- description: Filters the list of action types to those created by a specified entity.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: '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.'
regionFilter:
allOf:
- $ref: '#/components/schemas/AWSRegionName'
- description: The Region to filter on for the list of action types.
description: Represents the input of a ListActionTypes action.
ListPipelineExecutionsOutput:
type: object
properties:
pipelineExecutionSummaries:
allOf:
- $ref: '#/components/schemas/PipelineExecutionSummaryList'
- description: A list of executions in the history of a pipeline.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: '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.'
description: Represents the output of a ListPipelineExecutions action.
ListPipelineExecutionsInput:
type: object
required:
- pipelineName
title: ListPipelineExecutionsInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline for which you want to get execution summary information.
maxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to
the most recent 12 months, based on pipeline execution start times. Default value is 100.'
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: '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.'
description: Represents the input of a ListPipelineExecutions action.
ListPipelinesOutput:
type: object
properties:
pipelines:
allOf:
- $ref: '#/components/schemas/PipelineList'
- description: The list of pipelines.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list pipelines call to return the next set of pipelines
in the list.'
description: Represents the output of a ListPipelines action.
ListPipelinesInput:
type: object
title: ListPipelinesInput
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.
maxResults:
allOf:
- $ref: '#/components/schemas/MaxPipelines'
- description: 'The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can
specify is 1. The maximum accepted value is 1000.'
description: Represents the input of a ListPipelines action.
ListTagsForResourceOutput:
type: object
properties:
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags for the resource.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent API call to return the next page of the list. The ListTagsforResource
call lists all available tags in one call and does not use pagination.'
ListTagsForResourceInput:
type: object
required:
- resourceArn
title: ListTagsForResourceInput
properties:
resourceArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- description: The Amazon Resource Name (ARN) of the resource to get tags for.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The token that was returned from the previous API call, which would be used to return the next page of the list. The ListTagsforResource call lists all available tags in one call
and does not use pagination.'
maxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to return in a single call.
ResourceNotFoundException: {}
InvalidArnException: {}
ListWebhooksOutput:
type: object
properties:
webhooks:
allOf:
- $ref: '#/components/schemas/WebhookList'
- description: The JSON detail returned for each webhook in the list output for the ListWebhooks call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: '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. '
ListWebhooksInput:
type: object
title: ListWebhooksInput
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.'
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
PollForJobsOutput:
type: object
properties:
jobs:
allOf:
- $ref: '#/components/schemas/JobList'
- description: Information about the jobs to take action on.
description: Represents the output of a PollForJobs action.
PollForJobsInput:
type: object
required:
- actionTypeId
title: PollForJobsInput
properties:
actionTypeId:
allOf:
- $ref: '#/components/schemas/ActionTypeId'
- description: Represents information about an action type.
maxBatchSize:
allOf:
- $ref: '#/components/schemas/MaxBatchSize'
- description: The maximum number of jobs to return in a poll for jobs call.
queryParam:
allOf:
- $ref: '#/components/schemas/QueryParamMap'
- description: '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 are returned.'
description: Represents the input of a PollForJobs action.
PollForThirdPartyJobsOutput:
type: object
properties:
jobs:
allOf:
- $ref: '#/components/schemas/ThirdPartyJobList'
- description: Information about the jobs to take action on.
description: Represents the output of a PollForThirdPartyJobs action.
PollForThirdPartyJobsInput:
type: object
required:
- actionTypeId
title: PollForThirdPartyJobsInput
properties:
actionTypeId:
allOf:
- $ref: '#/components/schemas/ActionTypeId'
- description: Represents information about an action type.
maxBatchSize:
allOf:
- $ref: '#/components/schemas/MaxBatchSize'
- description: The maximum number of jobs to return in a poll for jobs call.
description: Represents the input of a PollForThirdPartyJobs action.
PutActionRevisionOutput:
type: object
properties:
newRevision:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the artifact revision was previously used in an execution of the specified pipeline.
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The ID of the current workflow state of the pipeline.
description: Represents the output of a PutActionRevision action.
PutActionRevisionInput:
type: object
required:
- pipelineName
- stageName
- actionName
- actionRevision
title: PutActionRevisionInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline that starts processing the revision to the source.
stageName:
allOf:
- $ref: '#/components/schemas/StageName'
- description: The name of the stage that contains the action that acts on the revision.
actionName:
allOf:
- $ref: '#/components/schemas/ActionName'
- description: The name of the action that processes the revision.
actionRevision:
allOf:
- $ref: '#/components/schemas/ActionRevision'
- description: Represents information about the version (or revision) of an action.
description: Represents the input of a PutActionRevision action.
ActionNotFoundException: {}
PutApprovalResultOutput:
type: object
properties:
approvedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The timestamp showing when the approval or rejection was submitted.
description: Represents the output of a PutApprovalResult action.
PutApprovalResultInput:
type: object
required:
- pipelineName
- stageName
- actionName
- result
- token
title: PutApprovalResultInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: 'The name of the pipeline that contains the action. '
stageName:
allOf:
- $ref: '#/components/schemas/StageName'
- description: The name of the stage that contains the action.
actionName:
allOf:
- $ref: '#/components/schemas/ActionName'
- description: The name of the action for which approval is requested.
result:
allOf:
- $ref: '#/components/schemas/ApprovalResult'
- description: Represents information about the result of the approval request.
token:
allOf:
- $ref: '#/components/schemas/ApprovalToken'
- description: The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is
used to validate that the approval request corresponding to this token is still valid.
description: Represents the input of a PutApprovalResult action.
InvalidApprovalTokenException: {}
ApprovalAlreadyCompletedException: {}
PutJobFailureResultInput:
type: object
required:
- jobId
- failureDetails
title: PutJobFailureResultInput
properties:
jobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
failureDetails:
allOf:
- $ref: '#/components/schemas/FailureDetails'
- description: The details about the failure of a job.
description: Represents the input of a PutJobFailureResult action.
InvalidJobStateException: {}
PutJobSuccessResultInput:
type: object
required:
- jobId
title: PutJobSuccessResultInput
properties:
jobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
currentRevision:
allOf:
- $ref: '#/components/schemas/CurrentRevision'
- description: The ID of the current revision of the artifact successfully worked on by the job.
continuationToken:
allOf:
- $ref: '#/components/schemas/ContinuationToken'
- description: 'A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify
the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.'
executionDetails:
allOf:
- $ref: '#/components/schemas/ExecutionDetails'
- description: 'The execution details of the successful job, such as the actions taken by the job worker.'
outputVariables:
allOf:
- $ref: '#/components/schemas/OutputVariablesMap'
- description: Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when
there is no continuation token on the request.
description: Represents the input of a PutJobSuccessResult action.
OutputVariablesSizeExceededException: {}
PutThirdPartyJobFailureResultInput:
type: object
required:
- jobId
- clientToken
- failureDetails
title: PutThirdPartyJobFailureResultInput
properties:
jobId:
allOf:
- $ref: '#/components/schemas/ThirdPartyJobId'
- description: The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 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.
failureDetails:
allOf:
- $ref: '#/components/schemas/FailureDetails'
- description: Represents information about failure details.
description: Represents the input of a PutThirdPartyJobFailureResult action.
PutThirdPartyJobSuccessResultInput:
type: object
required:
- jobId
- clientToken
title: PutThirdPartyJobSuccessResultInput
properties:
jobId:
allOf:
- $ref: '#/components/schemas/ThirdPartyJobId'
- description: The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 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.
currentRevision:
allOf:
- $ref: '#/components/schemas/CurrentRevision'
- description: Represents information about a current revision.
continuationToken:
allOf:
- $ref: '#/components/schemas/ContinuationToken'
- description: 'A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify
the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.'
executionDetails:
allOf:
- $ref: '#/components/schemas/ExecutionDetails'
- description: 'The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline. '
description: Represents the input of a PutThirdPartyJobSuccessResult action.
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.'
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.
InvalidWebhookFilterPatternException: {}
InvalidWebhookAuthenticationParametersException: {}
RegisterWebhookWithThirdPartyOutput:
type: object
properties: {}
RegisterWebhookWithThirdPartyInput:
type: object
title: RegisterWebhookWithThirdPartyInput
properties:
webhookName:
allOf:
- $ref: '#/components/schemas/WebhookName'
- description: 'The name of an existing webhook created with PutWebhook to register with a supported third party. '
RetryStageExecutionOutput:
type: object
properties:
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The ID of the current workflow execution in the failed stage.
description: Represents the output of a RetryStageExecution action.
RetryStageExecutionInput:
type: object
required:
- pipelineName
- stageName
- pipelineExecutionId
- retryMode
title: RetryStageExecutionInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline that contains the failed stage.
stageName:
allOf:
- $ref: '#/components/schemas/StageName'
- description: The name of the failed stage to be retried.
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage
retryMode:
allOf:
- $ref: '#/components/schemas/StageRetryMode'
- description: 'The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.'
description: Represents the input of a RetryStageExecution action.
ConflictException: {}
StageNotRetryableException: {}
NotLatestPipelineExecutionException: {}
StartPipelineExecutionOutput:
type: object
properties:
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The unique system-generated ID of the pipeline execution that was started.
description: Represents the output of a StartPipelineExecution action.
StartPipelineExecutionInput:
type: object
required:
- name
title: StartPipelineExecutionInput
properties:
name:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline to start.
clientRequestToken:
allOf:
- $ref: '#/components/schemas/ClientRequestToken'
- description: The system-generated unique ID used to identify a unique execution request.
description: Represents the input of a StartPipelineExecution action.
StopPipelineExecutionOutput:
type: object
properties:
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The unique system-generated ID of the pipeline execution that was stopped.
StopPipelineExecutionInput:
type: object
required:
- pipelineName
- pipelineExecutionId
title: StopPipelineExecutionInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline to stop.
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.
abandon:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
This option can lead to failed or out-of-sequence tasks.
UpdatePipeline action.
UpdatePipelineInput:
type: object
required:
- pipeline
title: UpdatePipelineInput
properties:
pipeline:
allOf:
- $ref: '#/components/schemas/PipelineDeclaration'
- description: The name of the pipeline to be updated.
description: Represents the input of an UpdatePipeline action.
AWSRegionName:
type: string
minLength: 4
maxLength: 30
AccessKeyId:
type: string
format: password
SecretAccessKey:
type: string
format: password
SessionToken:
type: string
format: password
AWSSessionCredentials:
type: object
required:
- accessKeyId
- secretAccessKey
- sessionToken
properties:
accessKeyId:
allOf:
- $ref: '#/components/schemas/AccessKeyId'
- description: The access key for the session.
secretAccessKey:
allOf:
- $ref: '#/components/schemas/SecretAccessKey'
- description: The secret access key for the session.
sessionToken:
allOf:
- $ref: '#/components/schemas/SessionToken'
- description: The token for the session.
description: Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can
be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in CodePipeline.
AccountId:
type: string
pattern: '[0-9]{12}'
JobId:
type: string
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
Nonce:
type: string
minLength: 1
maxLength: 50
JobStatus:
type: string
enum:
- Created
- Queued
- Dispatched
- InProgress
- TimedOut
- Succeeded
- Failed
ThirdPartyJobId:
type: string
minLength: 1
maxLength: 512
ClientToken:
type: string
minLength: 1
maxLength: 256
ActionCategory:
type: string
enum:
- Source
- Build
- Deploy
- Test
- Invoke
- Approval
ActionConfigurationMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ActionConfigurationValue'
ActionConfiguration:
type: object
properties:
configuration:
allOf:
- $ref: '#/components/schemas/ActionConfigurationMap'
- description: The configuration data for the action.
description: Represents information about an action configuration.
ActionConfigurationKey:
type: string
minLength: 1
maxLength: 50
ActionConfigurationValue:
type: string
minLength: 1
maxLength: 1000
Boolean:
type: boolean
Description:
type: string
minLength: 1
maxLength: 160
ActionConfigurationPropertyType:
type: string
enum:
- String
- Number
- Boolean
ActionConfigurationProperty:
type: object
required:
- name
- required
- key
- secret
properties:
name:
allOf:
- $ref: '#/components/schemas/ActionConfigurationKey'
- description: The name of the action configuration property.
required:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the configuration property is a required value.
key:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the configuration property is a key.
secret:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs,
and PollForThirdPartyJobs.
When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
' queryable: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates that the property is used 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.
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 other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
' description: allOf: - $ref: '#/components/schemas/Description' - description: The description of the action configuration property that is displayed to users. type: allOf: - $ref: '#/components/schemas/ActionConfigurationPropertyType' - description: The type of the configuration property. description: Represents information about an action configuration property. ActionConfigurationPropertyList: type: array items: $ref: '#/components/schemas/ActionConfigurationProperty' maxItems: 10 ActionConfigurationQueryableValue: type: string pattern: '[a-zA-Z0-9_-]+' minLength: 1 maxLength: 50 ActionName: type: string pattern: '[A-Za-z0-9.@\-_]+' minLength: 1 maxLength: 100 ActionExecutionId: type: string ActionContext: type: object properties: name: allOf: - $ref: '#/components/schemas/ActionName' - description: The name of the action in the context of a job. actionExecutionId: allOf: - $ref: '#/components/schemas/ActionExecutionId' - description: The system-generated unique ID that corresponds to an action's execution. description: Represents the context of an action in the stage of a pipeline to a job worker. ActionTypeId: type: object required: - category - owner - provider - version properties: category: allOf: - $ref: '#/components/schemas/ActionCategory' - description: '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 following values.
Source
Build
Test
Deploy
Invoke
Approval
Owner field in the action category section within your pipeline structure: AWS,
ThirdParty, and Custom. For more information, see Valid
Action Types and Providers in CodePipeline.'
provider:
allOf:
- $ref: '#/components/schemas/ActionProvider'
- description: '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 CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid
Action Types and Providers in CodePipeline.'
version:
allOf:
- $ref: '#/components/schemas/Version'
- description: A string that describes the action version.
description: Represents information about an action type.
ActionRunOrder:
type: integer
minimum: 1
maximum: 999
OutputArtifactList:
type: array
items:
$ref: '#/components/schemas/OutputArtifact'
InputArtifactList:
type: array
items:
$ref: '#/components/schemas/InputArtifact'
RoleArn:
type: string
pattern: 'arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*'
maxLength: 1024
ActionNamespace:
type: string
pattern: '[A-Za-z0-9@\-_]+'
minLength: 1
maxLength: 100
ActionDeclaration:
type: object
required:
- name
- actionTypeId
properties:
name:
allOf:
- $ref: '#/components/schemas/ActionName'
- description: The action declaration's name.
actionTypeId:
allOf:
- $ref: '#/components/schemas/ActionTypeId'
- description: Specifies the action type and the provider of the action.
runOrder:
allOf:
- $ref: '#/components/schemas/ActionRunOrder'
- description: The order in which actions are run.
configuration:
allOf:
- $ref: '#/components/schemas/ActionConfigurationMap'
- description: 'The action''s configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage.
For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.
GetPipelineState
command. It is used to validate that the approval request corresponding to this token is still valid.
lastUpdatedBy:
allOf:
- $ref: '#/components/schemas/LastUpdatedBy'
- description: The ARN of the user who last changed the pipeline.
externalExecutionId:
allOf:
- $ref: '#/components/schemas/ExecutionId'
- description: The external ID of the run of the action.
externalExecutionUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: 'The URL of a resource external to Amazon Web Services that is used when running the action (for example, an external repository URL).'
percentComplete:
allOf:
- $ref: '#/components/schemas/Percentage'
- description: A percentage of completeness of the action as it runs.
errorDetails:
allOf:
- $ref: '#/components/schemas/ErrorDetails'
- description: The details of an error returned by a URL external to Amazon Web Services.
description: Represents information about the run of an action.
PipelineExecutionId:
type: string
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
PipelineVersion:
type: integer
minimum: 1
StageName:
type: string
pattern: '[A-Za-z0-9.@\-_]+'
minLength: 1
maxLength: 100
ActionExecutionInput:
type: object
properties:
actionTypeId:
$ref: '#/components/schemas/ActionTypeId'
configuration:
allOf:
- $ref: '#/components/schemas/ActionConfigurationMap'
- description: Configuration data for an action execution.
resolvedConfiguration:
allOf:
- $ref: '#/components/schemas/ResolvedActionConfigurationMap'
- description: Configuration data for an action execution with all variable references replaced with their real values for the execution.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: 'The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline. '
region:
allOf:
- $ref: '#/components/schemas/AWSRegionName'
- description: 'The Amazon Web Services Region for the action, such as us-east-1.'
inputArtifacts:
allOf:
- $ref: '#/components/schemas/ArtifactDetailList'
- description: Details of input artifacts of the action that correspond to the action execution.
namespace:
allOf:
- $ref: '#/components/schemas/ActionNamespace'
- description: The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
description: Input information used for an action execution.
ActionExecutionOutput:
type: object
properties:
outputArtifacts:
allOf:
- $ref: '#/components/schemas/ArtifactDetailList'
- description: Details of output artifacts of the action that correspond to the action execution.
executionResult:
allOf:
- $ref: '#/components/schemas/ActionExecutionResult'
- description: Execution result information listed in the output details for an action execution.
outputVariables:
allOf:
- $ref: '#/components/schemas/OutputVariablesMap'
- description: The outputVariables field shows the key-value pairs that were output as part of that execution.
description: 'Output details listed for an action execution, such as the action execution result.'
ActionExecutionDetail:
type: object
properties:
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The pipeline execution ID for the action execution.
actionExecutionId:
allOf:
- $ref: '#/components/schemas/ActionExecutionId'
- description: The action execution ID.
pipelineVersion:
allOf:
- $ref: '#/components/schemas/PipelineVersion'
- description: The version of the pipeline where the action was run.
stageName:
allOf:
- $ref: '#/components/schemas/StageName'
- description: The name of the stage that contains the action.
actionName:
allOf:
- $ref: '#/components/schemas/ActionName'
- description: The name of the action.
startTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The start time of the action execution.
lastUpdateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last update time of the action execution.
status:
allOf:
- $ref: '#/components/schemas/ActionExecutionStatus'
- description: ' The status of the action execution. Status categories are InProgress, Succeeded, and Failed.'
input:
allOf:
- $ref: '#/components/schemas/ActionExecutionInput'
- description: 'Input details for the action execution, such as role ARN, Region, and input artifacts.'
output:
allOf:
- $ref: '#/components/schemas/ActionExecutionOutput'
- description: 'Output details for the action execution, such as the action execution result.'
description: 'Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action. '
ActionExecutionDetailList:
type: array
items:
$ref: '#/components/schemas/ActionExecutionDetail'
ActionExecutionFilter:
type: object
properties:
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The pipeline execution ID used to filter action execution history.
description: Filter values for the action execution.
ResolvedActionConfigurationMap:
type: object
additionalProperties:
$ref: '#/components/schemas/String'
ArtifactDetailList:
type: array
items:
$ref: '#/components/schemas/ArtifactDetail'
ActionExecutionResult:
type: object
properties:
externalExecutionId:
allOf:
- $ref: '#/components/schemas/ExternalExecutionId'
- description: The action provider's external ID for the action execution.
externalExecutionSummary:
allOf:
- $ref: '#/components/schemas/ExternalExecutionSummary'
- description: The action provider's summary for the action execution.
externalExecutionUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: 'The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.'
description: 'Execution result information, such as the external execution ID.'
OutputVariablesMap:
type: object
additionalProperties:
$ref: '#/components/schemas/OutputVariablesValue'
ExternalExecutionId:
type: string
ExternalExecutionSummary:
type: string
ActionOwner:
type: string
enum:
- AWS
- ThirdParty
- Custom
ActionProvider:
type: string
pattern: '[0-9A-Za-z_-]+'
minLength: 1
maxLength: 35
Revision:
type: string
minLength: 1
maxLength: 1500
RevisionChangeIdentifier:
type: string
minLength: 1
maxLength: 100
ActionRevision:
type: object
required:
- revisionId
- revisionChangeId
- created
properties:
revisionId:
allOf:
- $ref: '#/components/schemas/Revision'
- description: The system-generated unique ID that identifies the revision number of the action.
revisionChangeId:
allOf:
- $ref: '#/components/schemas/RevisionChangeIdentifier'
- description: 'The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).'
created:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time when the most recent version of the action was created, in timestamp format.'
description: Represents information about the version (or revision) of an action.
ActionState:
type: object
properties:
actionName:
allOf:
- $ref: '#/components/schemas/ActionName'
- description: The name of the action.
currentRevision:
allOf:
- $ref: '#/components/schemas/ActionRevision'
- description: Represents information about the version (or revision) of an action.
latestExecution:
allOf:
- $ref: '#/components/schemas/ActionExecution'
- description: Represents information about the run of an action.
entityUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: 'A URL link for more information about the state of the action, such as a deployment group details page.'
revisionUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: 'A URL link for more information about the revision, such as a commit details page.'
description: Represents information about the state of an action.
ActionStateList:
type: array
items:
$ref: '#/components/schemas/ActionState'
ActionTypeSettings:
type: object
properties:
thirdPartyConfigurationUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: 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.
entityUrlTemplate:
allOf:
- $ref: '#/components/schemas/UrlTemplate'
- description: 'The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group.
This link is provided as part of the action display in the pipeline.'
executionUrlTemplate:
allOf:
- $ref: '#/components/schemas/UrlTemplate'
- description: 'The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown
on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.'
revisionUrlTemplate:
allOf:
- $ref: '#/components/schemas/UrlTemplate'
- description: The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
description: Returns information about the settings for an action type.
ArtifactDetails:
type: object
required:
- minimumCount
- maximumCount
properties:
minimumCount:
allOf:
- $ref: '#/components/schemas/MinimumArtifactCount'
- description: The minimum number of artifacts allowed for the action type.
maximumCount:
allOf:
- $ref: '#/components/schemas/MaximumArtifactCount'
- description: The maximum number of artifacts allowed for the action type.
description: Returns information about the details of an artifact.
ActionType:
type: object
required:
- id
- inputArtifactDetails
- outputArtifactDetails
properties:
id:
allOf:
- $ref: '#/components/schemas/ActionTypeId'
- description: Represents information about an action type.
settings:
allOf:
- $ref: '#/components/schemas/ActionTypeSettings'
- description: The settings for the action type.
actionConfigurationProperties:
allOf:
- $ref: '#/components/schemas/ActionConfigurationPropertyList'
- description: The configuration properties for the action type.
inputArtifactDetails:
allOf:
- $ref: '#/components/schemas/ArtifactDetails'
- description: 'The details of the input artifact for the action, such as its commit ID.'
outputArtifactDetails:
allOf:
- $ref: '#/components/schemas/ArtifactDetails'
- description: 'The details of the output artifact of the action, such as its commit ID.'
description: Returns information about the details of an action type.
MinimumActionTypeArtifactCount:
type: integer
minimum: 0
maximum: 10
MaximumActionTypeArtifactCount:
type: integer
minimum: 0
maximum: 10
ActionTypeArtifactDetails:
type: object
required:
- minimumCount
- maximumCount
properties:
minimumCount:
allOf:
- $ref: '#/components/schemas/MinimumActionTypeArtifactCount'
- description: 'The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category
of source.'
maximumCount:
allOf:
- $ref: '#/components/schemas/MaximumActionTypeArtifactCount'
- description: 'The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category
of source.'
description: 'Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.'
ActionTypeDescription:
type: string
minLength: 1
maxLength: 1024
ActionTypeExecutor:
type: object
required:
- configuration
- type
properties:
configuration:
allOf:
- $ref: '#/components/schemas/ExecutorConfiguration'
- description: The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.
type:
allOf:
- $ref: '#/components/schemas/ExecutorType'
- description: 'The integration model used to create and update the action type, Lambda or JobWorker. '
policyStatementsTemplate:
allOf:
- $ref: '#/components/schemas/PolicyStatementsTemplate'
- description: 'The policy statement that specifies the permissions in the CodePipeline customer account that are needed to successfully run an action.
To grant permission to another
account, specify the account ID as the Principal, a domain-style identifier defined by the service, for example codepipeline.amazonaws.com.
The size of the passed JSON policy document cannot exceed 2048 characters.
Defines what kind of action can be taken in the stage, one of the following:
Source
Build
Test
Deploy
Approval
Invoke
AWS or ThirdParty.'
provider:
allOf:
- $ref: '#/components/schemas/ActionProvider'
- description: The provider of the action type being called. The provider name is supplied when the action type is created.
version:
allOf:
- $ref: '#/components/schemas/Version'
- description: A string that describes the action type version.
description: 'Specifies the category, owner, provider, and version of the action type.'
ActionTypePermissions:
type: object
required:
- allowedAccounts
properties:
allowedAccounts:
allOf:
- $ref: '#/components/schemas/AllowedAccounts'
- description: A list of Amazon Web Services account IDs with access to use the action type in their pipelines.
description: Details identifying the users with permissions to use the action type.
ActionTypeUrls:
type: object
properties:
configurationUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.
entityUrlTemplate:
allOf:
- $ref: '#/components/schemas/UrlTemplate'
- description: 'The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as a status page. This link is provided as part of the action
display in the pipeline.'
executionUrlTemplate:
allOf:
- $ref: '#/components/schemas/UrlTemplate'
- description: 'The link to an execution page for the action type in progress. For example, for a CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and
it links to a CodeDeploy status page.'
revisionUrlTemplate:
allOf:
- $ref: '#/components/schemas/UrlTemplate'
- description: The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
description: 'Returns information about URLs for web pages that display to customers as links on the pipeline view, such as an external configuration page for the action type.'
ActionTypeDeclaration:
type: object
required:
- executor
- id
- inputArtifactDetails
- outputArtifactDetails
properties:
description:
allOf:
- $ref: '#/components/schemas/ActionTypeDescription'
- description: The description for the action type to be updated.
executor:
allOf:
- $ref: '#/components/schemas/ActionTypeExecutor'
- description: Information about the executor for an action type that was created with any supported integration model.
id:
allOf:
- $ref: '#/components/schemas/ActionTypeIdentifier'
- description: 'The action category, owner, provider, and version of the action type to be updated.'
inputArtifactDetails:
allOf:
- $ref: '#/components/schemas/ActionTypeArtifactDetails'
- description: 'Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.'
outputArtifactDetails:
allOf:
- $ref: '#/components/schemas/ActionTypeArtifactDetails'
- description: 'Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.'
permissions:
allOf:
- $ref: '#/components/schemas/ActionTypePermissions'
- description: Details identifying the accounts with permissions to use the action type.
properties:
description: The properties of the action type to be updated.
urls:
allOf:
- $ref: '#/components/schemas/ActionTypeUrls'
- description: The links associated with the action type to be updated.
description: The parameters for the action type definition that are provided when the action type is created or updated.
ExecutorConfiguration:
type: object
properties:
lambdaExecutorConfiguration:
allOf:
- $ref: '#/components/schemas/LambdaExecutorConfiguration'
- description: Details about the Lambda executor of the action type.
jobWorkerExecutorConfiguration:
allOf:
- $ref: '#/components/schemas/JobWorkerExecutorConfiguration'
- description: Details about the JobWorker executor of the action type.
description: 'The action engine, or executor, related to the supported integration model used to create and update the action type. The available executor types are Lambda and JobWorker.'
ExecutorType:
type: string
enum:
- JobWorker
- Lambda
PolicyStatementsTemplate:
type: string
minLength: 1
maxLength: 2048
JobTimeout:
type: integer
minimum: 60
maximum: 43200
Version:
type: string
pattern: '[0-9A-Za-z_-]+'
minLength: 1
maxLength: 9
ActionTypeOwner:
type: string
pattern: AWS|ThirdParty
ActionTypeList:
type: array
items:
$ref: '#/components/schemas/ActionType'
AllowedAccounts:
type: array
items:
$ref: '#/components/schemas/AllowedAccount'
minItems: 1
maxItems: 1000
ActionTypeProperty:
type: object
required:
- name
- optional
- key
- noEcho
properties:
name:
allOf:
- $ref: '#/components/schemas/ActionConfigurationKey'
- description: The property name that is displayed to users.
optional:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the configuration property is an optional value.
key:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the configuration property is a key.
noEcho:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Whether to omit the field value entered by the customer in the log. If true, the value is not saved in CloudTrail logs for the action execution.'
queryable:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.'
description:
allOf:
- $ref: '#/components/schemas/PropertyDescription'
- description: The description of the property that is displayed to users.
description: 'Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.'
ActionTypeProperties:
type: array
items:
$ref: '#/components/schemas/ActionTypeProperty'
maxItems: 10
PropertyDescription:
type: string
minLength: 1
maxLength: 250
UrlTemplate:
type: string
minLength: 1
maxLength: 2048
AllowedAccount:
type: string
pattern: '[0-9]{12}|\*'
ApprovalSummary:
type: string
minLength: 0
maxLength: 512
ApprovalStatus:
type: string
enum:
- Approved
- Rejected
ApprovalResult:
type: object
required:
- summary
- status
properties:
summary:
allOf:
- $ref: '#/components/schemas/ApprovalSummary'
- description: The summary of the current status of the approval request.
status:
allOf:
- $ref: '#/components/schemas/ApprovalStatus'
- description: The response submitted by a reviewer assigned to an approval action request.
description: Represents information about the result of an approval request.
ApprovalToken:
type: string
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
ArtifactName:
type: string
pattern: '[a-zA-Z0-9_\-]+'
minLength: 1
maxLength: 100
ArtifactLocation:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/ArtifactLocationType'
- description: The type of artifact in the location.
s3Location:
allOf:
- $ref: '#/components/schemas/S3ArtifactLocation'
- description: The S3 bucket that contains the artifact.
description: Represents information about the location of an artifact.
Artifact:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ArtifactName'
- description: The artifact's name.
revision:
allOf:
- $ref: '#/components/schemas/Revision'
- description: 'The artifact''s revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).'
location:
allOf:
- $ref: '#/components/schemas/ArtifactLocation'
- description: The location of an artifact.
description: 'Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source
action artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip'
S3Location:
type: object
properties:
bucket:
allOf:
- $ref: '#/components/schemas/S3Bucket'
- description: The Amazon S3 artifact bucket for an action's artifacts.
key:
allOf:
- $ref: '#/components/schemas/S3Key'
- description: The artifact name.
description: The Amazon S3 artifact location for an action's artifacts.
ArtifactDetail:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ArtifactName'
- description: The artifact object name for the action execution.
s3location:
allOf:
- $ref: '#/components/schemas/S3Location'
- description: The Amazon S3 artifact location for the action execution.
description: 'Artifact details for the action execution, such as the artifact location.'
MinimumArtifactCount:
type: integer
minimum: 0
maximum: 5
MaximumArtifactCount:
type: integer
minimum: 0
maximum: 5
ArtifactList:
type: array
items:
$ref: '#/components/schemas/Artifact'
ArtifactLocationType:
type: string
enum:
- S3
S3ArtifactLocation:
type: object
required:
- bucketName
- objectKey
properties:
bucketName:
allOf:
- $ref: '#/components/schemas/S3BucketName'
- description: The name of the S3 bucket.
objectKey:
allOf:
- $ref: '#/components/schemas/S3ObjectKey'
- description: 'The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.'
description: The location of the S3 bucket that contains a revision.
RevisionSummary:
type: string
minLength: 1
maxLength: 2048
ArtifactRevision:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ArtifactName'
- description: 'The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.'
revisionId:
allOf:
- $ref: '#/components/schemas/Revision'
- description: The revision ID of the artifact.
revisionChangeIdentifier:
allOf:
- $ref: '#/components/schemas/RevisionChangeIdentifier'
- description: 'An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.'
revisionSummary:
allOf:
- $ref: '#/components/schemas/RevisionSummary'
- description: 'Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided
content of a codepipeline-artifact-revision-summary key specified in the object metadata.'
created:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time when the most recent revision of the artifact was created, in timestamp format.'
revisionUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: 'The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.'
description: 'Represents revision details of an artifact. '
ArtifactRevisionList:
type: array
items:
$ref: '#/components/schemas/ArtifactRevision'
ArtifactStoreType:
type: string
enum:
- S3
ArtifactStoreLocation:
type: string
pattern: '[a-zA-Z0-9\-\.]+'
minLength: 3
maxLength: 63
EncryptionKey:
type: object
required:
- id
- type
properties:
id:
allOf:
- $ref: '#/components/schemas/EncryptionKeyId'
- description: 'The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.
Aliases are recognized only in the account that created the KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).
The S3 bucket where artifacts for the pipeline are stored.
You must include either artifactStore or artifactStores in your pipeline, but you
cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
actionRoleArn, or to use to assume roles for actions with an actionRoleArn.'
artifactStore:
allOf:
- $ref: '#/components/schemas/ArtifactStore'
- description: 'Represents information about the S3 bucket where artifacts are stored for the pipeline.
You must include either artifactStore or artifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region
action in the pipeline.
You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region
action in your pipeline, you must use artifactStores.
start-pipeline-execution CLI command.'
description: The interaction or event that started a pipeline execution.
LambdaExecutorConfiguration:
type: object
required:
- lambdaFunctionArn
properties:
lambdaFunctionArn:
allOf:
- $ref: '#/components/schemas/LambdaFunctionArn'
- description: The ARN of the Lambda function used by the action engine.
description: 'Details about the configuration for the Lambda action engine, or executor.'
JobWorkerExecutorConfiguration:
type: object
properties:
pollingAccounts:
allOf:
- $ref: '#/components/schemas/PollingAccountList'
- description: The accounts in which the job worker is configured and might poll for jobs as part of the action execution.
pollingServicePrincipals:
allOf:
- $ref: '#/components/schemas/PollingServicePrincipalList'
- description: The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.
description: 'Details about the polling configuration for the JobWorker action engine, or executor.'
FailureType:
type: string
enum:
- JobFailed
- ConfigurationError
- PermissionError
- RevisionOutOfSync
- RevisionUnavailable
- SystemUnavailable
FailureDetails:
type: object
required:
- type
- message
properties:
type:
allOf:
- $ref: '#/components/schemas/FailureType'
- description: The type of the failure.
message:
allOf:
- $ref: '#/components/schemas/Message'
- description: The message about the failure.
externalExecutionId:
allOf:
- $ref: '#/components/schemas/ExecutionId'
- description: The external ID of the run of the action that failed.
description: Represents information about failure details.
JobDetails:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The unique system-generated ID of the job.
data:
allOf:
- $ref: '#/components/schemas/JobData'
- description: 'Represents other information about a job required for a job worker to complete the job. '
accountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The Amazon Web Services account ID associated with the job.
description: Represents information about the details of a job.
PipelineExecution:
type: object
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline with the specified pipeline execution.
pipelineVersion:
allOf:
- $ref: '#/components/schemas/PipelineVersion'
- description: The version number of the pipeline with the specified pipeline execution.
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The ID of the pipeline execution.
status:
allOf:
- $ref: '#/components/schemas/PipelineExecutionStatus'
- description: 'The status of the pipeline execution.
Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
InProgress: The pipeline execution is currently running.
Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
Succeeded: The pipeline execution was completed successfully.
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. For more information, see Superseded Executions.
Failed: The pipeline execution was not completed successfully.
ArtifactRevision objects included in a pipeline execution.
description: Represents information about an execution of a pipeline.
PipelineMetadata:
type: object
properties:
pipelineArn:
allOf:
- $ref: '#/components/schemas/PipelineArn'
- description: The Amazon Resource Name (ARN) of the pipeline.
created:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time the pipeline was created, in timestamp format.'
updated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time the pipeline was last updated, in timestamp format.'
pollingDisabledAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use event-based
change detection. For example, for a pipeline with a CodeCommit source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate
polling pipelines to use event-based change detection in the CodePipeline User Guide.'
description: Information about a pipeline.
StageStateList:
type: array
items:
$ref: '#/components/schemas/StageState'
ThirdPartyJobDetails:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/ThirdPartyJobId'
- description: The identifier used to identify the job details in CodePipeline.
data:
allOf:
- $ref: '#/components/schemas/ThirdPartyJobData'
- description: The data to be returned by the third party job worker.
nonce:
allOf:
- $ref: '#/components/schemas/Nonce'
- description: A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob
request.
description: The details of a job sent in response to a GetThirdPartyJobDetails request.
InputArtifact:
type: object
required:
- name
properties:
name:
allOf:
- $ref: '#/components/schemas/ArtifactName'
- description: 'The name of the artifact to be worked on (for example, "My App").
Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
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.
' description: 'Represents information about an artifact to be worked on, such as a test or build artifact.' JobData: type: object properties: actionTypeId: allOf: - $ref: '#/components/schemas/ActionTypeId' - description: Represents information about an action type. actionConfiguration: allOf: - $ref: '#/components/schemas/ActionConfiguration' - description: Represents information about an action configuration. pipelineContext: allOf: - $ref: '#/components/schemas/PipelineContext' - description:Represents information about a pipeline to a job worker.
Includes pipelineArn and pipelineExecutionId for custom jobs.
Represents information about a pipeline to a job worker.
PipelineContext contains pipelineArn and pipelineExecutionId for custom action
jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
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.'
description: Represents information about a webhook and its definition.
WebhookUrl:
type: string
minLength: 1
maxLength: 1000
WebhookErrorMessage:
type: string
WebhookErrorCode:
type: string
WebhookLastTriggered:
type: string
format: date-time
WebhookArn:
type: string
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.'
WebhookList:
type: array
items:
$ref: '#/components/schemas/ListWebhookItem'
MatchEquals:
type: string
minLength: 1
maxLength: 150
MaxBatchSize:
type: integer
minimum: 1
OutputArtifact:
type: object
required:
- name
properties:
name:
allOf:
- $ref: '#/components/schemas/ArtifactName'
- description: 'The name of the output of an artifact, such as "My App".
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.
Output artifact names must be unique within a pipeline.
' description: Represents information about the output of an action. OutputVariablesKey: type: string pattern: '[A-Za-z0-9@\-_]+' OutputVariablesValue: type: string PipelineArn: type: string pattern: 'arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+' StageContext: type: object properties: name: allOf: - $ref: '#/components/schemas/StageName' - description: The name of the stage. description: Represents information about a stage to a job worker. PipelineStageDeclarationList: type: array items: $ref: '#/components/schemas/StageDeclaration' PipelineExecutionStatus: type: string enum: - Cancelled - InProgress - Stopped - Stopping - Succeeded - Superseded - Failed PipelineExecutionStatusSummary: type: string SourceRevisionList: type: array items: $ref: '#/components/schemas/SourceRevision' StopExecutionTrigger: type: object properties: reason: allOf: - $ref: '#/components/schemas/StopPipelineExecutionReason' - description: The user-specified reason the pipeline was stopped. description: The interaction that stopped a pipeline execution. PipelineExecutionSummary: type: object properties: pipelineExecutionId: allOf: - $ref: '#/components/schemas/PipelineExecutionId' - description: The ID of the pipeline execution. status: allOf: - $ref: '#/components/schemas/PipelineExecutionStatus' - description: 'The status of the pipeline execution.
InProgress: The pipeline execution is currently running.
Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
Succeeded: The pipeline execution was completed successfully.
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. For more information, see Superseded Executions.
Failed: The pipeline execution was not completed successfully.
StartPipelineExecution API call.'
stopTrigger:
allOf:
- $ref: '#/components/schemas/StopExecutionTrigger'
- description: The interaction that stopped a pipeline execution.
description: Summary information about a pipeline execution.
PipelineSummary:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline.
version:
allOf:
- $ref: '#/components/schemas/PipelineVersion'
- description: The version number of the pipeline.
created:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time the pipeline was created, in timestamp format.'
updated:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time of the last update to the pipeline, in timestamp format.'
description: Returns a summary of a pipeline.
StageDeclaration:
type: object
required:
- name
- actions
properties:
name:
allOf:
- $ref: '#/components/schemas/StageName'
- description: The name of the stage.
blockers:
allOf:
- $ref: '#/components/schemas/StageBlockerDeclarationList'
- description: Reserved for future use.
actions:
allOf:
- $ref: '#/components/schemas/StageActionDeclarationList'
- description: The actions included in a stage.
description: Represents information about a stage and its definition.
QueryParamMap:
type: object
minProperties: 0
maxProperties: 1
additionalProperties:
$ref: '#/components/schemas/ActionConfigurationQueryableValue'
ThirdPartyJobList:
type: array
items:
$ref: '#/components/schemas/ThirdPartyJob'
ServicePrincipal:
type: string
minLength: 1
maxLength: 128
String:
type: string
StageRetryMode:
type: string
enum:
- FAILED_ACTIONS
S3BucketName:
type: string
S3ObjectKey:
type: string
S3Bucket:
type: string
minLength: 3
maxLength: 63
S3Key:
type: string
minLength: 1
maxLength: 100
SourceRevision:
type: object
required:
- actionName
properties:
actionName:
allOf:
- $ref: '#/components/schemas/ActionName'
- description: The name of the action that processed the revision to the source artifact.
revisionId:
allOf:
- $ref: '#/components/schemas/Revision'
- description: The system-generated unique ID that identifies the revision number of the artifact.
revisionSummary:
allOf:
- $ref: '#/components/schemas/RevisionSummary'
- description: 'Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided
content of a codepipeline-artifact-revision-summary key specified in the object metadata.'
revisionUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: 'The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.'
description: Information about the version (or revision) of a source artifact that initiated a pipeline execution.
StageActionDeclarationList:
type: array
items:
$ref: '#/components/schemas/ActionDeclaration'
StageBlockerDeclarationList:
type: array
items:
$ref: '#/components/schemas/BlockerDeclaration'
StageExecutionStatus:
type: string
enum:
- Cancelled
- InProgress
- Failed
- Stopped
- Stopping
- Succeeded
StageExecution:
type: object
required:
- pipelineExecutionId
- status
properties:
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The ID of the pipeline execution associated with the stage.
status:
allOf:
- $ref: '#/components/schemas/StageExecutionStatus'
- description: 'The status of the stage, or for a completed stage, the last status of the stage.
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its
details.
jobId:
allOf:
- $ref: '#/components/schemas/JobId'
- description: The identifier used to identify the job in CodePipeline.
description: A response to a PollForThirdPartyJobs request returned by CodePipeline when there is a job to be worked on by a partner action.
ThirdPartyJobData:
type: object
properties:
actionTypeId:
allOf:
- $ref: '#/components/schemas/ActionTypeId'
- description: Represents information about an action type.
actionConfiguration:
allOf:
- $ref: '#/components/schemas/ActionConfiguration'
- description: Represents information about an action configuration.
pipelineContext:
allOf:
- $ref: '#/components/schemas/PipelineContext'
- description: Represents information about a pipeline to a job worker.
Does not include pipelineArn and pipelineExecutionId for ThirdParty
jobs.
AllowedIPRange 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 SecretToken property must be set.'
description: The authentication applied to incoming webhook trigger requests.
WebhookAuthenticationType:
type: string
enum:
- GITHUB_HMAC
- IP
- UNAUTHENTICATED
WebhookFilters:
type: array
items:
$ref: '#/components/schemas/WebhookFilterRule'
maxItems: 5
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 MatchEquals
field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.'
matchEquals:
allOf:
- $ref: '#/components/schemas/MatchEquals'
- description: 'The value selected by the JsonPath expression must match what is supplied in the MatchEquals 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 MatchEquals value is evaluated as "refs/heads/main". For a list of action
configuration properties for built-in action types, see Pipeline Structure
Reference Action Requirements.'
description: The event criteria that specify when a webhook notification is sent to your URL.
security:
- hmac: []