❤
npm
Sign UpSign In

@datafire/amazonaws_codepipeline

5.0.0 • Public • Published

@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

Output

AcknowledgeThirdPartyJob

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

Input

Output

CreateCustomActionType

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

Input

Output

CreatePipeline

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

Input

Output

DeleteCustomActionType

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

Input

Output

Output schema unknown

DeletePipeline

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

Input

Output

Output schema unknown

DisableStageTransition

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

Input

Output

Output schema unknown

EnableStageTransition

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

Input

Output

Output schema unknown

GetJobDetails

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

Input

  • input object

Output

GetPipeline

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

Input

Output

GetPipelineExecution

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

Input

Output

GetPipelineState

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

Input

Output

GetThirdPartyJobDetails

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

Input

Output

ListActionTypes

amazonaws_codepipeline.ListActionTypes({}, context)

Input

Output

ListPipelineExecutions

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

Input

Output

ListPipelines

amazonaws_codepipeline.ListPipelines({}, context)

Input

Output

PollForJobs

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

Input

Output

PollForThirdPartyJobs

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

Input

Output

PutActionRevision

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

Input

Output

PutApprovalResult

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

Input

Output

PutJobFailureResult

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

Input

Output

Output schema unknown

PutJobSuccessResult

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

Input

Output

Output schema unknown

PutThirdPartyJobFailureResult

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

Input

Output

Output schema unknown

PutThirdPartyJobSuccessResult

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

Input

Output

Output schema unknown

RetryStageExecution

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

Input

Output

StartPipelineExecution

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

Input

Output

UpdatePipeline

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

Input

Output

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

  • AccessKeyId string

AccountId

  • AccountId string

AcknowledgeJobInput

  • AcknowledgeJobInput object: Represents the input of an AcknowledgeJob action.

AcknowledgeJobOutput

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

AcknowledgeThirdPartyJobInput

  • AcknowledgeThirdPartyJobInput object: Represents the input of an AcknowledgeThirdPartyJob action.

AcknowledgeThirdPartyJobOutput

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

ActionCategory

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

ActionConfiguration

  • ActionConfiguration object: Represents information about an action configuration.

ActionConfigurationKey

  • ActionConfigurationKey string

ActionConfigurationMap

ActionConfigurationProperty

ActionConfigurationPropertyList

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.

ActionDeclaration

ActionExecution

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

ActionRunOrder

  • ActionRunOrder integer

ActionState

ActionStateList

ActionType

ActionTypeId

ActionTypeList

ActionTypeNotFoundException

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

ActionTypeSettings

  • ActionTypeSettings object: Returns information about the settings for an action type.

ApprovalAlreadyCompletedException

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

ApprovalResult

  • ApprovalResult object: Represents information about the result of an approval request.

ApprovalStatus

  • ApprovalStatus string (values: Approved, Rejected)

ApprovalSummary

  • ApprovalSummary string

ApprovalToken

  • ApprovalToken string

Artifact

ArtifactDetails

ArtifactList

ArtifactLocation

ArtifactLocationType

  • ArtifactLocationType string (values: S3)

ArtifactName

  • ArtifactName string

ArtifactRevision

ArtifactRevisionList

ArtifactStore

ArtifactStoreLocation

  • ArtifactStoreLocation string

ArtifactStoreType

  • ArtifactStoreType string (values: S3)

BlockerDeclaration

BlockerName

  • BlockerName string

BlockerType

  • BlockerType string (values: Schedule)

Boolean

  • Boolean boolean

ClientId

  • ClientId string

ClientToken

  • ClientToken string

Code

  • Code string

ContinuationToken

  • ContinuationToken string

CreateCustomActionTypeInput

CreateCustomActionTypeOutput

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

CreatePipelineInput

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

CreatePipelineOutput

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

CurrentRevision

DeleteCustomActionTypeInput

  • DeleteCustomActionTypeInput object: Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.

DeletePipelineInput

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

Description

  • Description string

DisableStageTransitionInput

DisabledReason

  • DisabledReason string

EnableStageTransitionInput

  • EnableStageTransitionInput object: Represents the input of an EnableStageTransition action.

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.

