@datafire/amazonaws_codepipeline

Client library for AWS CodePipeline

Installation and Usage

npm install --save @datafire/amazonaws_codepipeline

let amazonaws_codepipeline = require('@datafire/amazonaws_codepipeline').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_codepipeline.AcknowledgeJob({
  "jobId": "",
  "nonce": ""
}).then(data => {
  console.log(data);
});

Description

AWS CodePipeline Overview This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide. You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below. Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages. 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. 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 the most recent revision of an artifact through the pipeline. UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline. Pipelines include stages, which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call 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, also refer to the AWS CodePipeline Pipeline Structure Reference. Pipeline stages include actions, which are categorized into categories such as source or build actions performed within 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. 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 AWS CodePipeline For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will 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 upon, PutJobFailureResult, which provides details of a job failure, and 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 AWS CodePipeline. Partner actions are created by members of the AWS 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 upon, PutThirdPartyJobFailureResult, which provides details of a job failure, and PutThirdPartyJobSuccessResult, which provides details of a job success.

Actions

AcknowledgeJob

amazonaws_codepipeline.AcknowledgeJob({
  "jobId": "",
  "nonce": ""
}, context)

Input

• input object
  • jobId required JobId
  • nonce required Nonce

Output

• output AcknowledgeJobOutput

AcknowledgeThirdPartyJob

amazonaws_codepipeline.AcknowledgeThirdPartyJob({
  "jobId": "",
  "nonce": "",
  "clientToken": ""
}, context)

Input

• input object
  • clientToken required ClientToken
  • jobId required ThirdPartyJobId
  • nonce required Nonce

Output

• output AcknowledgeThirdPartyJobOutput

CreateCustomActionType

amazonaws_codepipeline.CreateCustomActionType({
  "category": "",
  "provider": "",
  "version": "",
  "inputArtifactDetails": {
    "minimumCount": 0,
    "maximumCount": 0
  },
  "outputArtifactDetails": {
    "minimumCount": 0,
    "maximumCount": 0
  }
}, context)

Input

• input object
  • category required ActionCategory
  • configurationProperties ActionConfigurationPropertyList
  • inputArtifactDetails required ArtifactDetails
  • outputArtifactDetails required ArtifactDetails
  • provider required ActionProvider
  • settings ActionTypeSettings
  • version required Version

Output

• output CreateCustomActionTypeOutput

CreatePipeline

amazonaws_codepipeline.CreatePipeline({
  "pipeline": {
    "name": "",
    "roleArn": "",
    "artifactStore": {
      "type": "",
      "location": ""
    },
    "stages": []
  }
}, context)

Input

• input object
  • pipeline required PipelineDeclaration

Output

• output CreatePipelineOutput

DeleteCustomActionType

amazonaws_codepipeline.DeleteCustomActionType({
  "category": "",
  "provider": "",
  "version": ""
}, context)

Input

• input object
  • category required ActionCategory
  • provider required ActionProvider
  • version required Version

Output

Output schema unknown

DeletePipeline

amazonaws_codepipeline.DeletePipeline({
  "name": ""
}, context)

Input

• input object
  • name required PipelineName

Output

Output schema unknown

DisableStageTransition

amazonaws_codepipeline.DisableStageTransition({
  "pipelineName": "",
  "stageName": "",
  "transitionType": "",
  "reason": ""
}, context)

Input

• input object
  • pipelineName required PipelineName
  • reason required DisabledReason
  • stageName required StageName
  • transitionType required StageTransitionType

Output

Output schema unknown

EnableStageTransition

amazonaws_codepipeline.EnableStageTransition({
  "pipelineName": "",
  "stageName": "",
  "transitionType": ""
}, context)

Input

• input object
  • pipelineName required PipelineName
  • stageName required StageName
  • transitionType required StageTransitionType

Output

Output schema unknown

GetJobDetails

amazonaws_codepipeline.GetJobDetails({
  "jobId": ""
}, context)

Input

• input object
  • jobId required JobId

Output

• output GetJobDetailsOutput

GetPipeline

amazonaws_codepipeline.GetPipeline({
  "name": ""
}, context)

Input

• input object
  • name required PipelineName
  • version PipelineVersion

Output

• output GetPipelineOutput

GetPipelineExecution

amazonaws_codepipeline.GetPipelineExecution({
  "pipelineName": "",
  "pipelineExecutionId": ""
}, context)

