| Copyright | (c) 2013-2021 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 |
Amazonka.CodePipeline.Types
Contents
- Service Configuration
- Errors
- ActionCategory
- ActionConfigurationPropertyType
- ActionExecutionStatus
- ActionOwner
- ApprovalStatus
- ArtifactLocationType
- ArtifactStoreType
- BlockerType
- EncryptionKeyType
- ExecutorType
- FailureType
- JobStatus
- PipelineExecutionStatus
- StageExecutionStatus
- StageRetryMode
- StageTransitionType
- TriggerType
- WebhookAuthenticationType
- AWSSessionCredentials
- ActionConfiguration
- ActionConfigurationProperty
- ActionContext
- ActionDeclaration
- ActionExecution
- ActionExecutionDetail
- ActionExecutionFilter
- ActionExecutionInput
- ActionExecutionOutput
- ActionExecutionResult
- ActionRevision
- ActionState
- ActionType
- ActionTypeArtifactDetails
- ActionTypeDeclaration
- ActionTypeExecutor
- ActionTypeId
- ActionTypeIdentifier
- ActionTypePermissions
- ActionTypeProperty
- ActionTypeSettings
- ActionTypeUrls
- ApprovalResult
- Artifact
- ArtifactDetail
- ArtifactDetails
- ArtifactLocation
- ArtifactRevision
- ArtifactStore
- BlockerDeclaration
- CurrentRevision
- EncryptionKey
- ErrorDetails
- ExecutionDetails
- ExecutionTrigger
- ExecutorConfiguration
- FailureDetails
- InputArtifact
- Job
- JobData
- JobDetails
- JobWorkerExecutorConfiguration
- LambdaExecutorConfiguration
- ListWebhookItem
- OutputArtifact
- PipelineContext
- PipelineDeclaration
- PipelineExecution
- PipelineExecutionSummary
- PipelineMetadata
- PipelineSummary
- S3ArtifactLocation
- S3Location
- SourceRevision
- StageContext
- StageDeclaration
- StageExecution
- StageState
- StopExecutionTrigger
- Tag
- ThirdPartyJob
- ThirdPartyJobData
- ThirdPartyJobDetails
- TransitionState
- WebhookAuthConfiguration
- WebhookDefinition
- WebhookFilterRule
Description
Synopsis
- defaultService :: 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
- _RequestFailedException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineExecutionNotStoppableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidBlockerDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError
- _OutputVariablesSizeExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: 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
- _InvalidTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ActionTypeAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ActionTypeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStageDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicatedStopRequestException :: 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
- _InvalidArnException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotLatestPipelineExecutionException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype ActionCategory where
- ActionCategory' { }
- pattern ActionCategory_Approval :: ActionCategory
- pattern ActionCategory_Build :: ActionCategory
- pattern ActionCategory_Deploy :: ActionCategory
- pattern ActionCategory_Invoke :: ActionCategory
- pattern ActionCategory_Source :: ActionCategory
- pattern ActionCategory_Test :: ActionCategory
- newtype ActionConfigurationPropertyType where
- newtype ActionExecutionStatus where
- newtype ActionOwner where
- ActionOwner' { }
- pattern ActionOwner_AWS :: ActionOwner
- pattern ActionOwner_Custom :: ActionOwner
- pattern ActionOwner_ThirdParty :: ActionOwner
- newtype ApprovalStatus where
- ApprovalStatus' { }
- pattern ApprovalStatus_Approved :: ApprovalStatus
- pattern ApprovalStatus_Rejected :: ApprovalStatus
- newtype ArtifactLocationType where
- newtype ArtifactStoreType where
- ArtifactStoreType' { }
- pattern ArtifactStoreType_S3 :: ArtifactStoreType
- newtype BlockerType where
- BlockerType' { }
- pattern BlockerType_Schedule :: BlockerType
- newtype EncryptionKeyType where
- EncryptionKeyType' { }
- pattern EncryptionKeyType_KMS :: EncryptionKeyType
- newtype ExecutorType where
- ExecutorType' { }
- pattern ExecutorType_JobWorker :: ExecutorType
- pattern ExecutorType_Lambda :: ExecutorType
- newtype FailureType where
- FailureType' { }
- pattern FailureType_ConfigurationError :: FailureType
- pattern FailureType_JobFailed :: FailureType
- pattern FailureType_PermissionError :: FailureType
- pattern FailureType_RevisionOutOfSync :: FailureType
- pattern FailureType_RevisionUnavailable :: FailureType
- pattern FailureType_SystemUnavailable :: FailureType
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_Created :: JobStatus
- pattern JobStatus_Dispatched :: JobStatus
- pattern JobStatus_Failed :: JobStatus
- pattern JobStatus_InProgress :: JobStatus
- pattern JobStatus_Queued :: JobStatus
- pattern JobStatus_Succeeded :: JobStatus
- pattern JobStatus_TimedOut :: JobStatus
- newtype PipelineExecutionStatus where
- PipelineExecutionStatus' { }
- pattern PipelineExecutionStatus_Cancelled :: PipelineExecutionStatus
- pattern PipelineExecutionStatus_Failed :: PipelineExecutionStatus
- pattern PipelineExecutionStatus_InProgress :: PipelineExecutionStatus
- pattern PipelineExecutionStatus_Stopped :: PipelineExecutionStatus
- pattern PipelineExecutionStatus_Stopping :: PipelineExecutionStatus
- pattern PipelineExecutionStatus_Succeeded :: PipelineExecutionStatus
- pattern PipelineExecutionStatus_Superseded :: PipelineExecutionStatus
- newtype StageExecutionStatus where
- StageExecutionStatus' { }
- pattern StageExecutionStatus_Cancelled :: StageExecutionStatus
- pattern StageExecutionStatus_Failed :: StageExecutionStatus
- pattern StageExecutionStatus_InProgress :: StageExecutionStatus
- pattern StageExecutionStatus_Stopped :: StageExecutionStatus
- pattern StageExecutionStatus_Stopping :: StageExecutionStatus
- pattern StageExecutionStatus_Succeeded :: StageExecutionStatus
- newtype StageRetryMode where
- StageRetryMode' { }
- pattern StageRetryMode_FAILED_ACTIONS :: StageRetryMode
- newtype StageTransitionType where
- newtype TriggerType where
- TriggerType' { }
- pattern TriggerType_CloudWatchEvent :: TriggerType
- pattern TriggerType_CreatePipeline :: TriggerType
- pattern TriggerType_PollForSourceChanges :: TriggerType
- pattern TriggerType_PutActionRevision :: TriggerType
- pattern TriggerType_StartPipelineExecution :: TriggerType
- pattern TriggerType_Webhook :: TriggerType
- newtype WebhookAuthenticationType where
- data AWSSessionCredentials = AWSSessionCredentials' {}
- newAWSSessionCredentials :: Text -> Text -> Text -> AWSSessionCredentials
- aWSSessionCredentials_accessKeyId :: Lens' AWSSessionCredentials Text
- aWSSessionCredentials_secretAccessKey :: Lens' AWSSessionCredentials Text
- aWSSessionCredentials_sessionToken :: Lens' AWSSessionCredentials Text
- data ActionConfiguration = ActionConfiguration' {
- configuration :: Maybe (HashMap Text Text)
- newActionConfiguration :: ActionConfiguration
- actionConfiguration_configuration :: Lens' ActionConfiguration (Maybe (HashMap Text Text))
- data ActionConfigurationProperty = ActionConfigurationProperty' {}
- newActionConfigurationProperty :: Text -> Bool -> Bool -> Bool -> ActionConfigurationProperty
- actionConfigurationProperty_queryable :: Lens' ActionConfigurationProperty (Maybe Bool)
- actionConfigurationProperty_type :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType)
- actionConfigurationProperty_description :: Lens' ActionConfigurationProperty (Maybe Text)
- actionConfigurationProperty_name :: Lens' ActionConfigurationProperty Text
- actionConfigurationProperty_required :: Lens' ActionConfigurationProperty Bool
- actionConfigurationProperty_key :: Lens' ActionConfigurationProperty Bool
- actionConfigurationProperty_secret :: Lens' ActionConfigurationProperty Bool
- data ActionContext = ActionContext' {}
- newActionContext :: ActionContext
- actionContext_name :: Lens' ActionContext (Maybe Text)
- actionContext_actionExecutionId :: Lens' ActionContext (Maybe Text)
- data ActionDeclaration = ActionDeclaration' {
- outputArtifacts :: Maybe [OutputArtifact]
- namespace :: Maybe Text
- runOrder :: Maybe Natural
- region :: Maybe Text
- configuration :: Maybe (HashMap Text Text)
- inputArtifacts :: Maybe [InputArtifact]
- roleArn :: Maybe Text
- name :: Text
- actionTypeId :: ActionTypeId
- newActionDeclaration :: Text -> ActionTypeId -> ActionDeclaration
- actionDeclaration_outputArtifacts :: Lens' ActionDeclaration (Maybe [OutputArtifact])
- actionDeclaration_namespace :: Lens' ActionDeclaration (Maybe Text)
- actionDeclaration_runOrder :: Lens' ActionDeclaration (Maybe Natural)
- actionDeclaration_region :: Lens' ActionDeclaration (Maybe Text)
- actionDeclaration_configuration :: Lens' ActionDeclaration (Maybe (HashMap Text Text))
- actionDeclaration_inputArtifacts :: Lens' ActionDeclaration (Maybe [InputArtifact])
- actionDeclaration_roleArn :: Lens' ActionDeclaration (Maybe Text)
- actionDeclaration_name :: Lens' ActionDeclaration Text
- actionDeclaration_actionTypeId :: Lens' ActionDeclaration ActionTypeId
- data ActionExecution = ActionExecution' {}
- newActionExecution :: ActionExecution
- actionExecution_lastUpdatedBy :: Lens' ActionExecution (Maybe Text)
- actionExecution_summary :: Lens' ActionExecution (Maybe Text)
- actionExecution_status :: Lens' ActionExecution (Maybe ActionExecutionStatus)
- actionExecution_lastStatusChange :: Lens' ActionExecution (Maybe UTCTime)
- actionExecution_token :: Lens' ActionExecution (Maybe Text)
- actionExecution_externalExecutionUrl :: Lens' ActionExecution (Maybe Text)
- actionExecution_externalExecutionId :: Lens' ActionExecution (Maybe Text)
- actionExecution_errorDetails :: Lens' ActionExecution (Maybe ErrorDetails)
- actionExecution_percentComplete :: Lens' ActionExecution (Maybe Natural)
- actionExecution_actionExecutionId :: Lens' ActionExecution (Maybe Text)
- data ActionExecutionDetail = ActionExecutionDetail' {
- status :: Maybe ActionExecutionStatus
- startTime :: Maybe POSIX
- pipelineVersion :: Maybe Natural
- input :: Maybe ActionExecutionInput
- actionName :: Maybe Text
- output :: Maybe ActionExecutionOutput
- pipelineExecutionId :: Maybe Text
- stageName :: Maybe Text
- lastUpdateTime :: Maybe POSIX
- actionExecutionId :: Maybe Text
- newActionExecutionDetail :: ActionExecutionDetail
- actionExecutionDetail_status :: Lens' ActionExecutionDetail (Maybe ActionExecutionStatus)
- actionExecutionDetail_startTime :: Lens' ActionExecutionDetail (Maybe UTCTime)
- actionExecutionDetail_pipelineVersion :: Lens' ActionExecutionDetail (Maybe Natural)
- actionExecutionDetail_input :: Lens' ActionExecutionDetail (Maybe ActionExecutionInput)
- actionExecutionDetail_actionName :: Lens' ActionExecutionDetail (Maybe Text)
- actionExecutionDetail_output :: Lens' ActionExecutionDetail (Maybe ActionExecutionOutput)
- actionExecutionDetail_pipelineExecutionId :: Lens' ActionExecutionDetail (Maybe Text)
- actionExecutionDetail_stageName :: Lens' ActionExecutionDetail (Maybe Text)
- actionExecutionDetail_lastUpdateTime :: Lens' ActionExecutionDetail (Maybe UTCTime)
- actionExecutionDetail_actionExecutionId :: Lens' ActionExecutionDetail (Maybe Text)
- data ActionExecutionFilter = ActionExecutionFilter' {}
- newActionExecutionFilter :: ActionExecutionFilter
- actionExecutionFilter_pipelineExecutionId :: Lens' ActionExecutionFilter (Maybe Text)
- data ActionExecutionInput = ActionExecutionInput' {}
- newActionExecutionInput :: ActionExecutionInput
- actionExecutionInput_namespace :: Lens' ActionExecutionInput (Maybe Text)
- actionExecutionInput_resolvedConfiguration :: Lens' ActionExecutionInput (Maybe (HashMap Text Text))
- actionExecutionInput_region :: Lens' ActionExecutionInput (Maybe Text)
- actionExecutionInput_configuration :: Lens' ActionExecutionInput (Maybe (HashMap Text Text))
- actionExecutionInput_actionTypeId :: Lens' ActionExecutionInput (Maybe ActionTypeId)
- actionExecutionInput_inputArtifacts :: Lens' ActionExecutionInput (Maybe [ArtifactDetail])
- actionExecutionInput_roleArn :: Lens' ActionExecutionInput (Maybe Text)
- data ActionExecutionOutput = ActionExecutionOutput' {}
- newActionExecutionOutput :: ActionExecutionOutput
- actionExecutionOutput_outputVariables :: Lens' ActionExecutionOutput (Maybe (HashMap Text Text))
- actionExecutionOutput_outputArtifacts :: Lens' ActionExecutionOutput (Maybe [ArtifactDetail])
- actionExecutionOutput_executionResult :: Lens' ActionExecutionOutput (Maybe ActionExecutionResult)
- data ActionExecutionResult = ActionExecutionResult' {}
- newActionExecutionResult :: ActionExecutionResult
- actionExecutionResult_externalExecutionUrl :: Lens' ActionExecutionResult (Maybe Text)
- actionExecutionResult_externalExecutionId :: Lens' ActionExecutionResult (Maybe Text)
- actionExecutionResult_externalExecutionSummary :: Lens' ActionExecutionResult (Maybe Text)
- data ActionRevision = ActionRevision' {
- revisionId :: Text
- revisionChangeId :: Text
- created :: POSIX
- newActionRevision :: Text -> Text -> UTCTime -> ActionRevision
- actionRevision_revisionId :: Lens' ActionRevision Text
- actionRevision_revisionChangeId :: Lens' ActionRevision Text
- actionRevision_created :: Lens' ActionRevision UTCTime
- data ActionState = ActionState' {}
- newActionState :: ActionState
- actionState_revisionUrl :: Lens' ActionState (Maybe Text)
- actionState_entityUrl :: Lens' ActionState (Maybe Text)
- actionState_actionName :: Lens' ActionState (Maybe Text)
- actionState_currentRevision :: Lens' ActionState (Maybe ActionRevision)
- actionState_latestExecution :: Lens' ActionState (Maybe ActionExecution)
- data ActionType = ActionType' {}
- newActionType :: ActionTypeId -> ArtifactDetails -> ArtifactDetails -> ActionType
- actionType_settings :: Lens' ActionType (Maybe ActionTypeSettings)
- actionType_actionConfigurationProperties :: Lens' ActionType (Maybe [ActionConfigurationProperty])
- actionType_id :: Lens' ActionType ActionTypeId
- actionType_inputArtifactDetails :: Lens' ActionType ArtifactDetails
- actionType_outputArtifactDetails :: Lens' ActionType ArtifactDetails
- data ActionTypeArtifactDetails = ActionTypeArtifactDetails' {}
- newActionTypeArtifactDetails :: Natural -> Natural -> ActionTypeArtifactDetails
- actionTypeArtifactDetails_minimumCount :: Lens' ActionTypeArtifactDetails Natural
- actionTypeArtifactDetails_maximumCount :: Lens' ActionTypeArtifactDetails Natural
- data ActionTypeDeclaration = ActionTypeDeclaration' {}
- newActionTypeDeclaration :: ActionTypeExecutor -> ActionTypeIdentifier -> ActionTypeArtifactDetails -> ActionTypeArtifactDetails -> ActionTypeDeclaration
- actionTypeDeclaration_urls :: Lens' ActionTypeDeclaration (Maybe ActionTypeUrls)
- actionTypeDeclaration_permissions :: Lens' ActionTypeDeclaration (Maybe ActionTypePermissions)
- actionTypeDeclaration_description :: Lens' ActionTypeDeclaration (Maybe Text)
- actionTypeDeclaration_properties :: Lens' ActionTypeDeclaration (Maybe [ActionTypeProperty])
- actionTypeDeclaration_executor :: Lens' ActionTypeDeclaration ActionTypeExecutor
- actionTypeDeclaration_id :: Lens' ActionTypeDeclaration ActionTypeIdentifier
- actionTypeDeclaration_inputArtifactDetails :: Lens' ActionTypeDeclaration ActionTypeArtifactDetails
- actionTypeDeclaration_outputArtifactDetails :: Lens' ActionTypeDeclaration ActionTypeArtifactDetails
- data ActionTypeExecutor = ActionTypeExecutor' {}
- newActionTypeExecutor :: ExecutorConfiguration -> ExecutorType -> ActionTypeExecutor
- actionTypeExecutor_jobTimeout :: Lens' ActionTypeExecutor (Maybe Natural)
- actionTypeExecutor_policyStatementsTemplate :: Lens' ActionTypeExecutor (Maybe Text)
- actionTypeExecutor_configuration :: Lens' ActionTypeExecutor ExecutorConfiguration
- actionTypeExecutor_type :: Lens' ActionTypeExecutor ExecutorType
- data ActionTypeId = ActionTypeId' {
- category :: ActionCategory
- owner :: ActionOwner
- provider :: Text
- version :: Text
- newActionTypeId :: ActionCategory -> ActionOwner -> Text -> Text -> ActionTypeId
- actionTypeId_category :: Lens' ActionTypeId ActionCategory
- actionTypeId_owner :: Lens' ActionTypeId ActionOwner
- actionTypeId_provider :: Lens' ActionTypeId Text
- actionTypeId_version :: Lens' ActionTypeId Text
- data ActionTypeIdentifier = ActionTypeIdentifier' {}
- newActionTypeIdentifier :: ActionCategory -> Text -> Text -> Text -> ActionTypeIdentifier
- actionTypeIdentifier_category :: Lens' ActionTypeIdentifier ActionCategory
- actionTypeIdentifier_owner :: Lens' ActionTypeIdentifier Text
- actionTypeIdentifier_provider :: Lens' ActionTypeIdentifier Text
- actionTypeIdentifier_version :: Lens' ActionTypeIdentifier Text
- data ActionTypePermissions = ActionTypePermissions' {}
- newActionTypePermissions :: NonEmpty Text -> ActionTypePermissions
- actionTypePermissions_allowedAccounts :: Lens' ActionTypePermissions (NonEmpty Text)
- data ActionTypeProperty = ActionTypeProperty' {}
- newActionTypeProperty :: Text -> Bool -> Bool -> Bool -> ActionTypeProperty
- actionTypeProperty_queryable :: Lens' ActionTypeProperty (Maybe Bool)
- actionTypeProperty_description :: Lens' ActionTypeProperty (Maybe Text)
- actionTypeProperty_name :: Lens' ActionTypeProperty Text
- actionTypeProperty_optional :: Lens' ActionTypeProperty Bool
- actionTypeProperty_key :: Lens' ActionTypeProperty Bool
- actionTypeProperty_noEcho :: Lens' ActionTypeProperty Bool
- data ActionTypeSettings = ActionTypeSettings' {}
- newActionTypeSettings :: ActionTypeSettings
- actionTypeSettings_thirdPartyConfigurationUrl :: Lens' ActionTypeSettings (Maybe Text)
- actionTypeSettings_executionUrlTemplate :: Lens' ActionTypeSettings (Maybe Text)
- actionTypeSettings_revisionUrlTemplate :: Lens' ActionTypeSettings (Maybe Text)
- actionTypeSettings_entityUrlTemplate :: Lens' ActionTypeSettings (Maybe Text)
- data ActionTypeUrls = ActionTypeUrls' {}
- newActionTypeUrls :: ActionTypeUrls
- actionTypeUrls_executionUrlTemplate :: Lens' ActionTypeUrls (Maybe Text)
- actionTypeUrls_revisionUrlTemplate :: Lens' ActionTypeUrls (Maybe Text)
- actionTypeUrls_entityUrlTemplate :: Lens' ActionTypeUrls (Maybe Text)
- actionTypeUrls_configurationUrl :: Lens' ActionTypeUrls (Maybe Text)
- data ApprovalResult = ApprovalResult' {
- summary :: Text
- status :: ApprovalStatus
- newApprovalResult :: Text -> ApprovalStatus -> ApprovalResult
- approvalResult_summary :: Lens' ApprovalResult Text
- approvalResult_status :: Lens' ApprovalResult ApprovalStatus
- data Artifact = Artifact' {}
- newArtifact :: Artifact
- artifact_location :: Lens' Artifact (Maybe ArtifactLocation)
- artifact_name :: Lens' Artifact (Maybe Text)
- artifact_revision :: Lens' Artifact (Maybe Text)
- data ArtifactDetail = ArtifactDetail' {
- name :: Maybe Text
- s3location :: Maybe S3Location
- newArtifactDetail :: ArtifactDetail
- artifactDetail_name :: Lens' ArtifactDetail (Maybe Text)
- artifactDetail_s3location :: Lens' ArtifactDetail (Maybe S3Location)
- data ArtifactDetails = ArtifactDetails' {}
- newArtifactDetails :: Natural -> Natural -> ArtifactDetails
- artifactDetails_minimumCount :: Lens' ArtifactDetails Natural
- artifactDetails_maximumCount :: Lens' ArtifactDetails Natural
- data ArtifactLocation = ArtifactLocation' {}
- newArtifactLocation :: ArtifactLocation
- artifactLocation_s3Location :: Lens' ArtifactLocation (Maybe S3ArtifactLocation)
- artifactLocation_type :: Lens' ArtifactLocation (Maybe ArtifactLocationType)
- data ArtifactRevision = ArtifactRevision' {}
- newArtifactRevision :: ArtifactRevision
- artifactRevision_revisionSummary :: Lens' ArtifactRevision (Maybe Text)
- artifactRevision_revisionUrl :: Lens' ArtifactRevision (Maybe Text)
- artifactRevision_created :: Lens' ArtifactRevision (Maybe UTCTime)
- artifactRevision_name :: Lens' ArtifactRevision (Maybe Text)
- artifactRevision_revisionId :: Lens' ArtifactRevision (Maybe Text)
- artifactRevision_revisionChangeIdentifier :: Lens' ArtifactRevision (Maybe Text)
- data ArtifactStore = ArtifactStore' {}
- newArtifactStore :: ArtifactStoreType -> Text -> ArtifactStore
- artifactStore_encryptionKey :: Lens' ArtifactStore (Maybe EncryptionKey)
- artifactStore_type :: Lens' ArtifactStore ArtifactStoreType
- artifactStore_location :: Lens' ArtifactStore Text
- data BlockerDeclaration = BlockerDeclaration' {
- name :: Text
- type' :: BlockerType
- newBlockerDeclaration :: Text -> BlockerType -> BlockerDeclaration
- blockerDeclaration_name :: Lens' BlockerDeclaration Text
- blockerDeclaration_type :: Lens' BlockerDeclaration BlockerType
- data CurrentRevision = CurrentRevision' {}
- newCurrentRevision :: Text -> Text -> CurrentRevision
- currentRevision_revisionSummary :: Lens' CurrentRevision (Maybe Text)
- currentRevision_created :: Lens' CurrentRevision (Maybe UTCTime)
- currentRevision_revision :: Lens' CurrentRevision Text
- currentRevision_changeIdentifier :: Lens' CurrentRevision Text
- data EncryptionKey = EncryptionKey' {
- id :: Text
- type' :: EncryptionKeyType
- newEncryptionKey :: Text -> EncryptionKeyType -> EncryptionKey
- encryptionKey_id :: Lens' EncryptionKey Text
- encryptionKey_type :: Lens' EncryptionKey EncryptionKeyType
- data ErrorDetails = ErrorDetails' {}
- newErrorDetails :: ErrorDetails
- errorDetails_code :: Lens' ErrorDetails (Maybe Text)
- errorDetails_message :: Lens' ErrorDetails (Maybe Text)
- data ExecutionDetails = ExecutionDetails' {}
- newExecutionDetails :: ExecutionDetails
- executionDetails_summary :: Lens' ExecutionDetails (Maybe Text)
- executionDetails_externalExecutionId :: Lens' ExecutionDetails (Maybe Text)
- executionDetails_percentComplete :: Lens' ExecutionDetails (Maybe Natural)
- data ExecutionTrigger = ExecutionTrigger' {}
- newExecutionTrigger :: ExecutionTrigger
- executionTrigger_triggerType :: Lens' ExecutionTrigger (Maybe TriggerType)
- executionTrigger_triggerDetail :: Lens' ExecutionTrigger (Maybe Text)
- data ExecutorConfiguration = ExecutorConfiguration' {}
- newExecutorConfiguration :: ExecutorConfiguration
- executorConfiguration_lambdaExecutorConfiguration :: Lens' ExecutorConfiguration (Maybe LambdaExecutorConfiguration)
- executorConfiguration_jobWorkerExecutorConfiguration :: Lens' ExecutorConfiguration (Maybe JobWorkerExecutorConfiguration)
- data FailureDetails = FailureDetails' {}
- newFailureDetails :: FailureType -> Text -> FailureDetails
- failureDetails_externalExecutionId :: Lens' FailureDetails (Maybe Text)
- failureDetails_type :: Lens' FailureDetails FailureType
- failureDetails_message :: Lens' FailureDetails Text
- data InputArtifact = InputArtifact' {}
- newInputArtifact :: Text -> InputArtifact
- inputArtifact_name :: Lens' InputArtifact Text
- data Job = Job' {}
- newJob :: Job
- job_data :: Lens' Job (Maybe JobData)
- job_accountId :: Lens' Job (Maybe Text)
- job_id :: Lens' Job (Maybe Text)
- job_nonce :: Lens' Job (Maybe Text)
- data JobData = JobData' {
- continuationToken :: Maybe Text
- outputArtifacts :: Maybe [Artifact]
- artifactCredentials :: Maybe (Sensitive AWSSessionCredentials)
- pipelineContext :: Maybe PipelineContext
- encryptionKey :: Maybe EncryptionKey
- actionTypeId :: Maybe ActionTypeId
- inputArtifacts :: Maybe [Artifact]
- actionConfiguration :: Maybe ActionConfiguration
- newJobData :: JobData
- jobData_continuationToken :: Lens' JobData (Maybe Text)
- jobData_outputArtifacts :: Lens' JobData (Maybe [Artifact])
- jobData_artifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials)
- jobData_pipelineContext :: Lens' JobData (Maybe PipelineContext)
- jobData_encryptionKey :: Lens' JobData (Maybe EncryptionKey)
- jobData_actionTypeId :: Lens' JobData (Maybe ActionTypeId)
- jobData_inputArtifacts :: Lens' JobData (Maybe [Artifact])
- jobData_actionConfiguration :: Lens' JobData (Maybe ActionConfiguration)
- data JobDetails = JobDetails' {}
- newJobDetails :: JobDetails
- jobDetails_data :: Lens' JobDetails (Maybe JobData)
- jobDetails_accountId :: Lens' JobDetails (Maybe Text)
- jobDetails_id :: Lens' JobDetails (Maybe Text)
- data JobWorkerExecutorConfiguration = JobWorkerExecutorConfiguration' {}
- newJobWorkerExecutorConfiguration :: JobWorkerExecutorConfiguration
- jobWorkerExecutorConfiguration_pollingAccounts :: Lens' JobWorkerExecutorConfiguration (Maybe (NonEmpty Text))
- jobWorkerExecutorConfiguration_pollingServicePrincipals :: Lens' JobWorkerExecutorConfiguration (Maybe (NonEmpty Text))
- data LambdaExecutorConfiguration = LambdaExecutorConfiguration' {}
- newLambdaExecutorConfiguration :: Text -> LambdaExecutorConfiguration
- lambdaExecutorConfiguration_lambdaFunctionArn :: Lens' LambdaExecutorConfiguration Text
- data ListWebhookItem = ListWebhookItem' {
- arn :: Maybe Text
- errorCode :: Maybe Text
- lastTriggered :: Maybe POSIX
- errorMessage :: Maybe Text
- tags :: Maybe [Tag]
- definition :: WebhookDefinition
- url :: Text
- newListWebhookItem :: WebhookDefinition -> Text -> ListWebhookItem
- listWebhookItem_arn :: Lens' ListWebhookItem (Maybe Text)
- listWebhookItem_errorCode :: Lens' ListWebhookItem (Maybe Text)
- listWebhookItem_lastTriggered :: Lens' ListWebhookItem (Maybe UTCTime)
- listWebhookItem_errorMessage :: Lens' ListWebhookItem (Maybe Text)
- listWebhookItem_tags :: Lens' ListWebhookItem (Maybe [Tag])
- listWebhookItem_definition :: Lens' ListWebhookItem WebhookDefinition
- listWebhookItem_url :: Lens' ListWebhookItem Text
- data OutputArtifact = OutputArtifact' {}
- newOutputArtifact :: Text -> OutputArtifact
- outputArtifact_name :: Lens' OutputArtifact Text
- data PipelineContext = PipelineContext' {}
- newPipelineContext :: PipelineContext
- pipelineContext_stage :: Lens' PipelineContext (Maybe StageContext)
- pipelineContext_pipelineName :: Lens' PipelineContext (Maybe Text)
- pipelineContext_action :: Lens' PipelineContext (Maybe ActionContext)
- pipelineContext_pipelineArn :: Lens' PipelineContext (Maybe Text)
- pipelineContext_pipelineExecutionId :: Lens' PipelineContext (Maybe Text)
- data PipelineDeclaration = PipelineDeclaration' {}
- newPipelineDeclaration :: Text -> Text -> PipelineDeclaration
- pipelineDeclaration_artifactStores :: Lens' PipelineDeclaration (Maybe (HashMap Text ArtifactStore))
- pipelineDeclaration_artifactStore :: Lens' PipelineDeclaration (Maybe ArtifactStore)
- pipelineDeclaration_version :: Lens' PipelineDeclaration (Maybe Natural)
- pipelineDeclaration_name :: Lens' PipelineDeclaration Text
- pipelineDeclaration_roleArn :: Lens' PipelineDeclaration Text
- pipelineDeclaration_stages :: Lens' PipelineDeclaration [StageDeclaration]
- data PipelineExecution = PipelineExecution' {}
- newPipelineExecution :: PipelineExecution
- pipelineExecution_status :: Lens' PipelineExecution (Maybe PipelineExecutionStatus)
- pipelineExecution_pipelineName :: Lens' PipelineExecution (Maybe Text)
- pipelineExecution_statusSummary :: Lens' PipelineExecution (Maybe Text)
- pipelineExecution_pipelineVersion :: Lens' PipelineExecution (Maybe Natural)
- pipelineExecution_pipelineExecutionId :: Lens' PipelineExecution (Maybe Text)
- pipelineExecution_artifactRevisions :: Lens' PipelineExecution (Maybe [ArtifactRevision])
- data PipelineExecutionSummary = PipelineExecutionSummary' {}
- newPipelineExecutionSummary :: PipelineExecutionSummary
- pipelineExecutionSummary_status :: Lens' PipelineExecutionSummary (Maybe PipelineExecutionStatus)
- pipelineExecutionSummary_startTime :: Lens' PipelineExecutionSummary (Maybe UTCTime)
- pipelineExecutionSummary_stopTrigger :: Lens' PipelineExecutionSummary (Maybe StopExecutionTrigger)
- pipelineExecutionSummary_pipelineExecutionId :: Lens' PipelineExecutionSummary (Maybe Text)
- pipelineExecutionSummary_sourceRevisions :: Lens' PipelineExecutionSummary (Maybe [SourceRevision])
- pipelineExecutionSummary_trigger :: Lens' PipelineExecutionSummary (Maybe ExecutionTrigger)
- pipelineExecutionSummary_lastUpdateTime :: Lens' PipelineExecutionSummary (Maybe UTCTime)
- data PipelineMetadata = PipelineMetadata' {}
- newPipelineMetadata :: PipelineMetadata
- pipelineMetadata_created :: Lens' PipelineMetadata (Maybe UTCTime)
- pipelineMetadata_pipelineArn :: Lens' PipelineMetadata (Maybe Text)
- pipelineMetadata_updated :: Lens' PipelineMetadata (Maybe UTCTime)
- data PipelineSummary = PipelineSummary' {}
- newPipelineSummary :: PipelineSummary
- pipelineSummary_created :: Lens' PipelineSummary (Maybe UTCTime)
- pipelineSummary_name :: Lens' PipelineSummary (Maybe Text)
- pipelineSummary_version :: Lens' PipelineSummary (Maybe Natural)
- pipelineSummary_updated :: Lens' PipelineSummary (Maybe UTCTime)
- data S3ArtifactLocation = S3ArtifactLocation' {
- bucketName :: Text
- objectKey :: Text
- newS3ArtifactLocation :: Text -> Text -> S3ArtifactLocation
- s3ArtifactLocation_bucketName :: Lens' S3ArtifactLocation Text
- s3ArtifactLocation_objectKey :: Lens' S3ArtifactLocation Text
- data S3Location = S3Location' {}
- newS3Location :: S3Location
- s3Location_bucket :: Lens' S3Location (Maybe Text)
- s3Location_key :: Lens' S3Location (Maybe Text)
- data SourceRevision = SourceRevision' {}
- newSourceRevision :: Text -> SourceRevision
- sourceRevision_revisionSummary :: Lens' SourceRevision (Maybe Text)
- sourceRevision_revisionUrl :: Lens' SourceRevision (Maybe Text)
- sourceRevision_revisionId :: Lens' SourceRevision (Maybe Text)
- sourceRevision_actionName :: Lens' SourceRevision Text
- data StageContext = StageContext' {}
- newStageContext :: StageContext
- stageContext_name :: Lens' StageContext (Maybe Text)
- data StageDeclaration = StageDeclaration' {
- blockers :: Maybe [BlockerDeclaration]
- name :: Text
- actions :: [ActionDeclaration]
- newStageDeclaration :: Text -> StageDeclaration
- stageDeclaration_blockers :: Lens' StageDeclaration (Maybe [BlockerDeclaration])
- stageDeclaration_name :: Lens' StageDeclaration Text
- stageDeclaration_actions :: Lens' StageDeclaration [ActionDeclaration]
- data StageExecution = StageExecution' {}
- newStageExecution :: Text -> StageExecutionStatus -> StageExecution
- stageExecution_pipelineExecutionId :: Lens' StageExecution Text
- stageExecution_status :: Lens' StageExecution StageExecutionStatus
- data StageState = StageState' {}
- newStageState :: StageState
- stageState_inboundExecution :: Lens' StageState (Maybe StageExecution)
- stageState_inboundTransitionState :: Lens' StageState (Maybe TransitionState)
- stageState_actionStates :: Lens' StageState (Maybe [ActionState])
- stageState_stageName :: Lens' StageState (Maybe Text)
- stageState_latestExecution :: Lens' StageState (Maybe StageExecution)
- data StopExecutionTrigger = StopExecutionTrigger' {}
- newStopExecutionTrigger :: StopExecutionTrigger
- stopExecutionTrigger_reason :: Lens' StopExecutionTrigger (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data ThirdPartyJob = ThirdPartyJob' {}
- newThirdPartyJob :: ThirdPartyJob
- thirdPartyJob_clientId :: Lens' ThirdPartyJob (Maybe Text)
- thirdPartyJob_jobId :: Lens' ThirdPartyJob (Maybe Text)
- data ThirdPartyJobData = ThirdPartyJobData' {
- continuationToken :: Maybe Text
- outputArtifacts :: Maybe [Artifact]
- artifactCredentials :: Maybe (Sensitive AWSSessionCredentials)
- pipelineContext :: Maybe PipelineContext
- encryptionKey :: Maybe EncryptionKey
- actionTypeId :: Maybe ActionTypeId
- inputArtifacts :: Maybe [Artifact]
- actionConfiguration :: Maybe ActionConfiguration
- newThirdPartyJobData :: ThirdPartyJobData
- thirdPartyJobData_continuationToken :: Lens' ThirdPartyJobData (Maybe Text)
- thirdPartyJobData_outputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact])
- thirdPartyJobData_artifactCredentials :: Lens' ThirdPartyJobData (Maybe AWSSessionCredentials)
- thirdPartyJobData_pipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext)
- thirdPartyJobData_encryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey)
- thirdPartyJobData_actionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId)
- thirdPartyJobData_inputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact])
- thirdPartyJobData_actionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration)
- data ThirdPartyJobDetails = ThirdPartyJobDetails' {}
- newThirdPartyJobDetails :: ThirdPartyJobDetails
- thirdPartyJobDetails_data :: Lens' ThirdPartyJobDetails (Maybe ThirdPartyJobData)
- thirdPartyJobDetails_id :: Lens' ThirdPartyJobDetails (Maybe Text)
- thirdPartyJobDetails_nonce :: Lens' ThirdPartyJobDetails (Maybe Text)
- data TransitionState = TransitionState' {}
- newTransitionState :: TransitionState
- transitionState_enabled :: Lens' TransitionState (Maybe Bool)
- transitionState_disabledReason :: Lens' TransitionState (Maybe Text)
- transitionState_lastChangedAt :: Lens' TransitionState (Maybe UTCTime)
- transitionState_lastChangedBy :: Lens' TransitionState (Maybe Text)
- data WebhookAuthConfiguration = WebhookAuthConfiguration' {}
- newWebhookAuthConfiguration :: WebhookAuthConfiguration
- webhookAuthConfiguration_allowedIPRange :: Lens' WebhookAuthConfiguration (Maybe Text)
- webhookAuthConfiguration_secretToken :: Lens' WebhookAuthConfiguration (Maybe Text)
- data WebhookDefinition = WebhookDefinition' {}
- newWebhookDefinition :: Text -> Text -> Text -> WebhookAuthenticationType -> WebhookAuthConfiguration -> WebhookDefinition
- webhookDefinition_name :: Lens' WebhookDefinition Text
- webhookDefinition_targetPipeline :: Lens' WebhookDefinition Text
- webhookDefinition_targetAction :: Lens' WebhookDefinition Text
- webhookDefinition_filters :: Lens' WebhookDefinition [WebhookFilterRule]
- webhookDefinition_authentication :: Lens' WebhookDefinition WebhookAuthenticationType
- webhookDefinition_authenticationConfiguration :: Lens' WebhookDefinition WebhookAuthConfiguration
- data WebhookFilterRule = WebhookFilterRule' {
- matchEquals :: Maybe Text
- jsonPath :: Text
- newWebhookFilterRule :: Text -> WebhookFilterRule
- webhookFilterRule_matchEquals :: Lens' WebhookFilterRule (Maybe Text)
- webhookFilterRule_jsonPath :: Lens' WebhookFilterRule Text
Service Configuration
defaultService :: Service Source #
API version 2015-07-09 of the Amazon CodePipeline SDK configuration.
Errors
_InvalidClientTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client token was specified in an invalid format
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The validation was specified in an invalid format.
_InvalidNonceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The nonce was specified in an invalid format.
_ActionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified action cannot be found.
_InvalidApprovalTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The approval request already received a response or has expired.
_RequestFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed because of an unknown error, exception, or failure.
_PipelineExecutionNotStoppableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Unable to stop the pipeline execution. The execution might already be in
a Stopped state, or it might no longer be in progress.
_InvalidBlockerDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Reserved for future use.
_OutputVariablesSizeExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exceeded the total size limit for all variables in the pipeline.
_InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The job state was specified in an invalid format.
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The tags limit for a resource has been exceeded.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
_InvalidJobException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The job was specified in an invalid format or cannot be found.
_PipelineVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pipeline version was specified in an invalid format or cannot be found.
_StageNotRetryableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.
_PipelineExecutionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
_InvalidWebhookAuthenticationParametersException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified authentication type is in an invalid format.
_WebhookNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified webhook was entered in an invalid format or cannot be found.
_InvalidTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource tags are invalid.
_ActionTypeAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified action type already exists with a different definition.
_ActionTypeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified action type cannot be found.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Unable to modify the tag due to a simultaneous update request.
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
_InvalidStageDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The stage declaration was specified in an invalid format.
_DuplicatedStopRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pipeline execution is already in a Stopping state. If you already
chose to stop and wait, you cannot make that request again. You can
choose to stop and abandon now, but be aware that this option can lead
to failed tasks or out of sequence tasks. If you already chose to stop
and abandon, you cannot make that request again.
_InvalidWebhookFilterPatternException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified event filter rule is in an invalid format.
_InvalidActionDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The action declaration was specified in an invalid format.
_StageNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The stage was specified in an invalid format or cannot be found.
_InvalidStructureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The structure was specified in an invalid format.
_JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The job was specified in an invalid format or cannot be found.
_ApprovalAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The approval action has already been approved or rejected.
_InvalidArnException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource ARN is invalid.
_PipelineNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pipeline name is already in use.
_PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pipeline was specified in an invalid format or cannot be found.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource was specified in an invalid format.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
_NotLatestPipelineExecutionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.
ActionCategory
newtype ActionCategory Source #
Constructors
| ActionCategory' | |
Fields | |
Bundled Patterns
| pattern ActionCategory_Approval :: ActionCategory | |
| pattern ActionCategory_Build :: ActionCategory | |
| pattern ActionCategory_Deploy :: ActionCategory | |
| pattern ActionCategory_Invoke :: ActionCategory | |
| pattern ActionCategory_Source :: ActionCategory | |
| pattern ActionCategory_Test :: ActionCategory |
Instances
ActionConfigurationPropertyType
newtype ActionConfigurationPropertyType Source #
Constructors
| ActionConfigurationPropertyType' | |
Fields | |
Bundled Patterns
Instances
ActionExecutionStatus
newtype ActionExecutionStatus Source #
Constructors
| ActionExecutionStatus' | |
Fields | |
Bundled Patterns
Instances
ActionOwner
newtype ActionOwner Source #
Constructors
| ActionOwner' | |
Fields | |
Bundled Patterns
| pattern ActionOwner_AWS :: ActionOwner | |
| pattern ActionOwner_Custom :: ActionOwner | |
| pattern ActionOwner_ThirdParty :: ActionOwner |
Instances
ApprovalStatus
newtype ApprovalStatus Source #
Constructors
| ApprovalStatus' | |
Fields | |
Bundled Patterns
| pattern ApprovalStatus_Approved :: ApprovalStatus | |
| pattern ApprovalStatus_Rejected :: ApprovalStatus |
Instances
ArtifactLocationType
newtype ArtifactLocationType Source #
Constructors
| ArtifactLocationType' | |
Fields | |
Bundled Patterns
| pattern ArtifactLocationType_S3 :: ArtifactLocationType |
Instances
ArtifactStoreType
newtype ArtifactStoreType Source #
Constructors
| ArtifactStoreType' | |
Fields | |
Bundled Patterns
| pattern ArtifactStoreType_S3 :: ArtifactStoreType |
Instances
BlockerType
newtype BlockerType Source #
Constructors
| BlockerType' | |
Fields | |
Bundled Patterns
| pattern BlockerType_Schedule :: BlockerType |
Instances
EncryptionKeyType
newtype EncryptionKeyType Source #
Constructors
| EncryptionKeyType' | |
Fields | |
Bundled Patterns
| pattern EncryptionKeyType_KMS :: EncryptionKeyType |
Instances
ExecutorType
newtype ExecutorType Source #
Constructors
| ExecutorType' | |
Fields | |
Bundled Patterns
| pattern ExecutorType_JobWorker :: ExecutorType | |
| pattern ExecutorType_Lambda :: ExecutorType |
Instances
FailureType
newtype FailureType Source #
Constructors
| FailureType' | |
Fields | |
Bundled Patterns
| pattern FailureType_ConfigurationError :: FailureType | |
| pattern FailureType_JobFailed :: FailureType | |
| pattern FailureType_PermissionError :: FailureType | |
| pattern FailureType_RevisionOutOfSync :: FailureType | |
| pattern FailureType_RevisionUnavailable :: FailureType | |
| pattern FailureType_SystemUnavailable :: FailureType |
Instances
JobStatus
Constructors
| JobStatus' | |
Fields | |
Bundled Patterns
| pattern JobStatus_Created :: JobStatus | |
| pattern JobStatus_Dispatched :: JobStatus | |
| pattern JobStatus_Failed :: JobStatus | |
| pattern JobStatus_InProgress :: JobStatus | |
| pattern JobStatus_Queued :: JobStatus | |
| pattern JobStatus_Succeeded :: JobStatus | |
| pattern JobStatus_TimedOut :: JobStatus |
Instances
PipelineExecutionStatus
newtype PipelineExecutionStatus Source #
Constructors
| PipelineExecutionStatus' | |
Fields | |
Bundled Patterns
Instances
StageExecutionStatus
newtype StageExecutionStatus Source #
Constructors
| StageExecutionStatus' | |
Fields | |
Bundled Patterns
| pattern StageExecutionStatus_Cancelled :: StageExecutionStatus | |
| pattern StageExecutionStatus_Failed :: StageExecutionStatus | |
| pattern StageExecutionStatus_InProgress :: StageExecutionStatus | |
| pattern StageExecutionStatus_Stopped :: StageExecutionStatus | |
| pattern StageExecutionStatus_Stopping :: StageExecutionStatus | |
| pattern StageExecutionStatus_Succeeded :: StageExecutionStatus |
Instances
StageRetryMode
newtype StageRetryMode Source #
Constructors
| StageRetryMode' | |
Fields | |
Bundled Patterns
| pattern StageRetryMode_FAILED_ACTIONS :: StageRetryMode |
Instances
StageTransitionType
newtype StageTransitionType Source #
Constructors
| StageTransitionType' | |
Fields | |
Bundled Patterns
| pattern StageTransitionType_Inbound :: StageTransitionType | |
| pattern StageTransitionType_Outbound :: StageTransitionType |
Instances
TriggerType
newtype TriggerType Source #
Constructors
| TriggerType' | |
Fields | |
Bundled Patterns
| pattern TriggerType_CloudWatchEvent :: TriggerType | |
| pattern TriggerType_CreatePipeline :: TriggerType | |
| pattern TriggerType_PollForSourceChanges :: TriggerType | |
| pattern TriggerType_PutActionRevision :: TriggerType | |
| pattern TriggerType_StartPipelineExecution :: TriggerType | |
| pattern TriggerType_Webhook :: TriggerType |
Instances
WebhookAuthenticationType
newtype WebhookAuthenticationType Source #
Constructors
| WebhookAuthenticationType' | |
Fields | |
Bundled Patterns
Instances
AWSSessionCredentials
data AWSSessionCredentials Source #
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
See: newAWSSessionCredentials smart constructor.
Constructors
| AWSSessionCredentials' | |
Fields
| |
Instances
newAWSSessionCredentials Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AWSSessionCredentials |
Create a value of AWSSessionCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessKeyId:AWSSessionCredentials', aWSSessionCredentials_accessKeyId - The access key for the session.
$sel:secretAccessKey:AWSSessionCredentials', aWSSessionCredentials_secretAccessKey - The secret access key for the session.
$sel:sessionToken:AWSSessionCredentials', aWSSessionCredentials_sessionToken - The token for the session.
aWSSessionCredentials_accessKeyId :: Lens' AWSSessionCredentials Text Source #
The access key for the session.
aWSSessionCredentials_secretAccessKey :: Lens' AWSSessionCredentials Text Source #
The secret access key for the session.
aWSSessionCredentials_sessionToken :: Lens' AWSSessionCredentials Text Source #
The token for the session.
ActionConfiguration
data ActionConfiguration Source #
Represents information about an action configuration.
See: newActionConfiguration smart constructor.
Constructors
| ActionConfiguration' | |
Fields
| |
Instances
newActionConfiguration :: ActionConfiguration Source #
Create a value of ActionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configuration:ActionConfiguration', actionConfiguration_configuration - The configuration data for the action.
actionConfiguration_configuration :: Lens' ActionConfiguration (Maybe (HashMap Text Text)) Source #
The configuration data for the action.
ActionConfigurationProperty
data ActionConfigurationProperty Source #
Represents information about an action configuration property.
See: newActionConfigurationProperty smart constructor.
Constructors
| ActionConfigurationProperty' | |
Fields
| |
Instances
newActionConfigurationProperty Source #
Arguments
| :: Text | |
| -> Bool | |
| -> Bool | |
| -> Bool | |
| -> ActionConfigurationProperty |
Create a value of ActionConfigurationProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:queryable:ActionConfigurationProperty', actionConfigurationProperty_queryable - Indicates that the property is used with PollForJobs. When creating a
custom action, an action can have up to one queryable property. If it
has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
$sel:type':ActionConfigurationProperty', actionConfigurationProperty_type - The type of the configuration property.
$sel:description:ActionConfigurationProperty', actionConfigurationProperty_description - The description of the action configuration property that is displayed
to users.
$sel:name:ActionConfigurationProperty', actionConfigurationProperty_name - The name of the action configuration property.
$sel:required:ActionConfigurationProperty', actionConfigurationProperty_required - Whether the configuration property is a required value.
$sel:key:ActionConfigurationProperty', actionConfigurationProperty_key - Whether the configuration property is a key.
$sel:secret:ActionConfigurationProperty', actionConfigurationProperty_secret - Whether the configuration property is secret. Secrets are hidden from
all calls except for GetJobDetails, GetThirdPartyJobDetails,
PollForJobs, and PollForThirdPartyJobs.
When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
actionConfigurationProperty_queryable :: Lens' ActionConfigurationProperty (Maybe Bool) Source #
Indicates that the property is used with PollForJobs. When creating a
custom action, an action can have up to one queryable property. If it
has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
actionConfigurationProperty_type :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType) Source #
The type of the configuration property.
actionConfigurationProperty_description :: Lens' ActionConfigurationProperty (Maybe Text) Source #
The description of the action configuration property that is displayed to users.
actionConfigurationProperty_name :: Lens' ActionConfigurationProperty Text Source #
The name of the action configuration property.
actionConfigurationProperty_required :: Lens' ActionConfigurationProperty Bool Source #
Whether the configuration property is a required value.
actionConfigurationProperty_key :: Lens' ActionConfigurationProperty Bool Source #
Whether the configuration property is a key.
actionConfigurationProperty_secret :: Lens' ActionConfigurationProperty Bool Source #
Whether the configuration property is secret. Secrets are hidden from
all calls except for GetJobDetails, GetThirdPartyJobDetails,
PollForJobs, and PollForThirdPartyJobs.
When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
ActionContext
data ActionContext Source #
Represents the context of an action in the stage of a pipeline to a job worker.
See: newActionContext smart constructor.
Constructors
| ActionContext' | |
Instances
newActionContext :: ActionContext Source #
Create a value of ActionContext with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ActionContext', actionContext_name - The name of the action in the context of a job.
$sel:actionExecutionId:ActionContext', actionContext_actionExecutionId - The system-generated unique ID that corresponds to an action's
execution.
actionContext_name :: Lens' ActionContext (Maybe Text) Source #
The name of the action in the context of a job.
actionContext_actionExecutionId :: Lens' ActionContext (Maybe Text) Source #
The system-generated unique ID that corresponds to an action's execution.
ActionDeclaration
data ActionDeclaration Source #
Represents information about an action declaration.
See: newActionDeclaration smart constructor.
Constructors
| ActionDeclaration' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ActionTypeId | |
| -> ActionDeclaration |
Create a value of ActionDeclaration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:outputArtifacts:ActionDeclaration', actionDeclaration_outputArtifacts - The name or ID of the result of the action declaration, such as a test
or build artifact.
$sel:namespace:ActionDeclaration', actionDeclaration_namespace - The variable namespace associated with the action. All variables
produced as output by this action fall under this namespace.
$sel:runOrder:ActionDeclaration', actionDeclaration_runOrder - The order in which actions are run.
$sel:region:ActionDeclaration', actionDeclaration_region - The action declaration's AWS Region, such as us-east-1.
$sel:configuration:ActionDeclaration', actionDeclaration_configuration - The action's configuration. These are key-value pairs that specify
input values for an action. For more information, see
Action Structure Requirements in CodePipeline.
For the list of configuration properties for the AWS CloudFormation
action type in CodePipeline, see
Configuration Properties Reference
in the AWS CloudFormation User Guide. For template snippets with
examples, see
Using Parameter Override Functions with CodePipeline Pipelines
in the AWS CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },$sel:inputArtifacts:ActionDeclaration', actionDeclaration_inputArtifacts - The name or ID of the artifact consumed by the action, such as a test or
build artifact.
$sel:roleArn:ActionDeclaration', actionDeclaration_roleArn - The ARN of the IAM service role that performs the declared action. This
is assumed through the roleArn for the pipeline.
$sel:name:ActionDeclaration', actionDeclaration_name - The action declaration's name.
$sel:actionTypeId:ActionDeclaration', actionDeclaration_actionTypeId - Specifies the action type and the provider of the action.
actionDeclaration_outputArtifacts :: Lens' ActionDeclaration (Maybe [OutputArtifact]) Source #
The name or ID of the result of the action declaration, such as a test or build artifact.
actionDeclaration_namespace :: Lens' ActionDeclaration (Maybe Text) Source #
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
actionDeclaration_runOrder :: Lens' ActionDeclaration (Maybe Natural) Source #
The order in which actions are run.
actionDeclaration_region :: Lens' ActionDeclaration (Maybe Text) Source #
The action declaration's AWS Region, such as us-east-1.
actionDeclaration_configuration :: Lens' ActionDeclaration (Maybe (HashMap Text Text)) Source #
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },actionDeclaration_inputArtifacts :: Lens' ActionDeclaration (Maybe [InputArtifact]) Source #
The name or ID of the artifact consumed by the action, such as a test or build artifact.
actionDeclaration_roleArn :: Lens' ActionDeclaration (Maybe Text) Source #
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
actionDeclaration_name :: Lens' ActionDeclaration Text Source #
The action declaration's name.
actionDeclaration_actionTypeId :: Lens' ActionDeclaration ActionTypeId Source #
Specifies the action type and the provider of the action.
ActionExecution
data ActionExecution Source #
Represents information about the run of an action.
See: newActionExecution smart constructor.
Constructors
| ActionExecution' | |
Fields
| |
Instances
newActionExecution :: ActionExecution Source #
Create a value of ActionExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdatedBy:ActionExecution', actionExecution_lastUpdatedBy - The ARN of the user who last changed the pipeline.
$sel:summary:ActionExecution', actionExecution_summary - A summary of the run of the action.
$sel:status:ActionExecution', actionExecution_status - The status of the action, or for a completed action, the last status of
the action.
$sel:lastStatusChange:ActionExecution', actionExecution_lastStatusChange - The last status change of the action.
$sel:token:ActionExecution', actionExecution_token - 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. It is used to validate that the approval
request corresponding to this token is still valid.
$sel:externalExecutionUrl:ActionExecution', actionExecution_externalExecutionUrl - The URL of a resource external to AWS that is used when running the
action (for example, an external repository URL).
$sel:externalExecutionId:ActionExecution', actionExecution_externalExecutionId - The external ID of the run of the action.
$sel:errorDetails:ActionExecution', actionExecution_errorDetails - The details of an error returned by a URL external to AWS.
$sel:percentComplete:ActionExecution', actionExecution_percentComplete - A percentage of completeness of the action as it runs.
$sel:actionExecutionId:ActionExecution', actionExecution_actionExecutionId - ID of the workflow action execution in the current stage. Use the
GetPipelineState action to retrieve the current action execution details
of the current stage.
For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.
actionExecution_lastUpdatedBy :: Lens' ActionExecution (Maybe Text) Source #
The ARN of the user who last changed the pipeline.
actionExecution_summary :: Lens' ActionExecution (Maybe Text) Source #
A summary of the run of the action.
actionExecution_status :: Lens' ActionExecution (Maybe ActionExecutionStatus) Source #
The status of the action, or for a completed action, the last status of the action.
actionExecution_lastStatusChange :: Lens' ActionExecution (Maybe UTCTime) Source #
The last status change of the action.
actionExecution_token :: Lens' ActionExecution (Maybe Text) Source #
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. It is used to validate that the approval
request corresponding to this token is still valid.
actionExecution_externalExecutionUrl :: Lens' ActionExecution (Maybe Text) Source #
The URL of a resource external to AWS that is used when running the action (for example, an external repository URL).
actionExecution_externalExecutionId :: Lens' ActionExecution (Maybe Text) Source #
The external ID of the run of the action.
actionExecution_errorDetails :: Lens' ActionExecution (Maybe ErrorDetails) Source #
The details of an error returned by a URL external to AWS.
actionExecution_percentComplete :: Lens' ActionExecution (Maybe Natural) Source #
A percentage of completeness of the action as it runs.
actionExecution_actionExecutionId :: Lens' ActionExecution (Maybe Text) Source #
ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage.
For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.
ActionExecutionDetail
data ActionExecutionDetail Source #
Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.
See: newActionExecutionDetail smart constructor.
Constructors
| ActionExecutionDetail' | |
Fields
| |
Instances
newActionExecutionDetail :: ActionExecutionDetail Source #
Create a value of ActionExecutionDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ActionExecutionDetail', actionExecutionDetail_status - The status of the action execution. Status categories are InProgress,
Succeeded, and Failed.
$sel:startTime:ActionExecutionDetail', actionExecutionDetail_startTime - The start time of the action execution.
$sel:pipelineVersion:ActionExecutionDetail', actionExecutionDetail_pipelineVersion - The version of the pipeline where the action was run.
$sel:input:ActionExecutionDetail', actionExecutionDetail_input - Input details for the action execution, such as role ARN, Region, and
input artifacts.
$sel:actionName:ActionExecutionDetail', actionExecutionDetail_actionName - The name of the action.
$sel:output:ActionExecutionDetail', actionExecutionDetail_output - Output details for the action execution, such as the action execution
result.
$sel:pipelineExecutionId:ActionExecutionDetail', actionExecutionDetail_pipelineExecutionId - The pipeline execution ID for the action execution.
$sel:stageName:ActionExecutionDetail', actionExecutionDetail_stageName - The name of the stage that contains the action.
$sel:lastUpdateTime:ActionExecutionDetail', actionExecutionDetail_lastUpdateTime - The last update time of the action execution.
$sel:actionExecutionId:ActionExecutionDetail', actionExecutionDetail_actionExecutionId - The action execution ID.
actionExecutionDetail_status :: Lens' ActionExecutionDetail (Maybe ActionExecutionStatus) Source #
The status of the action execution. Status categories are InProgress,
Succeeded, and Failed.
actionExecutionDetail_startTime :: Lens' ActionExecutionDetail (Maybe UTCTime) Source #
The start time of the action execution.
actionExecutionDetail_pipelineVersion :: Lens' ActionExecutionDetail (Maybe Natural) Source #
The version of the pipeline where the action was run.
actionExecutionDetail_input :: Lens' ActionExecutionDetail (Maybe ActionExecutionInput) Source #
Input details for the action execution, such as role ARN, Region, and input artifacts.
actionExecutionDetail_actionName :: Lens' ActionExecutionDetail (Maybe Text) Source #
The name of the action.
actionExecutionDetail_output :: Lens' ActionExecutionDetail (Maybe ActionExecutionOutput) Source #
Output details for the action execution, such as the action execution result.
actionExecutionDetail_pipelineExecutionId :: Lens' ActionExecutionDetail (Maybe Text) Source #
The pipeline execution ID for the action execution.
actionExecutionDetail_stageName :: Lens' ActionExecutionDetail (Maybe Text) Source #
The name of the stage that contains the action.
actionExecutionDetail_lastUpdateTime :: Lens' ActionExecutionDetail (Maybe UTCTime) Source #
The last update time of the action execution.
actionExecutionDetail_actionExecutionId :: Lens' ActionExecutionDetail (Maybe Text) Source #
The action execution ID.
ActionExecutionFilter
data ActionExecutionFilter Source #
Filter values for the action execution.
See: newActionExecutionFilter smart constructor.
Constructors
| ActionExecutionFilter' | |
Fields
| |
Instances
newActionExecutionFilter :: ActionExecutionFilter Source #
Create a value of ActionExecutionFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineExecutionId:ActionExecutionFilter', actionExecutionFilter_pipelineExecutionId - The pipeline execution ID used to filter action execution history.
actionExecutionFilter_pipelineExecutionId :: Lens' ActionExecutionFilter (Maybe Text) Source #
The pipeline execution ID used to filter action execution history.
ActionExecutionInput
data ActionExecutionInput Source #
Input information used for an action execution.
See: newActionExecutionInput smart constructor.
Constructors
| ActionExecutionInput' | |
Fields
| |
Instances
newActionExecutionInput :: ActionExecutionInput Source #
Create a value of ActionExecutionInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namespace:ActionExecutionInput', actionExecutionInput_namespace - The variable namespace associated with the action. All variables
produced as output by this action fall under this namespace.
$sel:resolvedConfiguration:ActionExecutionInput', actionExecutionInput_resolvedConfiguration - Configuration data for an action execution with all variable references
replaced with their real values for the execution.
$sel:region:ActionExecutionInput', actionExecutionInput_region - The AWS Region for the action, such as us-east-1.
$sel:configuration:ActionExecutionInput', actionExecutionInput_configuration - Configuration data for an action execution.
$sel:actionTypeId:ActionExecutionInput', actionExecutionInput_actionTypeId - Undocumented member.
$sel:inputArtifacts:ActionExecutionInput', actionExecutionInput_inputArtifacts - Details of input artifacts of the action that correspond to the action
execution.
$sel:roleArn:ActionExecutionInput', actionExecutionInput_roleArn - The ARN of the IAM service role that performs the declared action. This
is assumed through the roleArn for the pipeline.
actionExecutionInput_namespace :: Lens' ActionExecutionInput (Maybe Text) Source #
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
actionExecutionInput_resolvedConfiguration :: Lens' ActionExecutionInput (Maybe (HashMap Text Text)) Source #
Configuration data for an action execution with all variable references replaced with their real values for the execution.
actionExecutionInput_region :: Lens' ActionExecutionInput (Maybe Text) Source #
The AWS Region for the action, such as us-east-1.
actionExecutionInput_configuration :: Lens' ActionExecutionInput (Maybe (HashMap Text Text)) Source #
Configuration data for an action execution.
actionExecutionInput_actionTypeId :: Lens' ActionExecutionInput (Maybe ActionTypeId) Source #
Undocumented member.
actionExecutionInput_inputArtifacts :: Lens' ActionExecutionInput (Maybe [ArtifactDetail]) Source #
Details of input artifacts of the action that correspond to the action execution.
actionExecutionInput_roleArn :: Lens' ActionExecutionInput (Maybe Text) Source #
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
ActionExecutionOutput
data ActionExecutionOutput Source #
Output details listed for an action execution, such as the action execution result.
See: newActionExecutionOutput smart constructor.
Constructors
| ActionExecutionOutput' | |
Fields
| |
Instances
newActionExecutionOutput :: ActionExecutionOutput Source #
Create a value of ActionExecutionOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:outputVariables:ActionExecutionOutput', actionExecutionOutput_outputVariables - The outputVariables field shows the key-value pairs that were output as
part of that execution.
$sel:outputArtifacts:ActionExecutionOutput', actionExecutionOutput_outputArtifacts - Details of output artifacts of the action that correspond to the action
execution.
$sel:executionResult:ActionExecutionOutput', actionExecutionOutput_executionResult - Execution result information listed in the output details for an action
execution.
actionExecutionOutput_outputVariables :: Lens' ActionExecutionOutput (Maybe (HashMap Text Text)) Source #
The outputVariables field shows the key-value pairs that were output as part of that execution.
actionExecutionOutput_outputArtifacts :: Lens' ActionExecutionOutput (Maybe [ArtifactDetail]) Source #
Details of output artifacts of the action that correspond to the action execution.
actionExecutionOutput_executionResult :: Lens' ActionExecutionOutput (Maybe ActionExecutionResult) Source #
Execution result information listed in the output details for an action execution.
ActionExecutionResult
data ActionExecutionResult Source #
Execution result information, such as the external execution ID.
See: newActionExecutionResult smart constructor.
Constructors
| ActionExecutionResult' | |
Fields
| |
Instances
newActionExecutionResult :: ActionExecutionResult Source #
Create a value of ActionExecutionResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalExecutionUrl:ActionExecutionResult', actionExecutionResult_externalExecutionUrl - The deepest external link to the external resource (for example, a
repository URL or deployment endpoint) that is used when running the
action.
$sel:externalExecutionId:ActionExecutionResult', actionExecutionResult_externalExecutionId - The action provider's external ID for the action execution.
$sel:externalExecutionSummary:ActionExecutionResult', actionExecutionResult_externalExecutionSummary - The action provider's summary for the action execution.
actionExecutionResult_externalExecutionUrl :: Lens' ActionExecutionResult (Maybe Text) Source #
The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
actionExecutionResult_externalExecutionId :: Lens' ActionExecutionResult (Maybe Text) Source #
The action provider's external ID for the action execution.
actionExecutionResult_externalExecutionSummary :: Lens' ActionExecutionResult (Maybe Text) Source #
The action provider's summary for the action execution.
ActionRevision
data ActionRevision Source #
Represents information about the version (or revision) of an action.
See: newActionRevision smart constructor.
Constructors
| ActionRevision' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ActionRevision |
Create a value of ActionRevision with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:revisionId:ActionRevision', actionRevision_revisionId - The system-generated unique ID that identifies the revision number of
the action.
$sel:revisionChangeId:ActionRevision', actionRevision_revisionChangeId - The unique identifier of the change that set the state to this revision
(for example, a deployment ID or timestamp).
$sel:created:ActionRevision', actionRevision_created - The date and time when the most recent version of the action was
created, in timestamp format.
actionRevision_revisionId :: Lens' ActionRevision Text Source #
The system-generated unique ID that identifies the revision number of the action.
actionRevision_revisionChangeId :: Lens' ActionRevision Text Source #
The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
actionRevision_created :: Lens' ActionRevision UTCTime Source #
The date and time when the most recent version of the action was created, in timestamp format.
ActionState
data ActionState Source #
Represents information about the state of an action.
See: newActionState smart constructor.
Constructors
| ActionState' | |
Fields
| |
Instances
newActionState :: ActionState Source #
Create a value of ActionState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:revisionUrl:ActionState', actionState_revisionUrl - A URL link for more information about the revision, such as a commit
details page.
$sel:entityUrl:ActionState', actionState_entityUrl - A URL link for more information about the state of the action, such as a
deployment group details page.
$sel:actionName:ActionState', actionState_actionName - The name of the action.
$sel:currentRevision:ActionState', actionState_currentRevision - Represents information about the version (or revision) of an action.
$sel:latestExecution:ActionState', actionState_latestExecution - Represents information about the run of an action.
actionState_revisionUrl :: Lens' ActionState (Maybe Text) Source #
A URL link for more information about the revision, such as a commit details page.
actionState_entityUrl :: Lens' ActionState (Maybe Text) Source #
A URL link for more information about the state of the action, such as a deployment group details page.
actionState_actionName :: Lens' ActionState (Maybe Text) Source #
The name of the action.
actionState_currentRevision :: Lens' ActionState (Maybe ActionRevision) Source #
Represents information about the version (or revision) of an action.
actionState_latestExecution :: Lens' ActionState (Maybe ActionExecution) Source #
Represents information about the run of an action.
ActionType
data ActionType Source #
Returns information about the details of an action type.
See: newActionType smart constructor.
Constructors
| ActionType' | |
Fields
| |
Instances
Arguments
| :: ActionTypeId | |
| -> ArtifactDetails | |
| -> ArtifactDetails | |
| -> ActionType |
Create a value of ActionType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:settings:ActionType', actionType_settings - The settings for the action type.
$sel:actionConfigurationProperties:ActionType', actionType_actionConfigurationProperties - The configuration properties for the action type.
$sel:id:ActionType', actionType_id - Represents information about an action type.
$sel:inputArtifactDetails:ActionType', actionType_inputArtifactDetails - The details of the input artifact for the action, such as its commit ID.
$sel:outputArtifactDetails:ActionType', actionType_outputArtifactDetails - The details of the output artifact of the action, such as its commit ID.
actionType_settings :: Lens' ActionType (Maybe ActionTypeSettings) Source #
The settings for the action type.
actionType_actionConfigurationProperties :: Lens' ActionType (Maybe [ActionConfigurationProperty]) Source #
The configuration properties for the action type.
actionType_id :: Lens' ActionType ActionTypeId Source #
Represents information about an action type.
actionType_inputArtifactDetails :: Lens' ActionType ArtifactDetails Source #
The details of the input artifact for the action, such as its commit ID.
actionType_outputArtifactDetails :: Lens' ActionType ArtifactDetails Source #
The details of the output artifact of the action, such as its commit ID.
ActionTypeArtifactDetails
data ActionTypeArtifactDetails Source #
Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.
See: newActionTypeArtifactDetails smart constructor.
Constructors
| ActionTypeArtifactDetails' | |
Fields
| |
Instances
newActionTypeArtifactDetails Source #
Arguments
| :: Natural | |
| -> Natural | |
| -> ActionTypeArtifactDetails |
Create a value of ActionTypeArtifactDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minimumCount:ActionTypeArtifactDetails', actionTypeArtifactDetails_minimumCount - The minimum number of artifacts that can be used with the action type.
For example, you should specify a minimum and maximum of zero input
artifacts for an action type with a category of source.
$sel:maximumCount:ActionTypeArtifactDetails', actionTypeArtifactDetails_maximumCount - The maximum number of artifacts that can be used with the actiontype.
For example, you should specify a minimum and maximum of zero input
artifacts for an action type with a category of source.
actionTypeArtifactDetails_minimumCount :: Lens' ActionTypeArtifactDetails Natural Source #
The minimum number of artifacts that can be used with the action type.
For example, you should specify a minimum and maximum of zero input
artifacts for an action type with a category of source.
actionTypeArtifactDetails_maximumCount :: Lens' ActionTypeArtifactDetails Natural Source #
The maximum number of artifacts that can be used with the actiontype.
For example, you should specify a minimum and maximum of zero input
artifacts for an action type with a category of source.
ActionTypeDeclaration
data ActionTypeDeclaration Source #
The parameters for the action type definition that are provided when the action type is created or updated.
See: newActionTypeDeclaration smart constructor.
Constructors
| ActionTypeDeclaration' | |
Fields
| |
Instances
newActionTypeDeclaration Source #
Arguments
| :: ActionTypeExecutor | |
| -> ActionTypeIdentifier | |
| -> ActionTypeArtifactDetails | |
| -> ActionTypeArtifactDetails | |
| -> ActionTypeDeclaration |
Create a value of ActionTypeDeclaration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:urls:ActionTypeDeclaration', actionTypeDeclaration_urls - The links associated with the action type to be updated.
$sel:permissions:ActionTypeDeclaration', actionTypeDeclaration_permissions - Details identifying the accounts with permissions to use the action
type.
$sel:description:ActionTypeDeclaration', actionTypeDeclaration_description - The description for the action type to be updated.
$sel:properties:ActionTypeDeclaration', actionTypeDeclaration_properties - The properties of the action type to be updated.
$sel:executor:ActionTypeDeclaration', actionTypeDeclaration_executor - Information about the executor for an action type that was created with
any supported integration model.
$sel:id:ActionTypeDeclaration', actionTypeDeclaration_id - The action category, owner, provider, and version of the action type to
be updated.
$sel:inputArtifactDetails:ActionTypeDeclaration', actionTypeDeclaration_inputArtifactDetails - Details for the artifacts, such as application files, to be worked on by
the action. For example, the minimum and maximum number of input
artifacts allowed.
$sel:outputArtifactDetails:ActionTypeDeclaration', actionTypeDeclaration_outputArtifactDetails - Details for the output artifacts, such as a built application, that are
the result of the action. For example, the minimum and maximum number of
output artifacts allowed.
actionTypeDeclaration_urls :: Lens' ActionTypeDeclaration (Maybe ActionTypeUrls) Source #
The links associated with the action type to be updated.
actionTypeDeclaration_permissions :: Lens' ActionTypeDeclaration (Maybe ActionTypePermissions) Source #
Details identifying the accounts with permissions to use the action type.
actionTypeDeclaration_description :: Lens' ActionTypeDeclaration (Maybe Text) Source #
The description for the action type to be updated.
actionTypeDeclaration_properties :: Lens' ActionTypeDeclaration (Maybe [ActionTypeProperty]) Source #
The properties of the action type to be updated.
actionTypeDeclaration_executor :: Lens' ActionTypeDeclaration ActionTypeExecutor Source #
Information about the executor for an action type that was created with any supported integration model.
actionTypeDeclaration_id :: Lens' ActionTypeDeclaration ActionTypeIdentifier Source #
The action category, owner, provider, and version of the action type to be updated.
actionTypeDeclaration_inputArtifactDetails :: Lens' ActionTypeDeclaration ActionTypeArtifactDetails Source #
Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.
actionTypeDeclaration_outputArtifactDetails :: Lens' ActionTypeDeclaration ActionTypeArtifactDetails Source #
Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.
ActionTypeExecutor
data ActionTypeExecutor Source #
The action engine, or executor, for an action type created for a provider, where the action is to be used by customers of the provider. The action engine is associated with the model used to create and update the action, such as the Lambda integration model.
See: newActionTypeExecutor smart constructor.
Constructors
| ActionTypeExecutor' | |
Fields
| |
Instances
newActionTypeExecutor Source #
Arguments
| :: ExecutorConfiguration | |
| -> ExecutorType | |
| -> ActionTypeExecutor |
Create a value of ActionTypeExecutor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTimeout:ActionTypeExecutor', actionTypeExecutor_jobTimeout - The timeout in seconds for the job. An action execution can have
multiple jobs. This is the timeout for a single job, not the entire
action execution.
$sel:policyStatementsTemplate:ActionTypeExecutor', actionTypeExecutor_policyStatementsTemplate - The policy statement that specifies the permissions in the CodePipeline
customer’s account that are needed to successfully run an action.
To grant permission to another account, specify the account ID as the
Principal, a domain-style identifier defined by the service, for example
codepipeline.amazonaws.com.
The size of the passed JSON policy document cannot exceed 2048 characters.
$sel:configuration:ActionTypeExecutor', actionTypeExecutor_configuration - The action configuration properties for the action type. These
properties are specified in the action definition when the action type
is created.
$sel:type':ActionTypeExecutor', actionTypeExecutor_type - The integration model used to create and update the action type,
Lambda or JobWorker.
actionTypeExecutor_jobTimeout :: Lens' ActionTypeExecutor (Maybe Natural) Source #
The timeout in seconds for the job. An action execution can have multiple jobs. This is the timeout for a single job, not the entire action execution.
actionTypeExecutor_policyStatementsTemplate :: Lens' ActionTypeExecutor (Maybe Text) Source #
The policy statement that specifies the permissions in the CodePipeline customer’s account that are needed to successfully run an action.
To grant permission to another account, specify the account ID as the
Principal, a domain-style identifier defined by the service, for example
codepipeline.amazonaws.com.
The size of the passed JSON policy document cannot exceed 2048 characters.
actionTypeExecutor_configuration :: Lens' ActionTypeExecutor ExecutorConfiguration Source #
The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.
actionTypeExecutor_type :: Lens' ActionTypeExecutor ExecutorType Source #
The integration model used to create and update the action type,
Lambda or JobWorker.
ActionTypeId
data ActionTypeId Source #
Represents information about an action type.
See: newActionTypeId smart constructor.
Constructors
| ActionTypeId' | |
Fields
| |
Instances
Arguments
| :: ActionCategory | |
| -> ActionOwner | |
| -> Text | |
| -> Text | |
| -> ActionTypeId |
Create a value of ActionTypeId with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:category:ActionTypeId', actionTypeId_category - A category defines what kind of action can be taken in the stage, and
constrains the provider type for the action. Valid categories are
limited to one of the following values.
- Source
- Build
- Test
- Deploy
- Invoke
- Approval
$sel:owner:ActionTypeId', actionTypeId_owner - The creator of the action being called. There are three valid values for
the Owner field in the action category section within your pipeline
structure: AWS, ThirdParty, and Custom. For more information, see
Valid Action Types and Providers in CodePipeline.
$sel:provider:ActionTypeId', actionTypeId_provider - 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. For more information, see
Valid Action Types and Providers in CodePipeline.
$sel:version:ActionTypeId', actionTypeId_version - A string that describes the action version.
actionTypeId_category :: Lens' ActionTypeId ActionCategory Source #
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.
- Source
- Build
- Test
- Deploy
- Invoke
- Approval
actionTypeId_owner :: Lens' ActionTypeId ActionOwner Source #
The creator of the action being called. There are three valid values for
the Owner field in the action category section within your pipeline
structure: AWS, ThirdParty, and Custom. For more information, see
Valid Action Types and Providers in CodePipeline.
actionTypeId_provider :: Lens' ActionTypeId Text Source #
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. For more information, see Valid Action Types and Providers in CodePipeline.
actionTypeId_version :: Lens' ActionTypeId Text Source #
A string that describes the action version.
ActionTypeIdentifier
data ActionTypeIdentifier Source #
Specifies the category, owner, provider, and version of the action type.
See: newActionTypeIdentifier smart constructor.
Constructors
| ActionTypeIdentifier' | |
Fields
| |
Instances
newActionTypeIdentifier Source #
Arguments
| :: ActionCategory | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ActionTypeIdentifier |
Create a value of ActionTypeIdentifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:category:ActionTypeIdentifier', actionTypeIdentifier_category - Defines what kind of action can be taken in the stage, one of the
following:
Source
Build
Test
Deploy
Approval
Invoke
$sel:owner:ActionTypeIdentifier', actionTypeIdentifier_owner - The creator of the action type being called: AWS or ThirdParty.
$sel:provider:ActionTypeIdentifier', actionTypeIdentifier_provider - The provider of the action type being called. The provider name is
supplied when the action type is created.
$sel:version:ActionTypeIdentifier', actionTypeIdentifier_version - A string that describes the action type version.
actionTypeIdentifier_category :: Lens' ActionTypeIdentifier ActionCategory Source #
Defines what kind of action can be taken in the stage, one of the following:
Source
Build
Test
Deploy
Approval
Invoke
actionTypeIdentifier_owner :: Lens' ActionTypeIdentifier Text Source #
The creator of the action type being called: AWS or ThirdParty.
actionTypeIdentifier_provider :: Lens' ActionTypeIdentifier Text Source #
The provider of the action type being called. The provider name is supplied when the action type is created.
actionTypeIdentifier_version :: Lens' ActionTypeIdentifier Text Source #
A string that describes the action type version.
ActionTypePermissions
data ActionTypePermissions Source #
Details identifying the users with permissions to use the action type.
See: newActionTypePermissions smart constructor.
Constructors
| ActionTypePermissions' | |
Fields
| |
Instances
newActionTypePermissions Source #
Create a value of ActionTypePermissions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowedAccounts:ActionTypePermissions', actionTypePermissions_allowedAccounts - A list of AWS account IDs with access to use the action type in their
pipelines.
actionTypePermissions_allowedAccounts :: Lens' ActionTypePermissions (NonEmpty Text) Source #
A list of AWS account IDs with access to use the action type in their pipelines.
ActionTypeProperty
data ActionTypeProperty Source #
Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.
See: newActionTypeProperty smart constructor.
Constructors
| ActionTypeProperty' | |
Fields
| |
Instances
newActionTypeProperty Source #
Arguments
| :: Text | |
| -> Bool | |
| -> Bool | |
| -> Bool | |
| -> ActionTypeProperty |
Create a value of ActionTypeProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:queryable:ActionTypeProperty', actionTypeProperty_queryable - Indicates that the property is used with polling. An action type can
have up to one queryable property. If it has one, that property must be
both required and not secret.
$sel:description:ActionTypeProperty', actionTypeProperty_description - The description of the property that is displayed to users.
$sel:name:ActionTypeProperty', actionTypeProperty_name - The property name that is displayed to users.
$sel:optional:ActionTypeProperty', actionTypeProperty_optional - Whether the configuration property is an optional value.
$sel:key:ActionTypeProperty', actionTypeProperty_key - Whether the configuration property is a key.
$sel:noEcho:ActionTypeProperty', actionTypeProperty_noEcho - Whether to omit the field value entered by the customer in the log. If
true, the value is not saved in CloudTrail logs for the action
execution.
actionTypeProperty_queryable :: Lens' ActionTypeProperty (Maybe Bool) Source #
Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.
actionTypeProperty_description :: Lens' ActionTypeProperty (Maybe Text) Source #
The description of the property that is displayed to users.
actionTypeProperty_name :: Lens' ActionTypeProperty Text Source #
The property name that is displayed to users.
actionTypeProperty_optional :: Lens' ActionTypeProperty Bool Source #
Whether the configuration property is an optional value.
actionTypeProperty_key :: Lens' ActionTypeProperty Bool Source #
Whether the configuration property is a key.
actionTypeProperty_noEcho :: Lens' ActionTypeProperty Bool Source #
Whether to omit the field value entered by the customer in the log. If
true, the value is not saved in CloudTrail logs for the action
execution.
ActionTypeSettings
data ActionTypeSettings Source #
Returns information about the settings for an action type.
See: newActionTypeSettings smart constructor.
Constructors
| ActionTypeSettings' | |
Fields
| |
Instances
newActionTypeSettings :: ActionTypeSettings Source #
Create a value of ActionTypeSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:thirdPartyConfigurationUrl:ActionTypeSettings', actionTypeSettings_thirdPartyConfigurationUrl - 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.
$sel:executionUrlTemplate:ActionTypeSettings', actionTypeSettings_executionUrlTemplate - The URL returned to the AWS CodePipeline console that contains a link to
the top-level landing page for the external system, such as the 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.
$sel:revisionUrlTemplate:ActionTypeSettings', actionTypeSettings_revisionUrlTemplate - 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.
$sel:entityUrlTemplate:ActionTypeSettings', actionTypeSettings_entityUrlTemplate - 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 in the pipeline.
actionTypeSettings_thirdPartyConfigurationUrl :: Lens' ActionTypeSettings (Maybe Text) Source #
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.
actionTypeSettings_executionUrlTemplate :: Lens' ActionTypeSettings (Maybe Text) Source #
The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the 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.
actionTypeSettings_revisionUrlTemplate :: Lens' ActionTypeSettings (Maybe Text) Source #
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.
actionTypeSettings_entityUrlTemplate :: Lens' ActionTypeSettings (Maybe Text) Source #
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 in the pipeline.
ActionTypeUrls
data ActionTypeUrls Source #
Returns information about URLs for web pages that display to customers as links on the pipeline view, such as an external configuration page for the action type.
See: newActionTypeUrls smart constructor.
Constructors
| ActionTypeUrls' | |
Fields
| |
Instances
newActionTypeUrls :: ActionTypeUrls Source #
Create a value of ActionTypeUrls with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:executionUrlTemplate:ActionTypeUrls', actionTypeUrls_executionUrlTemplate - The link to an execution page for the action type in progress. For
example, for a CodeDeploy action, this link is shown on the pipeline
view page in the CodePipeline console, and it links to a CodeDeploy
status page.
$sel:revisionUrlTemplate:ActionTypeUrls', actionTypeUrls_revisionUrlTemplate - The URL returned to the CodePipeline console that contains a link to the
page where customers can update or change the configuration of the
external action.
$sel:entityUrlTemplate:ActionTypeUrls', actionTypeUrls_entityUrlTemplate - The URL returned to the CodePipeline console that provides a deep link
to the resources of the external system, such as a status page. This
link is provided as part of the action display in the pipeline.
$sel:configurationUrl:ActionTypeUrls', actionTypeUrls_configurationUrl - The URL returned to the CodePipeline console that contains a link to the
page where customers can configure the external action.
actionTypeUrls_executionUrlTemplate :: Lens' ActionTypeUrls (Maybe Text) Source #
The link to an execution page for the action type in progress. For example, for a CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.
actionTypeUrls_revisionUrlTemplate :: Lens' ActionTypeUrls (Maybe Text) Source #
The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
actionTypeUrls_entityUrlTemplate :: Lens' ActionTypeUrls (Maybe Text) Source #
The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as a status page. This link is provided as part of the action display in the pipeline.
actionTypeUrls_configurationUrl :: Lens' ActionTypeUrls (Maybe Text) Source #
The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.
ApprovalResult
data ApprovalResult Source #
Represents information about the result of an approval request.
See: newApprovalResult smart constructor.
Constructors
| ApprovalResult' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ApprovalStatus | |
| -> ApprovalResult |
Create a value of ApprovalResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:summary:ApprovalResult', approvalResult_summary - The summary of the current status of the approval request.
$sel:status:ApprovalResult', approvalResult_status - The response submitted by a reviewer assigned to an approval action
request.
approvalResult_summary :: Lens' ApprovalResult Text Source #
The summary of the current status of the approval request.
approvalResult_status :: Lens' ApprovalResult ApprovalStatus Source #
The response submitted by a reviewer assigned to an approval action request.
Artifact
Represents information about an artifact that is worked on by actions in the pipeline.
See: newArtifact smart constructor.
Constructors
| Artifact' | |
Instances
| Eq Artifact Source # | |
| Read Artifact Source # | |
| Show Artifact Source # | |
| Generic Artifact Source # | |
| NFData Artifact Source # | |
Defined in Amazonka.CodePipeline.Types.Artifact | |
| Hashable Artifact Source # | |
Defined in Amazonka.CodePipeline.Types.Artifact | |
| FromJSON Artifact Source # | |
| type Rep Artifact Source # | |
Defined in Amazonka.CodePipeline.Types.Artifact type Rep Artifact = D1 ('MetaData "Artifact" "Amazonka.CodePipeline.Types.Artifact" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "Artifact'" 'PrefixI 'True) (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArtifactLocation)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newArtifact :: Artifact Source #
Create a value of Artifact with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:location:Artifact', artifact_location - The location of an artifact.
$sel:name:Artifact', artifact_name - The artifact's name.
$sel:revision:Artifact', artifact_revision - The artifact's revision ID. Depending on the type of object, this could
be a commit ID (GitHub) or a revision ID (Amazon S3).
artifact_location :: Lens' Artifact (Maybe ArtifactLocation) Source #
The location of an artifact.
artifact_revision :: Lens' Artifact (Maybe Text) Source #
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
ArtifactDetail
data ArtifactDetail Source #
Artifact details for the action execution, such as the artifact location.
See: newArtifactDetail smart constructor.
Constructors
| ArtifactDetail' | |
Fields
| |
Instances
newArtifactDetail :: ArtifactDetail Source #
Create a value of ArtifactDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ArtifactDetail', artifactDetail_name - The artifact object name for the action execution.
$sel:s3location:ArtifactDetail', artifactDetail_s3location - The Amazon S3 artifact location for the action execution.
artifactDetail_name :: Lens' ArtifactDetail (Maybe Text) Source #
The artifact object name for the action execution.
artifactDetail_s3location :: Lens' ArtifactDetail (Maybe S3Location) Source #
The Amazon S3 artifact location for the action execution.
ArtifactDetails
data ArtifactDetails Source #
Returns information about the details of an artifact.
See: newArtifactDetails smart constructor.
Constructors
| ArtifactDetails' | |
Fields
| |
Instances
Arguments
| :: Natural | |
| -> Natural | |
| -> ArtifactDetails |
Create a value of ArtifactDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:minimumCount:ArtifactDetails', artifactDetails_minimumCount - The minimum number of artifacts allowed for the action type.
$sel:maximumCount:ArtifactDetails', artifactDetails_maximumCount - The maximum number of artifacts allowed for the action type.
artifactDetails_minimumCount :: Lens' ArtifactDetails Natural Source #
The minimum number of artifacts allowed for the action type.
artifactDetails_maximumCount :: Lens' ArtifactDetails Natural Source #
The maximum number of artifacts allowed for the action type.
ArtifactLocation
data ArtifactLocation Source #
Represents information about the location of an artifact.
See: newArtifactLocation smart constructor.
Constructors
| ArtifactLocation' | |
Fields
| |
Instances
newArtifactLocation :: ArtifactLocation Source #
Create a value of ArtifactLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Location:ArtifactLocation', artifactLocation_s3Location - The S3 bucket that contains the artifact.
$sel:type':ArtifactLocation', artifactLocation_type - The type of artifact in the location.
artifactLocation_s3Location :: Lens' ArtifactLocation (Maybe S3ArtifactLocation) Source #
The S3 bucket that contains the artifact.
artifactLocation_type :: Lens' ArtifactLocation (Maybe ArtifactLocationType) Source #
The type of artifact in the location.
ArtifactRevision
data ArtifactRevision Source #
Represents revision details of an artifact.
See: newArtifactRevision smart constructor.
Constructors
| ArtifactRevision' | |
Fields
| |
Instances
newArtifactRevision :: ArtifactRevision Source #
Create a value of ArtifactRevision with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:revisionSummary:ArtifactRevision', artifactRevision_revisionSummary - 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.
$sel:revisionUrl:ArtifactRevision', artifactRevision_revisionUrl - 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.
$sel:created:ArtifactRevision', artifactRevision_created - The date and time when the most recent revision of the artifact was
created, in timestamp format.
$sel:name:ArtifactRevision', artifactRevision_name - The name of an artifact. This name might be system-generated, such as
"MyApp", or defined by the user when an action is created.
$sel:revisionId:ArtifactRevision', artifactRevision_revisionId - The revision ID of the artifact.
$sel:revisionChangeIdentifier:ArtifactRevision', artifactRevision_revisionChangeIdentifier - An additional identifier for a revision, such as a commit date or, for
artifacts stored in Amazon S3 buckets, the ETag value.
artifactRevision_revisionSummary :: Lens' ArtifactRevision (Maybe Text) Source #
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.
artifactRevision_revisionUrl :: Lens' ArtifactRevision (Maybe Text) Source #
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.
artifactRevision_created :: Lens' ArtifactRevision (Maybe UTCTime) Source #
The date and time when the most recent revision of the artifact was created, in timestamp format.
artifactRevision_name :: Lens' ArtifactRevision (Maybe Text) Source #
The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
artifactRevision_revisionId :: Lens' ArtifactRevision (Maybe Text) Source #
The revision ID of the artifact.
artifactRevision_revisionChangeIdentifier :: Lens' ArtifactRevision (Maybe Text) Source #
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 Source #
The S3 bucket where artifacts for the pipeline are stored.
You must include either artifactStore or artifactStores in your
pipeline, but you cannot use both. If you create a cross-region action
in your pipeline, you must use artifactStores.
See: newArtifactStore smart constructor.
Constructors
| ArtifactStore' | |
Fields
| |
Instances
Arguments
| :: ArtifactStoreType | |
| -> Text | |
| -> ArtifactStore |
Create a value of ArtifactStore with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionKey:ArtifactStore', artifactStore_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.
$sel:type':ArtifactStore', artifactStore_type - The type of the artifact store, such as S3.
$sel:location:ArtifactStore', artifactStore_location - The S3 bucket used for storing the artifacts for a pipeline. You can
specify the name of an S3 bucket but not a folder in the bucket. A
folder to contain the pipeline artifacts is created for you based on the
name of the pipeline. You can use any S3 bucket in the same AWS Region
as the pipeline to store your pipeline artifacts.
artifactStore_encryptionKey :: Lens' ArtifactStore (Maybe EncryptionKey) Source #
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.
artifactStore_type :: Lens' ArtifactStore ArtifactStoreType Source #
The type of the artifact store, such as S3.
artifactStore_location :: Lens' ArtifactStore Text Source #
The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
BlockerDeclaration
data BlockerDeclaration Source #
Reserved for future use.
See: newBlockerDeclaration smart constructor.
Constructors
| BlockerDeclaration' | |
Fields
| |
Instances
newBlockerDeclaration Source #
Arguments
| :: Text | |
| -> BlockerType | |
| -> BlockerDeclaration |
Create a value of BlockerDeclaration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:BlockerDeclaration', blockerDeclaration_name - Reserved for future use.
$sel:type':BlockerDeclaration', blockerDeclaration_type - Reserved for future use.
blockerDeclaration_name :: Lens' BlockerDeclaration Text Source #
Reserved for future use.
blockerDeclaration_type :: Lens' BlockerDeclaration BlockerType Source #
Reserved for future use.
CurrentRevision
data CurrentRevision Source #
Represents information about a current revision.
See: newCurrentRevision smart constructor.
Constructors
| CurrentRevision' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CurrentRevision |
Create a value of CurrentRevision with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:revisionSummary:CurrentRevision', currentRevision_revisionSummary - The summary of the most recent revision of the artifact.
$sel:created:CurrentRevision', currentRevision_created - The date and time when the most recent revision of the artifact was
created, in timestamp format.
$sel:revision:CurrentRevision', currentRevision_revision - The revision ID of the current version of an artifact.
$sel:changeIdentifier:CurrentRevision', currentRevision_changeIdentifier - The change identifier for the current revision.
currentRevision_revisionSummary :: Lens' CurrentRevision (Maybe Text) Source #
The summary of the most recent revision of the artifact.
currentRevision_created :: Lens' CurrentRevision (Maybe UTCTime) Source #
The date and time when the most recent revision of the artifact was created, in timestamp format.
currentRevision_revision :: Lens' CurrentRevision Text Source #
The revision ID of the current version of an artifact.
currentRevision_changeIdentifier :: Lens' CurrentRevision Text Source #
The change identifier for the current revision.
EncryptionKey
data EncryptionKey Source #
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
See: newEncryptionKey smart constructor.
Constructors
| EncryptionKey' | |
Fields
| |
Instances
Create a value of EncryptionKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:EncryptionKey', encryptionKey_id - The ID used to identify the key. For an AWS KMS key, you can use the key
ID, the key ARN, or the alias ARN.
Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
$sel:type':EncryptionKey', encryptionKey_type - 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'.
encryptionKey_id :: Lens' EncryptionKey Text Source #
The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.
Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
encryptionKey_type :: Lens' EncryptionKey EncryptionKeyType Source #
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 Source #
Represents information about an error in AWS CodePipeline.
See: newErrorDetails smart constructor.
Constructors
| ErrorDetails' | |
Instances
newErrorDetails :: ErrorDetails Source #
Create a value of ErrorDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:ErrorDetails', errorDetails_code - The system ID or number code of the error.
$sel:message:ErrorDetails', errorDetails_message - The text of the error message.
errorDetails_code :: Lens' ErrorDetails (Maybe Text) Source #
The system ID or number code of the error.
errorDetails_message :: Lens' ErrorDetails (Maybe Text) Source #
The text of the error message.
ExecutionDetails
data ExecutionDetails Source #
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
See: newExecutionDetails smart constructor.
Constructors
| ExecutionDetails' | |
Fields
| |
Instances
newExecutionDetails :: ExecutionDetails Source #
Create a value of ExecutionDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:summary:ExecutionDetails', executionDetails_summary - The summary of the current status of the actions.
$sel:externalExecutionId:ExecutionDetails', executionDetails_externalExecutionId - The system-generated unique ID of this action used to identify this job
worker in any external systems, such as AWS CodeDeploy.
$sel:percentComplete:ExecutionDetails', executionDetails_percentComplete - The percentage of work completed on the action, represented on a scale
of 0 to 100 percent.
executionDetails_summary :: Lens' ExecutionDetails (Maybe Text) Source #
The summary of the current status of the actions.
executionDetails_externalExecutionId :: Lens' ExecutionDetails (Maybe Text) Source #
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
executionDetails_percentComplete :: Lens' ExecutionDetails (Maybe Natural) Source #
The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
ExecutionTrigger
data ExecutionTrigger Source #
The interaction or event that started a pipeline execution.
See: newExecutionTrigger smart constructor.
Constructors
| ExecutionTrigger' | |
Fields
| |
Instances
newExecutionTrigger :: ExecutionTrigger Source #
Create a value of ExecutionTrigger with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:triggerType:ExecutionTrigger', executionTrigger_triggerType - The type of change-detection method, command, or user interaction that
started a pipeline execution.
$sel:triggerDetail:ExecutionTrigger', executionTrigger_triggerDetail - Detail related to the event that started a pipeline execution, such as
the webhook ARN of the webhook that triggered the pipeline execution or
the user ARN for a user-initiated start-pipeline-execution CLI
command.
executionTrigger_triggerType :: Lens' ExecutionTrigger (Maybe TriggerType) Source #
The type of change-detection method, command, or user interaction that started a pipeline execution.
executionTrigger_triggerDetail :: Lens' ExecutionTrigger (Maybe Text) Source #
Detail related to the event that started a pipeline execution, such as
the webhook ARN of the webhook that triggered the pipeline execution or
the user ARN for a user-initiated start-pipeline-execution CLI
command.
ExecutorConfiguration
data ExecutorConfiguration Source #
The action engine, or executor, related to the supported integration
model used to create and update the action type. The available executor
types are Lambda and JobWorker.
See: newExecutorConfiguration smart constructor.
Constructors
| ExecutorConfiguration' | |
Fields
| |
Instances
newExecutorConfiguration :: ExecutorConfiguration Source #
Create a value of ExecutorConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaExecutorConfiguration:ExecutorConfiguration', executorConfiguration_lambdaExecutorConfiguration - Details about the Lambda executor of the action type.
$sel:jobWorkerExecutorConfiguration:ExecutorConfiguration', executorConfiguration_jobWorkerExecutorConfiguration - Details about the JobWorker executor of the action type.
executorConfiguration_lambdaExecutorConfiguration :: Lens' ExecutorConfiguration (Maybe LambdaExecutorConfiguration) Source #
Details about the Lambda executor of the action type.
executorConfiguration_jobWorkerExecutorConfiguration :: Lens' ExecutorConfiguration (Maybe JobWorkerExecutorConfiguration) Source #
Details about the JobWorker executor of the action type.
FailureDetails
data FailureDetails Source #
Represents information about failure details.
See: newFailureDetails smart constructor.
Constructors
| FailureDetails' | |
Fields
| |
Instances
Arguments
| :: FailureType | |
| -> Text | |
| -> FailureDetails |
Create a value of FailureDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalExecutionId:FailureDetails', failureDetails_externalExecutionId - The external ID of the run of the action that failed.
$sel:type':FailureDetails', failureDetails_type - The type of the failure.
$sel:message:FailureDetails', failureDetails_message - The message about the failure.
failureDetails_externalExecutionId :: Lens' FailureDetails (Maybe Text) Source #
The external ID of the run of the action that failed.
failureDetails_type :: Lens' FailureDetails FailureType Source #
The type of the failure.
failureDetails_message :: Lens' FailureDetails Text Source #
The message about the failure.
InputArtifact
data InputArtifact Source #
Represents information about an artifact to be worked on, such as a test or build artifact.
See: newInputArtifact smart constructor.
Constructors
| InputArtifact' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> InputArtifact |
Create a value of InputArtifact with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:InputArtifact', inputArtifact_name - 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.
inputArtifact_name :: Lens' InputArtifact Text Source #
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: newJob smart constructor.
Constructors
| Job' | |
Fields
| |
Instances
| Eq Job Source # | |
| Show Job Source # | |
| Generic Job Source # | |
| NFData Job Source # | |
Defined in Amazonka.CodePipeline.Types.Job | |
| Hashable Job Source # | |
Defined in Amazonka.CodePipeline.Types.Job | |
| FromJSON Job Source # | |
| type Rep Job Source # | |
Defined in Amazonka.CodePipeline.Types.Job type Rep Job = D1 ('MetaData "Job" "Amazonka.CodePipeline.Types.Job" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "Job'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobData)) :*: S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nonce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
Create a value of Job with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':Job', job_data - Other data about a job.
$sel:accountId:Job', job_accountId - The ID of the AWS account to use when performing the job.
$sel:id:Job', job_id - The unique system-generated ID of the job.
$sel:nonce:Job', job_nonce - 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.
job_accountId :: Lens' Job (Maybe Text) Source #
The ID of the AWS account to use when performing the job.
job_nonce :: Lens' Job (Maybe Text) Source #
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 other information about a job required for a job worker to complete the job.
See: newJobData smart constructor.
Constructors
| JobData' | |
Fields
| |
Instances
newJobData :: JobData Source #
Create a value of JobData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:continuationToken:JobData', jobData_continuationToken - A system-generated token, such as a AWS CodeDeploy deployment ID,
required by a job to continue the job asynchronously.
$sel:outputArtifacts:JobData', jobData_outputArtifacts - The output of the job.
$sel:artifactCredentials:JobData', jobData_artifactCredentials - 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 S3 bucket
used to store artifacts for the pipeline in AWS CodePipeline.
$sel:pipelineContext:JobData', jobData_pipelineContext - Represents information about a pipeline to a job worker.
Includes pipelineArn and pipelineExecutionId for custom jobs.
$sel:encryptionKey:JobData', jobData_encryptionKey - Represents information about the key used to encrypt data in the
artifact store, such as an AWS Key Management Service (AWS KMS) key.
$sel:actionTypeId:JobData', jobData_actionTypeId - Represents information about an action type.
$sel:inputArtifacts:JobData', jobData_inputArtifacts - The artifact supplied to the job.
$sel:actionConfiguration:JobData', jobData_actionConfiguration - Represents information about an action configuration.
jobData_continuationToken :: Lens' JobData (Maybe Text) Source #
A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.
jobData_artifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials) Source #
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in AWS CodePipeline.
jobData_pipelineContext :: Lens' JobData (Maybe PipelineContext) Source #
Represents information about a pipeline to a job worker.
Includes pipelineArn and pipelineExecutionId for custom jobs.
jobData_encryptionKey :: Lens' JobData (Maybe EncryptionKey) Source #
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
jobData_actionTypeId :: Lens' JobData (Maybe ActionTypeId) Source #
Represents information about an action type.
jobData_inputArtifacts :: Lens' JobData (Maybe [Artifact]) Source #
The artifact supplied to the job.
jobData_actionConfiguration :: Lens' JobData (Maybe ActionConfiguration) Source #
Represents information about an action configuration.
JobDetails
data JobDetails Source #
Represents information about the details of a job.
See: newJobDetails smart constructor.
Constructors
| JobDetails' | |
Instances
newJobDetails :: JobDetails Source #
Create a value of JobDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':JobDetails', jobDetails_data - Represents other information about a job required for a job worker to
complete the job.
$sel:accountId:JobDetails', jobDetails_accountId - The AWS account ID associated with the job.
$sel:id:JobDetails', jobDetails_id - The unique system-generated ID of the job.
jobDetails_data :: Lens' JobDetails (Maybe JobData) Source #
Represents other information about a job required for a job worker to complete the job.
jobDetails_accountId :: Lens' JobDetails (Maybe Text) Source #
The AWS account ID associated with the job.
jobDetails_id :: Lens' JobDetails (Maybe Text) Source #
The unique system-generated ID of the job.
JobWorkerExecutorConfiguration
data JobWorkerExecutorConfiguration Source #
Details about the polling configuration for the JobWorker action
engine, or executor.
See: newJobWorkerExecutorConfiguration smart constructor.
Constructors
| JobWorkerExecutorConfiguration' | |
Fields
| |
Instances
newJobWorkerExecutorConfiguration :: JobWorkerExecutorConfiguration Source #
Create a value of JobWorkerExecutorConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pollingAccounts:JobWorkerExecutorConfiguration', jobWorkerExecutorConfiguration_pollingAccounts - The accounts in which the job worker is configured and might poll for
jobs as part of the action execution.
$sel:pollingServicePrincipals:JobWorkerExecutorConfiguration', jobWorkerExecutorConfiguration_pollingServicePrincipals - The service Principals in which the job worker is configured and might
poll for jobs as part of the action execution.
jobWorkerExecutorConfiguration_pollingAccounts :: Lens' JobWorkerExecutorConfiguration (Maybe (NonEmpty Text)) Source #
The accounts in which the job worker is configured and might poll for jobs as part of the action execution.
jobWorkerExecutorConfiguration_pollingServicePrincipals :: Lens' JobWorkerExecutorConfiguration (Maybe (NonEmpty Text)) Source #
The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.
LambdaExecutorConfiguration
data LambdaExecutorConfiguration Source #
Details about the configuration for the Lambda action engine, or
executor.
See: newLambdaExecutorConfiguration smart constructor.
Constructors
| LambdaExecutorConfiguration' | |
Fields
| |
Instances
newLambdaExecutorConfiguration Source #
Create a value of LambdaExecutorConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaFunctionArn:LambdaExecutorConfiguration', lambdaExecutorConfiguration_lambdaFunctionArn - The ARN of the Lambda function used by the action engine.
lambdaExecutorConfiguration_lambdaFunctionArn :: Lens' LambdaExecutorConfiguration Text Source #
The ARN of the Lambda function used by the action engine.
ListWebhookItem
data ListWebhookItem Source #
The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
See: newListWebhookItem smart constructor.
Constructors
| ListWebhookItem' | |
Fields
| |
Instances
Arguments
| :: WebhookDefinition | |
| -> Text | |
| -> ListWebhookItem |
Create a value of ListWebhookItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ListWebhookItem', listWebhookItem_arn - The Amazon Resource Name (ARN) of the webhook.
$sel:errorCode:ListWebhookItem', listWebhookItem_errorCode - The number code of the error.
$sel:lastTriggered:ListWebhookItem', listWebhookItem_lastTriggered - The date and time a webhook was last successfully triggered, in
timestamp format.
$sel:errorMessage:ListWebhookItem', listWebhookItem_errorMessage - The text of the error message about the webhook.
$sel:tags:ListWebhookItem', listWebhookItem_tags - Specifies the tags applied to the webhook.
$sel:definition:ListWebhookItem', listWebhookItem_definition - The detail returned for each webhook, such as the webhook authentication
type and filter rules.
$sel:url:ListWebhookItem', listWebhookItem_url - A unique URL generated by CodePipeline. When a POST request is made to
this URL, the defined pipeline is started as long as the body of the
post request satisfies the defined authentication and filtering
conditions. Deleting and re-creating a webhook makes the old URL invalid
and generates a new one.
listWebhookItem_arn :: Lens' ListWebhookItem (Maybe Text) Source #
The Amazon Resource Name (ARN) of the webhook.
listWebhookItem_errorCode :: Lens' ListWebhookItem (Maybe Text) Source #
The number code of the error.
listWebhookItem_lastTriggered :: Lens' ListWebhookItem (Maybe UTCTime) Source #
The date and time a webhook was last successfully triggered, in timestamp format.
listWebhookItem_errorMessage :: Lens' ListWebhookItem (Maybe Text) Source #
The text of the error message about the webhook.
listWebhookItem_tags :: Lens' ListWebhookItem (Maybe [Tag]) Source #
Specifies the tags applied to the webhook.
listWebhookItem_definition :: Lens' ListWebhookItem WebhookDefinition Source #
The detail returned for each webhook, such as the webhook authentication type and filter rules.
listWebhookItem_url :: Lens' ListWebhookItem Text Source #
A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
OutputArtifact
data OutputArtifact Source #
Represents information about the output of an action.
See: newOutputArtifact smart constructor.
Constructors
| OutputArtifact' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> OutputArtifact |
Create a value of OutputArtifact with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:OutputArtifact', outputArtifact_name - 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.
outputArtifact_name :: Lens' OutputArtifact Text Source #
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 Source #
Represents information about a pipeline to a job worker.
PipelineContext contains pipelineArn and pipelineExecutionId for
custom action jobs. The pipelineArn and pipelineExecutionId fields
are not populated for ThirdParty action jobs.
See: newPipelineContext smart constructor.
Constructors
| PipelineContext' | |
Fields
| |
Instances
newPipelineContext :: PipelineContext Source #
Create a value of PipelineContext with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stage:PipelineContext', pipelineContext_stage - The stage of the pipeline.
$sel:pipelineName:PipelineContext', pipelineContext_pipelineName - 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.
$sel:action:PipelineContext', pipelineContext_action - The context of an action to a job worker in the stage of a pipeline.
$sel:pipelineArn:PipelineContext', pipelineContext_pipelineArn - The Amazon Resource Name (ARN) of the pipeline.
$sel:pipelineExecutionId:PipelineContext', pipelineContext_pipelineExecutionId - The execution ID of the pipeline.
pipelineContext_stage :: Lens' PipelineContext (Maybe StageContext) Source #
The stage of the pipeline.
pipelineContext_pipelineName :: Lens' PipelineContext (Maybe Text) Source #
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.
pipelineContext_action :: Lens' PipelineContext (Maybe ActionContext) Source #
The context of an action to a job worker in the stage of a pipeline.
pipelineContext_pipelineArn :: Lens' PipelineContext (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pipeline.
pipelineContext_pipelineExecutionId :: Lens' PipelineContext (Maybe Text) Source #
The execution ID of the pipeline.
PipelineDeclaration
data PipelineDeclaration Source #
Represents the structure of actions and stages to be performed in the pipeline.
See: newPipelineDeclaration smart constructor.
Constructors
| PipelineDeclaration' | |
Fields
| |
Instances
newPipelineDeclaration Source #
Arguments
| :: Text | |
| -> Text | |
| -> PipelineDeclaration |
Create a value of PipelineDeclaration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:artifactStores:PipelineDeclaration', pipelineDeclaration_artifactStores - A mapping of artifactStore objects and their corresponding AWS
Regions. There must be an artifact store for the pipeline Region and for
each cross-region action in the pipeline.
You must include either artifactStore or artifactStores in your
pipeline, but you cannot use both. If you create a cross-region action
in your pipeline, you must use artifactStores.
$sel:artifactStore:PipelineDeclaration', pipelineDeclaration_artifactStore - Represents information about the S3 bucket where artifacts are stored
for the pipeline.
You must include either artifactStore or artifactStores in your
pipeline, but you cannot use both. If you create a cross-region action
in your pipeline, you must use artifactStores.
$sel:version:PipelineDeclaration', pipelineDeclaration_version - The version number of the pipeline. A new pipeline always has a version
number of 1. This number is incremented when a pipeline is updated.
$sel:name:PipelineDeclaration', pipelineDeclaration_name - The name of the pipeline.
$sel:roleArn:PipelineDeclaration', pipelineDeclaration_roleArn - 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.
$sel:stages:PipelineDeclaration', pipelineDeclaration_stages - The stage in which to perform the action.
pipelineDeclaration_artifactStores :: Lens' PipelineDeclaration (Maybe (HashMap Text ArtifactStore)) Source #
A mapping of artifactStore objects and their corresponding AWS
Regions. There must be an artifact store for the pipeline Region and for
each cross-region action in the pipeline.
You must include either artifactStore or artifactStores in your
pipeline, but you cannot use both. If you create a cross-region action
in your pipeline, you must use artifactStores.
pipelineDeclaration_artifactStore :: Lens' PipelineDeclaration (Maybe ArtifactStore) Source #
Represents information about the S3 bucket where artifacts are stored for the pipeline.
You must include either artifactStore or artifactStores in your
pipeline, but you cannot use both. If you create a cross-region action
in your pipeline, you must use artifactStores.
pipelineDeclaration_version :: Lens' PipelineDeclaration (Maybe Natural) Source #
The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
pipelineDeclaration_name :: Lens' PipelineDeclaration Text Source #
The name of the pipeline.
pipelineDeclaration_roleArn :: Lens' PipelineDeclaration Text Source #
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.
pipelineDeclaration_stages :: Lens' PipelineDeclaration [StageDeclaration] Source #
The stage in which to perform the action.
PipelineExecution
data PipelineExecution Source #
Represents information about an execution of a pipeline.
See: newPipelineExecution smart constructor.
Constructors
| PipelineExecution' | |
Fields
| |
Instances
newPipelineExecution :: PipelineExecution Source #
Create a value of PipelineExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:PipelineExecution', pipelineExecution_status - The status of the pipeline execution.
- Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
- InProgress: The pipeline execution is currently running.
- Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
- Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
- Succeeded: The pipeline execution was completed successfully.
- Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
- Failed: The pipeline execution was not completed successfully.
$sel:pipelineName:PipelineExecution', pipelineExecution_pipelineName - The name of the pipeline with the specified pipeline execution.
$sel:statusSummary:PipelineExecution', pipelineExecution_statusSummary - A summary that contains a description of the pipeline execution status.
$sel:pipelineVersion:PipelineExecution', pipelineExecution_pipelineVersion - The version number of the pipeline with the specified pipeline
execution.
$sel:pipelineExecutionId:PipelineExecution', pipelineExecution_pipelineExecutionId - The ID of the pipeline execution.
$sel:artifactRevisions:PipelineExecution', pipelineExecution_artifactRevisions - A list of ArtifactRevision objects included in a pipeline execution.
pipelineExecution_status :: Lens' PipelineExecution (Maybe PipelineExecutionStatus) Source #
The status of the pipeline execution.
- Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
- InProgress: The pipeline execution is currently running.
- Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
- Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
- Succeeded: The pipeline execution was completed successfully.
- Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
- Failed: The pipeline execution was not completed successfully.
pipelineExecution_pipelineName :: Lens' PipelineExecution (Maybe Text) Source #
The name of the pipeline with the specified pipeline execution.
pipelineExecution_statusSummary :: Lens' PipelineExecution (Maybe Text) Source #
A summary that contains a description of the pipeline execution status.
pipelineExecution_pipelineVersion :: Lens' PipelineExecution (Maybe Natural) Source #
The version number of the pipeline with the specified pipeline execution.
pipelineExecution_pipelineExecutionId :: Lens' PipelineExecution (Maybe Text) Source #
The ID of the pipeline execution.
pipelineExecution_artifactRevisions :: Lens' PipelineExecution (Maybe [ArtifactRevision]) Source #
A list of ArtifactRevision objects included in a pipeline execution.
PipelineExecutionSummary
data PipelineExecutionSummary Source #
Summary information about a pipeline execution.
See: newPipelineExecutionSummary smart constructor.
Constructors
| PipelineExecutionSummary' | |
Fields
| |
Instances
newPipelineExecutionSummary :: PipelineExecutionSummary Source #
Create a value of PipelineExecutionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:PipelineExecutionSummary', pipelineExecutionSummary_status - The status of the pipeline execution.
- InProgress: The pipeline execution is currently running.
- Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
- Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
- Succeeded: The pipeline execution was completed successfully.
- Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
- Failed: The pipeline execution was not completed successfully.
$sel:startTime:PipelineExecutionSummary', pipelineExecutionSummary_startTime - The date and time when the pipeline execution began, in timestamp
format.
$sel:stopTrigger:PipelineExecutionSummary', pipelineExecutionSummary_stopTrigger - The interaction that stopped a pipeline execution.
$sel:pipelineExecutionId:PipelineExecutionSummary', pipelineExecutionSummary_pipelineExecutionId - The ID of the pipeline execution.
$sel:sourceRevisions:PipelineExecutionSummary', pipelineExecutionSummary_sourceRevisions - A list of the source artifact revisions that initiated a pipeline
execution.
$sel:trigger:PipelineExecutionSummary', pipelineExecutionSummary_trigger - The interaction or event that started a pipeline execution, such as
automated change detection or a StartPipelineExecution API call.
$sel:lastUpdateTime:PipelineExecutionSummary', pipelineExecutionSummary_lastUpdateTime - The date and time of the last change to the pipeline execution, in
timestamp format.
pipelineExecutionSummary_status :: Lens' PipelineExecutionSummary (Maybe PipelineExecutionStatus) Source #
The status of the pipeline execution.
- InProgress: The pipeline execution is currently running.
- Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
- Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
- Succeeded: The pipeline execution was completed successfully.
- Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
- Failed: The pipeline execution was not completed successfully.
pipelineExecutionSummary_startTime :: Lens' PipelineExecutionSummary (Maybe UTCTime) Source #
The date and time when the pipeline execution began, in timestamp format.
pipelineExecutionSummary_stopTrigger :: Lens' PipelineExecutionSummary (Maybe StopExecutionTrigger) Source #
The interaction that stopped a pipeline execution.
pipelineExecutionSummary_pipelineExecutionId :: Lens' PipelineExecutionSummary (Maybe Text) Source #
The ID of the pipeline execution.
pipelineExecutionSummary_sourceRevisions :: Lens' PipelineExecutionSummary (Maybe [SourceRevision]) Source #
A list of the source artifact revisions that initiated a pipeline execution.
pipelineExecutionSummary_trigger :: Lens' PipelineExecutionSummary (Maybe ExecutionTrigger) Source #
The interaction or event that started a pipeline execution, such as
automated change detection or a StartPipelineExecution API call.
pipelineExecutionSummary_lastUpdateTime :: Lens' PipelineExecutionSummary (Maybe UTCTime) Source #
The date and time of the last change to the pipeline execution, in timestamp format.
PipelineMetadata
data PipelineMetadata Source #
Information about a pipeline.
See: newPipelineMetadata smart constructor.
Constructors
| PipelineMetadata' | |
Instances
newPipelineMetadata :: PipelineMetadata Source #
Create a value of PipelineMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:created:PipelineMetadata', pipelineMetadata_created - The date and time the pipeline was created, in timestamp format.
$sel:pipelineArn:PipelineMetadata', pipelineMetadata_pipelineArn - The Amazon Resource Name (ARN) of the pipeline.
$sel:updated:PipelineMetadata', pipelineMetadata_updated - The date and time the pipeline was last updated, in timestamp format.
pipelineMetadata_created :: Lens' PipelineMetadata (Maybe UTCTime) Source #
The date and time the pipeline was created, in timestamp format.
pipelineMetadata_pipelineArn :: Lens' PipelineMetadata (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pipeline.
pipelineMetadata_updated :: Lens' PipelineMetadata (Maybe UTCTime) Source #
The date and time the pipeline was last updated, in timestamp format.
PipelineSummary
data PipelineSummary Source #
Returns a summary of a pipeline.
See: newPipelineSummary smart constructor.
Constructors
| PipelineSummary' | |
Instances
newPipelineSummary :: PipelineSummary Source #
Create a value of PipelineSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:created:PipelineSummary', pipelineSummary_created - The date and time the pipeline was created, in timestamp format.
$sel:name:PipelineSummary', pipelineSummary_name - The name of the pipeline.
$sel:version:PipelineSummary', pipelineSummary_version - The version number of the pipeline.
$sel:updated:PipelineSummary', pipelineSummary_updated - The date and time of the last update to the pipeline, in timestamp
format.
pipelineSummary_created :: Lens' PipelineSummary (Maybe UTCTime) Source #
The date and time the pipeline was created, in timestamp format.
pipelineSummary_name :: Lens' PipelineSummary (Maybe Text) Source #
The name of the pipeline.
pipelineSummary_version :: Lens' PipelineSummary (Maybe Natural) Source #
The version number of the pipeline.
pipelineSummary_updated :: Lens' PipelineSummary (Maybe UTCTime) Source #
The date and time of the last update to the pipeline, in timestamp format.
S3ArtifactLocation
data S3ArtifactLocation Source #
The location of the S3 bucket that contains a revision.
See: newS3ArtifactLocation smart constructor.
Constructors
| S3ArtifactLocation' | |
Fields
| |
Instances
newS3ArtifactLocation Source #
Arguments
| :: Text | |
| -> Text | |
| -> S3ArtifactLocation |
Create a value of S3ArtifactLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketName:S3ArtifactLocation', s3ArtifactLocation_bucketName - The name of the S3 bucket.
$sel:objectKey:S3ArtifactLocation', s3ArtifactLocation_objectKey - The key of the object in the S3 bucket, which uniquely identifies the
object in the bucket.
s3ArtifactLocation_bucketName :: Lens' S3ArtifactLocation Text Source #
The name of the S3 bucket.
s3ArtifactLocation_objectKey :: Lens' S3ArtifactLocation Text Source #
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
S3Location
data S3Location Source #
The Amazon S3 artifact location for an action's artifacts.
See: newS3Location smart constructor.
Constructors
| S3Location' | |
Instances
newS3Location :: S3Location Source #
Create a value of S3Location with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:S3Location', s3Location_bucket - The Amazon S3 artifact bucket for an action's artifacts.
$sel:key:S3Location', s3Location_key - The artifact name.
s3Location_bucket :: Lens' S3Location (Maybe Text) Source #
The Amazon S3 artifact bucket for an action's artifacts.
s3Location_key :: Lens' S3Location (Maybe Text) Source #
The artifact name.
SourceRevision
data SourceRevision Source #
Information about the version (or revision) of a source artifact that initiated a pipeline execution.
See: newSourceRevision smart constructor.
Constructors
| SourceRevision' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SourceRevision |
Create a value of SourceRevision with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:revisionSummary:SourceRevision', sourceRevision_revisionSummary - 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.
$sel:revisionUrl:SourceRevision', sourceRevision_revisionUrl - 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.
$sel:revisionId:SourceRevision', sourceRevision_revisionId - The system-generated unique ID that identifies the revision number of
the artifact.
$sel:actionName:SourceRevision', sourceRevision_actionName - The name of the action that processed the revision to the source
artifact.
sourceRevision_revisionSummary :: Lens' SourceRevision (Maybe Text) Source #
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.
sourceRevision_revisionUrl :: Lens' SourceRevision (Maybe Text) Source #
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.
sourceRevision_revisionId :: Lens' SourceRevision (Maybe Text) Source #
The system-generated unique ID that identifies the revision number of the artifact.
sourceRevision_actionName :: Lens' SourceRevision Text Source #
The name of the action that processed the revision to the source artifact.
StageContext
data StageContext Source #
Represents information about a stage to a job worker.
See: newStageContext smart constructor.
Constructors
| StageContext' | |
Instances
newStageContext :: StageContext Source #
Create a value of StageContext with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:StageContext', stageContext_name - The name of the stage.
stageContext_name :: Lens' StageContext (Maybe Text) Source #
The name of the stage.
StageDeclaration
data StageDeclaration Source #
Represents information about a stage and its definition.
See: newStageDeclaration smart constructor.
Constructors
| StageDeclaration' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> StageDeclaration |
Create a value of StageDeclaration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockers:StageDeclaration', stageDeclaration_blockers - Reserved for future use.
$sel:name:StageDeclaration', stageDeclaration_name - The name of the stage.
$sel:actions:StageDeclaration', stageDeclaration_actions - The actions included in a stage.
stageDeclaration_blockers :: Lens' StageDeclaration (Maybe [BlockerDeclaration]) Source #
Reserved for future use.
stageDeclaration_name :: Lens' StageDeclaration Text Source #
The name of the stage.
stageDeclaration_actions :: Lens' StageDeclaration [ActionDeclaration] Source #
The actions included in a stage.
StageExecution
data StageExecution Source #
Represents information about the run of a stage.
See: newStageExecution smart constructor.
Constructors
| StageExecution' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> StageExecutionStatus | |
| -> StageExecution |
Create a value of StageExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineExecutionId:StageExecution', stageExecution_pipelineExecutionId - The ID of the pipeline execution associated with the stage.
$sel:status:StageExecution', stageExecution_status - The status of the stage, or for a completed stage, the last status of
the stage.
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
stageExecution_pipelineExecutionId :: Lens' StageExecution Text Source #
The ID of the pipeline execution associated with the stage.
stageExecution_status :: Lens' StageExecution StageExecutionStatus Source #
The status of the stage, or for a completed stage, the last status of the stage.
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
StageState
data StageState Source #
Represents information about the state of the stage.
See: newStageState smart constructor.
Constructors
| StageState' | |
Fields
| |
Instances
newStageState :: StageState Source #
Create a value of StageState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inboundExecution:StageState', stageState_inboundExecution - Undocumented member.
$sel:inboundTransitionState:StageState', stageState_inboundTransitionState - The state of the inbound transition, which is either enabled or
disabled.
$sel:actionStates:StageState', stageState_actionStates - The state of the stage.
$sel:stageName:StageState', stageState_stageName - The name of the stage.
$sel:latestExecution:StageState', stageState_latestExecution - Information about the latest execution in the stage, including its ID
and status.
stageState_inboundExecution :: Lens' StageState (Maybe StageExecution) Source #
Undocumented member.
stageState_inboundTransitionState :: Lens' StageState (Maybe TransitionState) Source #
The state of the inbound transition, which is either enabled or disabled.
stageState_actionStates :: Lens' StageState (Maybe [ActionState]) Source #
The state of the stage.
stageState_stageName :: Lens' StageState (Maybe Text) Source #
The name of the stage.
stageState_latestExecution :: Lens' StageState (Maybe StageExecution) Source #
Information about the latest execution in the stage, including its ID and status.
StopExecutionTrigger
data StopExecutionTrigger Source #
The interaction that stopped a pipeline execution.
See: newStopExecutionTrigger smart constructor.
Constructors
| StopExecutionTrigger' | |
Instances
newStopExecutionTrigger :: StopExecutionTrigger Source #
Create a value of StopExecutionTrigger with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reason:StopExecutionTrigger', stopExecutionTrigger_reason - The user-specified reason the pipeline was stopped.
stopExecutionTrigger_reason :: Lens' StopExecutionTrigger (Maybe Text) Source #
The user-specified reason the pipeline was stopped.
Tag
A tag is a key-value pair that is used to manage the resource.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.CodePipeline.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.CodePipeline.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.CodePipeline.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.CodePipeline.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CodePipeline.Types.Tag" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The tag's key.
$sel:value:Tag', tag_value - The tag's value.
ThirdPartyJob
data ThirdPartyJob Source #
A response to a PollForThirdPartyJobs request returned by AWS
CodePipeline when there is a job to be worked on by a partner action.
See: newThirdPartyJob smart constructor.
Constructors
| ThirdPartyJob' | |
Instances
newThirdPartyJob :: ThirdPartyJob Source #
Create a value of ThirdPartyJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientId:ThirdPartyJob', thirdPartyJob_clientId - 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.
$sel:jobId:ThirdPartyJob', thirdPartyJob_jobId - The identifier used to identify the job in AWS CodePipeline.
thirdPartyJob_clientId :: Lens' ThirdPartyJob (Maybe Text) Source #
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.
thirdPartyJob_jobId :: Lens' ThirdPartyJob (Maybe Text) Source #
The identifier used to identify the job in AWS CodePipeline.
ThirdPartyJobData
data ThirdPartyJobData Source #
Represents information about the job data for a partner action.
See: newThirdPartyJobData smart constructor.
Constructors
| ThirdPartyJobData' | |
Fields
| |
Instances
newThirdPartyJobData :: ThirdPartyJobData Source #
Create a value of ThirdPartyJobData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:continuationToken:ThirdPartyJobData', thirdPartyJobData_continuationToken - A system-generated token, such as a AWS CodeDeploy deployment ID, that a
job requires to continue the job asynchronously.
$sel:outputArtifacts:ThirdPartyJobData', thirdPartyJobData_outputArtifacts - The name of the artifact that is the result of the action, if any. This
name might be system-generated, such as "MyBuiltApp", or it might be
defined by the user when the action is created.
$sel:artifactCredentials:ThirdPartyJobData', thirdPartyJobData_artifactCredentials - 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 S3 bucket
used to store artifact for the pipeline in AWS CodePipeline.
$sel:pipelineContext:ThirdPartyJobData', thirdPartyJobData_pipelineContext - Represents information about a pipeline to a job worker.
Does not include pipelineArn and pipelineExecutionId for ThirdParty
jobs.
$sel:encryptionKey:ThirdPartyJobData', thirdPartyJobData_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.
$sel:actionTypeId:ThirdPartyJobData', thirdPartyJobData_actionTypeId - Represents information about an action type.
$sel:inputArtifacts:ThirdPartyJobData', thirdPartyJobData_inputArtifacts - The name of the artifact that is worked on by the action, if any. This
name might be system-generated, such as "MyApp", or it 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.
$sel:actionConfiguration:ThirdPartyJobData', thirdPartyJobData_actionConfiguration - Represents information about an action configuration.
thirdPartyJobData_continuationToken :: Lens' ThirdPartyJobData (Maybe Text) Source #
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
thirdPartyJobData_outputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact]) Source #
The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
thirdPartyJobData_artifactCredentials :: Lens' ThirdPartyJobData (Maybe AWSSessionCredentials) Source #
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
thirdPartyJobData_pipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext) Source #
Represents information about a pipeline to a job worker.
Does not include pipelineArn and pipelineExecutionId for ThirdParty
jobs.
thirdPartyJobData_encryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey) Source #
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.
thirdPartyJobData_actionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId) Source #
Represents information about an action type.
thirdPartyJobData_inputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact]) Source #
The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it 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.
thirdPartyJobData_actionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration) Source #
Represents information about an action configuration.
ThirdPartyJobDetails
data ThirdPartyJobDetails Source #
The details of a job sent in response to a GetThirdPartyJobDetails
request.
See: newThirdPartyJobDetails smart constructor.
Constructors
| ThirdPartyJobDetails' | |
Fields
| |
Instances
newThirdPartyJobDetails :: ThirdPartyJobDetails Source #
Create a value of ThirdPartyJobDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':ThirdPartyJobDetails', thirdPartyJobDetails_data - The data to be returned by the third party job worker.
$sel:id:ThirdPartyJobDetails', thirdPartyJobDetails_id - The identifier used to identify the job details in AWS CodePipeline.
$sel:nonce:ThirdPartyJobDetails', thirdPartyJobDetails_nonce - 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.
thirdPartyJobDetails_data :: Lens' ThirdPartyJobDetails (Maybe ThirdPartyJobData) Source #
The data to be returned by the third party job worker.
thirdPartyJobDetails_id :: Lens' ThirdPartyJobDetails (Maybe Text) Source #
The identifier used to identify the job details in AWS CodePipeline.
thirdPartyJobDetails_nonce :: Lens' ThirdPartyJobDetails (Maybe Text) Source #
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 Source #
Represents information about the state of transitions between one stage and another stage.
See: newTransitionState smart constructor.
Constructors
| TransitionState' | |
Fields
| |
Instances
newTransitionState :: TransitionState Source #
Create a value of TransitionState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:TransitionState', transitionState_enabled - Whether the transition between stages is enabled (true) or disabled
(false).
$sel:disabledReason:TransitionState', transitionState_disabledReason - The user-specified reason why the transition between two stages of a
pipeline was disabled.
$sel:lastChangedAt:TransitionState', transitionState_lastChangedAt - The timestamp when the transition state was last changed.
$sel:lastChangedBy:TransitionState', transitionState_lastChangedBy - The ID of the user who last changed the transition state.
transitionState_enabled :: Lens' TransitionState (Maybe Bool) Source #
Whether the transition between stages is enabled (true) or disabled (false).
transitionState_disabledReason :: Lens' TransitionState (Maybe Text) Source #
The user-specified reason why the transition between two stages of a pipeline was disabled.
transitionState_lastChangedAt :: Lens' TransitionState (Maybe UTCTime) Source #
The timestamp when the transition state was last changed.
transitionState_lastChangedBy :: Lens' TransitionState (Maybe Text) Source #
The ID of the user who last changed the transition state.
WebhookAuthConfiguration
data WebhookAuthConfiguration Source #
The authentication applied to incoming webhook trigger requests.
See: newWebhookAuthConfiguration smart constructor.
Constructors
| WebhookAuthConfiguration' | |
Fields
| |
Instances
newWebhookAuthConfiguration :: WebhookAuthConfiguration Source #
Create a value of WebhookAuthConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowedIPRange:WebhookAuthConfiguration', webhookAuthConfiguration_allowedIPRange - The property used to configure acceptance of webhooks in an IP address
range. For IP, only the AllowedIPRange property must be set. This
property must be set to a valid CIDR range.
$sel:secretToken:WebhookAuthConfiguration', webhookAuthConfiguration_secretToken - The property used to configure GitHub authentication. For GITHUB_HMAC,
only the SecretToken property must be set.
webhookAuthConfiguration_allowedIPRange :: Lens' WebhookAuthConfiguration (Maybe Text) Source #
The property used to configure acceptance of webhooks in an IP address
range. For IP, only the AllowedIPRange property must be set. This
property must be set to a valid CIDR range.
webhookAuthConfiguration_secretToken :: Lens' WebhookAuthConfiguration (Maybe Text) Source #
The property used to configure GitHub authentication. For GITHUB_HMAC,
only the SecretToken property must be set.
WebhookDefinition
data WebhookDefinition Source #
Represents information about a webhook and its definition.
See: newWebhookDefinition smart constructor.
Constructors
| WebhookDefinition' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> WebhookAuthenticationType | |
| -> WebhookAuthConfiguration | |
| -> WebhookDefinition |
Create a value of WebhookDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:WebhookDefinition', webhookDefinition_name - The name of the webhook.
$sel:targetPipeline:WebhookDefinition', webhookDefinition_targetPipeline - The name of the pipeline you want to connect to the webhook.
$sel:targetAction:WebhookDefinition', webhookDefinition_targetAction - 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.
$sel:filters:WebhookDefinition', webhookDefinition_filters - 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.
$sel:authentication:WebhookDefinition', webhookDefinition_authentication - Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
- For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
- IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
- UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
$sel:authenticationConfiguration:WebhookDefinition', webhookDefinition_authenticationConfiguration - 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.
webhookDefinition_name :: Lens' WebhookDefinition Text Source #
The name of the webhook.
webhookDefinition_targetPipeline :: Lens' WebhookDefinition Text Source #
The name of the pipeline you want to connect to the webhook.
webhookDefinition_targetAction :: Lens' WebhookDefinition Text Source #
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.
webhookDefinition_filters :: Lens' WebhookDefinition [WebhookFilterRule] Source #
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.
webhookDefinition_authentication :: Lens' WebhookDefinition WebhookAuthenticationType Source #
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
- For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
- IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
- UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
webhookDefinition_authenticationConfiguration :: Lens' WebhookDefinition WebhookAuthConfiguration Source #
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 Source #
The event criteria that specify when a webhook notification is sent to your URL.
See: newWebhookFilterRule smart constructor.
Constructors
| WebhookFilterRule' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> WebhookFilterRule |
Create a value of WebhookFilterRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:matchEquals:WebhookFilterRule', webhookFilterRule_matchEquals - The value selected by the JsonPath expression must match what is
supplied in the MatchEquals field. Otherwise, the request is ignored.
Properties from the target action configuration can be included as
placeholders in this value by surrounding the action configuration key
with curly brackets. For example, if the value supplied here is
"refs/heads/{Branch}" and the target action has an action
configuration property called "Branch" with a value of "master", the
MatchEquals value is evaluated as "refs/heads/master". For a list
of action configuration properties for built-in action types, see
Pipeline Structure Reference Action Requirements.
$sel:jsonPath:WebhookFilterRule', webhookFilterRule_jsonPath - A JsonPath expression that is applied to the body/payload of the
webhook. The value selected by the JsonPath expression must match the
value specified in the MatchEquals field. Otherwise, the request is
ignored. For more information, see
Java JsonPath implementation in
GitHub.
webhookFilterRule_matchEquals :: Lens' WebhookFilterRule (Maybe Text) Source #
The value selected by the JsonPath expression must match what is
supplied in the MatchEquals field. Otherwise, the request is ignored.
Properties from the target action configuration can be included as
placeholders in this value by surrounding the action configuration key
with curly brackets. For example, if the value supplied here is
"refs/heads/{Branch}" and the target action has an action
configuration property called "Branch" with a value of "master", the
MatchEquals value is evaluated as "refs/heads/master". For a list
of action configuration properties for built-in action types, see
Pipeline Structure Reference Action Requirements.
webhookFilterRule_jsonPath :: Lens' WebhookFilterRule Text Source #
A JsonPath expression that is applied to the body/payload of the
webhook. The value selected by the JsonPath expression must match the
value specified in the MatchEquals field. Otherwise, the request is
ignored. For more information, see
Java JsonPath implementation in
GitHub.