| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CodePipeline
Contents
- Service Configuration
- Errors
- InvalidClientTokenException
- ValidationException
- InvalidNonceException
- ActionNotFoundException
- InvalidApprovalTokenException
- InvalidBlockerDeclarationException
- InvalidJobStateException
- InvalidJobException
- PipelineVersionNotFoundException
- StageNotRetryableException
- PipelineExecutionNotFoundException
- InvalidWebhookAuthenticationParametersException
- WebhookNotFoundException
- ActionTypeNotFoundException
- InvalidNextTokenException
- InvalidStageDeclarationException
- InvalidWebhookFilterPatternException
- InvalidActionDeclarationException
- StageNotFoundException
- InvalidStructureException
- JobNotFoundException
- ApprovalAlreadyCompletedException
- PipelineNameInUseException
- PipelineNotFoundException
- LimitExceededException
- NotLatestPipelineExecutionException
- Waiters
- Operations
- GetPipeline
- PutJobFailureResult
- PutApprovalResult
- AcknowledgeThirdPartyJob
- PutThirdPartyJobFailureResult
- RegisterWebhookWithThirdParty
- PollForThirdPartyJobs
- PollForJobs
- StartPipelineExecution
- UpdatePipeline
- DeletePipeline
- GetPipelineState
- GetJobDetails
- ListPipelines
- RetryStageExecution
- GetPipelineExecution
- PutJobSuccessResult
- DeregisterWebhookWithThirdParty
- DeleteCustomActionType
- PutActionRevision
- DisableStageTransition
- ListActionTypes
- AcknowledgeJob
- EnableStageTransition
- DeleteWebhook
- PutWebhook
- ListWebhooks
- CreatePipeline
- GetThirdPartyJobDetails
- PutThirdPartyJobSuccessResult
- CreateCustomActionType
- ListPipelineExecutions
- Types
- ActionCategory
- ActionConfigurationPropertyType
- ActionExecutionStatus
- ActionOwner
- ApprovalStatus
- ArtifactLocationType
- ArtifactStoreType
- BlockerType
- EncryptionKeyType
- FailureType
- JobStatus
- PipelineExecutionStatus
- StageExecutionStatus
- StageRetryMode
- StageTransitionType
- WebhookAuthenticationType
- AWSSessionCredentials
- ActionConfiguration
- ActionConfigurationProperty
- ActionContext
- ActionDeclaration
- ActionExecution
- ActionRevision
- ActionState
- ActionType
- ActionTypeId
- ActionTypeSettings
- ApprovalResult
- Artifact
- ArtifactDetails
- ArtifactLocation
- ArtifactRevision
- ArtifactStore
- BlockerDeclaration
- CurrentRevision
- EncryptionKey
- ErrorDetails
- ExecutionDetails
- FailureDetails
- InputArtifact
- Job
- JobData
- JobDetails
- ListWebhookItem
- OutputArtifact
- PipelineContext
- PipelineDeclaration
- PipelineExecution
- PipelineExecutionSummary
- PipelineMetadata
- PipelineSummary
- S3ArtifactLocation
- SourceRevision
- StageContext
- StageDeclaration
- StageExecution
- StageState
- ThirdPartyJob
- ThirdPartyJobData
- ThirdPartyJobDetails
- TransitionState
- WebhookAuthConfiguration
- WebhookDefinition
- WebhookFilterRule
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, and transitions, as described below.
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.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 . 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 . 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 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, andPutJobSuccessResult, 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, andPutThirdPartyJobSuccessResult, which provides details of a job success.
Synopsis
- codePipeline :: Service
- _InvalidClientTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNonceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ActionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidApprovalTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidBlockerDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidJobException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _StageNotRetryableException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineExecutionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidWebhookAuthenticationParametersException :: AsError a => Getting (First ServiceError) a ServiceError
- _WebhookNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ActionTypeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStageDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidWebhookFilterPatternException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidActionDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError
- _StageNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStructureException :: AsError a => Getting (First ServiceError) a ServiceError
- _JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ApprovalAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotLatestPipelineExecutionException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.CodePipeline.GetPipeline
- module Network.AWS.CodePipeline.PutJobFailureResult
- module Network.AWS.CodePipeline.PutApprovalResult
- module Network.AWS.CodePipeline.AcknowledgeThirdPartyJob
- module Network.AWS.CodePipeline.PutThirdPartyJobFailureResult
- module Network.AWS.CodePipeline.RegisterWebhookWithThirdParty
- module Network.AWS.CodePipeline.PollForThirdPartyJobs
- module Network.AWS.CodePipeline.PollForJobs
- module Network.AWS.CodePipeline.StartPipelineExecution
- module Network.AWS.CodePipeline.UpdatePipeline
- module Network.AWS.CodePipeline.DeletePipeline
- module Network.AWS.CodePipeline.GetPipelineState
- module Network.AWS.CodePipeline.GetJobDetails
- module Network.AWS.CodePipeline.ListPipelines
- module Network.AWS.CodePipeline.RetryStageExecution
- module Network.AWS.CodePipeline.GetPipelineExecution
- module Network.AWS.CodePipeline.PutJobSuccessResult
- module Network.AWS.CodePipeline.DeregisterWebhookWithThirdParty
- module Network.AWS.CodePipeline.DeleteCustomActionType
- module Network.AWS.CodePipeline.PutActionRevision
- module Network.AWS.CodePipeline.DisableStageTransition
- module Network.AWS.CodePipeline.ListActionTypes
- module Network.AWS.CodePipeline.AcknowledgeJob
- module Network.AWS.CodePipeline.EnableStageTransition
- module Network.AWS.CodePipeline.DeleteWebhook
- module Network.AWS.CodePipeline.PutWebhook
- module Network.AWS.CodePipeline.ListWebhooks
- module Network.AWS.CodePipeline.CreatePipeline
- module Network.AWS.CodePipeline.GetThirdPartyJobDetails
- module Network.AWS.CodePipeline.PutThirdPartyJobSuccessResult
- module Network.AWS.CodePipeline.CreateCustomActionType
- module Network.AWS.CodePipeline.ListPipelineExecutions
- data ActionCategory
- data ActionConfigurationPropertyType
- data ActionExecutionStatus
- data ActionOwner
- = AWS
- | Custom
- | ThirdParty
- data ApprovalStatus
- data ArtifactLocationType = ALTS3
- data ArtifactStoreType = S3
- data BlockerType = Schedule
- data EncryptionKeyType = KMS
- data FailureType
- data JobStatus
- data PipelineExecutionStatus
- data StageExecutionStatus
- data StageRetryMode = FailedActions
- data StageTransitionType
- data WebhookAuthenticationType
- data AWSSessionCredentials
- awsSessionCredentials :: Text -> Text -> Text -> AWSSessionCredentials
- ascAccessKeyId :: Lens' AWSSessionCredentials Text
- ascSecretAccessKey :: Lens' AWSSessionCredentials Text
- ascSessionToken :: Lens' AWSSessionCredentials Text
- data ActionConfiguration
- actionConfiguration :: ActionConfiguration
- acConfiguration :: Lens' ActionConfiguration (HashMap Text Text)
- data ActionConfigurationProperty
- actionConfigurationProperty :: Text -> Bool -> Bool -> Bool -> ActionConfigurationProperty
- acpQueryable :: Lens' ActionConfigurationProperty (Maybe Bool)
- acpType :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType)
- acpDescription :: Lens' ActionConfigurationProperty (Maybe Text)
- acpName :: Lens' ActionConfigurationProperty Text
- acpRequired :: Lens' ActionConfigurationProperty Bool
- acpKey :: Lens' ActionConfigurationProperty Bool
- acpSecret :: Lens' ActionConfigurationProperty Bool
- data ActionContext
- actionContext :: ActionContext
- acName :: Lens' ActionContext (Maybe Text)
- data ActionDeclaration
- actionDeclaration :: Text -> ActionTypeId -> ActionDeclaration
- adOutputArtifacts :: Lens' ActionDeclaration [OutputArtifact]
- adRunOrder :: Lens' ActionDeclaration (Maybe Natural)
- adConfiguration :: Lens' ActionDeclaration (HashMap Text Text)
- adInputArtifacts :: Lens' ActionDeclaration [InputArtifact]
- adRoleARN :: Lens' ActionDeclaration (Maybe Text)
- adName :: Lens' ActionDeclaration Text
- adActionTypeId :: Lens' ActionDeclaration ActionTypeId
- data ActionExecution
- actionExecution :: ActionExecution
- aeLastUpdatedBy :: Lens' ActionExecution (Maybe Text)
- aeSummary :: Lens' ActionExecution (Maybe Text)
- aeStatus :: Lens' ActionExecution (Maybe ActionExecutionStatus)
- aeLastStatusChange :: Lens' ActionExecution (Maybe UTCTime)
- aeToken :: Lens' ActionExecution (Maybe Text)
- aeExternalExecutionURL :: Lens' ActionExecution (Maybe Text)
- aeExternalExecutionId :: Lens' ActionExecution (Maybe Text)
- aeErrorDetails :: Lens' ActionExecution (Maybe ErrorDetails)
- aePercentComplete :: Lens' ActionExecution (Maybe Natural)
- data ActionRevision
- actionRevision :: Text -> Text -> UTCTime -> ActionRevision
- aRevisionId :: Lens' ActionRevision Text
- aRevisionChangeId :: Lens' ActionRevision Text
- aCreated :: Lens' ActionRevision UTCTime
- data ActionState
- actionState :: ActionState
- asRevisionURL :: Lens' ActionState (Maybe Text)
- asEntityURL :: Lens' ActionState (Maybe Text)
- asActionName :: Lens' ActionState (Maybe Text)
- asCurrentRevision :: Lens' ActionState (Maybe ActionRevision)
- asLatestExecution :: Lens' ActionState (Maybe ActionExecution)
- data ActionType
- actionType :: ActionTypeId -> ArtifactDetails -> ArtifactDetails -> ActionType
- atSettings :: Lens' ActionType (Maybe ActionTypeSettings)
- atActionConfigurationProperties :: Lens' ActionType [ActionConfigurationProperty]
- atId :: Lens' ActionType ActionTypeId
- atInputArtifactDetails :: Lens' ActionType ArtifactDetails
- atOutputArtifactDetails :: Lens' ActionType ArtifactDetails
- data ActionTypeId
- actionTypeId :: ActionCategory -> ActionOwner -> Text -> Text -> ActionTypeId
- atiCategory :: Lens' ActionTypeId ActionCategory
- atiOwner :: Lens' ActionTypeId ActionOwner
- atiProvider :: Lens' ActionTypeId Text
- atiVersion :: Lens' ActionTypeId Text
- data ActionTypeSettings
- actionTypeSettings :: ActionTypeSettings
- atsThirdPartyConfigurationURL :: Lens' ActionTypeSettings (Maybe Text)
- atsExecutionURLTemplate :: Lens' ActionTypeSettings (Maybe Text)
- atsRevisionURLTemplate :: Lens' ActionTypeSettings (Maybe Text)
- atsEntityURLTemplate :: Lens' ActionTypeSettings (Maybe Text)
- data ApprovalResult
- approvalResult :: Text -> ApprovalStatus -> ApprovalResult
- arSummary :: Lens' ApprovalResult Text
- arStatus :: Lens' ApprovalResult ApprovalStatus
- data Artifact
- artifact :: Artifact
- aLocation :: Lens' Artifact (Maybe ArtifactLocation)
- aName :: Lens' Artifact (Maybe Text)
- aRevision :: Lens' Artifact (Maybe Text)
- data ArtifactDetails
- artifactDetails :: Natural -> Natural -> ArtifactDetails
- adMinimumCount :: Lens' ArtifactDetails Natural
- adMaximumCount :: Lens' ArtifactDetails Natural
- data ArtifactLocation
- artifactLocation :: ArtifactLocation
- alS3Location :: Lens' ArtifactLocation (Maybe S3ArtifactLocation)
- alType :: Lens' ArtifactLocation (Maybe ArtifactLocationType)
- data ArtifactRevision
- artifactRevision :: ArtifactRevision
- arRevisionSummary :: Lens' ArtifactRevision (Maybe Text)
- arRevisionURL :: Lens' ArtifactRevision (Maybe Text)
- arCreated :: Lens' ArtifactRevision (Maybe UTCTime)
- arName :: Lens' ArtifactRevision (Maybe Text)
- arRevisionId :: Lens' ArtifactRevision (Maybe Text)
- arRevisionChangeIdentifier :: Lens' ArtifactRevision (Maybe Text)
- data ArtifactStore
- artifactStore :: ArtifactStoreType -> Text -> ArtifactStore
- asEncryptionKey :: Lens' ArtifactStore (Maybe EncryptionKey)
- asType :: Lens' ArtifactStore ArtifactStoreType
- asLocation :: Lens' ArtifactStore Text
- data BlockerDeclaration
- blockerDeclaration :: Text -> BlockerType -> BlockerDeclaration
- bdName :: Lens' BlockerDeclaration Text
- bdType :: Lens' BlockerDeclaration BlockerType
- data CurrentRevision
- currentRevision :: Text -> Text -> CurrentRevision
- crRevisionSummary :: Lens' CurrentRevision (Maybe Text)
- crCreated :: Lens' CurrentRevision (Maybe UTCTime)
- crRevision :: Lens' CurrentRevision Text
- crChangeIdentifier :: Lens' CurrentRevision Text
- data EncryptionKey
- encryptionKey :: Text -> EncryptionKeyType -> EncryptionKey
- ekId :: Lens' EncryptionKey Text
- ekType :: Lens' EncryptionKey EncryptionKeyType
- data ErrorDetails
- errorDetails :: ErrorDetails
- edCode :: Lens' ErrorDetails (Maybe Text)
- edMessage :: Lens' ErrorDetails (Maybe Text)
- data ExecutionDetails
- executionDetails :: ExecutionDetails
- edSummary :: Lens' ExecutionDetails (Maybe Text)
- edExternalExecutionId :: Lens' ExecutionDetails (Maybe Text)
- edPercentComplete :: Lens' ExecutionDetails (Maybe Natural)
- data FailureDetails
- failureDetails :: FailureType -> Text -> FailureDetails
- fdExternalExecutionId :: Lens' FailureDetails (Maybe Text)
- fdType :: Lens' FailureDetails FailureType
- fdMessage :: Lens' FailureDetails Text
- data InputArtifact
- inputArtifact :: Text -> InputArtifact
- iaName :: Lens' InputArtifact Text
- data Job
- job :: Job
- jData :: Lens' Job (Maybe JobData)
- jAccountId :: Lens' Job (Maybe Text)
- jId :: Lens' Job (Maybe Text)
- jNonce :: Lens' Job (Maybe Text)
- data JobData
- jobData :: JobData
- jdContinuationToken :: Lens' JobData (Maybe Text)
- jdOutputArtifacts :: Lens' JobData [Artifact]
- jdArtifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials)
- jdPipelineContext :: Lens' JobData (Maybe PipelineContext)
- jdEncryptionKey :: Lens' JobData (Maybe EncryptionKey)
- jdActionTypeId :: Lens' JobData (Maybe ActionTypeId)
- jdInputArtifacts :: Lens' JobData [Artifact]
- jdActionConfiguration :: Lens' JobData (Maybe ActionConfiguration)
- data JobDetails
- jobDetails :: JobDetails
- jdData :: Lens' JobDetails (Maybe JobData)
- jdAccountId :: Lens' JobDetails (Maybe Text)
- jdId :: Lens' JobDetails (Maybe Text)
- data ListWebhookItem
- listWebhookItem :: WebhookDefinition -> Text -> ListWebhookItem
- lwiArn :: Lens' ListWebhookItem (Maybe Text)
- lwiErrorCode :: Lens' ListWebhookItem (Maybe Text)
- lwiLastTriggered :: Lens' ListWebhookItem (Maybe UTCTime)
- lwiErrorMessage :: Lens' ListWebhookItem (Maybe Text)
- lwiDefinition :: Lens' ListWebhookItem WebhookDefinition
- lwiUrl :: Lens' ListWebhookItem Text
- data OutputArtifact
- outputArtifact :: Text -> OutputArtifact
- oaName :: Lens' OutputArtifact Text
- data PipelineContext
- pipelineContext :: PipelineContext
- pcStage :: Lens' PipelineContext (Maybe StageContext)
- pcPipelineName :: Lens' PipelineContext (Maybe Text)
- pcAction :: Lens' PipelineContext (Maybe ActionContext)
- data PipelineDeclaration
- pipelineDeclaration :: Text -> Text -> ArtifactStore -> PipelineDeclaration
- pdVersion :: Lens' PipelineDeclaration (Maybe Natural)
- pdName :: Lens' PipelineDeclaration Text
- pdRoleARN :: Lens' PipelineDeclaration Text
- pdArtifactStore :: Lens' PipelineDeclaration ArtifactStore
- pdStages :: Lens' PipelineDeclaration [StageDeclaration]
- data PipelineExecution
- pipelineExecution :: PipelineExecution
- peStatus :: Lens' PipelineExecution (Maybe PipelineExecutionStatus)
- pePipelineName :: Lens' PipelineExecution (Maybe Text)
- pePipelineVersion :: Lens' PipelineExecution (Maybe Natural)
- pePipelineExecutionId :: Lens' PipelineExecution (Maybe Text)
- peArtifactRevisions :: Lens' PipelineExecution [ArtifactRevision]
- data PipelineExecutionSummary
- pipelineExecutionSummary :: PipelineExecutionSummary
- pesStatus :: Lens' PipelineExecutionSummary (Maybe PipelineExecutionStatus)
- pesStartTime :: Lens' PipelineExecutionSummary (Maybe UTCTime)
- pesPipelineExecutionId :: Lens' PipelineExecutionSummary (Maybe Text)
- pesSourceRevisions :: Lens' PipelineExecutionSummary [SourceRevision]
- pesLastUpdateTime :: Lens' PipelineExecutionSummary (Maybe UTCTime)
- data PipelineMetadata
- pipelineMetadata :: PipelineMetadata
- pmCreated :: Lens' PipelineMetadata (Maybe UTCTime)
- pmPipelineARN :: Lens' PipelineMetadata (Maybe Text)
- pmUpdated :: Lens' PipelineMetadata (Maybe UTCTime)
- data PipelineSummary
- pipelineSummary :: PipelineSummary
- psCreated :: Lens' PipelineSummary (Maybe UTCTime)
- psName :: Lens' PipelineSummary (Maybe Text)
- psVersion :: Lens' PipelineSummary (Maybe Natural)
- psUpdated :: Lens' PipelineSummary (Maybe UTCTime)
- data S3ArtifactLocation
- s3ArtifactLocation :: Text -> Text -> S3ArtifactLocation
- salBucketName :: Lens' S3ArtifactLocation Text
- salObjectKey :: Lens' S3ArtifactLocation Text
- data SourceRevision
- sourceRevision :: Text -> SourceRevision
- srRevisionSummary :: Lens' SourceRevision (Maybe Text)
- srRevisionURL :: Lens' SourceRevision (Maybe Text)
- srRevisionId :: Lens' SourceRevision (Maybe Text)
- srActionName :: Lens' SourceRevision Text
- data StageContext
- stageContext :: StageContext
- scName :: Lens' StageContext (Maybe Text)
- data StageDeclaration
- stageDeclaration :: Text -> StageDeclaration
- sdBlockers :: Lens' StageDeclaration [BlockerDeclaration]
- sdName :: Lens' StageDeclaration Text
- sdActions :: Lens' StageDeclaration [ActionDeclaration]
- data StageExecution
- stageExecution :: Text -> StageExecutionStatus -> StageExecution
- sePipelineExecutionId :: Lens' StageExecution Text
- seStatus :: Lens' StageExecution StageExecutionStatus
- data StageState
- stageState :: StageState
- ssInboundTransitionState :: Lens' StageState (Maybe TransitionState)
- ssActionStates :: Lens' StageState [ActionState]
- ssStageName :: Lens' StageState (Maybe Text)
- ssLatestExecution :: Lens' StageState (Maybe StageExecution)
- data ThirdPartyJob
- thirdPartyJob :: ThirdPartyJob
- tpjClientId :: Lens' ThirdPartyJob (Maybe Text)
- tpjJobId :: Lens' ThirdPartyJob (Maybe Text)
- data ThirdPartyJobData
- thirdPartyJobData :: ThirdPartyJobData
- tpjdContinuationToken :: Lens' ThirdPartyJobData (Maybe Text)
- tpjdOutputArtifacts :: Lens' ThirdPartyJobData [Artifact]
- tpjdArtifactCredentials :: Lens' ThirdPartyJobData (Maybe AWSSessionCredentials)
- tpjdPipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext)
- tpjdEncryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey)
- tpjdActionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId)
- tpjdInputArtifacts :: Lens' ThirdPartyJobData [Artifact]
- tpjdActionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration)
- data ThirdPartyJobDetails
- thirdPartyJobDetails :: ThirdPartyJobDetails
- tpjdData :: Lens' ThirdPartyJobDetails (Maybe ThirdPartyJobData)
- tpjdId :: Lens' ThirdPartyJobDetails (Maybe Text)
- tpjdNonce :: Lens' ThirdPartyJobDetails (Maybe Text)
- data TransitionState
- transitionState :: TransitionState
- tsEnabled :: Lens' TransitionState (Maybe Bool)
- tsDisabledReason :: Lens' TransitionState (Maybe Text)
- tsLastChangedAt :: Lens' TransitionState (Maybe UTCTime)
- tsLastChangedBy :: Lens' TransitionState (Maybe Text)
- data WebhookAuthConfiguration
- webhookAuthConfiguration :: WebhookAuthConfiguration
- wacAllowedIPRange :: Lens' WebhookAuthConfiguration (Maybe Text)
- wacSecretToken :: Lens' WebhookAuthConfiguration (Maybe Text)
- data WebhookDefinition
- webhookDefinition :: Text -> Text -> Text -> WebhookAuthenticationType -> WebhookAuthConfiguration -> WebhookDefinition
- wdName :: Lens' WebhookDefinition Text
- wdTargetPipeline :: Lens' WebhookDefinition Text
- wdTargetAction :: Lens' WebhookDefinition Text
- wdFilters :: Lens' WebhookDefinition [WebhookFilterRule]
- wdAuthentication :: Lens' WebhookDefinition WebhookAuthenticationType
- wdAuthenticationConfiguration :: Lens' WebhookDefinition WebhookAuthConfiguration
- data WebhookFilterRule
- webhookFilterRule :: Text -> WebhookFilterRule
- wfrMatchEquals :: Lens' WebhookFilterRule (Maybe Text)
- wfrJsonPath :: Lens' WebhookFilterRule Text
Service Configuration
codePipeline :: Service Source #
API version 2015-07-09 of the Amazon CodePipeline SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CodePipeline.
InvalidClientTokenException
_InvalidClientTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client token was specified in an invalid format
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The validation was specified in an invalid format.
InvalidNonceException
_InvalidNonceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified nonce was specified in an invalid format.
ActionNotFoundException
_ActionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified action cannot be found.
InvalidApprovalTokenException
_InvalidApprovalTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The approval request already received a response or has expired.
InvalidBlockerDeclarationException
_InvalidBlockerDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Reserved for future use.
InvalidJobStateException
_InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified job state was specified in an invalid format.
InvalidJobException
_InvalidJobException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified job was specified in an invalid format or cannot be found.
PipelineVersionNotFoundException
_PipelineVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pipeline version was specified in an invalid format or cannot be found.
StageNotRetryableException
_StageNotRetryableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
PipelineExecutionNotFoundException
_PipelineExecutionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
InvalidWebhookAuthenticationParametersException
_InvalidWebhookAuthenticationParametersException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified authentication type is in an invalid format.
WebhookNotFoundException
_WebhookNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified webhook was entered in an invalid format or cannot be found.
ActionTypeNotFoundException
_ActionTypeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified action type cannot be found.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
InvalidStageDeclarationException
_InvalidStageDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified stage declaration was specified in an invalid format.
InvalidWebhookFilterPatternException
_InvalidWebhookFilterPatternException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified event filter rule is in an invalid format.
InvalidActionDeclarationException
_InvalidActionDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified action declaration was specified in an invalid format.
StageNotFoundException
_StageNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified stage was specified in an invalid format or cannot be found.
InvalidStructureException
_InvalidStructureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified structure was specified in an invalid format.
JobNotFoundException
_JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified job was specified in an invalid format or cannot be found.
ApprovalAlreadyCompletedException
_ApprovalAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The approval action has already been approved or rejected.
PipelineNameInUseException
_PipelineNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pipeline name is already in use.
PipelineNotFoundException
_PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pipeline was specified in an invalid format or cannot be found.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
NotLatestPipelineExecutionException
_NotLatestPipelineExecutionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetPipeline
PutJobFailureResult
PutApprovalResult
AcknowledgeThirdPartyJob
PutThirdPartyJobFailureResult
RegisterWebhookWithThirdParty
PollForThirdPartyJobs
PollForJobs
StartPipelineExecution
UpdatePipeline
DeletePipeline
GetPipelineState
GetJobDetails
ListPipelines
RetryStageExecution
GetPipelineExecution
PutJobSuccessResult
DeregisterWebhookWithThirdParty
DeleteCustomActionType
PutActionRevision
DisableStageTransition
ListActionTypes
AcknowledgeJob
EnableStageTransition
DeleteWebhook
PutWebhook
ListWebhooks
CreatePipeline
GetThirdPartyJobDetails
PutThirdPartyJobSuccessResult
CreateCustomActionType
ListPipelineExecutions
Types
ActionCategory
data ActionCategory Source #
Instances
ActionConfigurationPropertyType
data ActionConfigurationPropertyType Source #
Instances
ActionExecutionStatus
data ActionExecutionStatus Source #
Constructors
| AESFailed | |
| AESInProgress | |
| AESSucceeded |
Instances
ActionOwner
data ActionOwner Source #
Constructors
| AWS | |
| Custom | |
| ThirdParty |
Instances
ApprovalStatus
data ApprovalStatus Source #
Instances
ArtifactLocationType
data ArtifactLocationType Source #
Constructors
| ALTS3 |
Instances
ArtifactStoreType
data ArtifactStoreType Source #
Constructors
| S3 |
Instances
BlockerType
data BlockerType Source #
Constructors
| Schedule |
Instances
EncryptionKeyType
data EncryptionKeyType Source #
Constructors
| KMS |
Instances
FailureType
data FailureType Source #
Constructors
| ConfigurationError | |
| JobFailed | |
| PermissionError | |
| RevisionOutOfSync | |
| RevisionUnavailable | |
| SystemUnavailable |
Instances
JobStatus
Constructors
| JSCreated | |
| JSDispatched | |
| JSFailed | |
| JSInProgress | |
| JSQueued | |
| JSSucceeded | |
| JSTimedOut |
Instances
PipelineExecutionStatus
data PipelineExecutionStatus Source #
Constructors
| Failed | |
| InProgress | |
| Succeeded | |
| Superseded |
Instances
StageExecutionStatus
data StageExecutionStatus Source #
Constructors
| SESFailed | |
| SESInProgress | |
| SESSucceeded |
Instances
StageRetryMode
data StageRetryMode Source #
Constructors
| FailedActions |
Instances
StageTransitionType
data StageTransitionType Source #
Instances
WebhookAuthenticationType
data WebhookAuthenticationType Source #
Constructors
| GithubHmac | |
| IP | |
| Unauthenticated |
Instances
AWSSessionCredentials
data AWSSessionCredentials Source #
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.
See: awsSessionCredentials smart constructor.
Instances
awsSessionCredentials Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AWSSessionCredentials |
Creates a value of AWSSessionCredentials with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ascAccessKeyId- The access key for the session.ascSecretAccessKey- The secret access key for the session.ascSessionToken- The token for the session.
ascAccessKeyId :: Lens' AWSSessionCredentials Text Source #
The access key for the session.
ascSecretAccessKey :: Lens' AWSSessionCredentials Text Source #
The secret access key for the session.
ascSessionToken :: Lens' AWSSessionCredentials Text Source #
The token for the session.
ActionConfiguration
data ActionConfiguration Source #
Represents information about an action configuration.
See: actionConfiguration smart constructor.
Instances
actionConfiguration :: ActionConfiguration Source #
Creates a value of ActionConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acConfiguration- The configuration data for the action.
acConfiguration :: Lens' ActionConfiguration (HashMap Text Text) Source #
The configuration data for the action.
ActionConfigurationProperty
data ActionConfigurationProperty Source #
Represents information about an action configuration property.
See: actionConfigurationProperty smart constructor.
Instances
actionConfigurationProperty Source #
Arguments
| :: Text | |
| -> Bool | |
| -> Bool | |
| -> Bool | |
| -> ActionConfigurationProperty |
Creates a value of ActionConfigurationProperty with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acpQueryable- Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.acpType- The type of the configuration property.acpDescription- The description of the action configuration property that will be displayed to users.acpName- The name of the action configuration property.acpRequired- Whether the configuration property is a required value.acpKey- Whether the configuration property is a key.acpSecret- 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 will preserve the prior value of the secret.
acpQueryable :: Lens' ActionConfigurationProperty (Maybe Bool) Source #
Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
acpType :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType) Source #
The type of the configuration property.
acpDescription :: Lens' ActionConfigurationProperty (Maybe Text) Source #
The description of the action configuration property that will be displayed to users.
acpName :: Lens' ActionConfigurationProperty Text Source #
The name of the action configuration property.
acpRequired :: Lens' ActionConfigurationProperty Bool Source #
Whether the configuration property is a required value.
acpKey :: Lens' ActionConfigurationProperty Bool Source #
Whether the configuration property is a key.
acpSecret :: Lens' ActionConfigurationProperty Bool Source #
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 will preserve the prior value of the secret.
ActionContext
data ActionContext Source #
Represents the context of an action within the stage of a pipeline to a job worker.
See: actionContext smart constructor.
Instances
actionContext :: ActionContext Source #
Creates a value of ActionContext with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acName- The name of the action within the context of a job.
acName :: Lens' ActionContext (Maybe Text) Source #
The name of the action within the context of a job.
ActionDeclaration
data ActionDeclaration Source #
Represents information about an action declaration.
See: actionDeclaration smart constructor.
Instances
Arguments
| :: Text | |
| -> ActionTypeId | |
| -> ActionDeclaration |
Creates a value of ActionDeclaration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
adOutputArtifacts- The name or ID of the result of the action declaration, such as a test or build artifact.adRunOrder- The order in which actions are run.adConfiguration- The action declaration's configuration.adInputArtifacts- The name or ID of the artifact consumed by the action, such as a test or build artifact.adRoleARN- The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.adName- The action declaration's name.adActionTypeId- The configuration information for the action type.
adOutputArtifacts :: Lens' ActionDeclaration [OutputArtifact] Source #
The name or ID of the result of the action declaration, such as a test or build artifact.
adRunOrder :: Lens' ActionDeclaration (Maybe Natural) Source #
The order in which actions are run.
adConfiguration :: Lens' ActionDeclaration (HashMap Text Text) Source #
The action declaration's configuration.
adInputArtifacts :: Lens' ActionDeclaration [InputArtifact] Source #
The name or ID of the artifact consumed by the action, such as a test or build artifact.
adRoleARN :: Lens' ActionDeclaration (Maybe Text) Source #
The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.
adActionTypeId :: Lens' ActionDeclaration ActionTypeId Source #
The configuration information for the action type.
ActionExecution
data ActionExecution Source #
Represents information about the run of an action.
See: actionExecution smart constructor.