Input

• input object
  • pipelineExecutionId required PipelineExecutionId
  • pipelineName required PipelineName

Output

• output GetPipelineExecutionOutput

GetPipelineState

amazonaws_codepipeline.GetPipelineState({
  "name": ""
}, context)

Input

• input object
  • name required PipelineName

Output

• output GetPipelineStateOutput

GetThirdPartyJobDetails

amazonaws_codepipeline.GetThirdPartyJobDetails({
  "jobId": "",
  "clientToken": ""
}, context)

Input

• input object
  • clientToken required ClientToken
  • jobId required ThirdPartyJobId

Output

• output GetThirdPartyJobDetailsOutput

ListActionTypes

amazonaws_codepipeline.ListActionTypes({}, context)

Input

• input object
  • actionOwnerFilter ActionOwner
  • nextToken NextToken

Output

• output ListActionTypesOutput

ListPipelineExecutions

amazonaws_codepipeline.ListPipelineExecutions({
  "pipelineName": ""
}, context)

Input

• input object
  • maxResults MaxResults
  • nextToken NextToken
  • pipelineName required PipelineName

Output

• output ListPipelineExecutionsOutput

ListPipelines

amazonaws_codepipeline.ListPipelines({}, context)

Input

• input object
  • nextToken NextToken

Output

• output ListPipelinesOutput

PollForJobs

amazonaws_codepipeline.PollForJobs({
  "actionTypeId": {
    "category": "",
    "owner": "",
    "provider": "",
    "version": ""
  }
}, context)

Input

• input object
  • actionTypeId required ActionTypeId
  • maxBatchSize MaxBatchSize
  • queryParam QueryParamMap

Output

• output PollForJobsOutput

PollForThirdPartyJobs

amazonaws_codepipeline.PollForThirdPartyJobs({
  "actionTypeId": {
    "category": "",
    "owner": "",
    "provider": "",
    "version": ""
  }
}, context)

Input

• input object
  • actionTypeId required ActionTypeId
  • maxBatchSize MaxBatchSize

Output

• output PollForThirdPartyJobsOutput

PutActionRevision

amazonaws_codepipeline.PutActionRevision({
  "pipelineName": "",
  "stageName": "",
  "actionName": "",
  "actionRevision": {
    "revisionId": "",
    "revisionChangeId": "",
    "created": ""
  }
}, context)

Input

• input object
  • actionName required ActionName
  • actionRevision required ActionRevision
  • pipelineName required PipelineName
  • stageName required StageName

Output

• output PutActionRevisionOutput

PutApprovalResult

amazonaws_codepipeline.PutApprovalResult({
  "pipelineName": "",
  "stageName": "",
  "actionName": "",
  "result": {
    "summary": "",
    "status": ""
  },
  "token": ""
}, context)

Input

• input object
  • actionName required ActionName
  • pipelineName required PipelineName
  • result required ApprovalResult
  • stageName required StageName
  • token required ApprovalToken

Output

• output PutApprovalResultOutput

PutJobFailureResult

amazonaws_codepipeline.PutJobFailureResult({
  "jobId": "",
  "failureDetails": {
    "type": "",
    "message": ""
  }
}, context)

Input

• input object
  • failureDetails required FailureDetails
  • jobId required JobId

Output

Output schema unknown

PutJobSuccessResult

amazonaws_codepipeline.PutJobSuccessResult({
  "jobId": ""
}, context)

Input

• input object
  • continuationToken ContinuationToken
  • currentRevision CurrentRevision
  • executionDetails ExecutionDetails
  • jobId required JobId

Output

Output schema unknown

PutThirdPartyJobFailureResult

amazonaws_codepipeline.PutThirdPartyJobFailureResult({
  "jobId": "",
  "clientToken": "",
  "failureDetails": {
    "type": "",
    "message": ""
  }
}, context)

Input

• input object
  • clientToken required ClientToken
  • failureDetails required FailureDetails
  • jobId required ThirdPartyJobId

Output

Output schema unknown

PutThirdPartyJobSuccessResult

amazonaws_codepipeline.PutThirdPartyJobSuccessResult({
  "jobId": "",
  "clientToken": ""
}, context)

Input

• input object
  • clientToken required ClientToken
  • continuationToken ContinuationToken
  • currentRevision CurrentRevision
  • executionDetails ExecutionDetails
  • jobId required ThirdPartyJobId

Output

