Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- ActionNotFoundException
- ActionTypeAlreadyExistsException
- ActionTypeNotFoundException
- ApprovalAlreadyCompletedException
- ConcurrentModificationException
- ConflictException
- DuplicatedStopRequestException
- InvalidActionDeclarationException
- InvalidApprovalTokenException
- InvalidArnException
- InvalidBlockerDeclarationException
- InvalidClientTokenException
- InvalidJobException
- InvalidJobStateException
- InvalidNextTokenException
- InvalidNonceException
- InvalidStageDeclarationException
- InvalidStructureException
- InvalidTagsException
- InvalidWebhookAuthenticationParametersException
- InvalidWebhookFilterPatternException
- JobNotFoundException
- LimitExceededException
- NotLatestPipelineExecutionException
- OutputVariablesSizeExceededException
- PipelineExecutionNotFoundException
- PipelineExecutionNotStoppableException
- PipelineNameInUseException
- PipelineNotFoundException
- PipelineVersionNotFoundException
- RequestFailedException
- ResourceNotFoundException
- StageNotFoundException
- StageNotRetryableException
- TooManyTagsException
- ValidationException
- WebhookNotFoundException
- Waiters
- Operations
- AcknowledgeJob
- AcknowledgeThirdPartyJob
- CreateCustomActionType
- CreatePipeline
- DeleteCustomActionType
- DeletePipeline
- DeleteWebhook
- DeregisterWebhookWithThirdParty
- DisableStageTransition
- EnableStageTransition
- GetActionType
- GetJobDetails
- GetPipeline
- GetPipelineExecution
- GetPipelineState
- GetThirdPartyJobDetails
- ListActionExecutions (Paginated)
- ListActionTypes (Paginated)
- ListPipelineExecutions (Paginated)
- ListPipelines (Paginated)
- ListTagsForResource (Paginated)
- ListWebhooks (Paginated)
- PollForJobs
- PollForThirdPartyJobs
- PutActionRevision
- PutApprovalResult
- PutJobFailureResult
- PutJobSuccessResult
- PutThirdPartyJobFailureResult
- PutThirdPartyJobSuccessResult
- PutWebhook
- RegisterWebhookWithThirdParty
- RetryStageExecution
- StartPipelineExecution
- StopPipelineExecution
- TagResource
- UntagResource
- UpdateActionType
- UpdatePipeline
- Types
- 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
Derived from API version 2015-07-09
of the AWS service descriptions, licensed under Apache 2.0.
AWS CodePipeline
Overview
This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the AWS CodePipeline User Guide.
You can use the AWS CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
- CreatePipeline, which creates a uniquely named pipeline.
- DeletePipeline, which deletes the specified pipeline.
- GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
- GetPipelineExecution, which returns information about a specific execution of a pipeline.
- GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
- ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
- ListPipelines, which gets a summary of all of the pipelines associated with your account.
- ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
- StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
- StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
- UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see AWS CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
- Source
- Build
- Test
- Deploy
- Approval
- Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
- DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
- EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with AWS CodePipeline
For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. To integrate with AWS CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
- AcknowledgeJob, which confirms whether a job worker has received the specified job.
- GetJobDetails, which returns the details of a job.
- PollForJobs, which determines whether there are any jobs to act on.
- PutJobFailureResult, which provides details of a job failure.
- PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.
You can work with third party jobs by calling:
- AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
- GetThirdPartyJobDetails, which requests the details of a job for a partner action.
- PollForThirdPartyJobs, which determines whether there are any jobs to act on.
- PutThirdPartyJobFailureResult, which provides details of a job failure.
- PutThirdPartyJobSuccessResult, which provides details of a job success.
Synopsis
- defaultService :: Service
- _ActionNotFoundException :: AsError a => Fold a ServiceError
- _ActionTypeAlreadyExistsException :: AsError a => Fold a ServiceError
- _ActionTypeNotFoundException :: AsError a => Fold a ServiceError
- _ApprovalAlreadyCompletedException :: AsError a => Fold a ServiceError
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _DuplicatedStopRequestException :: AsError a => Fold a ServiceError
- _InvalidActionDeclarationException :: AsError a => Fold a ServiceError
- _InvalidApprovalTokenException :: AsError a => Fold a ServiceError
- _InvalidArnException :: AsError a => Fold a ServiceError
- _InvalidBlockerDeclarationException :: AsError a => Fold a ServiceError
- _InvalidClientTokenException :: AsError a => Fold a ServiceError
- _InvalidJobException :: AsError a => Fold a ServiceError
- _InvalidJobStateException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidNonceException :: AsError a => Fold a ServiceError
- _InvalidStageDeclarationException :: AsError a => Fold a ServiceError
- _InvalidStructureException :: AsError a => Fold a ServiceError
- _InvalidTagsException :: AsError a => Fold a ServiceError
- _InvalidWebhookAuthenticationParametersException :: AsError a => Fold a ServiceError
- _InvalidWebhookFilterPatternException :: AsError a => Fold a ServiceError
- _JobNotFoundException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _NotLatestPipelineExecutionException :: AsError a => Fold a ServiceError
- _OutputVariablesSizeExceededException :: AsError a => Fold a ServiceError
- _PipelineExecutionNotFoundException :: AsError a => Fold a ServiceError
- _PipelineExecutionNotStoppableException :: AsError a => Fold a ServiceError
- _PipelineNameInUseException :: AsError a => Fold a ServiceError
- _PipelineNotFoundException :: AsError a => Fold a ServiceError
- _PipelineVersionNotFoundException :: AsError a => Fold a ServiceError
- _RequestFailedException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _StageNotFoundException :: AsError a => Fold a ServiceError
- _StageNotRetryableException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- _WebhookNotFoundException :: AsError a => Fold a ServiceError
- data AcknowledgeJob = AcknowledgeJob' Text Text
- newAcknowledgeJob :: Text -> Text -> AcknowledgeJob
- data AcknowledgeJobResponse = AcknowledgeJobResponse' (Maybe JobStatus) Int
- newAcknowledgeJobResponse :: Int -> AcknowledgeJobResponse
- data AcknowledgeThirdPartyJob = AcknowledgeThirdPartyJob' Text Text Text
- newAcknowledgeThirdPartyJob :: Text -> Text -> Text -> AcknowledgeThirdPartyJob
- data AcknowledgeThirdPartyJobResponse = AcknowledgeThirdPartyJobResponse' (Maybe JobStatus) Int
- newAcknowledgeThirdPartyJobResponse :: Int -> AcknowledgeThirdPartyJobResponse
- data CreateCustomActionType = CreateCustomActionType' (Maybe [ActionConfigurationProperty]) (Maybe ActionTypeSettings) (Maybe [Tag]) ActionCategory Text Text ArtifactDetails ArtifactDetails
- newCreateCustomActionType :: ActionCategory -> Text -> Text -> ArtifactDetails -> ArtifactDetails -> CreateCustomActionType
- data CreateCustomActionTypeResponse = CreateCustomActionTypeResponse' (Maybe [Tag]) Int ActionType
- newCreateCustomActionTypeResponse :: Int -> ActionType -> CreateCustomActionTypeResponse
- data CreatePipeline = CreatePipeline' (Maybe [Tag]) PipelineDeclaration
- newCreatePipeline :: PipelineDeclaration -> CreatePipeline
- data CreatePipelineResponse = CreatePipelineResponse' (Maybe PipelineDeclaration) (Maybe [Tag]) Int
- newCreatePipelineResponse :: Int -> CreatePipelineResponse
- data DeleteCustomActionType = DeleteCustomActionType' ActionCategory Text Text
- newDeleteCustomActionType :: ActionCategory -> Text -> Text -> DeleteCustomActionType
- data DeleteCustomActionTypeResponse = DeleteCustomActionTypeResponse' {
- newDeleteCustomActionTypeResponse :: DeleteCustomActionTypeResponse
- data DeletePipeline = DeletePipeline' Text
- newDeletePipeline :: Text -> DeletePipeline
- data DeletePipelineResponse = DeletePipelineResponse' {
- newDeletePipelineResponse :: DeletePipelineResponse
- data DeleteWebhook = DeleteWebhook' Text
- newDeleteWebhook :: Text -> DeleteWebhook
- data DeleteWebhookResponse = DeleteWebhookResponse' Int
- newDeleteWebhookResponse :: Int -> DeleteWebhookResponse
- data DeregisterWebhookWithThirdParty = DeregisterWebhookWithThirdParty' (Maybe Text)
- newDeregisterWebhookWithThirdParty :: DeregisterWebhookWithThirdParty
- data DeregisterWebhookWithThirdPartyResponse = DeregisterWebhookWithThirdPartyResponse' Int
- newDeregisterWebhookWithThirdPartyResponse :: Int -> DeregisterWebhookWithThirdPartyResponse
- data DisableStageTransition = DisableStageTransition' Text Text StageTransitionType Text
- newDisableStageTransition :: Text -> Text -> StageTransitionType -> Text -> DisableStageTransition
- data DisableStageTransitionResponse = DisableStageTransitionResponse' {
- newDisableStageTransitionResponse :: DisableStageTransitionResponse
- data EnableStageTransition = EnableStageTransition' Text Text StageTransitionType
- newEnableStageTransition :: Text -> Text -> StageTransitionType -> EnableStageTransition
- data EnableStageTransitionResponse = EnableStageTransitionResponse' {
- newEnableStageTransitionResponse :: EnableStageTransitionResponse
- data GetActionType = GetActionType' ActionCategory Text Text Text
- newGetActionType :: ActionCategory -> Text -> Text -> Text -> GetActionType
- data GetActionTypeResponse = GetActionTypeResponse' (Maybe ActionTypeDeclaration) Int
- newGetActionTypeResponse :: Int -> GetActionTypeResponse
- data GetJobDetails = GetJobDetails' Text
- newGetJobDetails :: Text -> GetJobDetails
- data GetJobDetailsResponse = GetJobDetailsResponse' (Maybe JobDetails) Int
- newGetJobDetailsResponse :: Int -> GetJobDetailsResponse
- data GetPipeline = GetPipeline' (Maybe Natural) Text
- newGetPipeline :: Text -> GetPipeline
- data GetPipelineResponse = GetPipelineResponse' (Maybe PipelineMetadata) (Maybe PipelineDeclaration) Int
- newGetPipelineResponse :: Int -> GetPipelineResponse
- data GetPipelineExecution = GetPipelineExecution' Text Text
- newGetPipelineExecution :: Text -> Text -> GetPipelineExecution
- data GetPipelineExecutionResponse = GetPipelineExecutionResponse' (Maybe PipelineExecution) Int
- newGetPipelineExecutionResponse :: Int -> GetPipelineExecutionResponse
- data GetPipelineState = GetPipelineState' Text
- newGetPipelineState :: Text -> GetPipelineState
- data GetPipelineStateResponse = GetPipelineStateResponse' (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe [StageState]) (Maybe POSIX) Int
- newGetPipelineStateResponse :: Int -> GetPipelineStateResponse
- data GetThirdPartyJobDetails = GetThirdPartyJobDetails' Text Text
- newGetThirdPartyJobDetails :: Text -> Text -> GetThirdPartyJobDetails
- data GetThirdPartyJobDetailsResponse = GetThirdPartyJobDetailsResponse' (Maybe ThirdPartyJobDetails) Int
- newGetThirdPartyJobDetailsResponse :: Int -> GetThirdPartyJobDetailsResponse
- data ListActionExecutions = ListActionExecutions' (Maybe ActionExecutionFilter) (Maybe Natural) (Maybe Text) Text
- newListActionExecutions :: Text -> ListActionExecutions
- data ListActionExecutionsResponse = ListActionExecutionsResponse' (Maybe [ActionExecutionDetail]) (Maybe Text) Int
- newListActionExecutionsResponse :: Int -> ListActionExecutionsResponse
- data ListActionTypes = ListActionTypes' (Maybe ActionOwner) (Maybe Text) (Maybe Text)
- newListActionTypes :: ListActionTypes
- data ListActionTypesResponse = ListActionTypesResponse' (Maybe Text) Int [ActionType]
- newListActionTypesResponse :: Int -> ListActionTypesResponse
- data ListPipelineExecutions = ListPipelineExecutions' (Maybe Natural) (Maybe Text) Text
- newListPipelineExecutions :: Text -> ListPipelineExecutions
- data ListPipelineExecutionsResponse = ListPipelineExecutionsResponse' (Maybe Text) (Maybe [PipelineExecutionSummary]) Int
- newListPipelineExecutionsResponse :: Int -> ListPipelineExecutionsResponse
- data ListPipelines = ListPipelines' (Maybe Natural) (Maybe Text)
- newListPipelines :: ListPipelines
- data ListPipelinesResponse = ListPipelinesResponse' (Maybe Text) (Maybe [PipelineSummary]) Int
- newListPipelinesResponse :: Int -> ListPipelinesResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListWebhooks = ListWebhooks' (Maybe Natural) (Maybe Text)
- newListWebhooks :: ListWebhooks
- data ListWebhooksResponse = ListWebhooksResponse' (Maybe Text) (Maybe [ListWebhookItem]) Int
- newListWebhooksResponse :: Int -> ListWebhooksResponse
- data PollForJobs = PollForJobs' (Maybe Natural) (Maybe (HashMap Text Text)) ActionTypeId
- newPollForJobs :: ActionTypeId -> PollForJobs
- data PollForJobsResponse = PollForJobsResponse' (Maybe [Job]) Int
- newPollForJobsResponse :: Int -> PollForJobsResponse
- data PollForThirdPartyJobs = PollForThirdPartyJobs' (Maybe Natural) ActionTypeId
- newPollForThirdPartyJobs :: ActionTypeId -> PollForThirdPartyJobs
- data PollForThirdPartyJobsResponse = PollForThirdPartyJobsResponse' (Maybe [ThirdPartyJob]) Int
- newPollForThirdPartyJobsResponse :: Int -> PollForThirdPartyJobsResponse
- data PutActionRevision = PutActionRevision' Text Text Text ActionRevision
- newPutActionRevision :: Text -> Text -> Text -> ActionRevision -> PutActionRevision
- data PutActionRevisionResponse = PutActionRevisionResponse' (Maybe Bool) (Maybe Text) Int
- newPutActionRevisionResponse :: Int -> PutActionRevisionResponse
- data PutApprovalResult = PutApprovalResult' Text Text Text ApprovalResult Text
- newPutApprovalResult :: Text -> Text -> Text -> ApprovalResult -> Text -> PutApprovalResult
- data PutApprovalResultResponse = PutApprovalResultResponse' (Maybe POSIX) Int
- newPutApprovalResultResponse :: Int -> PutApprovalResultResponse
- data PutJobFailureResult = PutJobFailureResult' Text FailureDetails
- newPutJobFailureResult :: Text -> FailureDetails -> PutJobFailureResult
- data PutJobFailureResultResponse = PutJobFailureResultResponse' {
- newPutJobFailureResultResponse :: PutJobFailureResultResponse
- data PutJobSuccessResult = PutJobSuccessResult' (Maybe Text) (Maybe CurrentRevision) (Maybe ExecutionDetails) (Maybe (HashMap Text Text)) Text
- newPutJobSuccessResult :: Text -> PutJobSuccessResult
- data PutJobSuccessResultResponse = PutJobSuccessResultResponse' {
- newPutJobSuccessResultResponse :: PutJobSuccessResultResponse
- data PutThirdPartyJobFailureResult = PutThirdPartyJobFailureResult' Text Text FailureDetails
- newPutThirdPartyJobFailureResult :: Text -> Text -> FailureDetails -> PutThirdPartyJobFailureResult
- data PutThirdPartyJobFailureResultResponse = PutThirdPartyJobFailureResultResponse' {
- newPutThirdPartyJobFailureResultResponse :: PutThirdPartyJobFailureResultResponse
- data PutThirdPartyJobSuccessResult = PutThirdPartyJobSuccessResult' (Maybe Text) (Maybe CurrentRevision) (Maybe ExecutionDetails) Text Text
- newPutThirdPartyJobSuccessResult :: Text -> Text -> PutThirdPartyJobSuccessResult
- data PutThirdPartyJobSuccessResultResponse = PutThirdPartyJobSuccessResultResponse' {
- newPutThirdPartyJobSuccessResultResponse :: PutThirdPartyJobSuccessResultResponse
- data PutWebhook = PutWebhook' (Maybe [Tag]) WebhookDefinition
- newPutWebhook :: WebhookDefinition -> PutWebhook
- data PutWebhookResponse = PutWebhookResponse' (Maybe ListWebhookItem) Int
- newPutWebhookResponse :: Int -> PutWebhookResponse
- data RegisterWebhookWithThirdParty = RegisterWebhookWithThirdParty' (Maybe Text)
- newRegisterWebhookWithThirdParty :: RegisterWebhookWithThirdParty
- data RegisterWebhookWithThirdPartyResponse = RegisterWebhookWithThirdPartyResponse' Int
- newRegisterWebhookWithThirdPartyResponse :: Int -> RegisterWebhookWithThirdPartyResponse
- data RetryStageExecution = RetryStageExecution' Text Text Text StageRetryMode
- newRetryStageExecution :: Text -> Text -> Text -> StageRetryMode -> RetryStageExecution
- data RetryStageExecutionResponse = RetryStageExecutionResponse' (Maybe Text) Int
- newRetryStageExecutionResponse :: Int -> RetryStageExecutionResponse
- data StartPipelineExecution = StartPipelineExecution' (Maybe Text) Text
- newStartPipelineExecution :: Text -> StartPipelineExecution
- data StartPipelineExecutionResponse = StartPipelineExecutionResponse' (Maybe Text) Int
- newStartPipelineExecutionResponse :: Int -> StartPipelineExecutionResponse
- data StopPipelineExecution = StopPipelineExecution' (Maybe Bool) (Maybe Text) Text Text
- newStopPipelineExecution :: Text -> Text -> StopPipelineExecution
- data StopPipelineExecutionResponse = StopPipelineExecutionResponse' (Maybe Text) Int
- newStopPipelineExecutionResponse :: Int -> StopPipelineExecutionResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateActionType = UpdateActionType' ActionTypeDeclaration
- newUpdateActionType :: ActionTypeDeclaration -> UpdateActionType
- data UpdateActionTypeResponse = UpdateActionTypeResponse' {
- newUpdateActionTypeResponse :: UpdateActionTypeResponse
- data UpdatePipeline = UpdatePipeline' PipelineDeclaration
- newUpdatePipeline :: PipelineDeclaration -> UpdatePipeline
- data UpdatePipelineResponse = UpdatePipelineResponse' (Maybe PipelineDeclaration) Int
- newUpdatePipelineResponse :: Int -> UpdatePipelineResponse
- 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' (Sensitive Text) (Sensitive Text) (Sensitive Text)
- newAWSSessionCredentials :: Text -> Text -> Text -> AWSSessionCredentials
- data ActionConfiguration = ActionConfiguration' (Maybe (HashMap Text Text))
- newActionConfiguration :: ActionConfiguration
- data ActionConfigurationProperty = ActionConfigurationProperty' (Maybe Text) (Maybe Bool) (Maybe ActionConfigurationPropertyType) Text Bool Bool Bool
- newActionConfigurationProperty :: Text -> Bool -> Bool -> Bool -> ActionConfigurationProperty
- data ActionContext = ActionContext' (Maybe Text) (Maybe Text)
- newActionContext :: ActionContext
- data ActionDeclaration = ActionDeclaration' (Maybe (HashMap Text Text)) (Maybe [InputArtifact]) (Maybe Text) (Maybe [OutputArtifact]) (Maybe Text) (Maybe Text) (Maybe Natural) Text ActionTypeId
- newActionDeclaration :: Text -> ActionTypeId -> ActionDeclaration
- data ActionExecution = ActionExecution' (Maybe Text) (Maybe ErrorDetails) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe ActionExecutionStatus) (Maybe Text) (Maybe Text)
- newActionExecution :: ActionExecution
- data ActionExecutionDetail = ActionExecutionDetail' (Maybe Text) (Maybe Text) (Maybe ActionExecutionInput) (Maybe POSIX) (Maybe ActionExecutionOutput) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe ActionExecutionStatus)
- newActionExecutionDetail :: ActionExecutionDetail
- data ActionExecutionFilter = ActionExecutionFilter' (Maybe Text)
- newActionExecutionFilter :: ActionExecutionFilter
- data ActionExecutionInput = ActionExecutionInput' (Maybe ActionTypeId) (Maybe (HashMap Text Text)) (Maybe [ArtifactDetail]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text)
- newActionExecutionInput :: ActionExecutionInput
- data ActionExecutionOutput = ActionExecutionOutput' (Maybe ActionExecutionResult) (Maybe [ArtifactDetail]) (Maybe (HashMap Text Text))
- newActionExecutionOutput :: ActionExecutionOutput
- data ActionExecutionResult = ActionExecutionResult' (Maybe Text) (Maybe Text) (Maybe Text)
- newActionExecutionResult :: ActionExecutionResult
- data ActionRevision = ActionRevision' Text Text POSIX
- newActionRevision :: Text -> Text -> UTCTime -> ActionRevision
- data ActionState = ActionState' (Maybe Text) (Maybe ActionRevision) (Maybe Text) (Maybe ActionExecution) (Maybe Text)
- newActionState :: ActionState
- data ActionType = ActionType' (Maybe [ActionConfigurationProperty]) (Maybe ActionTypeSettings) ActionTypeId ArtifactDetails ArtifactDetails
- newActionType :: ActionTypeId -> ArtifactDetails -> ArtifactDetails -> ActionType
- data ActionTypeArtifactDetails = ActionTypeArtifactDetails' Natural Natural
- newActionTypeArtifactDetails :: Natural -> Natural -> ActionTypeArtifactDetails
- data ActionTypeDeclaration = ActionTypeDeclaration' (Maybe Text) (Maybe ActionTypePermissions) (Maybe [ActionTypeProperty]) (Maybe ActionTypeUrls) ActionTypeExecutor ActionTypeIdentifier ActionTypeArtifactDetails ActionTypeArtifactDetails
- newActionTypeDeclaration :: ActionTypeExecutor -> ActionTypeIdentifier -> ActionTypeArtifactDetails -> ActionTypeArtifactDetails -> ActionTypeDeclaration
- data ActionTypeExecutor = ActionTypeExecutor' (Maybe Natural) (Maybe Text) ExecutorConfiguration ExecutorType
- newActionTypeExecutor :: ExecutorConfiguration -> ExecutorType -> ActionTypeExecutor
- data ActionTypeId = ActionTypeId' ActionCategory ActionOwner Text Text
- newActionTypeId :: ActionCategory -> ActionOwner -> Text -> Text -> ActionTypeId
- data ActionTypeIdentifier = ActionTypeIdentifier' ActionCategory Text Text Text
- newActionTypeIdentifier :: ActionCategory -> Text -> Text -> Text -> ActionTypeIdentifier
- data ActionTypePermissions = ActionTypePermissions' (NonEmpty Text)
- newActionTypePermissions :: NonEmpty Text -> ActionTypePermissions
- data ActionTypeProperty = ActionTypeProperty' (Maybe Text) (Maybe Bool) Text Bool Bool Bool
- newActionTypeProperty :: Text -> Bool -> Bool -> Bool -> ActionTypeProperty
- data ActionTypeSettings = ActionTypeSettings' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newActionTypeSettings :: ActionTypeSettings
- data ActionTypeUrls = ActionTypeUrls' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newActionTypeUrls :: ActionTypeUrls
- data ApprovalResult = ApprovalResult' Text ApprovalStatus
- newApprovalResult :: Text -> ApprovalStatus -> ApprovalResult
- data Artifact = Artifact' (Maybe ArtifactLocation) (Maybe Text) (Maybe Text)
- newArtifact :: Artifact
- data ArtifactDetail = ArtifactDetail' (Maybe Text) (Maybe S3Location)
- newArtifactDetail :: ArtifactDetail
- data ArtifactDetails = ArtifactDetails' Natural Natural
- newArtifactDetails :: Natural -> Natural -> ArtifactDetails
- data ArtifactLocation = ArtifactLocation' (Maybe S3ArtifactLocation) (Maybe ArtifactLocationType)
- newArtifactLocation :: ArtifactLocation
- data ArtifactRevision = ArtifactRevision' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newArtifactRevision :: ArtifactRevision
- data ArtifactStore = ArtifactStore' (Maybe EncryptionKey) ArtifactStoreType Text
- newArtifactStore :: ArtifactStoreType -> Text -> ArtifactStore
- data BlockerDeclaration = BlockerDeclaration' Text BlockerType
- newBlockerDeclaration :: Text -> BlockerType -> BlockerDeclaration
- data CurrentRevision = CurrentRevision' (Maybe POSIX) (Maybe Text) Text Text
- newCurrentRevision :: Text -> Text -> CurrentRevision
- data EncryptionKey = EncryptionKey' Text EncryptionKeyType
- newEncryptionKey :: Text -> EncryptionKeyType -> EncryptionKey
- data ErrorDetails = ErrorDetails' (Maybe Text) (Maybe Text)
- newErrorDetails :: ErrorDetails
- data ExecutionDetails = ExecutionDetails' (Maybe Text) (Maybe Natural) (Maybe Text)
- newExecutionDetails :: ExecutionDetails
- data ExecutionTrigger = ExecutionTrigger' (Maybe Text) (Maybe TriggerType)
- newExecutionTrigger :: ExecutionTrigger
- data ExecutorConfiguration = ExecutorConfiguration' (Maybe JobWorkerExecutorConfiguration) (Maybe LambdaExecutorConfiguration)
- newExecutorConfiguration :: ExecutorConfiguration
- data FailureDetails = FailureDetails' (Maybe Text) FailureType Text
- newFailureDetails :: FailureType -> Text -> FailureDetails
- data InputArtifact = InputArtifact' Text
- newInputArtifact :: Text -> InputArtifact
- data Job = Job' (Maybe Text) (Maybe JobData) (Maybe Text) (Maybe Text)
- newJob :: Job
- data JobData = JobData' (Maybe ActionConfiguration) (Maybe ActionTypeId) (Maybe (Sensitive AWSSessionCredentials)) (Maybe Text) (Maybe EncryptionKey) (Maybe [Artifact]) (Maybe [Artifact]) (Maybe PipelineContext)
- newJobData :: JobData
- data JobDetails = JobDetails' (Maybe Text) (Maybe JobData) (Maybe Text)
- newJobDetails :: JobDetails
- data JobWorkerExecutorConfiguration = JobWorkerExecutorConfiguration' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text))
- newJobWorkerExecutorConfiguration :: JobWorkerExecutorConfiguration
- data LambdaExecutorConfiguration = LambdaExecutorConfiguration' Text
- newLambdaExecutorConfiguration :: Text -> LambdaExecutorConfiguration
- data ListWebhookItem = ListWebhookItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [Tag]) WebhookDefinition Text
- newListWebhookItem :: WebhookDefinition -> Text -> ListWebhookItem
- data OutputArtifact = OutputArtifact' Text
- newOutputArtifact :: Text -> OutputArtifact
- data PipelineContext = PipelineContext' (Maybe ActionContext) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe StageContext)
- newPipelineContext :: PipelineContext
- data PipelineDeclaration = PipelineDeclaration' (Maybe ArtifactStore) (Maybe (HashMap Text ArtifactStore)) (Maybe Natural) Text Text [StageDeclaration]
- newPipelineDeclaration :: Text -> Text -> PipelineDeclaration
- data PipelineExecution = PipelineExecution' (Maybe [ArtifactRevision]) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe PipelineExecutionStatus) (Maybe Text)
- newPipelineExecution :: PipelineExecution
- data PipelineExecutionSummary = PipelineExecutionSummary' (Maybe POSIX) (Maybe Text) (Maybe [SourceRevision]) (Maybe POSIX) (Maybe PipelineExecutionStatus) (Maybe StopExecutionTrigger) (Maybe ExecutionTrigger)
- newPipelineExecutionSummary :: PipelineExecutionSummary
- data PipelineMetadata = PipelineMetadata' (Maybe POSIX) (Maybe Text) (Maybe POSIX)
- newPipelineMetadata :: PipelineMetadata
- data PipelineSummary = PipelineSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Natural)
- newPipelineSummary :: PipelineSummary
- data S3ArtifactLocation = S3ArtifactLocation' Text Text
- newS3ArtifactLocation :: Text -> Text -> S3ArtifactLocation
- data S3Location = S3Location' (Maybe Text) (Maybe Text)
- newS3Location :: S3Location
- data SourceRevision = SourceRevision' (Maybe Text) (Maybe Text) (Maybe Text) Text
- newSourceRevision :: Text -> SourceRevision
- data StageContext = StageContext' (Maybe Text)
- newStageContext :: StageContext
- data StageDeclaration = StageDeclaration' (Maybe [BlockerDeclaration]) Text [ActionDeclaration]
- newStageDeclaration :: Text -> StageDeclaration
- data StageExecution = StageExecution' Text StageExecutionStatus
- newStageExecution :: Text -> StageExecutionStatus -> StageExecution
- data StageState = StageState' (Maybe [ActionState]) (Maybe StageExecution) (Maybe TransitionState) (Maybe StageExecution) (Maybe Text)
- newStageState :: StageState
- data StopExecutionTrigger = StopExecutionTrigger' (Maybe Text)
- newStopExecutionTrigger :: StopExecutionTrigger
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data ThirdPartyJob = ThirdPartyJob' (Maybe Text) (Maybe Text)
- newThirdPartyJob :: ThirdPartyJob
- data ThirdPartyJobData = ThirdPartyJobData' (Maybe ActionConfiguration) (Maybe ActionTypeId) (Maybe (Sensitive AWSSessionCredentials)) (Maybe Text) (Maybe EncryptionKey) (Maybe [Artifact]) (Maybe [Artifact]) (Maybe PipelineContext)
- newThirdPartyJobData :: ThirdPartyJobData
- data ThirdPartyJobDetails = ThirdPartyJobDetails' (Maybe ThirdPartyJobData) (Maybe Text) (Maybe Text)
- newThirdPartyJobDetails :: ThirdPartyJobDetails
- data TransitionState = TransitionState' (Maybe Text) (Maybe Bool) (Maybe POSIX) (Maybe Text)
- newTransitionState :: TransitionState
- data WebhookAuthConfiguration = WebhookAuthConfiguration' (Maybe Text) (Maybe Text)
- newWebhookAuthConfiguration :: WebhookAuthConfiguration
- data WebhookDefinition = WebhookDefinition' Text Text Text [WebhookFilterRule] WebhookAuthenticationType WebhookAuthConfiguration
- newWebhookDefinition :: Text -> Text -> Text -> WebhookAuthenticationType -> WebhookAuthConfiguration -> WebhookDefinition
- data WebhookFilterRule = WebhookFilterRule' (Maybe Text) Text
- newWebhookFilterRule :: Text -> WebhookFilterRule
Service Configuration
defaultService :: Service Source #
API version 2015-07-09
of the Amazon CodePipeline SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CodePipeline
.
ActionNotFoundException
_ActionNotFoundException :: AsError a => Fold a ServiceError Source #
The specified action cannot be found.
ActionTypeAlreadyExistsException
_ActionTypeAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified action type already exists with a different definition.
ActionTypeNotFoundException
_ActionTypeNotFoundException :: AsError a => Fold a ServiceError Source #
The specified action type cannot be found.
ApprovalAlreadyCompletedException
_ApprovalAlreadyCompletedException :: AsError a => Fold a ServiceError Source #
The approval action has already been approved or rejected.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
Unable to modify the tag due to a simultaneous update request.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
DuplicatedStopRequestException
_DuplicatedStopRequestException :: AsError a => Fold 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.
InvalidActionDeclarationException
_InvalidActionDeclarationException :: AsError a => Fold a ServiceError Source #
The action declaration was specified in an invalid format.
InvalidApprovalTokenException
_InvalidApprovalTokenException :: AsError a => Fold a ServiceError Source #
The approval request already received a response or has expired.
InvalidArnException
_InvalidArnException :: AsError a => Fold a ServiceError Source #
The specified resource ARN is invalid.
InvalidBlockerDeclarationException
_InvalidBlockerDeclarationException :: AsError a => Fold a ServiceError Source #
Reserved for future use.
InvalidClientTokenException
_InvalidClientTokenException :: AsError a => Fold a ServiceError Source #
The client token was specified in an invalid format
InvalidJobException
_InvalidJobException :: AsError a => Fold a ServiceError Source #
The job was specified in an invalid format or cannot be found.
InvalidJobStateException
_InvalidJobStateException :: AsError a => Fold a ServiceError Source #
The job state was specified in an invalid format.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold 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.
InvalidNonceException
_InvalidNonceException :: AsError a => Fold a ServiceError Source #
The nonce was specified in an invalid format.
InvalidStageDeclarationException
_InvalidStageDeclarationException :: AsError a => Fold a ServiceError Source #
The stage declaration was specified in an invalid format.
InvalidStructureException
_InvalidStructureException :: AsError a => Fold a ServiceError Source #
The structure was specified in an invalid format.
InvalidTagsException
_InvalidTagsException :: AsError a => Fold a ServiceError Source #
The specified resource tags are invalid.
InvalidWebhookAuthenticationParametersException
_InvalidWebhookAuthenticationParametersException :: AsError a => Fold a ServiceError Source #
The specified authentication type is in an invalid format.
InvalidWebhookFilterPatternException
_InvalidWebhookFilterPatternException :: AsError a => Fold a ServiceError Source #
The specified event filter rule is in an invalid format.
JobNotFoundException
_JobNotFoundException :: AsError a => Fold a ServiceError Source #
The job was specified in an invalid format or cannot be found.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
NotLatestPipelineExecutionException
_NotLatestPipelineExecutionException :: AsError a => Fold 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.
OutputVariablesSizeExceededException
_OutputVariablesSizeExceededException :: AsError a => Fold a ServiceError Source #
Exceeded the total size limit for all variables in the pipeline.
PipelineExecutionNotFoundException
_PipelineExecutionNotFoundException :: AsError a => Fold 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.
PipelineExecutionNotStoppableException
_PipelineExecutionNotStoppableException :: AsError a => Fold 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.
PipelineNameInUseException
_PipelineNameInUseException :: AsError a => Fold a ServiceError Source #
The specified pipeline name is already in use.
PipelineNotFoundException
_PipelineNotFoundException :: AsError a => Fold a ServiceError Source #
The pipeline was specified in an invalid format or cannot be found.
PipelineVersionNotFoundException
_PipelineVersionNotFoundException :: AsError a => Fold a ServiceError Source #
The pipeline version was specified in an invalid format or cannot be found.
RequestFailedException
_RequestFailedException :: AsError a => Fold a ServiceError Source #
The request failed because of an unknown error, exception, or failure.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource was specified in an invalid format.
StageNotFoundException
_StageNotFoundException :: AsError a => Fold a ServiceError Source #
The stage was specified in an invalid format or cannot be found.
StageNotRetryableException
_StageNotRetryableException :: AsError a => Fold 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.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
The tags limit for a resource has been exceeded.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The validation was specified in an invalid format.
WebhookNotFoundException
_WebhookNotFoundException :: AsError a => Fold a ServiceError Source #
The specified webhook was entered in an invalid format or cannot be found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AcknowledgeJob
data AcknowledgeJob Source #
Represents the input of an AcknowledgeJob action.
See: newAcknowledgeJob
smart constructor.
Instances
Create a value of AcknowledgeJob
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:
AcknowledgeJob
, acknowledgeJob_jobId
- The unique system-generated ID of the job for which you want to confirm
receipt.
AcknowledgeJob
, acknowledgeJob_nonce
- A system-generated random number that AWS CodePipeline uses to ensure
that the job is being worked on by only one job worker. Get this number
from the response of the PollForJobs request that returned this job.
data AcknowledgeJobResponse Source #
Represents the output of an AcknowledgeJob action.
See: newAcknowledgeJobResponse
smart constructor.
Instances
newAcknowledgeJobResponse Source #
Create a value of AcknowledgeJobResponse
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:
AcknowledgeJobResponse
, acknowledgeJobResponse_status
- Whether the job worker has received the specified job.
$sel:httpStatus:AcknowledgeJobResponse'
, acknowledgeJobResponse_httpStatus
- The response's http status code.
AcknowledgeThirdPartyJob
data AcknowledgeThirdPartyJob Source #
Represents the input of an AcknowledgeThirdPartyJob action.
See: newAcknowledgeThirdPartyJob
smart constructor.
Instances
newAcknowledgeThirdPartyJob Source #
:: Text | |
-> Text | |
-> Text | |
-> AcknowledgeThirdPartyJob |
Create a value of AcknowledgeThirdPartyJob
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:
AcknowledgeThirdPartyJob
, acknowledgeThirdPartyJob_jobId
- The unique system-generated ID of the job.
AcknowledgeThirdPartyJob
, acknowledgeThirdPartyJob_nonce
- A system-generated random number that AWS CodePipeline uses to ensure
that the job is being worked on by only one job worker. Get this number
from the response to a GetThirdPartyJobDetails request.
$sel:clientToken:AcknowledgeThirdPartyJob'
, acknowledgeThirdPartyJob_clientToken
- 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.
data AcknowledgeThirdPartyJobResponse Source #
Represents the output of an AcknowledgeThirdPartyJob action.
See: newAcknowledgeThirdPartyJobResponse
smart constructor.
Instances
Generic AcknowledgeThirdPartyJobResponse Source # | |
Read AcknowledgeThirdPartyJobResponse Source # | |
Show AcknowledgeThirdPartyJobResponse Source # | |
NFData AcknowledgeThirdPartyJobResponse Source # | |
Defined in Amazonka.CodePipeline.AcknowledgeThirdPartyJob rnf :: AcknowledgeThirdPartyJobResponse -> () # | |
Eq AcknowledgeThirdPartyJobResponse Source # | |
type Rep AcknowledgeThirdPartyJobResponse Source # | |
Defined in Amazonka.CodePipeline.AcknowledgeThirdPartyJob type Rep AcknowledgeThirdPartyJobResponse = D1 ('MetaData "AcknowledgeThirdPartyJobResponse" "Amazonka.CodePipeline.AcknowledgeThirdPartyJob" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "AcknowledgeThirdPartyJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newAcknowledgeThirdPartyJobResponse Source #
Create a value of AcknowledgeThirdPartyJobResponse
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:
AcknowledgeThirdPartyJobResponse
, acknowledgeThirdPartyJobResponse_status
- The status information for the third party job, if any.
$sel:httpStatus:AcknowledgeThirdPartyJobResponse'
, acknowledgeThirdPartyJobResponse_httpStatus
- The response's http status code.
CreateCustomActionType
data CreateCustomActionType Source #
Represents the input of a CreateCustomActionType operation.
See: newCreateCustomActionType
smart constructor.
CreateCustomActionType' (Maybe [ActionConfigurationProperty]) (Maybe ActionTypeSettings) (Maybe [Tag]) ActionCategory Text Text ArtifactDetails ArtifactDetails |
Instances
newCreateCustomActionType Source #
Create a value of CreateCustomActionType
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:configurationProperties:CreateCustomActionType'
, createCustomActionType_configurationProperties
- The configuration properties for the custom action.
You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.
CreateCustomActionType
, createCustomActionType_settings
- URLs that provide users information about this custom action.
CreateCustomActionType
, createCustomActionType_tags
- The tags for the custom action.
CreateCustomActionType
, createCustomActionType_category
- The category of the custom action, such as a build action or a test
action.
CreateCustomActionType
, createCustomActionType_provider
- The provider of the service used in the custom action, such as AWS
CodeDeploy.
CreateCustomActionType
, createCustomActionType_version
- The version identifier of the custom action.
CreateCustomActionType
, createCustomActionType_inputArtifactDetails
- The details of the input artifact for the action, such as its commit ID.
CreateCustomActionType
, createCustomActionType_outputArtifactDetails
- The details of the output artifact of the action, such as its commit ID.
data CreateCustomActionTypeResponse Source #
Represents the output of a CreateCustomActionType
operation.
See: newCreateCustomActionTypeResponse
smart constructor.
Instances
newCreateCustomActionTypeResponse Source #
Create a value of CreateCustomActionTypeResponse
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:
CreateCustomActionType
, createCustomActionTypeResponse_tags
- Specifies the tags applied to the custom action.
$sel:httpStatus:CreateCustomActionTypeResponse'
, createCustomActionTypeResponse_httpStatus
- The response's http status code.
$sel:actionType:CreateCustomActionTypeResponse'
, createCustomActionTypeResponse_actionType
- Returns information about the details of an action type.
CreatePipeline
data CreatePipeline Source #
Represents the input of a CreatePipeline
action.
See: newCreatePipeline
smart constructor.
Instances
Create a value of CreatePipeline
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:
CreatePipeline
, createPipeline_tags
- The tags for the pipeline.
CreatePipeline
, createPipeline_pipeline
- Represents the structure of actions and stages to be performed in the
pipeline.
data CreatePipelineResponse Source #
Represents the output of a CreatePipeline
action.
See: newCreatePipelineResponse
smart constructor.
Instances
newCreatePipelineResponse Source #
Create a value of CreatePipelineResponse
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:
CreatePipeline
, createPipelineResponse_pipeline
- Represents the structure of actions and stages to be performed in the
pipeline.
CreatePipeline
, createPipelineResponse_tags
- Specifies the tags applied to the pipeline.
$sel:httpStatus:CreatePipelineResponse'
, createPipelineResponse_httpStatus
- The response's http status code.
DeleteCustomActionType
data DeleteCustomActionType Source #
Represents the input of a DeleteCustomActionType
operation. The custom
action will be marked as deleted.
See: newDeleteCustomActionType
smart constructor.
Instances
newDeleteCustomActionType Source #
:: ActionCategory | |
-> Text | |
-> Text | |
-> DeleteCustomActionType |
Create a value of DeleteCustomActionType
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:
DeleteCustomActionType
, deleteCustomActionType_category
- The category of the custom action that you want to delete, such as
source or deploy.
DeleteCustomActionType
, deleteCustomActionType_provider
- The provider of the service used in the custom action, such as AWS
CodeDeploy.
DeleteCustomActionType
, deleteCustomActionType_version
- The version of the custom action to delete.
data DeleteCustomActionTypeResponse Source #
See: newDeleteCustomActionTypeResponse
smart constructor.
Instances
newDeleteCustomActionTypeResponse :: DeleteCustomActionTypeResponse Source #
Create a value of DeleteCustomActionTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePipeline
data DeletePipeline Source #
Represents the input of a DeletePipeline
action.
See: newDeletePipeline
smart constructor.
Instances
Create a value of DeletePipeline
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:
DeletePipeline
, deletePipeline_name
- The name of the pipeline to be deleted.
data DeletePipelineResponse Source #
See: newDeletePipelineResponse
smart constructor.
Instances
Generic DeletePipelineResponse Source # | |
Defined in Amazonka.CodePipeline.DeletePipeline type Rep DeletePipelineResponse :: Type -> Type # | |
Read DeletePipelineResponse Source # | |
Show DeletePipelineResponse Source # | |
Defined in Amazonka.CodePipeline.DeletePipeline showsPrec :: Int -> DeletePipelineResponse -> ShowS # show :: DeletePipelineResponse -> String # showList :: [DeletePipelineResponse] -> ShowS # | |
NFData DeletePipelineResponse Source # | |
Defined in Amazonka.CodePipeline.DeletePipeline rnf :: DeletePipelineResponse -> () # | |
Eq DeletePipelineResponse Source # | |
Defined in Amazonka.CodePipeline.DeletePipeline | |
type Rep DeletePipelineResponse Source # | |
newDeletePipelineResponse :: DeletePipelineResponse Source #
Create a value of DeletePipelineResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteWebhook
data DeleteWebhook Source #
See: newDeleteWebhook
smart constructor.
Instances
Create a value of DeleteWebhook
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:
DeleteWebhook
, deleteWebhook_name
- The name of the webhook you want to delete.
data DeleteWebhookResponse Source #
See: newDeleteWebhookResponse
smart constructor.
Instances
newDeleteWebhookResponse Source #
Create a value of DeleteWebhookResponse
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:httpStatus:DeleteWebhookResponse'
, deleteWebhookResponse_httpStatus
- The response's http status code.
DeregisterWebhookWithThirdParty
data DeregisterWebhookWithThirdParty Source #
See: newDeregisterWebhookWithThirdParty
smart constructor.
Instances
newDeregisterWebhookWithThirdParty :: DeregisterWebhookWithThirdParty Source #
Create a value of DeregisterWebhookWithThirdParty
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:webhookName:DeregisterWebhookWithThirdParty'
, deregisterWebhookWithThirdParty_webhookName
- The name of the webhook you want to deregister.
data DeregisterWebhookWithThirdPartyResponse Source #
See: newDeregisterWebhookWithThirdPartyResponse
smart constructor.
Instances
Generic DeregisterWebhookWithThirdPartyResponse Source # | |
Defined in Amazonka.CodePipeline.DeregisterWebhookWithThirdParty type Rep DeregisterWebhookWithThirdPartyResponse :: Type -> Type # | |
Read DeregisterWebhookWithThirdPartyResponse Source # | |
Show DeregisterWebhookWithThirdPartyResponse Source # | |
NFData DeregisterWebhookWithThirdPartyResponse Source # | |
Eq DeregisterWebhookWithThirdPartyResponse Source # | |
type Rep DeregisterWebhookWithThirdPartyResponse Source # | |
Defined in Amazonka.CodePipeline.DeregisterWebhookWithThirdParty type Rep DeregisterWebhookWithThirdPartyResponse = D1 ('MetaData "DeregisterWebhookWithThirdPartyResponse" "Amazonka.CodePipeline.DeregisterWebhookWithThirdParty" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "DeregisterWebhookWithThirdPartyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeregisterWebhookWithThirdPartyResponse Source #
Create a value of DeregisterWebhookWithThirdPartyResponse
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:httpStatus:DeregisterWebhookWithThirdPartyResponse'
, deregisterWebhookWithThirdPartyResponse_httpStatus
- The response's http status code.
DisableStageTransition
data DisableStageTransition Source #
Represents the input of a DisableStageTransition
action.
See: newDisableStageTransition
smart constructor.
Instances
newDisableStageTransition Source #
:: Text | |
-> Text | |
-> StageTransitionType | |
-> Text | |
-> DisableStageTransition |
Create a value of DisableStageTransition
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:
DisableStageTransition
, disableStageTransition_pipelineName
- The name of the pipeline in which you want to disable the flow of
artifacts from one stage to another.
DisableStageTransition
, disableStageTransition_stageName
- The name of the stage where you want to disable the inbound or outbound
transition of artifacts.
$sel:transitionType:DisableStageTransition'
, disableStageTransition_transitionType
- Specifies whether artifacts are prevented from transitioning into the
stage and being processed by the actions in that stage (inbound), or
prevented from transitioning from the stage after they have been
processed by the actions in that stage (outbound).
DisableStageTransition
, disableStageTransition_reason
- The reason given to the user that a stage is disabled, such as waiting
for manual approval or manual tests. This message is displayed in the
pipeline console UI.
data DisableStageTransitionResponse Source #
See: newDisableStageTransitionResponse
smart constructor.
Instances
newDisableStageTransitionResponse :: DisableStageTransitionResponse Source #
Create a value of DisableStageTransitionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
EnableStageTransition
data EnableStageTransition Source #
Represents the input of an EnableStageTransition
action.
See: newEnableStageTransition
smart constructor.
Instances
newEnableStageTransition Source #
:: Text | |
-> Text | |
-> StageTransitionType | |
-> EnableStageTransition |
Create a value of EnableStageTransition
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:
EnableStageTransition
, enableStageTransition_pipelineName
- The name of the pipeline in which you want to enable the flow of
artifacts from one stage to another.
EnableStageTransition
, enableStageTransition_stageName
- The name of the stage where you want to enable the transition of
artifacts, either into the stage (inbound) or from that stage to the
next stage (outbound).
$sel:transitionType:EnableStageTransition'
, enableStageTransition_transitionType
- Specifies whether artifacts are allowed to enter the stage and be
processed by the actions in that stage (inbound) or whether already
processed artifacts are allowed to transition to the next stage
(outbound).
data EnableStageTransitionResponse Source #
See: newEnableStageTransitionResponse
smart constructor.
Instances
newEnableStageTransitionResponse :: EnableStageTransitionResponse Source #
Create a value of EnableStageTransitionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetActionType
data GetActionType Source #
See: newGetActionType
smart constructor.
Instances
:: ActionCategory | |
-> Text | |
-> Text | |
-> Text | |
-> GetActionType |
Create a value of GetActionType
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:
GetActionType
, getActionType_category
- Defines what kind of action can be taken in the stage. The following are
the valid values:
Source
Build
Test
Deploy
Approval
Invoke
GetActionType
, getActionType_owner
- The creator of an action type that was created with any supported
integration model. There are two valid values: AWS
and ThirdParty
.
GetActionType
, getActionType_provider
- The provider of the action type being called. The provider name is
specified when the action type is created.
GetActionType
, getActionType_version
- A string that describes the action type version.
data GetActionTypeResponse Source #
See: newGetActionTypeResponse
smart constructor.
Instances
newGetActionTypeResponse Source #
Create a value of GetActionTypeResponse
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:actionType:GetActionTypeResponse'
, getActionTypeResponse_actionType
- The action type information for the requested action type, such as the
action type ID.
$sel:httpStatus:GetActionTypeResponse'
, getActionTypeResponse_httpStatus
- The response's http status code.
GetJobDetails
data GetJobDetails Source #
Represents the input of a GetJobDetails
action.
See: newGetJobDetails
smart constructor.
Instances
Create a value of GetJobDetails
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:
GetJobDetails
, getJobDetails_jobId
- The unique system-generated ID for the job.
data GetJobDetailsResponse Source #
Represents the output of a GetJobDetails
action.
See: newGetJobDetailsResponse
smart constructor.
Instances
newGetJobDetailsResponse Source #
Create a value of GetJobDetailsResponse
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:jobDetails:GetJobDetailsResponse'
, getJobDetailsResponse_jobDetails
- The details of the job.
If AWSSessionCredentials is used, a long-running job can call
GetJobDetails
again to obtain new credentials.
$sel:httpStatus:GetJobDetailsResponse'
, getJobDetailsResponse_httpStatus
- The response's http status code.
GetPipeline
data GetPipeline Source #
Represents the input of a GetPipeline
action.
See: newGetPipeline
smart constructor.
Instances
Create a value of GetPipeline
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:
GetPipeline
, getPipeline_version
- The version number of the pipeline. If you do not specify a version,
defaults to the current version.
GetPipeline
, getPipeline_name
- The name of the pipeline for which you want to get information. Pipeline
names must be unique under an AWS user account.
data GetPipelineResponse Source #
Represents the output of a GetPipeline
action.
See: newGetPipelineResponse
smart constructor.
Instances
newGetPipelineResponse Source #
Create a value of GetPipelineResponse
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:metadata:GetPipelineResponse'
, getPipelineResponse_metadata
- Represents the pipeline metadata information returned as part of the
output of a GetPipeline
action.
$sel:pipeline:GetPipelineResponse'
, getPipelineResponse_pipeline
- Represents the structure of actions and stages to be performed in the
pipeline.
$sel:httpStatus:GetPipelineResponse'
, getPipelineResponse_httpStatus
- The response's http status code.
GetPipelineExecution
data GetPipelineExecution Source #
Represents the input of a GetPipelineExecution
action.
See: newGetPipelineExecution
smart constructor.
Instances
newGetPipelineExecution Source #
Create a value of GetPipelineExecution
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:
GetPipelineExecution
, getPipelineExecution_pipelineName
- The name of the pipeline about which you want to get execution details.
GetPipelineExecution
, getPipelineExecution_pipelineExecutionId
- The ID of the pipeline execution about which you want to get execution
details.
data GetPipelineExecutionResponse Source #
Represents the output of a GetPipelineExecution
action.
See: newGetPipelineExecutionResponse
smart constructor.
Instances
newGetPipelineExecutionResponse Source #
Create a value of GetPipelineExecutionResponse
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:pipelineExecution:GetPipelineExecutionResponse'
, getPipelineExecutionResponse_pipelineExecution
- Represents information about the execution of a pipeline.
$sel:httpStatus:GetPipelineExecutionResponse'
, getPipelineExecutionResponse_httpStatus
- The response's http status code.
GetPipelineState
data GetPipelineState Source #
Represents the input of a GetPipelineState
action.
See: newGetPipelineState
smart constructor.
Instances
Create a value of GetPipelineState
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:
GetPipelineState
, getPipelineState_name
- The name of the pipeline about which you want to get information.
data GetPipelineStateResponse Source #
Represents the output of a GetPipelineState
action.
See: newGetPipelineStateResponse
smart constructor.
GetPipelineStateResponse' (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe [StageState]) (Maybe POSIX) Int |
Instances
newGetPipelineStateResponse Source #
Create a value of GetPipelineStateResponse
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:
GetPipelineStateResponse
, getPipelineStateResponse_created
- The date and time the pipeline was created, in timestamp format.
GetPipelineStateResponse
, getPipelineStateResponse_pipelineName
- The name of the pipeline for which you want to get the state.
GetPipelineStateResponse
, getPipelineStateResponse_pipelineVersion
- The version number of the pipeline.
A newly created pipeline is always assigned a version number of 1
.
$sel:stageStates:GetPipelineStateResponse'
, getPipelineStateResponse_stageStates
- A list of the pipeline stage output information, including stage name,
state, most recent run details, whether the stage is disabled, and other
data.
GetPipelineStateResponse
, getPipelineStateResponse_updated
- The date and time the pipeline was last updated, in timestamp format.
$sel:httpStatus:GetPipelineStateResponse'
, getPipelineStateResponse_httpStatus
- The response's http status code.
GetThirdPartyJobDetails
data GetThirdPartyJobDetails Source #
Represents the input of a GetThirdPartyJobDetails
action.
See: newGetThirdPartyJobDetails
smart constructor.
Instances
newGetThirdPartyJobDetails Source #
:: Text | |
-> Text | |
-> GetThirdPartyJobDetails |
Create a value of GetThirdPartyJobDetails
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:
GetThirdPartyJobDetails
, getThirdPartyJobDetails_jobId
- The unique system-generated ID used for identifying the job.
$sel:clientToken:GetThirdPartyJobDetails'
, getThirdPartyJobDetails_clientToken
- 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.
data GetThirdPartyJobDetailsResponse Source #
Represents the output of a GetThirdPartyJobDetails
action.
See: newGetThirdPartyJobDetailsResponse
smart constructor.
Instances
Generic GetThirdPartyJobDetailsResponse Source # | |
Show GetThirdPartyJobDetailsResponse Source # | |
NFData GetThirdPartyJobDetailsResponse Source # | |
Defined in Amazonka.CodePipeline.GetThirdPartyJobDetails rnf :: GetThirdPartyJobDetailsResponse -> () # | |
Eq GetThirdPartyJobDetailsResponse Source # | |
type Rep GetThirdPartyJobDetailsResponse Source # | |
Defined in Amazonka.CodePipeline.GetThirdPartyJobDetails type Rep GetThirdPartyJobDetailsResponse = D1 ('MetaData "GetThirdPartyJobDetailsResponse" "Amazonka.CodePipeline.GetThirdPartyJobDetails" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "GetThirdPartyJobDetailsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThirdPartyJobDetails)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newGetThirdPartyJobDetailsResponse Source #
Create a value of GetThirdPartyJobDetailsResponse
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:jobDetails:GetThirdPartyJobDetailsResponse'
, getThirdPartyJobDetailsResponse_jobDetails
- The details of the job, including any protected values defined for the
job.
$sel:httpStatus:GetThirdPartyJobDetailsResponse'
, getThirdPartyJobDetailsResponse_httpStatus
- The response's http status code.
ListActionExecutions (Paginated)
data ListActionExecutions Source #
See: newListActionExecutions
smart constructor.
Instances
newListActionExecutions Source #
Create a value of ListActionExecutions
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:filter':ListActionExecutions'
, listActionExecutions_filter
- Input information used to filter action execution history.
$sel:maxResults:ListActionExecutions'
, listActionExecutions_maxResults
- The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned nextToken
value. Action execution history is retained for up to 12 months, based
on action execution start times. Default value is 100.
Detailed execution history is available for executions run on or after February 21, 2019.
ListActionExecutions
, listActionExecutions_nextToken
- The token that was returned from the previous ListActionExecutions
call, which can be used to return the next set of action executions in
the list.
ListActionExecutions
, listActionExecutions_pipelineName
- The name of the pipeline for which you want to list action execution
history.
data ListActionExecutionsResponse Source #
See: newListActionExecutionsResponse
smart constructor.
Instances
newListActionExecutionsResponse Source #
Create a value of ListActionExecutionsResponse
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:actionExecutionDetails:ListActionExecutionsResponse'
, listActionExecutionsResponse_actionExecutionDetails
- The details for a list of recent executions, such as action execution
ID.
ListActionExecutions
, listActionExecutionsResponse_nextToken
- If the amount of returned information is significantly large, an
identifier is also returned and can be used in a subsequent
ListActionExecutions
call to return the next set of action executions
in the list.
$sel:httpStatus:ListActionExecutionsResponse'
, listActionExecutionsResponse_httpStatus
- The response's http status code.
ListActionTypes (Paginated)
data ListActionTypes Source #
Represents the input of a ListActionTypes
action.
See: newListActionTypes
smart constructor.
Instances
newListActionTypes :: ListActionTypes Source #
Create a value of ListActionTypes
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:actionOwnerFilter:ListActionTypes'
, listActionTypes_actionOwnerFilter
- Filters the list of action types to those created by a specified entity.
ListActionTypes
, listActionTypes_nextToken
- An identifier that was returned from the previous list action types
call, which can be used to return the next set of action types in the
list.
$sel:regionFilter:ListActionTypes'
, listActionTypes_regionFilter
- The Region to filter on for the list of action types.
data ListActionTypesResponse Source #
Represents the output of a ListActionTypes
action.
See: newListActionTypesResponse
smart constructor.
Instances
newListActionTypesResponse Source #
Create a value of ListActionTypesResponse
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:
ListActionTypes
, listActionTypesResponse_nextToken
- If the amount of returned information is significantly large, an
identifier is also returned. It can be used in a subsequent list action
types call to return the next set of action types in the list.
$sel:httpStatus:ListActionTypesResponse'
, listActionTypesResponse_httpStatus
- The response's http status code.
$sel:actionTypes:ListActionTypesResponse'
, listActionTypesResponse_actionTypes
- Provides details of the action types.
ListPipelineExecutions (Paginated)
data ListPipelineExecutions Source #
Represents the input of a ListPipelineExecutions
action.
See: newListPipelineExecutions
smart constructor.
Instances
newListPipelineExecutions Source #
Create a value of ListPipelineExecutions
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:maxResults:ListPipelineExecutions'
, listPipelineExecutions_maxResults
- The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned nextToken
value. Pipeline history is limited to the most recent 12 months, based
on pipeline execution start times. Default value is 100.
ListPipelineExecutions
, listPipelineExecutions_nextToken
- The token that was returned from the previous ListPipelineExecutions
call, which can be used to return the next set of pipeline executions in
the list.
ListPipelineExecutions
, listPipelineExecutions_pipelineName
- The name of the pipeline for which you want to get execution summary
information.
data ListPipelineExecutionsResponse Source #
Represents the output of a ListPipelineExecutions
action.
See: newListPipelineExecutionsResponse
smart constructor.
Instances
newListPipelineExecutionsResponse Source #
Create a value of ListPipelineExecutionsResponse
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:
ListPipelineExecutions
, listPipelineExecutionsResponse_nextToken
- A token that can be used in the next ListPipelineExecutions
call. To
view all items in the list, continue to call this operation with each
subsequent token until no more nextToken values are returned.
$sel:pipelineExecutionSummaries:ListPipelineExecutionsResponse'
, listPipelineExecutionsResponse_pipelineExecutionSummaries
- A list of executions in the history of a pipeline.
$sel:httpStatus:ListPipelineExecutionsResponse'
, listPipelineExecutionsResponse_httpStatus
- The response's http status code.
ListPipelines (Paginated)
data ListPipelines Source #
Represents the input of a ListPipelines
action.
See: newListPipelines
smart constructor.
Instances
newListPipelines :: ListPipelines Source #
Create a value of ListPipelines
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:maxResults:ListPipelines'
, listPipelines_maxResults
- The maximum number of pipelines to return in a single call. To retrieve
the remaining pipelines, make another call with the returned nextToken
value. The minimum value you can specify is 1. The maximum accepted
value is 1000.
ListPipelines
, listPipelines_nextToken
- An identifier that was returned from the previous list pipelines call.
It can be used to return the next set of pipelines in the list.
data ListPipelinesResponse Source #
Represents the output of a ListPipelines
action.
See: newListPipelinesResponse
smart constructor.
Instances
newListPipelinesResponse Source #
Create a value of ListPipelinesResponse
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:
ListPipelines
, listPipelinesResponse_nextToken
- If the amount of returned information is significantly large, an
identifier is also returned. It can be used in a subsequent list
pipelines call to return the next set of pipelines in the list.
$sel:pipelines:ListPipelinesResponse'
, listPipelinesResponse_pipelines
- The list of pipelines.
$sel:httpStatus:ListPipelinesResponse'
, listPipelinesResponse_httpStatus
- The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:maxResults:ListTagsForResource'
, listTagsForResource_maxResults
- The maximum number of results to return in a single call.
ListTagsForResource
, listTagsForResource_nextToken
- The token that was returned from the previous API call, which would be
used to return the next page of the list. The ListTagsforResource call
lists all available tags in one call and does not use pagination.
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) of the resource to get tags for.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:
ListTagsForResource
, listTagsForResourceResponse_nextToken
- If the amount of returned information is significantly large, an
identifier is also returned and can be used in a subsequent API call to
return the next page of the list. The ListTagsforResource call lists all
available tags in one call and does not use pagination.
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- The tags for the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListWebhooks (Paginated)
data ListWebhooks Source #
See: newListWebhooks
smart constructor.
Instances
newListWebhooks :: ListWebhooks Source #
Create a value of ListWebhooks
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:maxResults:ListWebhooks'
, listWebhooks_maxResults
- The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
ListWebhooks
, listWebhooks_nextToken
- The token that was returned from the previous ListWebhooks call, which
can be used to return the next set of webhooks in the list.
data ListWebhooksResponse Source #
See: newListWebhooksResponse
smart constructor.
Instances
newListWebhooksResponse Source #
Create a value of ListWebhooksResponse
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:
ListWebhooks
, listWebhooksResponse_nextToken
- If the amount of returned information is significantly large, an
identifier is also returned and can be used in a subsequent ListWebhooks
call to return the next set of webhooks in the list.
$sel:webhooks:ListWebhooksResponse'
, listWebhooksResponse_webhooks
- The JSON detail returned for each webhook in the list output for the
ListWebhooks call.
$sel:httpStatus:ListWebhooksResponse'
, listWebhooksResponse_httpStatus
- The response's http status code.
PollForJobs
data PollForJobs Source #
Represents the input of a PollForJobs
action.
See: newPollForJobs
smart constructor.
Instances
Create a value of PollForJobs
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:maxBatchSize:PollForJobs'
, pollForJobs_maxBatchSize
- The maximum number of jobs to return in a poll for jobs call.
$sel:queryParam:PollForJobs'
, pollForJobs_queryParam
- A map of property names and values. For an action type with no queryable
properties, this value must be null or an empty map. For an action type
with a queryable property, you must supply that property as a key in the
map. Only jobs whose action configuration matches the mapped value are
returned.
PollForJobs
, pollForJobs_actionTypeId
- Represents information about an action type.
data PollForJobsResponse Source #
Represents the output of a PollForJobs
action.
See: newPollForJobsResponse
smart constructor.
Instances
newPollForJobsResponse Source #
Create a value of PollForJobsResponse
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:jobs:PollForJobsResponse'
, pollForJobsResponse_jobs
- Information about the jobs to take action on.
$sel:httpStatus:PollForJobsResponse'
, pollForJobsResponse_httpStatus
- The response's http status code.
PollForThirdPartyJobs
data PollForThirdPartyJobs Source #
Represents the input of a PollForThirdPartyJobs
action.
See: newPollForThirdPartyJobs
smart constructor.
Instances
newPollForThirdPartyJobs Source #
Create a value of PollForThirdPartyJobs
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:maxBatchSize:PollForThirdPartyJobs'
, pollForThirdPartyJobs_maxBatchSize
- The maximum number of jobs to return in a poll for jobs call.
PollForThirdPartyJobs
, pollForThirdPartyJobs_actionTypeId
- Represents information about an action type.
data PollForThirdPartyJobsResponse Source #
Represents the output of a PollForThirdPartyJobs
action.
See: newPollForThirdPartyJobsResponse
smart constructor.
Instances
newPollForThirdPartyJobsResponse Source #
Create a value of PollForThirdPartyJobsResponse
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:jobs:PollForThirdPartyJobsResponse'
, pollForThirdPartyJobsResponse_jobs
- Information about the jobs to take action on.
$sel:httpStatus:PollForThirdPartyJobsResponse'
, pollForThirdPartyJobsResponse_httpStatus
- The response's http status code.
PutActionRevision
data PutActionRevision Source #
Represents the input of a PutActionRevision
action.
See: newPutActionRevision
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> ActionRevision | |
-> PutActionRevision |
Create a value of PutActionRevision
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:
PutActionRevision
, putActionRevision_pipelineName
- The name of the pipeline that starts processing the revision to the
source.
PutActionRevision
, putActionRevision_stageName
- The name of the stage that contains the action that acts on the
revision.
PutActionRevision
, putActionRevision_actionName
- The name of the action that processes the revision.
$sel:actionRevision:PutActionRevision'
, putActionRevision_actionRevision
- Represents information about the version (or revision) of an action.
data PutActionRevisionResponse Source #
Represents the output of a PutActionRevision
action.
See: newPutActionRevisionResponse
smart constructor.
Instances
newPutActionRevisionResponse Source #
Create a value of PutActionRevisionResponse
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:newRevision':PutActionRevisionResponse'
, putActionRevisionResponse_newRevision
- Indicates whether the artifact revision was previously used in an
execution of the specified pipeline.
PutActionRevisionResponse
, putActionRevisionResponse_pipelineExecutionId
- The ID of the current workflow state of the pipeline.
$sel:httpStatus:PutActionRevisionResponse'
, putActionRevisionResponse_httpStatus
- The response's http status code.
PutApprovalResult
data PutApprovalResult Source #
Represents the input of a PutApprovalResult
action.
See: newPutApprovalResult
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> ApprovalResult | |
-> Text | |
-> PutApprovalResult |
Create a value of PutApprovalResult
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:
PutApprovalResult
, putApprovalResult_pipelineName
- The name of the pipeline that contains the action.
PutApprovalResult
, putApprovalResult_stageName
- The name of the stage that contains the action.
PutApprovalResult
, putApprovalResult_actionName
- The name of the action for which approval is requested.
$sel:result:PutApprovalResult'
, putApprovalResult_result
- Represents information about the result of the approval request.
PutApprovalResult
, putApprovalResult_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 action. It is used to validate that the approval
request corresponding to this token is still valid.
data PutApprovalResultResponse Source #
Represents the output of a PutApprovalResult
action.
See: newPutApprovalResultResponse
smart constructor.
Instances
newPutApprovalResultResponse Source #
Create a value of PutApprovalResultResponse
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:approvedAt:PutApprovalResultResponse'
, putApprovalResultResponse_approvedAt
- The timestamp showing when the approval or rejection was submitted.
$sel:httpStatus:PutApprovalResultResponse'
, putApprovalResultResponse_httpStatus
- The response's http status code.
PutJobFailureResult
data PutJobFailureResult Source #
Represents the input of a PutJobFailureResult
action.
See: newPutJobFailureResult
smart constructor.
Instances
newPutJobFailureResult Source #
Create a value of PutJobFailureResult
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:
PutJobFailureResult
, putJobFailureResult_jobId
- The unique system-generated ID of the job that failed. This is the same
ID returned from PollForJobs
.
$sel:failureDetails:PutJobFailureResult'
, putJobFailureResult_failureDetails
- The details about the failure of a job.
data PutJobFailureResultResponse Source #
See: newPutJobFailureResultResponse
smart constructor.
Instances
newPutJobFailureResultResponse :: PutJobFailureResultResponse Source #
Create a value of PutJobFailureResultResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutJobSuccessResult
data PutJobSuccessResult Source #
Represents the input of a PutJobSuccessResult
action.
See: newPutJobSuccessResult
smart constructor.
PutJobSuccessResult' (Maybe Text) (Maybe CurrentRevision) (Maybe ExecutionDetails) (Maybe (HashMap Text Text)) Text |
Instances
newPutJobSuccessResult Source #
Create a value of PutJobSuccessResult
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:
PutJobSuccessResult
, putJobSuccessResult_continuationToken
- A token generated by a job worker, such as an AWS CodeDeploy deployment
ID, that a successful job provides to identify a custom action in
progress. Future jobs use this token to identify the running instance of
the action. It can be reused to return more information about the
progress of the custom action. When the action is complete, no
continuation token should be supplied.
PutJobSuccessResult
, putJobSuccessResult_currentRevision
- The ID of the current revision of the artifact successfully worked on by
the job.
$sel:executionDetails:PutJobSuccessResult'
, putJobSuccessResult_executionDetails
- The execution details of the successful job, such as the actions taken
by the job worker.
PutJobSuccessResult
, putJobSuccessResult_outputVariables
- Key-value pairs produced as output by a job worker that can be made
available to a downstream action configuration. outputVariables
can be
included only when there is no continuation token on the request.
PutJobSuccessResult
, putJobSuccessResult_jobId
- The unique system-generated ID of the job that succeeded. This is the
same ID returned from PollForJobs
.
data PutJobSuccessResultResponse Source #
See: newPutJobSuccessResultResponse
smart constructor.
Instances
newPutJobSuccessResultResponse :: PutJobSuccessResultResponse Source #
Create a value of PutJobSuccessResultResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutThirdPartyJobFailureResult
data PutThirdPartyJobFailureResult Source #
Represents the input of a PutThirdPartyJobFailureResult
action.
See: newPutThirdPartyJobFailureResult
smart constructor.
Instances
newPutThirdPartyJobFailureResult Source #
Create a value of PutThirdPartyJobFailureResult
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:
PutThirdPartyJobFailureResult
, putThirdPartyJobFailureResult_jobId
- The ID of the job that failed. This is the same ID returned from
PollForThirdPartyJobs
.
$sel:clientToken:PutThirdPartyJobFailureResult'
, putThirdPartyJobFailureResult_clientToken
- 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:failureDetails:PutThirdPartyJobFailureResult'
, putThirdPartyJobFailureResult_failureDetails
- Represents information about failure details.
data PutThirdPartyJobFailureResultResponse Source #
See: newPutThirdPartyJobFailureResultResponse
smart constructor.
Instances
Generic PutThirdPartyJobFailureResultResponse Source # | |
Defined in Amazonka.CodePipeline.PutThirdPartyJobFailureResult type Rep PutThirdPartyJobFailureResultResponse :: Type -> Type # | |
Read PutThirdPartyJobFailureResultResponse Source # | |
Show PutThirdPartyJobFailureResultResponse Source # | |
NFData PutThirdPartyJobFailureResultResponse Source # | |
Defined in Amazonka.CodePipeline.PutThirdPartyJobFailureResult rnf :: PutThirdPartyJobFailureResultResponse -> () # | |
Eq PutThirdPartyJobFailureResultResponse Source # | |
type Rep PutThirdPartyJobFailureResultResponse Source # | |
Defined in Amazonka.CodePipeline.PutThirdPartyJobFailureResult type Rep PutThirdPartyJobFailureResultResponse = D1 ('MetaData "PutThirdPartyJobFailureResultResponse" "Amazonka.CodePipeline.PutThirdPartyJobFailureResult" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "PutThirdPartyJobFailureResultResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newPutThirdPartyJobFailureResultResponse :: PutThirdPartyJobFailureResultResponse Source #
Create a value of PutThirdPartyJobFailureResultResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutThirdPartyJobSuccessResult
data PutThirdPartyJobSuccessResult Source #
Represents the input of a PutThirdPartyJobSuccessResult
action.
See: newPutThirdPartyJobSuccessResult
smart constructor.
PutThirdPartyJobSuccessResult' (Maybe Text) (Maybe CurrentRevision) (Maybe ExecutionDetails) Text Text |
Instances
newPutThirdPartyJobSuccessResult Source #
Create a value of PutThirdPartyJobSuccessResult
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:
PutThirdPartyJobSuccessResult
, putThirdPartyJobSuccessResult_continuationToken
- A token generated by a job worker, such as an AWS CodeDeploy deployment
ID, that a successful job provides to identify a partner action in
progress. Future jobs use this token to identify the running instance of
the action. It can be reused to return more information about the
progress of the partner action. When the action is complete, no
continuation token should be supplied.
PutThirdPartyJobSuccessResult
, putThirdPartyJobSuccessResult_currentRevision
- Represents information about a current revision.
$sel:executionDetails:PutThirdPartyJobSuccessResult'
, putThirdPartyJobSuccessResult_executionDetails
- The details of the actions taken and results produced on an artifact as
it passes through stages in the pipeline.
PutThirdPartyJobSuccessResult
, putThirdPartyJobSuccessResult_jobId
- The ID of the job that successfully completed. This is the same ID
returned from PollForThirdPartyJobs
.
$sel:clientToken:PutThirdPartyJobSuccessResult'
, putThirdPartyJobSuccessResult_clientToken
- 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.
data PutThirdPartyJobSuccessResultResponse Source #
See: newPutThirdPartyJobSuccessResultResponse
smart constructor.
Instances
Generic PutThirdPartyJobSuccessResultResponse Source # | |
Defined in Amazonka.CodePipeline.PutThirdPartyJobSuccessResult type Rep PutThirdPartyJobSuccessResultResponse :: Type -> Type # | |
Read PutThirdPartyJobSuccessResultResponse Source # | |
Show PutThirdPartyJobSuccessResultResponse Source # | |
NFData PutThirdPartyJobSuccessResultResponse Source # | |
Defined in Amazonka.CodePipeline.PutThirdPartyJobSuccessResult rnf :: PutThirdPartyJobSuccessResultResponse -> () # | |
Eq PutThirdPartyJobSuccessResultResponse Source # | |
type Rep PutThirdPartyJobSuccessResultResponse Source # | |
Defined in Amazonka.CodePipeline.PutThirdPartyJobSuccessResult type Rep PutThirdPartyJobSuccessResultResponse = D1 ('MetaData "PutThirdPartyJobSuccessResultResponse" "Amazonka.CodePipeline.PutThirdPartyJobSuccessResult" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "PutThirdPartyJobSuccessResultResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newPutThirdPartyJobSuccessResultResponse :: PutThirdPartyJobSuccessResultResponse Source #
Create a value of PutThirdPartyJobSuccessResultResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutWebhook
data PutWebhook Source #
See: newPutWebhook
smart constructor.
Instances
Create a value of PutWebhook
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:
PutWebhook
, putWebhook_tags
- The tags for the webhook.
PutWebhook
, putWebhook_webhook
- The detail provided in an input file to create the webhook, such as the
webhook name, the pipeline name, and the action name. Give the webhook a
unique name that helps you identify it. You might name the webhook after
the pipeline and action it targets so that you can easily recognize what
it's used for later.
data PutWebhookResponse Source #
See: newPutWebhookResponse
smart constructor.
Instances
newPutWebhookResponse Source #
Create a value of PutWebhookResponse
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:
PutWebhook
, putWebhookResponse_webhook
- The detail returned from creating the webhook, such as the webhook name,
webhook URL, and webhook ARN.
$sel:httpStatus:PutWebhookResponse'
, putWebhookResponse_httpStatus
- The response's http status code.
RegisterWebhookWithThirdParty
data RegisterWebhookWithThirdParty Source #
See: newRegisterWebhookWithThirdParty
smart constructor.
Instances
newRegisterWebhookWithThirdParty :: RegisterWebhookWithThirdParty Source #
Create a value of RegisterWebhookWithThirdParty
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:webhookName:RegisterWebhookWithThirdParty'
, registerWebhookWithThirdParty_webhookName
- The name of an existing webhook created with PutWebhook to register with
a supported third party.
data RegisterWebhookWithThirdPartyResponse Source #
See: newRegisterWebhookWithThirdPartyResponse
smart constructor.
Instances
newRegisterWebhookWithThirdPartyResponse Source #
Create a value of RegisterWebhookWithThirdPartyResponse
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:httpStatus:RegisterWebhookWithThirdPartyResponse'
, registerWebhookWithThirdPartyResponse_httpStatus
- The response's http status code.
RetryStageExecution
data RetryStageExecution Source #
Represents the input of a RetryStageExecution
action.
See: newRetryStageExecution
smart constructor.
Instances
newRetryStageExecution Source #
:: Text | |
-> Text | |
-> Text | |
-> StageRetryMode | |
-> RetryStageExecution |
Create a value of RetryStageExecution
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:
RetryStageExecution
, retryStageExecution_pipelineName
- The name of the pipeline that contains the failed stage.
RetryStageExecution
, retryStageExecution_stageName
- The name of the failed stage to be retried.
RetryStageExecution
, retryStageExecution_pipelineExecutionId
- The ID of the pipeline execution in the failed stage to be retried. Use
the GetPipelineState action to retrieve the current pipelineExecutionId
of the failed stage
$sel:retryMode:RetryStageExecution'
, retryStageExecution_retryMode
- The scope of the retry attempt. Currently, the only supported value is
FAILED_ACTIONS.
data RetryStageExecutionResponse Source #
Represents the output of a RetryStageExecution
action.
See: newRetryStageExecutionResponse
smart constructor.
Instances
newRetryStageExecutionResponse Source #
Create a value of RetryStageExecutionResponse
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:
RetryStageExecution
, retryStageExecutionResponse_pipelineExecutionId
- The ID of the current workflow execution in the failed stage.
$sel:httpStatus:RetryStageExecutionResponse'
, retryStageExecutionResponse_httpStatus
- The response's http status code.
StartPipelineExecution
data StartPipelineExecution Source #
Represents the input of a StartPipelineExecution
action.
See: newStartPipelineExecution
smart constructor.
Instances
newStartPipelineExecution Source #
Create a value of StartPipelineExecution
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:clientRequestToken:StartPipelineExecution'
, startPipelineExecution_clientRequestToken
- The system-generated unique ID used to identify a unique execution
request.
StartPipelineExecution
, startPipelineExecution_name
- The name of the pipeline to start.
data StartPipelineExecutionResponse Source #
Represents the output of a StartPipelineExecution
action.
See: newStartPipelineExecutionResponse
smart constructor.
Instances
Generic StartPipelineExecutionResponse Source # | |
Read StartPipelineExecutionResponse Source # | |
Show StartPipelineExecutionResponse Source # | |
Defined in Amazonka.CodePipeline.StartPipelineExecution | |
NFData StartPipelineExecutionResponse Source # | |
Defined in Amazonka.CodePipeline.StartPipelineExecution rnf :: StartPipelineExecutionResponse -> () # | |
Eq StartPipelineExecutionResponse Source # | |
type Rep StartPipelineExecutionResponse Source # | |
Defined in Amazonka.CodePipeline.StartPipelineExecution type Rep StartPipelineExecutionResponse = D1 ('MetaData "StartPipelineExecutionResponse" "Amazonka.CodePipeline.StartPipelineExecution" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "StartPipelineExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStartPipelineExecutionResponse Source #
Create a value of StartPipelineExecutionResponse
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:
StartPipelineExecutionResponse
, startPipelineExecutionResponse_pipelineExecutionId
- The unique system-generated ID of the pipeline execution that was
started.
$sel:httpStatus:StartPipelineExecutionResponse'
, startPipelineExecutionResponse_httpStatus
- The response's http status code.
StopPipelineExecution
data StopPipelineExecution Source #
See: newStopPipelineExecution
smart constructor.
Instances
newStopPipelineExecution Source #
Create a value of StopPipelineExecution
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:abandon:StopPipelineExecution'
, stopPipelineExecution_abandon
- Use this option to stop the pipeline execution by abandoning, rather
than finishing, in-progress actions.
This option can lead to failed or out-of-sequence tasks.
StopPipelineExecution
, stopPipelineExecution_reason
- Use this option to enter comments, such as the reason the pipeline was
stopped.
StopPipelineExecution
, stopPipelineExecution_pipelineName
- The name of the pipeline to stop.
StopPipelineExecution
, stopPipelineExecution_pipelineExecutionId
- The ID of the pipeline execution to be stopped in the current stage. Use
the GetPipelineState
action to retrieve the current
pipelineExecutionId.
data StopPipelineExecutionResponse Source #
See: newStopPipelineExecutionResponse
smart constructor.
Instances
newStopPipelineExecutionResponse Source #
Create a value of StopPipelineExecutionResponse
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:
StopPipelineExecution
, stopPipelineExecutionResponse_pipelineExecutionId
- The unique system-generated ID of the pipeline execution that was
stopped.
$sel:httpStatus:StopPipelineExecutionResponse'
, stopPipelineExecutionResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource you want to add tags to.
TagResource
, tagResource_tags
- The tags you want to modify or add to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource to remove tags from.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of keys for the tags to be removed from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateActionType
data UpdateActionType Source #
See: newUpdateActionType
smart constructor.
Instances
Create a value of UpdateActionType
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:actionType:UpdateActionType'
, updateActionType_actionType
- The action type definition for the action type to be updated.
data UpdateActionTypeResponse Source #
See: newUpdateActionTypeResponse
smart constructor.
Instances
Generic UpdateActionTypeResponse Source # | |
Defined in Amazonka.CodePipeline.UpdateActionType type Rep UpdateActionTypeResponse :: Type -> Type # | |
Read UpdateActionTypeResponse Source # | |
Show UpdateActionTypeResponse Source # | |
Defined in Amazonka.CodePipeline.UpdateActionType showsPrec :: Int -> UpdateActionTypeResponse -> ShowS # show :: UpdateActionTypeResponse -> String # showList :: [UpdateActionTypeResponse] -> ShowS # | |
NFData UpdateActionTypeResponse Source # | |
Defined in Amazonka.CodePipeline.UpdateActionType rnf :: UpdateActionTypeResponse -> () # | |
Eq UpdateActionTypeResponse Source # | |
Defined in Amazonka.CodePipeline.UpdateActionType | |
type Rep UpdateActionTypeResponse Source # | |
Defined in Amazonka.CodePipeline.UpdateActionType |
newUpdateActionTypeResponse :: UpdateActionTypeResponse Source #
Create a value of UpdateActionTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdatePipeline
data UpdatePipeline Source #
Represents the input of an UpdatePipeline
action.
See: newUpdatePipeline
smart constructor.
Instances
Create a value of UpdatePipeline
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:
UpdatePipeline
, updatePipeline_pipeline
- The name of the pipeline to be updated.
data UpdatePipelineResponse Source #
Represents the output of an UpdatePipeline
action.
See: newUpdatePipelineResponse
smart constructor.
Instances
newUpdatePipelineResponse Source #
Create a value of UpdatePipelineResponse
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:
UpdatePipeline
, updatePipelineResponse_pipeline
- The structure of the updated pipeline.
$sel:httpStatus:UpdatePipelineResponse'
, updatePipelineResponse_httpStatus
- The response's http status code.
Types
ActionCategory
newtype ActionCategory Source #
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 #
Instances
ActionExecutionStatus
newtype ActionExecutionStatus Source #
Instances
ActionOwner
newtype ActionOwner Source #
pattern ActionOwner_AWS :: ActionOwner | |
pattern ActionOwner_Custom :: ActionOwner | |
pattern ActionOwner_ThirdParty :: ActionOwner |
Instances
ApprovalStatus
newtype ApprovalStatus Source #
pattern ApprovalStatus_Approved :: ApprovalStatus | |
pattern ApprovalStatus_Rejected :: ApprovalStatus |
Instances
ArtifactLocationType
newtype ArtifactLocationType Source #
pattern ArtifactLocationType_S3 :: ArtifactLocationType |
Instances
ArtifactStoreType
newtype ArtifactStoreType Source #
pattern ArtifactStoreType_S3 :: ArtifactStoreType |
Instances
BlockerType
newtype BlockerType Source #
pattern BlockerType_Schedule :: BlockerType |
Instances
EncryptionKeyType
newtype EncryptionKeyType Source #
pattern EncryptionKeyType_KMS :: EncryptionKeyType |
Instances
ExecutorType
newtype ExecutorType Source #
pattern ExecutorType_JobWorker :: ExecutorType | |
pattern ExecutorType_Lambda :: ExecutorType |
Instances
FailureType
newtype FailureType Source #
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
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 #
Instances
StageExecutionStatus
newtype StageExecutionStatus Source #
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 #
pattern StageRetryMode_FAILED_ACTIONS :: StageRetryMode |
Instances
StageTransitionType
newtype StageTransitionType Source #
pattern StageTransitionType_Inbound :: StageTransitionType | |
pattern StageTransitionType_Outbound :: StageTransitionType |
Instances
TriggerType
newtype TriggerType Source #
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 #
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.
Instances
newAWSSessionCredentials Source #
:: 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.
ActionConfiguration
data ActionConfiguration Source #
Represents information about an action configuration.
See: newActionConfiguration
smart constructor.
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.
ActionConfigurationProperty
data ActionConfigurationProperty Source #
Represents information about an action configuration property.
See: newActionConfigurationProperty
smart constructor.
ActionConfigurationProperty' (Maybe Text) (Maybe Bool) (Maybe ActionConfigurationPropertyType) Text Bool Bool Bool |
Instances
newActionConfigurationProperty Source #
:: 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:description:ActionConfigurationProperty'
, actionConfigurationProperty_description
- The description of the action configuration property that is displayed
to users.
$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: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.
ActionContext
data ActionContext Source #
Represents the context of an action in the stage of a pipeline to a job worker.
See: newActionContext
smart constructor.
ActionContext' (Maybe Text) (Maybe Text) |
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:actionExecutionId:ActionContext'
, actionContext_actionExecutionId
- The system-generated unique ID that corresponds to an action's
execution.
$sel:name:ActionContext'
, actionContext_name
- The name of the action in the context of a job.
ActionDeclaration
data ActionDeclaration Source #
Represents information about an action declaration.
See: newActionDeclaration
smart constructor.
ActionDeclaration' (Maybe (HashMap Text Text)) (Maybe [InputArtifact]) (Maybe Text) (Maybe [OutputArtifact]) (Maybe Text) (Maybe Text) (Maybe Natural) Text ActionTypeId |
Instances
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: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:namespace:ActionDeclaration'
, actionDeclaration_namespace
- The variable namespace associated with the action. All variables
produced as output by this action fall under this namespace.
$sel:outputArtifacts:ActionDeclaration'
, actionDeclaration_outputArtifacts
- The name or ID of the result of the action declaration, such as a test
or build artifact.
$sel:region:ActionDeclaration'
, actionDeclaration_region
- The action declaration's AWS Region, such as us-east-1.
$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:runOrder:ActionDeclaration'
, actionDeclaration_runOrder
- The order in which actions are run.
ActionDeclaration
, actionDeclaration_name
- The action declaration's name.
$sel:actionTypeId:ActionDeclaration'
, actionDeclaration_actionTypeId
- 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.
ActionExecution' (Maybe Text) (Maybe ErrorDetails) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe ActionExecutionStatus) (Maybe Text) (Maybe Text) |
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: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.
$sel:errorDetails:ActionExecution'
, actionExecution_errorDetails
- The details of an error returned by a URL external to AWS.
$sel:externalExecutionId:ActionExecution'
, actionExecution_externalExecutionId
- The external ID of the run of the action.
$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:lastStatusChange:ActionExecution'
, actionExecution_lastStatusChange
- The last status change of the action.
$sel:lastUpdatedBy:ActionExecution'
, actionExecution_lastUpdatedBy
- The ARN of the user who last changed the pipeline.
$sel:percentComplete:ActionExecution'
, actionExecution_percentComplete
- A percentage of completeness of the action as it runs.
$sel:status:ActionExecution'
, actionExecution_status
- The status of the action, or for a completed action, the last status of
the action.
$sel:summary:ActionExecution'
, actionExecution_summary
- A summary of the run 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.
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.
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:actionExecutionId:ActionExecutionDetail'
, actionExecutionDetail_actionExecutionId
- The action execution ID.
$sel:actionName:ActionExecutionDetail'
, actionExecutionDetail_actionName
- The name of the action.
$sel:input:ActionExecutionDetail'
, actionExecutionDetail_input
- Input details for the action execution, such as role ARN, Region, and
input artifacts.
$sel:lastUpdateTime:ActionExecutionDetail'
, actionExecutionDetail_lastUpdateTime
- The last update time of the action execution.
$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:pipelineVersion:ActionExecutionDetail'
, actionExecutionDetail_pipelineVersion
- The version of the pipeline where the action was run.
$sel:stageName:ActionExecutionDetail'
, actionExecutionDetail_stageName
- The name of the stage that contains the action.
$sel:startTime:ActionExecutionDetail'
, actionExecutionDetail_startTime
- The start time of the action execution.
$sel:status:ActionExecutionDetail'
, actionExecutionDetail_status
- The status of the action execution. Status categories are InProgress
,
Succeeded
, and Failed
.
ActionExecutionFilter
data ActionExecutionFilter Source #
Filter values for the action execution.
See: newActionExecutionFilter
smart constructor.
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.
ActionExecutionInput
data ActionExecutionInput Source #
Input information used for an action execution.
See: newActionExecutionInput
smart constructor.
ActionExecutionInput' (Maybe ActionTypeId) (Maybe (HashMap Text Text)) (Maybe [ArtifactDetail]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) |
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:actionTypeId:ActionExecutionInput'
, actionExecutionInput_actionTypeId
- Undocumented member.
$sel:configuration:ActionExecutionInput'
, actionExecutionInput_configuration
- Configuration data for an action execution.
$sel:inputArtifacts:ActionExecutionInput'
, actionExecutionInput_inputArtifacts
- Details of input artifacts of the action that correspond to the action
execution.
$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:region:ActionExecutionInput'
, actionExecutionInput_region
- The AWS Region for the action, such as us-east-1.
$sel:resolvedConfiguration:ActionExecutionInput'
, actionExecutionInput_resolvedConfiguration
- Configuration data for an action execution with all variable references
replaced with their real values for the 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.
ActionExecutionOutput
data ActionExecutionOutput Source #
Output details listed for an action execution, such as the action execution result.
See: newActionExecutionOutput
smart constructor.
ActionExecutionOutput' (Maybe ActionExecutionResult) (Maybe [ArtifactDetail]) (Maybe (HashMap Text Text)) |
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:executionResult:ActionExecutionOutput'
, actionExecutionOutput_executionResult
- Execution result information listed in the output details for an action
execution.
$sel:outputArtifacts:ActionExecutionOutput'
, actionExecutionOutput_outputArtifacts
- Details of output artifacts of the action that correspond to the action
execution.
$sel:outputVariables:ActionExecutionOutput'
, actionExecutionOutput_outputVariables
- The outputVariables field shows the key-value pairs that were output as
part of that execution.
ActionExecutionResult
data ActionExecutionResult Source #
Execution result information, such as the external execution ID.
See: newActionExecutionResult
smart constructor.
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: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.
$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.
ActionRevision
data ActionRevision Source #
Represents information about the version (or revision) of an action.
See: newActionRevision
smart constructor.
Instances
:: 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.
ActionState
data ActionState Source #
Represents information about the state of an action.
See: newActionState
smart constructor.
ActionState' (Maybe Text) (Maybe ActionRevision) (Maybe Text) (Maybe ActionExecution) (Maybe Text) |
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: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:entityUrl:ActionState'
, actionState_entityUrl
- A URL link for more information about the state of the action, such as a
deployment group details page.
$sel:latestExecution:ActionState'
, actionState_latestExecution
- Represents information about the run of an action.
$sel:revisionUrl:ActionState'
, actionState_revisionUrl
- A URL link for more information about the revision, such as a commit
details page.
ActionType
data ActionType Source #
Returns information about the details of an action type.
See: newActionType
smart constructor.
ActionType' (Maybe [ActionConfigurationProperty]) (Maybe ActionTypeSettings) ActionTypeId ArtifactDetails ArtifactDetails |
Instances
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:actionConfigurationProperties:ActionType'
, actionType_actionConfigurationProperties
- The configuration properties for the action type.
$sel:settings:ActionType'
, actionType_settings
- The settings 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.
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.
Instances
newActionTypeArtifactDetails Source #
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
.
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.
Instances
newActionTypeDeclaration Source #
:: 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:
ActionTypeDeclaration
, actionTypeDeclaration_description
- The description for the action type to be updated.
$sel:permissions:ActionTypeDeclaration'
, actionTypeDeclaration_permissions
- Details identifying the accounts with permissions to use the action
type.
$sel:properties:ActionTypeDeclaration'
, actionTypeDeclaration_properties
- The properties of the action type to be updated.
$sel:urls:ActionTypeDeclaration'
, actionTypeDeclaration_urls
- The links associated with 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.
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.
Instances
newActionTypeExecutor Source #
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
.
ActionTypeId
data ActionTypeId Source #
Represents information about an action type.
See: newActionTypeId
smart constructor.
Instances
:: 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.
ActionTypeIdentifier
data ActionTypeIdentifier Source #
Specifies the category, owner, provider, and version of the action type.
See: newActionTypeIdentifier
smart constructor.
Instances
newActionTypeIdentifier Source #
:: 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.
ActionTypePermissions
data ActionTypePermissions Source #
Details identifying the users with permissions to use the action type.
See: newActionTypePermissions
smart constructor.
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.
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.
Instances
newActionTypeProperty Source #
:: 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:description:ActionTypeProperty'
, actionTypeProperty_description
- The description of the property that is displayed to users.
$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: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.
ActionTypeSettings
data ActionTypeSettings Source #
Returns information about the settings for an action type.
See: newActionTypeSettings
smart constructor.
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: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.
$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: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.
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.
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: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.
$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: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.
ApprovalResult
data ApprovalResult Source #
Represents information about the result of an approval request.
See: newApprovalResult
smart constructor.
Instances
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.
Artifact
Represents information about an artifact that is worked on by actions in the pipeline.
See: newArtifact
smart constructor.
Instances
FromJSON Artifact Source # | |
Generic Artifact Source # | |
Read Artifact Source # | |
Show Artifact Source # | |
NFData Artifact Source # | |
Defined in Amazonka.CodePipeline.Types.Artifact | |
Eq Artifact Source # | |
Hashable Artifact Source # | |
Defined in Amazonka.CodePipeline.Types.Artifact | |
type Rep Artifact Source # | |
Defined in Amazonka.CodePipeline.Types.Artifact type Rep Artifact = D1 ('MetaData "Artifact" "Amazonka.CodePipeline.Types.Artifact" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" '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).
ArtifactDetail
data ArtifactDetail Source #
Artifact details for the action execution, such as the artifact location.
See: newArtifactDetail
smart constructor.
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.
ArtifactDetails
data ArtifactDetails Source #
Returns information about the details of an artifact.
See: newArtifactDetails
smart constructor.
Instances
:: 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.
ArtifactLocation
data ArtifactLocation Source #
Represents information about the location of an artifact.
See: newArtifactLocation
smart constructor.
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.
ArtifactRevision
data ArtifactRevision Source #
Represents revision details of an artifact.
See: newArtifactRevision
smart constructor.
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: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: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.
$sel:revisionId:ArtifactRevision'
, artifactRevision_revisionId
- The revision ID of the artifact.
$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.
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.
Instances
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.
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.
BlockerDeclaration
data BlockerDeclaration Source #
Reserved for future use.
See: newBlockerDeclaration
smart constructor.
Instances
newBlockerDeclaration Source #
:: 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.
CurrentRevision
data CurrentRevision Source #
Represents information about a current revision.
See: newCurrentRevision
smart constructor.
Instances
:: 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:created:CurrentRevision'
, currentRevision_created
- The date and time when the most recent revision of the artifact was
created, in timestamp format.
$sel:revisionSummary:CurrentRevision'
, currentRevision_revisionSummary
- The summary of the most recent revision of the artifact.
$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.
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.
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'.
ErrorDetails
data ErrorDetails Source #
Represents information about an error in AWS CodePipeline.
See: newErrorDetails
smart constructor.
ErrorDetails' (Maybe Text) (Maybe Text) |
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.
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.
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: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.
$sel:summary:ExecutionDetails'
, executionDetails_summary
- The summary of the current status of the actions.
ExecutionTrigger
data ExecutionTrigger Source #
The interaction or event that started a pipeline execution.
See: newExecutionTrigger
smart constructor.
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: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.
$sel:triggerType:ExecutionTrigger'
, executionTrigger_triggerType
- The type of change-detection method, command, or user interaction that
started a pipeline execution.
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.
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:jobWorkerExecutorConfiguration:ExecutorConfiguration'
, executorConfiguration_jobWorkerExecutorConfiguration
- Details about the JobWorker
executor of the action type.
$sel:lambdaExecutorConfiguration:ExecutorConfiguration'
, executorConfiguration_lambdaExecutorConfiguration
- Details about the Lambda
executor of the action type.
FailureDetails
data FailureDetails Source #
Represents information about failure details.
See: newFailureDetails
smart constructor.
Instances
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.
InputArtifact
data InputArtifact Source #
Represents information about an artifact to be worked on, such as a test or build artifact.
See: newInputArtifact
smart constructor.
Instances
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.
Job
Represents information about a job.
See: newJob
smart constructor.
Instances
FromJSON Job Source # | |
Generic Job Source # | |
Show Job Source # | |
NFData Job Source # | |
Defined in Amazonka.CodePipeline.Types.Job | |
Eq Job Source # | |
Hashable Job Source # | |
Defined in Amazonka.CodePipeline.Types.Job | |
type Rep Job Source # | |
Defined in Amazonka.CodePipeline.Types.Job type Rep Job = D1 ('MetaData "Job" "Amazonka.CodePipeline.Types.Job" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "Job'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobData))) :*: (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:accountId:Job'
, job_accountId
- The ID of the AWS account to use when performing the job.
$sel:data':Job'
, job_data
- Other data about a 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.
JobData
Represents other information about a job required for a job worker to complete the job.
See: newJobData
smart constructor.
JobData' (Maybe ActionConfiguration) (Maybe ActionTypeId) (Maybe (Sensitive AWSSessionCredentials)) (Maybe Text) (Maybe EncryptionKey) (Maybe [Artifact]) (Maybe [Artifact]) (Maybe PipelineContext) |
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:actionConfiguration:JobData'
, jobData_actionConfiguration
- Represents information about an action configuration.
$sel:actionTypeId:JobData'
, jobData_actionTypeId
- Represents information about an action type.
$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: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: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:inputArtifacts:JobData'
, jobData_inputArtifacts
- The artifact supplied to the job.
$sel:outputArtifacts:JobData'
, jobData_outputArtifacts
- The output of the job.
$sel:pipelineContext:JobData'
, jobData_pipelineContext
- Represents information about a pipeline to a job worker.
Includes pipelineArn
and pipelineExecutionId
for custom jobs.
JobDetails
data JobDetails Source #
Represents information about the details of a job.
See: newJobDetails
smart constructor.
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:accountId:JobDetails'
, jobDetails_accountId
- The AWS account ID associated with the job.
$sel:data':JobDetails'
, jobDetails_data
- Represents other information about a job required for a job worker to
complete the job.
$sel:id:JobDetails'
, jobDetails_id
- 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.
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.
LambdaExecutorConfiguration
data LambdaExecutorConfiguration Source #
Details about the configuration for the Lambda
action engine, or
executor.
See: newLambdaExecutorConfiguration
smart constructor.
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.
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.
ListWebhookItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [Tag]) WebhookDefinition Text |
Instances
:: 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:errorMessage:ListWebhookItem'
, listWebhookItem_errorMessage
- The text of the error message about the webhook.
$sel:lastTriggered:ListWebhookItem'
, listWebhookItem_lastTriggered
- The date and time a webhook was last successfully triggered, in
timestamp format.
$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.
OutputArtifact
data OutputArtifact Source #
Represents information about the output of an action.
See: newOutputArtifact
smart constructor.
Instances
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.
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.
PipelineContext' (Maybe ActionContext) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe StageContext) |
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: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.
$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:stage:PipelineContext'
, pipelineContext_stage
- The stage of the pipeline.
PipelineDeclaration
data PipelineDeclaration Source #
Represents the structure of actions and stages to be performed in the pipeline.
See: newPipelineDeclaration
smart constructor.
PipelineDeclaration' (Maybe ArtifactStore) (Maybe (HashMap Text ArtifactStore)) (Maybe Natural) Text Text [StageDeclaration] |
Instances
newPipelineDeclaration Source #
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: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: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: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.
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.
PipelineExecution
data PipelineExecution Source #
Represents information about an execution of a pipeline.
See: newPipelineExecution
smart constructor.
PipelineExecution' (Maybe [ArtifactRevision]) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe PipelineExecutionStatus) (Maybe Text) |
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:artifactRevisions:PipelineExecution'
, pipelineExecution_artifactRevisions
- A list of ArtifactRevision
objects included in a pipeline execution.
$sel:pipelineExecutionId:PipelineExecution'
, pipelineExecution_pipelineExecutionId
- The ID of the pipeline execution.
$sel:pipelineName:PipelineExecution'
, pipelineExecution_pipelineName
- The name of the pipeline with the specified pipeline execution.
$sel:pipelineVersion:PipelineExecution'
, pipelineExecution_pipelineVersion
- The version number of the pipeline with the specified pipeline
execution.
$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:statusSummary:PipelineExecution'
, pipelineExecution_statusSummary
- A summary that contains a description of the pipeline execution status.
PipelineExecutionSummary
data PipelineExecutionSummary Source #
Summary information about a pipeline execution.
See: newPipelineExecutionSummary
smart constructor.
PipelineExecutionSummary' (Maybe POSIX) (Maybe Text) (Maybe [SourceRevision]) (Maybe POSIX) (Maybe PipelineExecutionStatus) (Maybe StopExecutionTrigger) (Maybe ExecutionTrigger) |
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:lastUpdateTime:PipelineExecutionSummary'
, pipelineExecutionSummary_lastUpdateTime
- The date and time of the last change to the pipeline execution, in
timestamp format.
$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:startTime:PipelineExecutionSummary'
, pipelineExecutionSummary_startTime
- The date and time when the pipeline execution began, in timestamp
format.
$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:stopTrigger:PipelineExecutionSummary'
, pipelineExecutionSummary_stopTrigger
- The interaction that stopped 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.
PipelineMetadata
data PipelineMetadata Source #
Information about a pipeline.
See: newPipelineMetadata
smart constructor.
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.
PipelineSummary
data PipelineSummary Source #
Returns a summary of a pipeline.
See: newPipelineSummary
smart constructor.
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:updated:PipelineSummary'
, pipelineSummary_updated
- The date and time of the last update to the pipeline, in timestamp
format.
$sel:version:PipelineSummary'
, pipelineSummary_version
- The version number of the pipeline.
S3ArtifactLocation
data S3ArtifactLocation Source #
The location of the S3 bucket that contains a revision.
See: newS3ArtifactLocation
smart constructor.
Instances
newS3ArtifactLocation Source #
:: 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.
S3Location
data S3Location Source #
The Amazon S3 artifact location for an action's artifacts.
See: newS3Location
smart constructor.
S3Location' (Maybe Text) (Maybe Text) |
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.
SourceRevision
data SourceRevision Source #
Information about the version (or revision) of a source artifact that initiated a pipeline execution.
See: newSourceRevision
smart constructor.
Instances
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:revisionId:SourceRevision'
, sourceRevision_revisionId
- The system-generated unique ID that identifies the revision number of
the artifact.
$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:actionName:SourceRevision'
, sourceRevision_actionName
- 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.
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.
StageDeclaration
data StageDeclaration Source #
Represents information about a stage and its definition.
See: newStageDeclaration
smart constructor.
Instances
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.
StageDeclaration
, stageDeclaration_name
- The name of the stage.
$sel:actions:StageDeclaration'
, stageDeclaration_actions
- The actions included in a stage.
StageExecution
data StageExecution Source #
Represents information about the run of a stage.
See: newStageExecution
smart constructor.
Instances
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.
StageState
data StageState Source #
Represents information about the state of the stage.
See: newStageState
smart constructor.
StageState' (Maybe [ActionState]) (Maybe StageExecution) (Maybe TransitionState) (Maybe StageExecution) (Maybe Text) |
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:actionStates:StageState'
, stageState_actionStates
- The state of the stage.
$sel:inboundExecution:StageState'
, stageState_inboundExecution
- Undocumented member.
$sel:inboundTransitionState:StageState'
, stageState_inboundTransitionState
- The state of the inbound transition, which is either enabled or
disabled.
StageState
, stageState_latestExecution
- Information about the latest execution in the stage, including its ID
and status.
$sel:stageName:StageState'
, stageState_stageName
- The name of the stage.
StopExecutionTrigger
data StopExecutionTrigger Source #
The interaction that stopped a pipeline execution.
See: newStopExecutionTrigger
smart constructor.
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.
Tag
A tag is a key-value pair that is used to manage the resource.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.CodePipeline.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.CodePipeline.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.CodePipeline.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.CodePipeline.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CodePipeline.Types.Tag" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" '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.
ThirdPartyJob' (Maybe Text) (Maybe Text) |
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.
ThirdPartyJobData
data ThirdPartyJobData Source #
Represents information about the job data for a partner action.
See: newThirdPartyJobData
smart constructor.
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:actionConfiguration:ThirdPartyJobData'
, thirdPartyJobData_actionConfiguration
- Represents information about an action configuration.
$sel:actionTypeId:ThirdPartyJobData'
, thirdPartyJobData_actionTypeId
- Represents information about an action type.
$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: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: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: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: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:pipelineContext:ThirdPartyJobData'
, thirdPartyJobData_pipelineContext
- Represents information about a pipeline to a job worker.
Does not include pipelineArn
and pipelineExecutionId
for ThirdParty
jobs.
ThirdPartyJobDetails
data ThirdPartyJobDetails Source #
The details of a job sent in response to a GetThirdPartyJobDetails
request.
See: newThirdPartyJobDetails
smart constructor.
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.
TransitionState
data TransitionState Source #
Represents information about the state of transitions between one stage and another stage.
See: newTransitionState
smart constructor.
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:disabledReason:TransitionState'
, transitionState_disabledReason
- The user-specified reason why the transition between two stages of a
pipeline was disabled.
$sel:enabled:TransitionState'
, transitionState_enabled
- Whether the transition between stages is enabled (true) or disabled
(false).
$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.
WebhookAuthConfiguration
data WebhookAuthConfiguration Source #
The authentication applied to incoming webhook trigger requests.
See: newWebhookAuthConfiguration
smart constructor.
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.
WebhookDefinition
data WebhookDefinition Source #
Represents information about a webhook and its definition.
See: newWebhookDefinition
smart constructor.
WebhookDefinition' Text Text Text [WebhookFilterRule] WebhookAuthenticationType WebhookAuthConfiguration |
Instances
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.
WebhookFilterRule
data WebhookFilterRule Source #
The event criteria that specify when a webhook notification is sent to your URL.
See: newWebhookFilterRule
smart constructor.
Instances
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.