| 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 #
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 #
The client token was specified in an invalid format
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError #
The validation was specified in an invalid format.
InvalidNonceException
_InvalidNonceException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified nonce was specified in an invalid format.
ActionNotFoundException
_ActionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified action cannot be found.
InvalidApprovalTokenException
_InvalidApprovalTokenException :: AsError a => Getting (First ServiceError) a ServiceError #
The approval request already received a response or has expired.
InvalidBlockerDeclarationException
_InvalidBlockerDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError #
Reserved for future use.
InvalidJobStateException
_InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified job state was specified in an invalid format.
InvalidJobException
_InvalidJobException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified job was specified in an invalid format or cannot be found.
PipelineVersionNotFoundException
_PipelineVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified pipeline version was specified in an invalid format or cannot be found.
StageNotRetryableException
_StageNotRetryableException :: AsError a => Getting (First ServiceError) a ServiceError #
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 #
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 #
The specified authentication type is in an invalid format.
WebhookNotFoundException
_WebhookNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified webhook was entered in an invalid format or cannot be found.
ActionTypeNotFoundException
_ActionTypeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified action type cannot be found.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError #
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 #
The specified stage declaration was specified in an invalid format.
InvalidWebhookFilterPatternException
_InvalidWebhookFilterPatternException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified event filter rule is in an invalid format.
InvalidActionDeclarationException
_InvalidActionDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified action declaration was specified in an invalid format.
StageNotFoundException
_StageNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified stage was specified in an invalid format or cannot be found.
InvalidStructureException
_InvalidStructureException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified structure was specified in an invalid format.
JobNotFoundException
_JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified job was specified in an invalid format or cannot be found.
ApprovalAlreadyCompletedException
_ApprovalAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError #
The approval action has already been approved or rejected.
PipelineNameInUseException
_PipelineNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified pipeline name is already in use.
PipelineNotFoundException
_PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified pipeline was specified in an invalid format or cannot be found.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
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 #
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 #
Instances
ActionConfigurationPropertyType
data ActionConfigurationPropertyType #
Instances
ActionExecutionStatus
data ActionExecutionStatus #
Constructors
| AESFailed | |
| AESInProgress | |
| AESSucceeded |
Instances
ActionOwner
data ActionOwner #
Constructors
| AWS | |
| Custom | |
| ThirdParty |
Instances
ApprovalStatus
data ApprovalStatus #
Instances
ArtifactLocationType
data ArtifactLocationType #
Constructors
| ALTS3 |
Instances
ArtifactStoreType
data ArtifactStoreType #
Constructors
| S3 |
Instances
BlockerType
data BlockerType #
Constructors
| Schedule |
Instances
EncryptionKeyType
data EncryptionKeyType #
Constructors
| KMS |
Instances
FailureType
data FailureType #
Constructors
| ConfigurationError | |
| JobFailed | |
| PermissionError | |
| RevisionOutOfSync | |
| RevisionUnavailable | |
| SystemUnavailable |
Instances
JobStatus
Constructors
| JSCreated | |
| JSDispatched | |
| JSFailed | |
| JSInProgress | |
| JSQueued | |
| JSSucceeded | |
| JSTimedOut |
Instances
PipelineExecutionStatus
data PipelineExecutionStatus #
Constructors
| Failed | |
| InProgress | |
| Succeeded | |
| Superseded |
Instances
StageExecutionStatus
data StageExecutionStatus #
Constructors
| SESFailed | |
| SESInProgress | |
| SESSucceeded |
Instances
StageRetryMode
data StageRetryMode #
Constructors
| FailedActions |
Instances
StageTransitionType
data StageTransitionType #
Instances
WebhookAuthenticationType
data WebhookAuthenticationType #
Constructors
| GithubHmac | |
| IP | |
| Unauthenticated |
Instances
AWSSessionCredentials
data AWSSessionCredentials #
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
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 #
The access key for the session.
ascSecretAccessKey :: Lens' AWSSessionCredentials Text #
The secret access key for the session.
ascSessionToken :: Lens' AWSSessionCredentials Text #
The token for the session.
ActionConfiguration
data ActionConfiguration #
Represents information about an action configuration.
See: actionConfiguration smart constructor.
Instances
actionConfiguration :: ActionConfiguration #
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) #
The configuration data for the action.
ActionConfigurationProperty
data ActionConfigurationProperty #
Represents information about an action configuration property.
See: actionConfigurationProperty smart constructor.
Instances
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) #
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) #
The type of the configuration property.
acpDescription :: Lens' ActionConfigurationProperty (Maybe Text) #
The description of the action configuration property that will be displayed to users.
acpName :: Lens' ActionConfigurationProperty Text #
The name of the action configuration property.
acpRequired :: Lens' ActionConfigurationProperty Bool #
Whether the configuration property is a required value.
acpKey :: Lens' ActionConfigurationProperty Bool #
Whether the configuration property is a key.
acpSecret :: Lens' ActionConfigurationProperty Bool #
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 #
Represents the context of an action within the stage of a pipeline to a job worker.
See: actionContext smart constructor.
Instances
actionContext :: ActionContext #
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.
ActionDeclaration
data ActionDeclaration #
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] #
The name or ID of the result of the action declaration, such as a test or build artifact.
adRunOrder :: Lens' ActionDeclaration (Maybe Natural) #
The order in which actions are run.
adConfiguration :: Lens' ActionDeclaration (HashMap Text Text) #
The action declaration's configuration.
adInputArtifacts :: Lens' ActionDeclaration [InputArtifact] #
The name or ID of the artifact consumed by the action, such as a test or build artifact.
adRoleARN :: Lens' ActionDeclaration (Maybe Text) #
The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.
adName :: Lens' ActionDeclaration Text #
The action declaration's name.
adActionTypeId :: Lens' ActionDeclaration ActionTypeId #
The configuration information for the action type.
ActionExecution
data ActionExecution #
Represents information about the run of an action.
See: actionExecution smart constructor.
Instances
actionExecution :: ActionExecution #
Creates a value of ActionExecution with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aeLastUpdatedBy- The ARN of the user who last changed the pipeline.aeSummary- A summary of the run of the action.aeStatus- The status of the action, or for a completed action, the last status of the action.aeLastStatusChange- The last status change of the action.aeToken- The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command and is used to validate that the approval request corresponding to this token is still valid.aeExternalExecutionURL- The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.aeExternalExecutionId- The external ID of the run of the action.aeErrorDetails- The details of an error returned by a URL external to AWS.aePercentComplete- A percentage of completeness of the action as it runs.
aeLastUpdatedBy :: Lens' ActionExecution (Maybe Text) #
The ARN of the user who last changed the pipeline.
aeStatus :: Lens' ActionExecution (Maybe ActionExecutionStatus) #
The status of the action, or for a completed action, the last status of the action.
aeLastStatusChange :: Lens' ActionExecution (Maybe UTCTime) #
The last status change of the action.
aeToken :: Lens' ActionExecution (Maybe Text) #
The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command and is used to validate that the approval request corresponding to this token is still valid.
aeExternalExecutionURL :: Lens' ActionExecution (Maybe Text) #
The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.
aeExternalExecutionId :: Lens' ActionExecution (Maybe Text) #
The external ID of the run of the action.
aeErrorDetails :: Lens' ActionExecution (Maybe ErrorDetails) #
The details of an error returned by a URL external to AWS.
aePercentComplete :: Lens' ActionExecution (Maybe Natural) #
A percentage of completeness of the action as it runs.
ActionRevision
data ActionRevision #
Represents information about the version (or revision) of an action.
See: actionRevision smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ActionRevision |
Creates a value of ActionRevision with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aRevisionId- The system-generated unique ID that identifies the revision number of the action.aRevisionChangeId- The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.aCreated- The date and time when the most recent version of the action was created, in timestamp format.
aRevisionId :: Lens' ActionRevision Text #
The system-generated unique ID that identifies the revision number of the action.
aRevisionChangeId :: Lens' ActionRevision Text #
The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.
aCreated :: Lens' ActionRevision UTCTime #
The date and time when the most recent version of the action was created, in timestamp format.
ActionState
data ActionState #
Represents information about the state of an action.
See: actionState smart constructor.
Instances
Creates a value of ActionState with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asRevisionURL- A URL link for more information about the revision, such as a commit details page.asEntityURL- A URL link for more information about the state of the action, such as a deployment group details page.asActionName- The name of the action.asCurrentRevision- Represents information about the version (or revision) of an action.asLatestExecution- Represents information about the run of an action.
asRevisionURL :: Lens' ActionState (Maybe Text) #
A URL link for more information about the revision, such as a commit details page.
asEntityURL :: Lens' ActionState (Maybe Text) #
A URL link for more information about the state of the action, such as a deployment group details page.
asActionName :: Lens' ActionState (Maybe Text) #
The name of the action.
asCurrentRevision :: Lens' ActionState (Maybe ActionRevision) #
Represents information about the version (or revision) of an action.
asLatestExecution :: Lens' ActionState (Maybe ActionExecution) #
Represents information about the run of an action.
ActionType
data ActionType #
Returns information about the details of an action type.
See: actionType smart constructor.
Instances
Arguments
| :: ActionTypeId | |
| -> ArtifactDetails | |
| -> ArtifactDetails | |
| -> ActionType |
Creates a value of ActionType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atSettings- The settings for the action type.atActionConfigurationProperties- The configuration properties for the action type.atId- Represents information about an action type.atInputArtifactDetails- The details of the input artifact for the action, such as its commit ID.atOutputArtifactDetails- The details of the output artifact of the action, such as its commit ID.
atSettings :: Lens' ActionType (Maybe ActionTypeSettings) #
The settings for the action type.
atActionConfigurationProperties :: Lens' ActionType [ActionConfigurationProperty] #
The configuration properties for the action type.
atId :: Lens' ActionType ActionTypeId #
Represents information about an action type.
atInputArtifactDetails :: Lens' ActionType ArtifactDetails #
The details of the input artifact for the action, such as its commit ID.
atOutputArtifactDetails :: Lens' ActionType ArtifactDetails #
The details of the output artifact of the action, such as its commit ID.
ActionTypeId
data ActionTypeId #
Represents information about an action type.
See: actionTypeId smart constructor.
Instances
Arguments
| :: ActionCategory | |
| -> ActionOwner | |
| -> Text | |
| -> Text | |
| -> ActionTypeId |
Creates a value of ActionTypeId with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atiCategory- A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.atiOwner- The creator of the action being called.atiProvider- The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.atiVersion- A string that describes the action version.
atiCategory :: Lens' ActionTypeId ActionCategory #
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.
atiOwner :: Lens' ActionTypeId ActionOwner #
The creator of the action being called.
atiProvider :: Lens' ActionTypeId Text #
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.
atiVersion :: Lens' ActionTypeId Text #
A string that describes the action version.
ActionTypeSettings
data ActionTypeSettings #
Returns information about the settings for an action type.
See: actionTypeSettings smart constructor.
Instances
actionTypeSettings :: ActionTypeSettings #
Creates a value of ActionTypeSettings with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atsThirdPartyConfigurationURL- The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.atsExecutionURLTemplate- The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.atsRevisionURLTemplate- The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.atsEntityURLTemplate- The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.
atsThirdPartyConfigurationURL :: Lens' ActionTypeSettings (Maybe Text) #
The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
atsExecutionURLTemplate :: Lens' ActionTypeSettings (Maybe Text) #
The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
atsRevisionURLTemplate :: Lens' ActionTypeSettings (Maybe Text) #
The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
atsEntityURLTemplate :: Lens' ActionTypeSettings (Maybe Text) #
The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.
ApprovalResult
data ApprovalResult #
Represents information about the result of an approval request.
See: approvalResult smart constructor.
Instances
Arguments
| :: Text | |
| -> ApprovalStatus | |
| -> ApprovalResult |
Creates a value of ApprovalResult with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arSummary :: Lens' ApprovalResult Text #
The summary of the current status of the approval request.
arStatus :: Lens' ApprovalResult ApprovalStatus #
The response submitted by a reviewer assigned to an approval action request.
Artifact
Represents information about an artifact that will be worked upon by actions in the pipeline.
See: artifact smart constructor.
Instances
| Eq Artifact # | |
| Data Artifact # | |
Defined in Network.AWS.CodePipeline.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Artifact -> c Artifact # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Artifact # toConstr :: Artifact -> Constr # dataTypeOf :: Artifact -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Artifact) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Artifact) # gmapT :: (forall b. Data b => b -> b) -> Artifact -> Artifact # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Artifact -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Artifact -> r # gmapQ :: (forall d. Data d => d -> u) -> Artifact -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Artifact -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Artifact -> m Artifact # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Artifact -> m Artifact # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Artifact -> m Artifact # | |
| Read Artifact # | |
| Show Artifact # | |
| Generic Artifact # | |
| Hashable Artifact # | |
Defined in Network.AWS.CodePipeline.Types.Product | |
| FromJSON Artifact # | |
| NFData Artifact # | |
Defined in Network.AWS.CodePipeline.Types.Product | |
| type Rep Artifact # | |
Defined in Network.AWS.CodePipeline.Types.Product type Rep Artifact = D1 (MetaData "Artifact" "Network.AWS.CodePipeline.Types.Product" "amazonka-codepipeline-1.6.0-CC2BPnoufmqE0zbjOUPBZ9" False) (C1 (MetaCons "Artifact'" PrefixI True) (S1 (MetaSel (Just "_aLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ArtifactLocation)) :*: (S1 (MetaSel (Just "_aName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_aRevision") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
Creates a value of Artifact with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aRevision :: Lens' Artifact (Maybe Text) #
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
ArtifactDetails
data ArtifactDetails #
Returns information about the details of an artifact.
See: artifactDetails smart constructor.
Instances
Arguments
| :: Natural | |
| -> Natural | |
| -> ArtifactDetails |
Creates a value of ArtifactDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
adMinimumCount- The minimum number of artifacts allowed for the action type.adMaximumCount- The maximum number of artifacts allowed for the action type.
adMinimumCount :: Lens' ArtifactDetails Natural #
The minimum number of artifacts allowed for the action type.
adMaximumCount :: Lens' ArtifactDetails Natural #
The maximum number of artifacts allowed for the action type.
ArtifactLocation
data ArtifactLocation #
Represents information about the location of an artifact.
See: artifactLocation smart constructor.
Instances
artifactLocation :: ArtifactLocation #
Creates a value of ArtifactLocation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alS3Location- The Amazon S3 bucket that contains the artifact.alType- The type of artifact in the location.
alS3Location :: Lens' ArtifactLocation (Maybe S3ArtifactLocation) #
The Amazon S3 bucket that contains the artifact.
alType :: Lens' ArtifactLocation (Maybe ArtifactLocationType) #
The type of artifact in the location.
ArtifactRevision
data ArtifactRevision #
Represents revision details of an artifact.
See: artifactRevision smart constructor.
Instances
artifactRevision :: ArtifactRevision #
Creates a value of ArtifactRevision with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arRevisionSummary- Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of acodepipeline-artifact-revision-summarykey specified in the object metadata.arRevisionURL- The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.arCreated- The date and time when the most recent revision of the artifact was created, in timestamp format.arName- The name of an artifact. This name might be system-generated, such as MyApp, or might be defined by the user when an action is created.arRevisionId- The revision ID of the artifact.arRevisionChangeIdentifier- An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
arRevisionSummary :: Lens' ArtifactRevision (Maybe Text) #
Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
arRevisionURL :: Lens' ArtifactRevision (Maybe Text) #
The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
arCreated :: Lens' ArtifactRevision (Maybe UTCTime) #
The date and time when the most recent revision of the artifact was created, in timestamp format.
arName :: Lens' ArtifactRevision (Maybe Text) #
The name of an artifact. This name might be system-generated, such as MyApp, or might be defined by the user when an action is created.
arRevisionId :: Lens' ArtifactRevision (Maybe Text) #
The revision ID of the artifact.
arRevisionChangeIdentifier :: Lens' ArtifactRevision (Maybe Text) #
An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
ArtifactStore
data ArtifactStore #
The Amazon S3 bucket where artifacts are stored for the pipeline.
See: artifactStore smart constructor.
Instances
Arguments
| :: ArtifactStoreType | |
| -> Text | |
| -> ArtifactStore |
Creates a value of ArtifactStore with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asEncryptionKey- The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.asType- The type of the artifact store, such as S3.asLocation- The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
asEncryptionKey :: Lens' ArtifactStore (Maybe EncryptionKey) #
The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
asType :: Lens' ArtifactStore ArtifactStoreType #
The type of the artifact store, such as S3.
asLocation :: Lens' ArtifactStore Text #
The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
BlockerDeclaration
data BlockerDeclaration #
Reserved for future use.
See: blockerDeclaration smart constructor.
Instances
Arguments
| :: Text | |
| -> BlockerType | |
| -> BlockerDeclaration |
Creates a value of BlockerDeclaration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdName :: Lens' BlockerDeclaration Text #
Reserved for future use.
bdType :: Lens' BlockerDeclaration BlockerType #
Reserved for future use.
CurrentRevision
data CurrentRevision #
Represents information about a current revision.
See: currentRevision smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CurrentRevision |
Creates a value of CurrentRevision with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crRevisionSummary- The summary of the most recent revision of the artifact.crCreated- The date and time when the most recent revision of the artifact was created, in timestamp format.crRevision- The revision ID of the current version of an artifact.crChangeIdentifier- The change identifier for the current revision.
crRevisionSummary :: Lens' CurrentRevision (Maybe Text) #
The summary of the most recent revision of the artifact.
crCreated :: Lens' CurrentRevision (Maybe UTCTime) #
The date and time when the most recent revision of the artifact was created, in timestamp format.
crRevision :: Lens' CurrentRevision Text #
The revision ID of the current version of an artifact.
crChangeIdentifier :: Lens' CurrentRevision Text #
The change identifier for the current revision.
EncryptionKey
data EncryptionKey #
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
See: encryptionKey smart constructor.
Instances
Arguments
| :: Text | |
| -> EncryptionKeyType | |
| -> EncryptionKey |
Creates a value of EncryptionKey with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ekId :: Lens' EncryptionKey Text #
The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.
ekType :: Lens' EncryptionKey EncryptionKeyType #
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to KMS.
ErrorDetails
data ErrorDetails #
Represents information about an error in AWS CodePipeline.
See: errorDetails smart constructor.
Instances
errorDetails :: ErrorDetails #
Creates a value of ErrorDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ExecutionDetails
data ExecutionDetails #
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
See: executionDetails smart constructor.
Instances
executionDetails :: ExecutionDetails #
Creates a value of ExecutionDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edSummary- The summary of the current status of the actions.edExternalExecutionId- The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.edPercentComplete- The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
edExternalExecutionId :: Lens' ExecutionDetails (Maybe Text) #
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
edPercentComplete :: Lens' ExecutionDetails (Maybe Natural) #
The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
FailureDetails
data FailureDetails #
Represents information about failure details.
See: failureDetails smart constructor.
Instances
Arguments
| :: FailureType | |
| -> Text | |
| -> FailureDetails |
Creates a value of FailureDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fdExternalExecutionId- The external ID of the run of the action that failed.fdType- The type of the failure.fdMessage- The message about the failure.
fdExternalExecutionId :: Lens' FailureDetails (Maybe Text) #
The external ID of the run of the action that failed.
fdType :: Lens' FailureDetails FailureType #
The type of the failure.
fdMessage :: Lens' FailureDetails Text #
The message about the failure.
InputArtifact
data InputArtifact #
Represents information about an artifact to be worked on, such as a test or build artifact.
See: inputArtifact smart constructor.
Instances
Arguments
| :: Text | |
| -> InputArtifact |
Creates a value of InputArtifact with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaName- The name of the artifact to be worked on, for example, "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
iaName :: Lens' InputArtifact Text #
The name of the artifact to be worked on, for example, "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Job
Represents information about a job.
See: job smart constructor.
Instances
| Eq Job # | |
| Data Job # | |
Defined in Network.AWS.CodePipeline.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Job -> c Job # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Job # dataTypeOf :: Job -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Job) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Job) # gmapT :: (forall b. Data b => b -> b) -> Job -> Job # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Job -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Job -> r # gmapQ :: (forall d. Data d => d -> u) -> Job -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Job -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Job -> m Job # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Job -> m Job # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Job -> m Job # | |
| Show Job # | |
| Generic Job # | |
| Hashable Job # | |
Defined in Network.AWS.CodePipeline.Types.Product | |
| FromJSON Job # | |
| NFData Job # | |
Defined in Network.AWS.CodePipeline.Types.Product | |
| type Rep Job # | |
Defined in Network.AWS.CodePipeline.Types.Product type Rep Job = D1 (MetaData "Job" "Network.AWS.CodePipeline.Types.Product" "amazonka-codepipeline-1.6.0-CC2BPnoufmqE0zbjOUPBZ9" False) (C1 (MetaCons "Job'" PrefixI True) ((S1 (MetaSel (Just "_jData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JobData)) :*: S1 (MetaSel (Just "_jAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_jId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_jNonce") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
Creates a value of Job with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jData- Additional data about a job.jAccountId- The ID of the AWS account to use when performing the job.jId- The unique system-generated ID of the job.jNonce- A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in anAcknowledgeJobrequest.
jNonce :: Lens' Job (Maybe Text) #
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.
JobData
Represents additional information about a job required for a job worker to complete the job.
See: jobData smart constructor.
Instances
Creates a value of JobData with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jdContinuationToken- A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.jdOutputArtifacts- The output of the job.jdArtifactCredentials- 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.jdPipelineContext- Represents information about a pipeline to a job worker.jdEncryptionKey- Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.jdActionTypeId- Represents information about an action type.jdInputArtifacts- The artifact supplied to the job.jdActionConfiguration- Represents information about an action configuration.
jdContinuationToken :: Lens' JobData (Maybe Text) #
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
jdOutputArtifacts :: Lens' JobData [Artifact] #
The output of the job.
jdArtifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials) #
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.
jdPipelineContext :: Lens' JobData (Maybe PipelineContext) #
Represents information about a pipeline to a job worker.
jdEncryptionKey :: Lens' JobData (Maybe EncryptionKey) #
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
jdActionTypeId :: Lens' JobData (Maybe ActionTypeId) #
Represents information about an action type.
jdInputArtifacts :: Lens' JobData [Artifact] #
The artifact supplied to the job.
jdActionConfiguration :: Lens' JobData (Maybe ActionConfiguration) #
Represents information about an action configuration.
JobDetails
data JobDetails #
Represents information about the details of a job.
See: jobDetails smart constructor.
Instances
Creates a value of JobDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jdData- Represents additional information about a job required for a job worker to complete the job.jdAccountId- The AWS account ID associated with the job.jdId- The unique system-generated ID of the job.
jdData :: Lens' JobDetails (Maybe JobData) #
Represents additional information about a job required for a job worker to complete the job.
jdAccountId :: Lens' JobDetails (Maybe Text) #
The AWS account ID associated with the job.
ListWebhookItem
data ListWebhookItem #
The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
See: listWebhookItem smart constructor.
Instances
Arguments
| :: WebhookDefinition | |
| -> Text | |
| -> ListWebhookItem |
Creates a value of ListWebhookItem with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lwiArn- The Amazon Resource Name (ARN) of the webhook.lwiErrorCode- The number code of the error.lwiLastTriggered- The date and time a webhook was last successfully triggered, in timestamp format.lwiErrorMessage- The text of the error message about the webhook.lwiDefinition- The detail returned for each webhook, such as the webhook authentication type and filter rules.lwiUrl- A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook will make the old URL invalid and generate a new URL.
lwiErrorCode :: Lens' ListWebhookItem (Maybe Text) #
The number code of the error.
lwiLastTriggered :: Lens' ListWebhookItem (Maybe UTCTime) #
The date and time a webhook was last successfully triggered, in timestamp format.
lwiErrorMessage :: Lens' ListWebhookItem (Maybe Text) #
The text of the error message about the webhook.
lwiDefinition :: Lens' ListWebhookItem WebhookDefinition #
The detail returned for each webhook, such as the webhook authentication type and filter rules.
lwiUrl :: Lens' ListWebhookItem Text #
A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook will make the old URL invalid and generate a new URL.
OutputArtifact
data OutputArtifact #
Represents information about the output of an action.
See: outputArtifact smart constructor.
Instances
Arguments
| :: Text | |
| -> OutputArtifact |
Creates a value of OutputArtifact with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oaName- The name of the output of an artifact, such as "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. Output artifact names must be unique within a pipeline.
oaName :: Lens' OutputArtifact Text #
The name of the output of an artifact, such as "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. Output artifact names must be unique within a pipeline.
PipelineContext
data PipelineContext #
Represents information about a pipeline to a job worker.
See: pipelineContext smart constructor.
Instances
pipelineContext :: PipelineContext #
Creates a value of PipelineContext with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcStage- The stage of the pipeline.pcPipelineName- The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.pcAction- The context of an action to a job worker within the stage of a pipeline.
pcStage :: Lens' PipelineContext (Maybe StageContext) #
The stage of the pipeline.
pcPipelineName :: Lens' PipelineContext (Maybe Text) #
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
pcAction :: Lens' PipelineContext (Maybe ActionContext) #
The context of an action to a job worker within the stage of a pipeline.
PipelineDeclaration
data PipelineDeclaration #
Represents the structure of actions and stages to be performed in the pipeline.
See: pipelineDeclaration smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ArtifactStore | |
| -> PipelineDeclaration |
Creates a value of PipelineDeclaration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdVersion- The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.pdName- The name of the action to be performed.pdRoleARN- The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.pdArtifactStore- Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.pdStages- The stage in which to perform the action.
pdVersion :: Lens' PipelineDeclaration (Maybe Natural) #
The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.
pdName :: Lens' PipelineDeclaration Text #
The name of the action to be performed.
pdRoleARN :: Lens' PipelineDeclaration Text #
The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
pdArtifactStore :: Lens' PipelineDeclaration ArtifactStore #
Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.
pdStages :: Lens' PipelineDeclaration [StageDeclaration] #
The stage in which to perform the action.
PipelineExecution
data PipelineExecution #
Represents information about an execution of a pipeline.
See: pipelineExecution smart constructor.
Instances
pipelineExecution :: PipelineExecution #
Creates a value of PipelineExecution with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
peStatus- The status of the pipeline execution. * InProgress: The pipeline execution is currently running. * Succeeded: The pipeline execution was completed successfully. * Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. * Failed: The pipeline execution was not completed successfully.pePipelineName- The name of the pipeline that was executed.pePipelineVersion- The version number of the pipeline that was executed.pePipelineExecutionId- The ID of the pipeline execution.peArtifactRevisions- A list of ArtifactRevision objects included in a pipeline execution.
peStatus :: Lens' PipelineExecution (Maybe PipelineExecutionStatus) #
The status of the pipeline execution. * InProgress: The pipeline execution is currently running. * Succeeded: The pipeline execution was completed successfully. * Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. * Failed: The pipeline execution was not completed successfully.
pePipelineName :: Lens' PipelineExecution (Maybe Text) #
The name of the pipeline that was executed.
pePipelineVersion :: Lens' PipelineExecution (Maybe Natural) #
The version number of the pipeline that was executed.
pePipelineExecutionId :: Lens' PipelineExecution (Maybe Text) #
The ID of the pipeline execution.
peArtifactRevisions :: Lens' PipelineExecution [ArtifactRevision] #
A list of ArtifactRevision objects included in a pipeline execution.
PipelineExecutionSummary
data PipelineExecutionSummary #
Summary information about a pipeline execution.
See: pipelineExecutionSummary smart constructor.
Instances
pipelineExecutionSummary :: PipelineExecutionSummary #
Creates a value of PipelineExecutionSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pesStatus- The status of the pipeline execution. * InProgress: The pipeline execution is currently running. * Succeeded: The pipeline execution was completed successfully. * Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. * Failed: The pipeline execution was not completed successfully.pesStartTime- The date and time when the pipeline execution began, in timestamp format.pesPipelineExecutionId- The ID of the pipeline execution.pesSourceRevisions- Undocumented member.pesLastUpdateTime- The date and time of the last change to the pipeline execution, in timestamp format.
pesStatus :: Lens' PipelineExecutionSummary (Maybe PipelineExecutionStatus) #
The status of the pipeline execution. * InProgress: The pipeline execution is currently running. * Succeeded: The pipeline execution was completed successfully. * Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. * Failed: The pipeline execution was not completed successfully.
pesStartTime :: Lens' PipelineExecutionSummary (Maybe UTCTime) #
The date and time when the pipeline execution began, in timestamp format.
pesPipelineExecutionId :: Lens' PipelineExecutionSummary (Maybe Text) #
The ID of the pipeline execution.
pesSourceRevisions :: Lens' PipelineExecutionSummary [SourceRevision] #
Undocumented member.
pesLastUpdateTime :: Lens' PipelineExecutionSummary (Maybe UTCTime) #
The date and time of the last change to the pipeline execution, in timestamp format.
PipelineMetadata
data PipelineMetadata #
Information about a pipeline.
See: pipelineMetadata smart constructor.
Instances
pipelineMetadata :: PipelineMetadata #
Creates a value of PipelineMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pmCreated- The date and time the pipeline was created, in timestamp format.pmPipelineARN- The Amazon Resource Name (ARN) of the pipeline.pmUpdated- The date and time the pipeline was last updated, in timestamp format.
pmCreated :: Lens' PipelineMetadata (Maybe UTCTime) #
The date and time the pipeline was created, in timestamp format.
pmPipelineARN :: Lens' PipelineMetadata (Maybe Text) #
The Amazon Resource Name (ARN) of the pipeline.
pmUpdated :: Lens' PipelineMetadata (Maybe UTCTime) #
The date and time the pipeline was last updated, in timestamp format.
PipelineSummary
data PipelineSummary #
Returns a summary of a pipeline.
See: pipelineSummary smart constructor.
Instances
pipelineSummary :: PipelineSummary #
Creates a value of PipelineSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psCreated :: Lens' PipelineSummary (Maybe UTCTime) #
The date and time the pipeline was created, in timestamp format.
psUpdated :: Lens' PipelineSummary (Maybe UTCTime) #
The date and time of the last update to the pipeline, in timestamp format.
S3ArtifactLocation
data S3ArtifactLocation #
The location of the Amazon S3 bucket that contains a revision.
See: s3ArtifactLocation smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> S3ArtifactLocation |
Creates a value of S3ArtifactLocation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
salBucketName- The name of the Amazon S3 bucket.salObjectKey- The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.
salBucketName :: Lens' S3ArtifactLocation Text #
The name of the Amazon S3 bucket.
salObjectKey :: Lens' S3ArtifactLocation Text #
The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.
SourceRevision
data SourceRevision #
See: sourceRevision smart constructor.
Instances
Arguments
| :: Text | |
| -> SourceRevision |
Creates a value of SourceRevision with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srRevisionSummary- Undocumented member.srRevisionURL- Undocumented member.srRevisionId- Undocumented member.srActionName- Undocumented member.
srRevisionSummary :: Lens' SourceRevision (Maybe Text) #
Undocumented member.
srRevisionURL :: Lens' SourceRevision (Maybe Text) #
Undocumented member.
srRevisionId :: Lens' SourceRevision (Maybe Text) #
Undocumented member.
srActionName :: Lens' SourceRevision Text #
Undocumented member.
StageContext
data StageContext #
Represents information about a stage to a job worker.
See: stageContext smart constructor.
Instances
stageContext :: StageContext #
Creates a value of StageContext with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scName- The name of the stage.
StageDeclaration
data StageDeclaration #
Represents information about a stage and its definition.
See: stageDeclaration smart constructor.
Instances
Arguments
| :: Text | |
| -> StageDeclaration |
Creates a value of StageDeclaration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdBlockers- Reserved for future use.sdName- The name of the stage.sdActions- The actions included in a stage.
sdBlockers :: Lens' StageDeclaration [BlockerDeclaration] #
Reserved for future use.
sdName :: Lens' StageDeclaration Text #
The name of the stage.
sdActions :: Lens' StageDeclaration [ActionDeclaration] #
The actions included in a stage.
StageExecution
data StageExecution #
Represents information about the run of a stage.
See: stageExecution smart constructor.
Instances
Arguments
| :: Text | |
| -> StageExecutionStatus | |
| -> StageExecution |
Creates a value of StageExecution with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sePipelineExecutionId- The ID of the pipeline execution associated with the stage.seStatus- The status of the stage, or for a completed stage, the last status of the stage.
sePipelineExecutionId :: Lens' StageExecution Text #
The ID of the pipeline execution associated with the stage.
seStatus :: Lens' StageExecution StageExecutionStatus #
The status of the stage, or for a completed stage, the last status of the stage.
StageState
data StageState #
Represents information about the state of the stage.
See: stageState smart constructor.
Instances
Creates a value of StageState with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssInboundTransitionState- The state of the inbound transition, which is either enabled or disabled.ssActionStates- The state of the stage.ssStageName- The name of the stage.ssLatestExecution- Information about the latest execution in the stage, including its ID and status.
ssInboundTransitionState :: Lens' StageState (Maybe TransitionState) #
The state of the inbound transition, which is either enabled or disabled.
ssActionStates :: Lens' StageState [ActionState] #
The state of the stage.
ssStageName :: Lens' StageState (Maybe Text) #
The name of the stage.
ssLatestExecution :: Lens' StageState (Maybe StageExecution) #
Information about the latest execution in the stage, including its ID and status.
ThirdPartyJob
data ThirdPartyJob #
A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked upon by a partner action.
See: thirdPartyJob smart constructor.
Instances
thirdPartyJob :: ThirdPartyJob #
Creates a value of ThirdPartyJob with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpjClientId- The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.tpjJobId- The identifier used to identify the job in AWS CodePipeline.
tpjClientId :: Lens' ThirdPartyJob (Maybe Text) #
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
tpjJobId :: Lens' ThirdPartyJob (Maybe Text) #
The identifier used to identify the job in AWS CodePipeline.
ThirdPartyJobData
data ThirdPartyJobData #
Represents information about the job data for a partner action.
See: thirdPartyJobData smart constructor.
Instances
thirdPartyJobData :: ThirdPartyJobData #
Creates a value of ThirdPartyJobData with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpjdContinuationToken- A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.tpjdOutputArtifacts- The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as MyBuiltApp, or might be defined by the user when the action is created.tpjdArtifactCredentials- 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.tpjdPipelineContext- Represents information about a pipeline to a job worker.tpjdEncryptionKey- The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.tpjdActionTypeId- Represents information about an action type.tpjdInputArtifacts- The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as MyApp, or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.tpjdActionConfiguration- Represents information about an action configuration.
tpjdContinuationToken :: Lens' ThirdPartyJobData (Maybe Text) #
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
tpjdOutputArtifacts :: Lens' ThirdPartyJobData [Artifact] #
The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as MyBuiltApp, or might be defined by the user when the action is created.
tpjdArtifactCredentials :: Lens' ThirdPartyJobData (Maybe AWSSessionCredentials) #
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.
tpjdPipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext) #
Represents information about a pipeline to a job worker.
tpjdEncryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey) #
The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.
tpjdActionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId) #
Represents information about an action type.
tpjdInputArtifacts :: Lens' ThirdPartyJobData [Artifact] #
The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as MyApp, or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
tpjdActionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration) #
Represents information about an action configuration.
ThirdPartyJobDetails
data ThirdPartyJobDetails #
The details of a job sent in response to a GetThirdPartyJobDetails request.
See: thirdPartyJobDetails smart constructor.
Instances
thirdPartyJobDetails :: ThirdPartyJobDetails #
Creates a value of ThirdPartyJobDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpjdData- The data to be returned by the third party job worker.tpjdId- The identifier used to identify the job details in AWS CodePipeline.tpjdNonce- A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in anAcknowledgeThirdPartyJobrequest.
tpjdData :: Lens' ThirdPartyJobDetails (Maybe ThirdPartyJobData) #
The data to be returned by the third party job worker.
tpjdId :: Lens' ThirdPartyJobDetails (Maybe Text) #
The identifier used to identify the job details in AWS CodePipeline.
tpjdNonce :: Lens' ThirdPartyJobDetails (Maybe Text) #
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.
TransitionState
data TransitionState #
Represents information about the state of transitions between one stage and another stage.
See: transitionState smart constructor.
Instances
transitionState :: TransitionState #
Creates a value of TransitionState with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsEnabled- Whether the transition between stages is enabled (true) or disabled (false).tsDisabledReason- The user-specified reason why the transition between two stages of a pipeline was disabled.tsLastChangedAt- The timestamp when the transition state was last changed.tsLastChangedBy- The ID of the user who last changed the transition state.
tsEnabled :: Lens' TransitionState (Maybe Bool) #
Whether the transition between stages is enabled (true) or disabled (false).
tsDisabledReason :: Lens' TransitionState (Maybe Text) #
The user-specified reason why the transition between two stages of a pipeline was disabled.
tsLastChangedAt :: Lens' TransitionState (Maybe UTCTime) #
The timestamp when the transition state was last changed.
tsLastChangedBy :: Lens' TransitionState (Maybe Text) #
The ID of the user who last changed the transition state.
WebhookAuthConfiguration
data WebhookAuthConfiguration #
See: webhookAuthConfiguration smart constructor.
Instances
webhookAuthConfiguration :: WebhookAuthConfiguration #
Creates a value of WebhookAuthConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wacAllowedIPRange- Undocumented member.wacSecretToken- Undocumented member.
wacAllowedIPRange :: Lens' WebhookAuthConfiguration (Maybe Text) #
Undocumented member.
wacSecretToken :: Lens' WebhookAuthConfiguration (Maybe Text) #
Undocumented member.
WebhookDefinition
data WebhookDefinition #
Represents information about a webhook and its definition.
See: webhookDefinition smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> WebhookAuthenticationType | |
| -> WebhookAuthConfiguration | |
| -> WebhookDefinition |
Creates a value of WebhookDefinition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wdName- The name of the webhook.wdTargetPipeline- The name of the pipeline you want to connect to the webhook.wdTargetAction- The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.wdFilters- A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.wdAuthentication- Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED. * GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/ * IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration. * UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.wdAuthenticationConfiguration- Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
wdName :: Lens' WebhookDefinition Text #
The name of the webhook.
wdTargetPipeline :: Lens' WebhookDefinition Text #
The name of the pipeline you want to connect to the webhook.
wdTargetAction :: Lens' WebhookDefinition Text #
The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
wdFilters :: Lens' WebhookDefinition [WebhookFilterRule] #
A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
wdAuthentication :: Lens' WebhookDefinition WebhookAuthenticationType #
Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED. * GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/ * IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration. * UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.
wdAuthenticationConfiguration :: Lens' WebhookDefinition WebhookAuthConfiguration #
Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
WebhookFilterRule
data WebhookFilterRule #
The event criteria that specify when a webhook notification is sent to your URL.
See: webhookFilterRule smart constructor.
Instances
Arguments
| :: Text | |
| -> WebhookFilterRule |
Creates a value of WebhookFilterRule with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wfrMatchEquals- The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refsheads{Branch}" and the target action has an action configuration property called Branch with a value of "master", the MatchEquals value will be evaluated as "refsheadsmaster". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements .wfrJsonPath- A JsonPath expression that will be applied to the bodypayload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https:github.comjson-path/JsonPath.
wfrMatchEquals :: Lens' WebhookFilterRule (Maybe Text) #
The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refsheads{Branch}" and the target action has an action configuration property called Branch with a value of "master", the MatchEquals value will be evaluated as "refsheadsmaster". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements .
wfrJsonPath :: Lens' WebhookFilterRule Text #
A JsonPath expression that will be applied to the bodypayload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https:github.comjson-path/JsonPath.