Output schema unknown

RetryStageExecution

amazonaws_codepipeline.RetryStageExecution({
  "pipelineName": "",
  "stageName": "",
  "pipelineExecutionId": "",
  "retryMode": ""
}, context)

Input

• input object
  • pipelineExecutionId required PipelineExecutionId
  • pipelineName required PipelineName
  • retryMode required StageRetryMode
  • stageName required StageName

Output

• output RetryStageExecutionOutput

StartPipelineExecution

amazonaws_codepipeline.StartPipelineExecution({
  "name": ""
}, context)

Input

• input object
  • name required PipelineName

Output

• output StartPipelineExecutionOutput

UpdatePipeline

amazonaws_codepipeline.UpdatePipeline({
  "pipeline": {
    "name": "",
    "roleArn": "",
    "artifactStore": {
      "type": "",
      "location": ""
    },
    "stages": []
  }
}, context)

Input

• input object
  • pipeline required PipelineDeclaration

Output

• output UpdatePipelineOutput

Definitions

AWSSessionCredentials

• AWSSessionCredentials object: Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
  • accessKeyId required AccessKeyId
  • secretAccessKey required SecretAccessKey
  • sessionToken required SessionToken

AccessKeyId

• AccessKeyId string

AccountId

• AccountId string

AcknowledgeJobInput

• AcknowledgeJobInput object: Represents the input of an AcknowledgeJob action.
  • jobId required JobId
  • nonce required Nonce

AcknowledgeJobOutput

• AcknowledgeJobOutput object: Represents the output of an AcknowledgeJob action.
  • status JobStatus

AcknowledgeThirdPartyJobInput

• AcknowledgeThirdPartyJobInput object: Represents the input of an AcknowledgeThirdPartyJob action.
  • clientToken required ClientToken
  • jobId required ThirdPartyJobId
  • nonce required Nonce

AcknowledgeThirdPartyJobOutput

• AcknowledgeThirdPartyJobOutput object: Represents the output of an AcknowledgeThirdPartyJob action.
  • status JobStatus

ActionCategory

• ActionCategory string (values: Source, Build, Deploy, Test, Invoke, Approval)

ActionConfiguration

• ActionConfiguration object: Represents information about an action configuration.
  • configuration ActionConfigurationMap

ActionConfigurationKey

• ActionConfigurationKey string

ActionConfigurationMap

• ActionConfigurationMap array
  • items object
    • key ActionConfigurationKey
    • value ActionConfigurationValue

ActionConfigurationProperty

• ActionConfigurationProperty object: Represents information about an action configuration property.
  • description Description
  • key required Boolean
  • name required ActionConfigurationKey
  • queryable Boolean
  • required required Boolean
  • secret required Boolean
  • type ActionConfigurationPropertyType

ActionConfigurationPropertyList

• ActionConfigurationPropertyList array
  • items ActionConfigurationProperty

ActionConfigurationPropertyType

• ActionConfigurationPropertyType string (values: String, Number, Boolean)

ActionConfigurationQueryableValue

• ActionConfigurationQueryableValue string

ActionConfigurationValue

• ActionConfigurationValue string

ActionContext

• ActionContext object: Represents the context of an action within the stage of a pipeline to a job worker.
  • name ActionName

ActionDeclaration

• ActionDeclaration object: Represents information about an action declaration.
  • actionTypeId required ActionTypeId
  • configuration ActionConfigurationMap
  • inputArtifacts InputArtifactList
  • name required ActionName
  • outputArtifacts OutputArtifactList
  • roleArn RoleArn
  • runOrder ActionRunOrder

ActionExecution

• ActionExecution object: Represents information about the run of an action.
  • errorDetails ErrorDetails
  • externalExecutionId ExecutionId
  • externalExecutionUrl Url
  • lastStatusChange Timestamp
  • lastUpdatedBy LastUpdatedBy
  • percentComplete Percentage
  • status ActionExecutionStatus
  • summary ExecutionSummary
  • token ActionExecutionToken

ActionExecutionStatus

• ActionExecutionStatus string (values: InProgress, Succeeded, Failed)

ActionExecutionToken

• ActionExecutionToken string

ActionName

• ActionName string

ActionNotFoundException

• ActionNotFoundException object: The specified action cannot be found.

ActionOwner

• ActionOwner string (values: AWS, ThirdParty, Custom)

ActionProvider

• ActionProvider string

ActionRevision