EncryptionKeyId

  • EncryptionKeyId string

EncryptionKeyType

  • EncryptionKeyType string (values: KMS)

ErrorDetails

  • ErrorDetails object: Represents information about an error in AWS CodePipeline.

ExecutionDetails

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

ExecutionId

  • ExecutionId string

ExecutionSummary

  • ExecutionSummary string

FailureDetails

  • FailureDetails object: Represents information about failure details.

FailureType

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

GetJobDetailsInput

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

GetJobDetailsOutput

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

GetPipelineExecutionInput

  • GetPipelineExecutionInput object: Represents the input of a GetPipelineExecution action.

GetPipelineExecutionOutput

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

GetPipelineInput

GetPipelineOutput

GetPipelineStateInput

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

GetPipelineStateOutput

GetThirdPartyJobDetailsInput

  • GetThirdPartyJobDetailsInput object: Represents the input of a GetThirdPartyJobDetails action.

GetThirdPartyJobDetailsOutput

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

InputArtifact

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

InputArtifactList

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

JobData

JobDetails

  • JobDetails object: Represents information about the details of a job.

JobId

  • JobId string

JobList

  • JobList array

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.

ListActionTypesOutput

  • ListActionTypesOutput object: Represents the output of a ListActionTypes action.

ListPipelineExecutionsInput

  • ListPipelineExecutionsInput object: Represents the input of a ListPipelineExecutions action.

ListPipelineExecutionsOutput

ListPipelinesInput

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

ListPipelinesOutput

  • ListPipelinesOutput object: Represents the output of a ListPipelines action.

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.

OutputArtifactList

Percentage

  • Percentage integer

PipelineArn

  • PipelineArn string

PipelineContext

PipelineDeclaration

PipelineExecution

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

PipelineExecutionSummaryList

PipelineList

PipelineMetadata

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

PipelineSummary

PipelineVersion

  • PipelineVersion integer

PipelineVersionNotFoundException

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

PollForJobsInput

PollForJobsOutput

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

PollForThirdPartyJobsInput

  • PollForThirdPartyJobsInput object: Represents the input of a PollForThirdPartyJobs action.

PollForThirdPartyJobsOutput

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

PutActionRevisionInput

PutActionRevisionOutput

  • PutActionRevisionOutput object: Represents the output of a PutActionRevision action.

PutApprovalResultInput

PutApprovalResultOutput

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

PutJobFailureResultInput

  • PutJobFailureResultInput object: Represents the input of a PutJobFailureResult action.

PutJobSuccessResultInput

PutThirdPartyJobFailureResultInput

  • PutThirdPartyJobFailureResultInput object: Represents the input of a PutThirdPartyJobFailureResult action.

PutThirdPartyJobSuccessResultInput

QueryParamMap

RetryStageExecutionInput

RetryStageExecutionOutput

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

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.

S3BucketName

  • S3BucketName string

S3ObjectKey

  • S3ObjectKey string

SecretAccessKey

  • SecretAccessKey string

SessionToken

  • SessionToken string

StageActionDeclarationList

StageBlockerDeclarationList

StageContext

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

StageDeclaration

StageExecution

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

StageStateList

StageTransitionType

  • StageTransitionType string (values: Inbound, Outbound)

StartPipelineExecutionInput

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

StartPipelineExecutionOutput

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

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.

ThirdPartyJobData

ThirdPartyJobDetails

ThirdPartyJobId

  • ThirdPartyJobId string

ThirdPartyJobList

Time

  • Time string

Timestamp

  • Timestamp string

TransitionState

UpdatePipelineInput

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

UpdatePipelineOutput

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

Url

  • Url string

UrlTemplate

  • UrlTemplate string

ValidationException

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

Version

  • Version string

Dependencies (2)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @datafire/amazonaws_codepipeline

    Repository

    github.com/DataFire/integrations

    Homepage

    github.com/DataFire/integrations#readme

    Weekly Downloads

    2

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    202 kB

    Total Files

    5

    Last publish

    Collaborators

    • datafire
    Try on RunKit
    Report malware