• ActionRevision object: Represents information about the version (or revision) of an action.
  • created required Timestamp
  • revisionChangeId required RevisionChangeIdentifier
  • revisionId required Revision

ActionRunOrder

• ActionRunOrder integer

ActionState

• ActionState object: Represents information about the state of an action.
  • actionName ActionName
  • currentRevision ActionRevision
  • entityUrl Url
  • latestExecution ActionExecution
  • revisionUrl Url

ActionStateList

• ActionStateList array
  • items ActionState

ActionType

• ActionType object: Returns information about the details of an action type.
  • actionConfigurationProperties ActionConfigurationPropertyList
  • id required ActionTypeId
  • inputArtifactDetails required ArtifactDetails
  • outputArtifactDetails required ArtifactDetails
  • settings ActionTypeSettings

ActionTypeId

• ActionTypeId object: Represents information about an action type.
  • category required ActionCategory
  • owner required ActionOwner
  • provider required ActionProvider
  • version required Version

ActionTypeList

• ActionTypeList array
  • items ActionType

ActionTypeNotFoundException

• ActionTypeNotFoundException object: The specified action type cannot be found.

ActionTypeSettings

• ActionTypeSettings object: Returns information about the settings for an action type.
  • entityUrlTemplate UrlTemplate
  • executionUrlTemplate UrlTemplate
  • revisionUrlTemplate UrlTemplate
  • thirdPartyConfigurationUrl Url

ApprovalAlreadyCompletedException

• ApprovalAlreadyCompletedException object: The approval action has already been approved or rejected.

ApprovalResult

• ApprovalResult object: Represents information about the result of an approval request.
  • status required ApprovalStatus
  • summary required ApprovalSummary

ApprovalStatus

• ApprovalStatus string (values: Approved, Rejected)

ApprovalSummary

• ApprovalSummary string

ApprovalToken

• ApprovalToken string

Artifact

• Artifact object: Represents information about an artifact that will be worked upon by actions in the pipeline.
  • location ArtifactLocation
  • name ArtifactName
  • revision Revision

ArtifactDetails

• ArtifactDetails object: Returns information about the details of an artifact.
  • maximumCount required MaximumArtifactCount
  • minimumCount required MinimumArtifactCount

ArtifactList

• ArtifactList array
  • items Artifact

ArtifactLocation

• ArtifactLocation object: Represents information about the location of an artifact.
  • s3Location S3ArtifactLocation
  • type ArtifactLocationType

ArtifactLocationType

• ArtifactLocationType string (values: S3)

ArtifactName

• ArtifactName string

ArtifactRevision

• ArtifactRevision object: Represents revision details of an artifact.
  • created Timestamp
  • name ArtifactName
  • revisionChangeIdentifier RevisionChangeIdentifier
  • revisionId Revision
  • revisionSummary RevisionSummary
  • revisionUrl Url

ArtifactRevisionList

• ArtifactRevisionList array
  • items ArtifactRevision

ArtifactStore

• ArtifactStore object: The Amazon S3 bucket where artifacts are stored for the pipeline.
  • encryptionKey EncryptionKey
  • location required ArtifactStoreLocation
  • type required ArtifactStoreType

ArtifactStoreLocation

• ArtifactStoreLocation string

ArtifactStoreType

• ArtifactStoreType string (values: S3)

BlockerDeclaration

• BlockerDeclaration object: Reserved for future use.
  • name required BlockerName
  • type required BlockerType

BlockerName

• BlockerName string

BlockerType

• BlockerType string (values: Schedule)

Boolean

• Boolean boolean

ClientId

• ClientId string

ClientToken

• ClientToken string

Code

• Code string

ContinuationToken

• ContinuationToken string

CreateCustomActionTypeInput

• CreateCustomActionTypeInput object: Represents the input of a CreateCustomActionType operation.
  • category required ActionCategory
  • configurationProperties ActionConfigurationPropertyList
  • inputArtifactDetails required ArtifactDetails
  • outputArtifactDetails required ArtifactDetails
  • provider required ActionProvider
  • settings ActionTypeSettings
  • version required Version

CreateCustomActionTypeOutput

• CreateCustomActionTypeOutput object: Represents the output of a CreateCustomActionType operation.
  • actionType required ActionType

CreatePipelineInput

• CreatePipelineInput object: Represents the input of a CreatePipeline action.
  • pipeline required PipelineDeclaration

CreatePipelineOutput

• CreatePipelineOutput object: Represents the output of a CreatePipeline action.
  • pipeline PipelineDeclaration

CurrentRevision

• CurrentRevision object: Represents information about a current revision.
  • changeIdentifier required RevisionChangeIdentifier
  • created Time
  • revision required Revision
  • revisionSummary RevisionSummary

DeleteCustomActionTypeInput

• DeleteCustomActionTypeInput object: Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.
  • category required ActionCategory
  • provider required ActionProvider
  • version required Version

DeletePipelineInput

• DeletePipelineInput object: Represents the input of a DeletePipeline action.
  • name required PipelineName

Description

• Description string

DisableStageTransitionInput

• DisableStageTransitionInput object: Represents the input of a DisableStageTransition action.
  • pipelineName required PipelineName
  • reason required DisabledReason
  • stageName required StageName
  • transitionType required StageTransitionType

DisabledReason

• DisabledReason string

EnableStageTransitionInput

• EnableStageTransitionInput object: Represents the input of an EnableStageTransition action.
  • pipelineName required PipelineName
  • stageName required StageName
  • transitionType required StageTransitionType

Enabled

• Enabled boolean

EncryptionKey

• EncryptionKey object: Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
  • id required EncryptionKeyId
  • type required EncryptionKeyType

EncryptionKeyId

• EncryptionKeyId string

EncryptionKeyType

• EncryptionKeyType string (values: KMS)

ErrorDetails

• ErrorDetails object: Represents information about an error in AWS CodePipeline.
  • code Code
  • message Message

ExecutionDetails

• ExecutionDetails object: The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
  • externalExecutionId ExecutionId
  • percentComplete Percentage
  • summary ExecutionSummary

ExecutionId

• ExecutionId string

ExecutionSummary

• ExecutionSummary string

FailureDetails

• FailureDetails object: Represents information about failure details.
  • externalExecutionId ExecutionId
  • message required Message
  • type required FailureType

FailureType

• FailureType string (values: JobFailed, ConfigurationError, PermissionError, RevisionOutOfSync, RevisionUnavailable, SystemUnavailable)

GetJobDetailsInput

• GetJobDetailsInput object: Represents the input of a GetJobDetails action.
  • jobId required JobId

GetJobDetailsOutput

• GetJobDetailsOutput object: Represents the output of a GetJobDetails action.
  • jobDetails JobDetails

GetPipelineExecutionInput

• GetPipelineExecutionInput object: Represents the input of a GetPipelineExecution action.
  • pipelineExecutionId required PipelineExecutionId
  • pipelineName required PipelineName

GetPipelineExecutionOutput

• GetPipelineExecutionOutput object: Represents the output of a GetPipelineExecution action.
  • pipelineExecution PipelineExecution

GetPipelineInput

• GetPipelineInput object: Represents the input of a GetPipeline action.
  • name required PipelineName
  • version PipelineVersion

GetPipelineOutput

• GetPipelineOutput object: Represents the output of a GetPipeline action.
  • metadata PipelineMetadata
  • pipeline PipelineDeclaration

GetPipelineStateInput

• GetPipelineStateInput object: Represents the input of a GetPipelineState action.
  • name required PipelineName

GetPipelineStateOutput

• GetPipelineStateOutput object: Represents the output of a GetPipelineState action.
  • created Timestamp
  • pipelineName PipelineName
  • pipelineVersion PipelineVersion
  • stageStates StageStateList
  • updated Timestamp

GetThirdPartyJobDetailsInput

• GetThirdPartyJobDetailsInput object: Represents the input of a GetThirdPartyJobDetails action.
  • clientToken required ClientToken
  • jobId required ThirdPartyJobId

GetThirdPartyJobDetailsOutput

• GetThirdPartyJobDetailsOutput object: Represents the output of a GetThirdPartyJobDetails action.
  • jobDetails ThirdPartyJobDetails

InputArtifact

• InputArtifact object: Represents information about an artifact to be worked on, such as a test or build artifact.
  • name required ArtifactName

InputArtifactList

• InputArtifactList array
  • items InputArtifact

InvalidActionDeclarationException

• InvalidActionDeclarationException object: The specified action declaration was specified in an invalid format.

InvalidApprovalTokenException

• InvalidApprovalTokenException object: The approval request already received a response or has expired.

InvalidBlockerDeclarationException

• InvalidBlockerDeclarationException object: Reserved for future use.

InvalidClientTokenException

• InvalidClientTokenException object: The client token was specified in an invalid format

InvalidJobException

• InvalidJobException object: The specified job was specified in an invalid format or cannot be found.

InvalidJobStateException

• InvalidJobStateException object: The specified job state was specified in an invalid format.

InvalidNextTokenException

• InvalidNextTokenException object: The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.

InvalidNonceException

• InvalidNonceException object: The specified nonce was specified in an invalid format.

InvalidStageDeclarationException

• InvalidStageDeclarationException object: The specified stage declaration was specified in an invalid format.

InvalidStructureException

• InvalidStructureException object: The specified structure was specified in an invalid format.

Job

• Job object: Represents information about a job.
  • accountId AccountId
  • data JobData
  • id JobId
  • nonce Nonce

JobData

• JobData object: Represents additional information about a job required for a job worker to complete the job.
  • actionConfiguration ActionConfiguration
  • actionTypeId ActionTypeId
  • artifactCredentials AWSSessionCredentials
  • continuationToken ContinuationToken
  • encryptionKey EncryptionKey
  • inputArtifacts ArtifactList
  • outputArtifacts ArtifactList
  • pipelineContext PipelineContext

JobDetails

• JobDetails object: Represents information about the details of a job.
  • accountId AccountId
  • data JobData
  • id JobId

JobId

• JobId string

JobList

• JobList array
  • items Job

JobNotFoundException

• JobNotFoundException object: The specified job was specified in an invalid format or cannot be found.

JobStatus

• JobStatus string (values: Created, Queued, Dispatched, InProgress, TimedOut, Succeeded, Failed)

LastChangedAt

• LastChangedAt string

LastChangedBy

• LastChangedBy string

LastUpdatedBy

• LastUpdatedBy string

LimitExceededException

• LimitExceededException object: The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.

ListActionTypesInput

• ListActionTypesInput object: Represents the input of a ListActionTypes action.
  • actionOwnerFilter ActionOwner
  • nextToken NextToken

ListActionTypesOutput

• ListActionTypesOutput object: Represents the output of a ListActionTypes action.
  • actionTypes required ActionTypeList
  • nextToken NextToken

ListPipelineExecutionsInput

• ListPipelineExecutionsInput object: Represents the input of a ListPipelineExecutions action.
  • maxResults MaxResults
  • nextToken NextToken
  • pipelineName required PipelineName

ListPipelineExecutionsOutput

• ListPipelineExecutionsOutput object: Represents the output of a ListPipelineExecutions action.
  • nextToken NextToken
  • pipelineExecutionSummaries PipelineExecutionSummaryList

ListPipelinesInput

• ListPipelinesInput object: Represents the input of a ListPipelines action.
  • nextToken NextToken

ListPipelinesOutput

• ListPipelinesOutput object: Represents the output of a ListPipelines action.
  • nextToken NextToken
  • pipelines PipelineList

MaxBatchSize

• MaxBatchSize integer

MaxResults

• MaxResults integer

MaximumArtifactCount

• MaximumArtifactCount integer

Message

• Message string

MinimumArtifactCount

• MinimumArtifactCount integer

NextToken

• NextToken string

Nonce

• Nonce string

NotLatestPipelineExecutionException

• NotLatestPipelineExecutionException object: The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

OutputArtifact

• OutputArtifact object: Represents information about the output of an action.
  • name required ArtifactName

OutputArtifactList

• OutputArtifactList array
  • items OutputArtifact

Percentage

• Percentage integer

PipelineArn

• PipelineArn string

PipelineContext

• PipelineContext object: Represents information about a pipeline to a job worker.
  • action ActionContext
  • pipelineName PipelineName
  • stage StageContext

PipelineDeclaration

• PipelineDeclaration object: Represents the structure of actions and stages to be performed in the pipeline.
  • artifactStore required ArtifactStore
  • name required PipelineName
  • roleArn required RoleArn
  • stages required PipelineStageDeclarationList
  • version PipelineVersion

PipelineExecution

• PipelineExecution object: Represents information about an execution of a pipeline.
  • artifactRevisions ArtifactRevisionList
  • pipelineExecutionId PipelineExecutionId
  • pipelineName PipelineName
  • pipelineVersion PipelineVersion
  • status PipelineExecutionStatus

PipelineExecutionId

• PipelineExecutionId string

PipelineExecutionNotFoundException

• PipelineExecutionNotFoundException object: The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.

PipelineExecutionStatus

• PipelineExecutionStatus string (values: InProgress, Succeeded, Superseded, Failed)

PipelineExecutionSummary

• PipelineExecutionSummary object: Summary information about a pipeline execution.
  • lastUpdateTime Timestamp
  • pipelineExecutionId PipelineExecutionId
  • startTime Timestamp
  • status PipelineExecutionStatus

PipelineExecutionSummaryList

• PipelineExecutionSummaryList array
  • items PipelineExecutionSummary

PipelineList

• PipelineList array
  • items PipelineSummary

PipelineMetadata

• PipelineMetadata object: Information about a pipeline.
  • created Timestamp
  • pipelineArn PipelineArn
  • updated Timestamp

PipelineName

• PipelineName string

PipelineNameInUseException

• PipelineNameInUseException object: The specified pipeline name is already in use.

PipelineNotFoundException

• PipelineNotFoundException object: The specified pipeline was specified in an invalid format or cannot be found.

PipelineStageDeclarationList

• PipelineStageDeclarationList array
  • items StageDeclaration

PipelineSummary

• PipelineSummary object: Returns a summary of a pipeline.
  • created Timestamp
  • name PipelineName
  • updated Timestamp
  • version PipelineVersion

PipelineVersion

• PipelineVersion integer

PipelineVersionNotFoundException

• PipelineVersionNotFoundException object: The specified pipeline version was specified in an invalid format or cannot be found.

PollForJobsInput

• PollForJobsInput object: Represents the input of a PollForJobs action.
  • actionTypeId required ActionTypeId
  • maxBatchSize MaxBatchSize
  • queryParam QueryParamMap

PollForJobsOutput

• PollForJobsOutput object: Represents the output of a PollForJobs action.
  • jobs JobList

PollForThirdPartyJobsInput

• PollForThirdPartyJobsInput object: Represents the input of a PollForThirdPartyJobs action.
  • actionTypeId required ActionTypeId
  • maxBatchSize MaxBatchSize

PollForThirdPartyJobsOutput

• PollForThirdPartyJobsOutput object: Represents the output of a PollForThirdPartyJobs action.
  • jobs ThirdPartyJobList

PutActionRevisionInput

• PutActionRevisionInput object: Represents the input of a PutActionRevision action.
  • actionName required ActionName
  • actionRevision required ActionRevision
  • pipelineName required PipelineName
  • stageName required StageName

PutActionRevisionOutput

• PutActionRevisionOutput object: Represents the output of a PutActionRevision action.
  • newRevision Boolean
  • pipelineExecutionId PipelineExecutionId

PutApprovalResultInput

• PutApprovalResultInput object: Represents the input of a PutApprovalResult action.
  • actionName required ActionName
  • pipelineName required PipelineName
  • result required ApprovalResult
  • stageName required StageName
  • token required ApprovalToken

PutApprovalResultOutput

• PutApprovalResultOutput object: Represents the output of a PutApprovalResult action.
  • approvedAt Timestamp

PutJobFailureResultInput

• PutJobFailureResultInput object: Represents the input of a PutJobFailureResult action.
  • failureDetails required FailureDetails
  • jobId required JobId

PutJobSuccessResultInput

• PutJobSuccessResultInput object: Represents the input of a PutJobSuccessResult action.
  • continuationToken ContinuationToken
  • currentRevision CurrentRevision
  • executionDetails ExecutionDetails
  • jobId required JobId

PutThirdPartyJobFailureResultInput

• PutThirdPartyJobFailureResultInput object: Represents the input of a PutThirdPartyJobFailureResult action.
  • clientToken required ClientToken
  • failureDetails required FailureDetails
  • jobId required ThirdPartyJobId

PutThirdPartyJobSuccessResultInput

• PutThirdPartyJobSuccessResultInput object: Represents the input of a PutThirdPartyJobSuccessResult action.
  • clientToken required ClientToken
  • continuationToken ContinuationToken
  • currentRevision CurrentRevision
  • executionDetails ExecutionDetails
  • jobId required ThirdPartyJobId

QueryParamMap

• QueryParamMap array
  • items object
    • key ActionConfigurationKey
    • value ActionConfigurationQueryableValue

RetryStageExecutionInput

• RetryStageExecutionInput object: Represents the input of a RetryStageExecution action.
  • pipelineExecutionId required PipelineExecutionId
  • pipelineName required PipelineName
  • retryMode required StageRetryMode
  • stageName required StageName

RetryStageExecutionOutput

• RetryStageExecutionOutput object: Represents the output of a RetryStageExecution action.
  • pipelineExecutionId PipelineExecutionId

Revision

• Revision string

RevisionChangeIdentifier

• RevisionChangeIdentifier string

RevisionSummary

• RevisionSummary string

RoleArn

• RoleArn string

S3ArtifactLocation

• S3ArtifactLocation object: The location of the Amazon S3 bucket that contains a revision.
  • bucketName required S3BucketName
  • objectKey required S3ObjectKey

S3BucketName

• S3BucketName string

S3ObjectKey

• S3ObjectKey string

SecretAccessKey

• SecretAccessKey string

SessionToken

• SessionToken string

StageActionDeclarationList

• StageActionDeclarationList array
  • items ActionDeclaration

StageBlockerDeclarationList

• StageBlockerDeclarationList array
  • items BlockerDeclaration

StageContext

• StageContext object: Represents information about a stage to a job worker.
  • name StageName

StageDeclaration

• StageDeclaration object: Represents information about a stage and its definition.
  • actions required StageActionDeclarationList
  • blockers StageBlockerDeclarationList
  • name required StageName

StageExecution

• StageExecution object: Represents information about the run of a stage.
  • pipelineExecutionId required PipelineExecutionId
  • status required StageExecutionStatus

StageExecutionStatus

• StageExecutionStatus string (values: InProgress, Failed, Succeeded)

StageName

• StageName string

StageNotFoundException

• StageNotFoundException object: The specified stage was specified in an invalid format or cannot be found.

StageNotRetryableException

• StageNotRetryableException object: The specified stage can't be retried because the pipeline structure or stage state changed after the stage was not completed; the stage contains no failed actions; one or more actions are still in progress; or another retry attempt is already in progress.

StageRetryMode

• StageRetryMode string (values: FAILED_ACTIONS)

StageState

• StageState object: Represents information about the state of the stage.
  • actionStates ActionStateList
  • inboundTransitionState TransitionState
  • latestExecution StageExecution
  • stageName StageName

StageStateList

• StageStateList array
  • items StageState

StageTransitionType

• StageTransitionType string (values: Inbound, Outbound)

StartPipelineExecutionInput

• StartPipelineExecutionInput object: Represents the input of a StartPipelineExecution action.
  • name required PipelineName

StartPipelineExecutionOutput

• StartPipelineExecutionOutput object: Represents the output of a StartPipelineExecution action.
  • pipelineExecutionId PipelineExecutionId

ThirdPartyJob

• ThirdPartyJob object: A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked upon by a partner action.
  • clientId ClientId
  • jobId JobId

ThirdPartyJobData

• ThirdPartyJobData object: Represents information about the job data for a partner action.
  • actionConfiguration ActionConfiguration
  • actionTypeId ActionTypeId
  • artifactCredentials AWSSessionCredentials
  • continuationToken ContinuationToken
  • encryptionKey EncryptionKey
  • inputArtifacts ArtifactList
  • outputArtifacts ArtifactList
  • pipelineContext PipelineContext

ThirdPartyJobDetails

• ThirdPartyJobDetails object: The details of a job sent in response to a GetThirdPartyJobDetails request.
  • data ThirdPartyJobData
  • id ThirdPartyJobId
  • nonce Nonce

ThirdPartyJobId

• ThirdPartyJobId string

ThirdPartyJobList

• ThirdPartyJobList array
  • items ThirdPartyJob

Time

• Time string

Timestamp

• Timestamp string

TransitionState

• TransitionState object: Represents information about the state of transitions between one stage and another stage.
  • disabledReason DisabledReason
  • enabled Enabled
  • lastChangedAt LastChangedAt
  • lastChangedBy LastChangedBy

UpdatePipelineInput

• UpdatePipelineInput object: Represents the input of an UpdatePipeline action.
  • pipeline required PipelineDeclaration

UpdatePipelineOutput

• UpdatePipelineOutput object: Represents the output of an UpdatePipeline action.
  • pipeline PipelineDeclaration

Url

• Url string

UrlTemplate

• UrlTemplate string

ValidationException

• ValidationException object: The validation was specified in an invalid format.

Version

• Version string