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 |
- Operations
- AcknowledgeJob
- AcknowledgeThirdPartyJob
- CreateCustomActionType
- CreatePipeline
- DeleteCustomActionType
- DeletePipeline
- DeleteWebhook
- DeregisterWebhookWithThirdParty
- DisableStageTransition
- EnableStageTransition
- GetActionType
- GetJobDetails
- GetPipeline
- GetPipelineExecution
- GetPipelineState
- GetThirdPartyJobDetails
- ListActionExecutions
- ListActionTypes
- ListPipelineExecutions
- ListPipelines
- ListTagsForResource
- ListWebhooks
- PollForJobs
- PollForThirdPartyJobs
- PutActionRevision
- PutApprovalResult
- PutJobFailureResult
- PutJobSuccessResult
- PutThirdPartyJobFailureResult
- PutThirdPartyJobSuccessResult
- PutWebhook
- RegisterWebhookWithThirdParty
- RetryStageExecution
- StartPipelineExecution
- StopPipelineExecution
- TagResource
- UntagResource
- UpdateActionType
- UpdatePipeline
- Types
- 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
Synopsis
- acknowledgeJob_jobId :: Lens' AcknowledgeJob Text
- acknowledgeJob_nonce :: Lens' AcknowledgeJob Text
- acknowledgeJobResponse_status :: Lens' AcknowledgeJobResponse (Maybe JobStatus)
- acknowledgeJobResponse_httpStatus :: Lens' AcknowledgeJobResponse Int
- acknowledgeThirdPartyJob_jobId :: Lens' AcknowledgeThirdPartyJob Text
- acknowledgeThirdPartyJob_nonce :: Lens' AcknowledgeThirdPartyJob Text
- acknowledgeThirdPartyJob_clientToken :: Lens' AcknowledgeThirdPartyJob Text
- acknowledgeThirdPartyJobResponse_status :: Lens' AcknowledgeThirdPartyJobResponse (Maybe JobStatus)
- acknowledgeThirdPartyJobResponse_httpStatus :: Lens' AcknowledgeThirdPartyJobResponse Int
- createCustomActionType_configurationProperties :: Lens' CreateCustomActionType (Maybe [ActionConfigurationProperty])
- createCustomActionType_settings :: Lens' CreateCustomActionType (Maybe ActionTypeSettings)
- createCustomActionType_tags :: Lens' CreateCustomActionType (Maybe [Tag])
- createCustomActionType_category :: Lens' CreateCustomActionType ActionCategory
- createCustomActionType_provider :: Lens' CreateCustomActionType Text
- createCustomActionType_version :: Lens' CreateCustomActionType Text
- createCustomActionType_inputArtifactDetails :: Lens' CreateCustomActionType ArtifactDetails
- createCustomActionType_outputArtifactDetails :: Lens' CreateCustomActionType ArtifactDetails
- createCustomActionTypeResponse_tags :: Lens' CreateCustomActionTypeResponse (Maybe [Tag])
- createCustomActionTypeResponse_httpStatus :: Lens' CreateCustomActionTypeResponse Int
- createCustomActionTypeResponse_actionType :: Lens' CreateCustomActionTypeResponse ActionType
- createPipeline_tags :: Lens' CreatePipeline (Maybe [Tag])
- createPipeline_pipeline :: Lens' CreatePipeline PipelineDeclaration
- createPipelineResponse_pipeline :: Lens' CreatePipelineResponse (Maybe PipelineDeclaration)
- createPipelineResponse_tags :: Lens' CreatePipelineResponse (Maybe [Tag])
- createPipelineResponse_httpStatus :: Lens' CreatePipelineResponse Int
- deleteCustomActionType_category :: Lens' DeleteCustomActionType ActionCategory
- deleteCustomActionType_provider :: Lens' DeleteCustomActionType Text
- deleteCustomActionType_version :: Lens' DeleteCustomActionType Text
- deletePipeline_name :: Lens' DeletePipeline Text
- deleteWebhook_name :: Lens' DeleteWebhook Text
- deleteWebhookResponse_httpStatus :: Lens' DeleteWebhookResponse Int
- deregisterWebhookWithThirdParty_webhookName :: Lens' DeregisterWebhookWithThirdParty (Maybe Text)
- deregisterWebhookWithThirdPartyResponse_httpStatus :: Lens' DeregisterWebhookWithThirdPartyResponse Int
- disableStageTransition_pipelineName :: Lens' DisableStageTransition Text
- disableStageTransition_stageName :: Lens' DisableStageTransition Text
- disableStageTransition_transitionType :: Lens' DisableStageTransition StageTransitionType
- disableStageTransition_reason :: Lens' DisableStageTransition Text
- enableStageTransition_pipelineName :: Lens' EnableStageTransition Text
- enableStageTransition_stageName :: Lens' EnableStageTransition Text
- enableStageTransition_transitionType :: Lens' EnableStageTransition StageTransitionType
- getActionType_category :: Lens' GetActionType ActionCategory
- getActionType_owner :: Lens' GetActionType Text
- getActionType_provider :: Lens' GetActionType Text
- getActionType_version :: Lens' GetActionType Text
- getActionTypeResponse_actionType :: Lens' GetActionTypeResponse (Maybe ActionTypeDeclaration)
- getActionTypeResponse_httpStatus :: Lens' GetActionTypeResponse Int
- getJobDetails_jobId :: Lens' GetJobDetails Text
- getJobDetailsResponse_jobDetails :: Lens' GetJobDetailsResponse (Maybe JobDetails)
- getJobDetailsResponse_httpStatus :: Lens' GetJobDetailsResponse Int
- getPipeline_version :: Lens' GetPipeline (Maybe Natural)
- getPipeline_name :: Lens' GetPipeline Text
- getPipelineResponse_metadata :: Lens' GetPipelineResponse (Maybe PipelineMetadata)
- getPipelineResponse_pipeline :: Lens' GetPipelineResponse (Maybe PipelineDeclaration)
- getPipelineResponse_httpStatus :: Lens' GetPipelineResponse Int
- getPipelineExecution_pipelineName :: Lens' GetPipelineExecution Text
- getPipelineExecution_pipelineExecutionId :: Lens' GetPipelineExecution Text
- getPipelineExecutionResponse_pipelineExecution :: Lens' GetPipelineExecutionResponse (Maybe PipelineExecution)
- getPipelineExecutionResponse_httpStatus :: Lens' GetPipelineExecutionResponse Int
- getPipelineState_name :: Lens' GetPipelineState Text
- getPipelineStateResponse_created :: Lens' GetPipelineStateResponse (Maybe UTCTime)
- getPipelineStateResponse_pipelineName :: Lens' GetPipelineStateResponse (Maybe Text)
- getPipelineStateResponse_pipelineVersion :: Lens' GetPipelineStateResponse (Maybe Natural)
- getPipelineStateResponse_stageStates :: Lens' GetPipelineStateResponse (Maybe [StageState])
- getPipelineStateResponse_updated :: Lens' GetPipelineStateResponse (Maybe UTCTime)
- getPipelineStateResponse_httpStatus :: Lens' GetPipelineStateResponse Int
- getThirdPartyJobDetails_jobId :: Lens' GetThirdPartyJobDetails Text
- getThirdPartyJobDetails_clientToken :: Lens' GetThirdPartyJobDetails Text
- getThirdPartyJobDetailsResponse_jobDetails :: Lens' GetThirdPartyJobDetailsResponse (Maybe ThirdPartyJobDetails)
- getThirdPartyJobDetailsResponse_httpStatus :: Lens' GetThirdPartyJobDetailsResponse Int
- listActionExecutions_filter :: Lens' ListActionExecutions (Maybe ActionExecutionFilter)
- listActionExecutions_maxResults :: Lens' ListActionExecutions (Maybe Natural)
- listActionExecutions_nextToken :: Lens' ListActionExecutions (Maybe Text)
- listActionExecutions_pipelineName :: Lens' ListActionExecutions Text
- listActionExecutionsResponse_actionExecutionDetails :: Lens' ListActionExecutionsResponse (Maybe [ActionExecutionDetail])
- listActionExecutionsResponse_nextToken :: Lens' ListActionExecutionsResponse (Maybe Text)
- listActionExecutionsResponse_httpStatus :: Lens' ListActionExecutionsResponse Int
- listActionTypes_actionOwnerFilter :: Lens' ListActionTypes (Maybe ActionOwner)
- listActionTypes_nextToken :: Lens' ListActionTypes (Maybe Text)
- listActionTypes_regionFilter :: Lens' ListActionTypes (Maybe Text)
- listActionTypesResponse_nextToken :: Lens' ListActionTypesResponse (Maybe Text)
- listActionTypesResponse_httpStatus :: Lens' ListActionTypesResponse Int
- listActionTypesResponse_actionTypes :: Lens' ListActionTypesResponse [ActionType]
- listPipelineExecutions_maxResults :: Lens' ListPipelineExecutions (Maybe Natural)
- listPipelineExecutions_nextToken :: Lens' ListPipelineExecutions (Maybe Text)
- listPipelineExecutions_pipelineName :: Lens' ListPipelineExecutions Text
- listPipelineExecutionsResponse_nextToken :: Lens' ListPipelineExecutionsResponse (Maybe Text)
- listPipelineExecutionsResponse_pipelineExecutionSummaries :: Lens' ListPipelineExecutionsResponse (Maybe [PipelineExecutionSummary])
- listPipelineExecutionsResponse_httpStatus :: Lens' ListPipelineExecutionsResponse Int
- listPipelines_maxResults :: Lens' ListPipelines (Maybe Natural)
- listPipelines_nextToken :: Lens' ListPipelines (Maybe Text)
- listPipelinesResponse_nextToken :: Lens' ListPipelinesResponse (Maybe Text)
- listPipelinesResponse_pipelines :: Lens' ListPipelinesResponse (Maybe [PipelineSummary])
- listPipelinesResponse_httpStatus :: Lens' ListPipelinesResponse Int
- listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural)
- listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listWebhooks_maxResults :: Lens' ListWebhooks (Maybe Natural)
- listWebhooks_nextToken :: Lens' ListWebhooks (Maybe Text)
- listWebhooksResponse_nextToken :: Lens' ListWebhooksResponse (Maybe Text)
- listWebhooksResponse_webhooks :: Lens' ListWebhooksResponse (Maybe [ListWebhookItem])
- listWebhooksResponse_httpStatus :: Lens' ListWebhooksResponse Int
- pollForJobs_maxBatchSize :: Lens' PollForJobs (Maybe Natural)
- pollForJobs_queryParam :: Lens' PollForJobs (Maybe (HashMap Text Text))
- pollForJobs_actionTypeId :: Lens' PollForJobs ActionTypeId
- pollForJobsResponse_jobs :: Lens' PollForJobsResponse (Maybe [Job])
- pollForJobsResponse_httpStatus :: Lens' PollForJobsResponse Int
- pollForThirdPartyJobs_maxBatchSize :: Lens' PollForThirdPartyJobs (Maybe Natural)
- pollForThirdPartyJobs_actionTypeId :: Lens' PollForThirdPartyJobs ActionTypeId
- pollForThirdPartyJobsResponse_jobs :: Lens' PollForThirdPartyJobsResponse (Maybe [ThirdPartyJob])
- pollForThirdPartyJobsResponse_httpStatus :: Lens' PollForThirdPartyJobsResponse Int
- putActionRevision_pipelineName :: Lens' PutActionRevision Text
- putActionRevision_stageName :: Lens' PutActionRevision Text
- putActionRevision_actionName :: Lens' PutActionRevision Text
- putActionRevision_actionRevision :: Lens' PutActionRevision ActionRevision
- putActionRevisionResponse_newRevision :: Lens' PutActionRevisionResponse (Maybe Bool)
- putActionRevisionResponse_pipelineExecutionId :: Lens' PutActionRevisionResponse (Maybe Text)
- putActionRevisionResponse_httpStatus :: Lens' PutActionRevisionResponse Int
- putApprovalResult_pipelineName :: Lens' PutApprovalResult Text
- putApprovalResult_stageName :: Lens' PutApprovalResult Text
- putApprovalResult_actionName :: Lens' PutApprovalResult Text
- putApprovalResult_result :: Lens' PutApprovalResult ApprovalResult
- putApprovalResult_token :: Lens' PutApprovalResult Text
- putApprovalResultResponse_approvedAt :: Lens' PutApprovalResultResponse (Maybe UTCTime)
- putApprovalResultResponse_httpStatus :: Lens' PutApprovalResultResponse Int
- putJobFailureResult_jobId :: Lens' PutJobFailureResult Text
- putJobFailureResult_failureDetails :: Lens' PutJobFailureResult FailureDetails
- putJobSuccessResult_continuationToken :: Lens' PutJobSuccessResult (Maybe Text)
- putJobSuccessResult_currentRevision :: Lens' PutJobSuccessResult (Maybe CurrentRevision)
- putJobSuccessResult_executionDetails :: Lens' PutJobSuccessResult (Maybe ExecutionDetails)
- putJobSuccessResult_outputVariables :: Lens' PutJobSuccessResult (Maybe (HashMap Text Text))
- putJobSuccessResult_jobId :: Lens' PutJobSuccessResult Text
- putThirdPartyJobFailureResult_jobId :: Lens' PutThirdPartyJobFailureResult Text
- putThirdPartyJobFailureResult_clientToken :: Lens' PutThirdPartyJobFailureResult Text
- putThirdPartyJobFailureResult_failureDetails :: Lens' PutThirdPartyJobFailureResult FailureDetails
- putThirdPartyJobSuccessResult_continuationToken :: Lens' PutThirdPartyJobSuccessResult (Maybe Text)
- putThirdPartyJobSuccessResult_currentRevision :: Lens' PutThirdPartyJobSuccessResult (Maybe CurrentRevision)
- putThirdPartyJobSuccessResult_executionDetails :: Lens' PutThirdPartyJobSuccessResult (Maybe ExecutionDetails)
- putThirdPartyJobSuccessResult_jobId :: Lens' PutThirdPartyJobSuccessResult Text
- putThirdPartyJobSuccessResult_clientToken :: Lens' PutThirdPartyJobSuccessResult Text
- putWebhook_tags :: Lens' PutWebhook (Maybe [Tag])
- putWebhook_webhook :: Lens' PutWebhook WebhookDefinition
- putWebhookResponse_webhook :: Lens' PutWebhookResponse (Maybe ListWebhookItem)
- putWebhookResponse_httpStatus :: Lens' PutWebhookResponse Int
- registerWebhookWithThirdParty_webhookName :: Lens' RegisterWebhookWithThirdParty (Maybe Text)
- registerWebhookWithThirdPartyResponse_httpStatus :: Lens' RegisterWebhookWithThirdPartyResponse Int
- retryStageExecution_pipelineName :: Lens' RetryStageExecution Text
- retryStageExecution_stageName :: Lens' RetryStageExecution Text
- retryStageExecution_pipelineExecutionId :: Lens' RetryStageExecution Text
- retryStageExecution_retryMode :: Lens' RetryStageExecution StageRetryMode
- retryStageExecutionResponse_pipelineExecutionId :: Lens' RetryStageExecutionResponse (Maybe Text)
- retryStageExecutionResponse_httpStatus :: Lens' RetryStageExecutionResponse Int
- startPipelineExecution_clientRequestToken :: Lens' StartPipelineExecution (Maybe Text)
- startPipelineExecution_name :: Lens' StartPipelineExecution Text
- startPipelineExecutionResponse_pipelineExecutionId :: Lens' StartPipelineExecutionResponse (Maybe Text)
- startPipelineExecutionResponse_httpStatus :: Lens' StartPipelineExecutionResponse Int
- stopPipelineExecution_abandon :: Lens' StopPipelineExecution (Maybe Bool)
- stopPipelineExecution_reason :: Lens' StopPipelineExecution (Maybe Text)
- stopPipelineExecution_pipelineName :: Lens' StopPipelineExecution Text
- stopPipelineExecution_pipelineExecutionId :: Lens' StopPipelineExecution Text
- stopPipelineExecutionResponse_pipelineExecutionId :: Lens' StopPipelineExecutionResponse (Maybe Text)
- stopPipelineExecutionResponse_httpStatus :: Lens' StopPipelineExecutionResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource [Tag]
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateActionType_actionType :: Lens' UpdateActionType ActionTypeDeclaration
- updatePipeline_pipeline :: Lens' UpdatePipeline PipelineDeclaration
- updatePipelineResponse_pipeline :: Lens' UpdatePipelineResponse (Maybe PipelineDeclaration)
- updatePipelineResponse_httpStatus :: Lens' UpdatePipelineResponse Int
- aWSSessionCredentials_accessKeyId :: Lens' AWSSessionCredentials Text
- aWSSessionCredentials_secretAccessKey :: Lens' AWSSessionCredentials Text
- aWSSessionCredentials_sessionToken :: Lens' AWSSessionCredentials Text
- actionConfiguration_configuration :: Lens' ActionConfiguration (Maybe (HashMap Text Text))
- actionConfigurationProperty_description :: Lens' ActionConfigurationProperty (Maybe Text)
- actionConfigurationProperty_queryable :: Lens' ActionConfigurationProperty (Maybe Bool)
- actionConfigurationProperty_type :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType)
- actionConfigurationProperty_name :: Lens' ActionConfigurationProperty Text
- actionConfigurationProperty_required :: Lens' ActionConfigurationProperty Bool
- actionConfigurationProperty_key :: Lens' ActionConfigurationProperty Bool
- actionConfigurationProperty_secret :: Lens' ActionConfigurationProperty Bool
- actionContext_actionExecutionId :: Lens' ActionContext (Maybe Text)
- actionContext_name :: Lens' ActionContext (Maybe Text)
- actionDeclaration_configuration :: Lens' ActionDeclaration (Maybe (HashMap Text Text))
- actionDeclaration_inputArtifacts :: Lens' ActionDeclaration (Maybe [InputArtifact])
- actionDeclaration_namespace :: Lens' ActionDeclaration (Maybe Text)
- actionDeclaration_outputArtifacts :: Lens' ActionDeclaration (Maybe [OutputArtifact])
- actionDeclaration_region :: Lens' ActionDeclaration (Maybe Text)
- actionDeclaration_roleArn :: Lens' ActionDeclaration (Maybe Text)
- actionDeclaration_runOrder :: Lens' ActionDeclaration (Maybe Natural)
- actionDeclaration_name :: Lens' ActionDeclaration Text
- actionDeclaration_actionTypeId :: Lens' ActionDeclaration ActionTypeId
- actionExecution_actionExecutionId :: Lens' ActionExecution (Maybe Text)
- actionExecution_errorDetails :: Lens' ActionExecution (Maybe ErrorDetails)
- actionExecution_externalExecutionId :: Lens' ActionExecution (Maybe Text)
- actionExecution_externalExecutionUrl :: Lens' ActionExecution (Maybe Text)
- actionExecution_lastStatusChange :: Lens' ActionExecution (Maybe UTCTime)
- actionExecution_lastUpdatedBy :: Lens' ActionExecution (Maybe Text)
- actionExecution_percentComplete :: Lens' ActionExecution (Maybe Natural)
- actionExecution_status :: Lens' ActionExecution (Maybe ActionExecutionStatus)
- actionExecution_summary :: Lens' ActionExecution (Maybe Text)
- actionExecution_token :: Lens' ActionExecution (Maybe Text)
- actionExecutionDetail_actionExecutionId :: Lens' ActionExecutionDetail (Maybe Text)
- actionExecutionDetail_actionName :: Lens' ActionExecutionDetail (Maybe Text)
- actionExecutionDetail_input :: Lens' ActionExecutionDetail (Maybe ActionExecutionInput)
- actionExecutionDetail_lastUpdateTime :: Lens' ActionExecutionDetail (Maybe UTCTime)
- actionExecutionDetail_output :: Lens' ActionExecutionDetail (Maybe ActionExecutionOutput)
- actionExecutionDetail_pipelineExecutionId :: Lens' ActionExecutionDetail (Maybe Text)
- actionExecutionDetail_pipelineVersion :: Lens' ActionExecutionDetail (Maybe Natural)
- actionExecutionDetail_stageName :: Lens' ActionExecutionDetail (Maybe Text)
- actionExecutionDetail_startTime :: Lens' ActionExecutionDetail (Maybe UTCTime)
- actionExecutionDetail_status :: Lens' ActionExecutionDetail (Maybe ActionExecutionStatus)
- actionExecutionFilter_pipelineExecutionId :: Lens' ActionExecutionFilter (Maybe Text)
- actionExecutionInput_actionTypeId :: Lens' ActionExecutionInput (Maybe ActionTypeId)
- actionExecutionInput_configuration :: Lens' ActionExecutionInput (Maybe (HashMap Text Text))
- actionExecutionInput_inputArtifacts :: Lens' ActionExecutionInput (Maybe [ArtifactDetail])
- actionExecutionInput_namespace :: Lens' ActionExecutionInput (Maybe Text)
- actionExecutionInput_region :: Lens' ActionExecutionInput (Maybe Text)
- actionExecutionInput_resolvedConfiguration :: Lens' ActionExecutionInput (Maybe (HashMap Text Text))
- actionExecutionInput_roleArn :: Lens' ActionExecutionInput (Maybe Text)
- actionExecutionOutput_executionResult :: Lens' ActionExecutionOutput (Maybe ActionExecutionResult)
- actionExecutionOutput_outputArtifacts :: Lens' ActionExecutionOutput (Maybe [ArtifactDetail])
- actionExecutionOutput_outputVariables :: Lens' ActionExecutionOutput (Maybe (HashMap Text Text))
- actionExecutionResult_externalExecutionId :: Lens' ActionExecutionResult (Maybe Text)
- actionExecutionResult_externalExecutionSummary :: Lens' ActionExecutionResult (Maybe Text)
- actionExecutionResult_externalExecutionUrl :: Lens' ActionExecutionResult (Maybe Text)
- actionRevision_revisionId :: Lens' ActionRevision Text
- actionRevision_revisionChangeId :: Lens' ActionRevision Text
- actionRevision_created :: Lens' ActionRevision UTCTime
- actionState_actionName :: Lens' ActionState (Maybe Text)
- actionState_currentRevision :: Lens' ActionState (Maybe ActionRevision)
- actionState_entityUrl :: Lens' ActionState (Maybe Text)
- actionState_latestExecution :: Lens' ActionState (Maybe ActionExecution)
- actionState_revisionUrl :: Lens' ActionState (Maybe Text)
- actionType_actionConfigurationProperties :: Lens' ActionType (Maybe [ActionConfigurationProperty])
- actionType_settings :: Lens' ActionType (Maybe ActionTypeSettings)
- actionType_id :: Lens' ActionType ActionTypeId
- actionType_inputArtifactDetails :: Lens' ActionType ArtifactDetails
- actionType_outputArtifactDetails :: Lens' ActionType ArtifactDetails
- actionTypeArtifactDetails_minimumCount :: Lens' ActionTypeArtifactDetails Natural
- actionTypeArtifactDetails_maximumCount :: Lens' ActionTypeArtifactDetails Natural
- actionTypeDeclaration_description :: Lens' ActionTypeDeclaration (Maybe Text)
- actionTypeDeclaration_permissions :: Lens' ActionTypeDeclaration (Maybe ActionTypePermissions)
- actionTypeDeclaration_properties :: Lens' ActionTypeDeclaration (Maybe [ActionTypeProperty])
- actionTypeDeclaration_urls :: Lens' ActionTypeDeclaration (Maybe ActionTypeUrls)
- actionTypeDeclaration_executor :: Lens' ActionTypeDeclaration ActionTypeExecutor
- actionTypeDeclaration_id :: Lens' ActionTypeDeclaration ActionTypeIdentifier
- actionTypeDeclaration_inputArtifactDetails :: Lens' ActionTypeDeclaration ActionTypeArtifactDetails
- actionTypeDeclaration_outputArtifactDetails :: Lens' ActionTypeDeclaration ActionTypeArtifactDetails
- actionTypeExecutor_jobTimeout :: Lens' ActionTypeExecutor (Maybe Natural)
- actionTypeExecutor_policyStatementsTemplate :: Lens' ActionTypeExecutor (Maybe Text)
- actionTypeExecutor_configuration :: Lens' ActionTypeExecutor ExecutorConfiguration
- actionTypeExecutor_type :: Lens' ActionTypeExecutor ExecutorType
- actionTypeId_category :: Lens' ActionTypeId ActionCategory
- actionTypeId_owner :: Lens' ActionTypeId ActionOwner
- actionTypeId_provider :: Lens' ActionTypeId Text
- actionTypeId_version :: Lens' ActionTypeId Text
- actionTypeIdentifier_category :: Lens' ActionTypeIdentifier ActionCategory
- actionTypeIdentifier_owner :: Lens' ActionTypeIdentifier Text
- actionTypeIdentifier_provider :: Lens' ActionTypeIdentifier Text
- actionTypeIdentifier_version :: Lens' ActionTypeIdentifier Text
- actionTypePermissions_allowedAccounts :: Lens' ActionTypePermissions (NonEmpty Text)
- actionTypeProperty_description :: Lens' ActionTypeProperty (Maybe Text)
- actionTypeProperty_queryable :: Lens' ActionTypeProperty (Maybe Bool)
- actionTypeProperty_name :: Lens' ActionTypeProperty Text
- actionTypeProperty_optional :: Lens' ActionTypeProperty Bool
- actionTypeProperty_key :: Lens' ActionTypeProperty Bool
- actionTypeProperty_noEcho :: Lens' ActionTypeProperty Bool
- actionTypeSettings_entityUrlTemplate :: Lens' ActionTypeSettings (Maybe Text)
- actionTypeSettings_executionUrlTemplate :: Lens' ActionTypeSettings (Maybe Text)
- actionTypeSettings_revisionUrlTemplate :: Lens' ActionTypeSettings (Maybe Text)
- actionTypeSettings_thirdPartyConfigurationUrl :: Lens' ActionTypeSettings (Maybe Text)
- actionTypeUrls_configurationUrl :: Lens' ActionTypeUrls (Maybe Text)
- actionTypeUrls_entityUrlTemplate :: Lens' ActionTypeUrls (Maybe Text)
- actionTypeUrls_executionUrlTemplate :: Lens' ActionTypeUrls (Maybe Text)
- actionTypeUrls_revisionUrlTemplate :: Lens' ActionTypeUrls (Maybe Text)
- approvalResult_summary :: Lens' ApprovalResult Text
- approvalResult_status :: Lens' ApprovalResult ApprovalStatus
- artifact_location :: Lens' Artifact (Maybe ArtifactLocation)
- artifact_name :: Lens' Artifact (Maybe Text)
- artifact_revision :: Lens' Artifact (Maybe Text)
- artifactDetail_name :: Lens' ArtifactDetail (Maybe Text)
- artifactDetail_s3location :: Lens' ArtifactDetail (Maybe S3Location)
- artifactDetails_minimumCount :: Lens' ArtifactDetails Natural
- artifactDetails_maximumCount :: Lens' ArtifactDetails Natural
- artifactLocation_s3Location :: Lens' ArtifactLocation (Maybe S3ArtifactLocation)
- artifactLocation_type :: Lens' ArtifactLocation (Maybe ArtifactLocationType)
- artifactRevision_created :: Lens' ArtifactRevision (Maybe UTCTime)
- artifactRevision_name :: Lens' ArtifactRevision (Maybe Text)
- artifactRevision_revisionChangeIdentifier :: Lens' ArtifactRevision (Maybe Text)
- artifactRevision_revisionId :: Lens' ArtifactRevision (Maybe Text)
- artifactRevision_revisionSummary :: Lens' ArtifactRevision (Maybe Text)
- artifactRevision_revisionUrl :: Lens' ArtifactRevision (Maybe Text)
- artifactStore_encryptionKey :: Lens' ArtifactStore (Maybe EncryptionKey)
- artifactStore_type :: Lens' ArtifactStore ArtifactStoreType
- artifactStore_location :: Lens' ArtifactStore Text
- blockerDeclaration_name :: Lens' BlockerDeclaration Text
- blockerDeclaration_type :: Lens' BlockerDeclaration BlockerType
- currentRevision_created :: Lens' CurrentRevision (Maybe UTCTime)
- currentRevision_revisionSummary :: Lens' CurrentRevision (Maybe Text)
- currentRevision_revision :: Lens' CurrentRevision Text
- currentRevision_changeIdentifier :: Lens' CurrentRevision Text
- encryptionKey_id :: Lens' EncryptionKey Text
- encryptionKey_type :: Lens' EncryptionKey EncryptionKeyType
- errorDetails_code :: Lens' ErrorDetails (Maybe Text)
- errorDetails_message :: Lens' ErrorDetails (Maybe Text)
- executionDetails_externalExecutionId :: Lens' ExecutionDetails (Maybe Text)
- executionDetails_percentComplete :: Lens' ExecutionDetails (Maybe Natural)
- executionDetails_summary :: Lens' ExecutionDetails (Maybe Text)
- executionTrigger_triggerDetail :: Lens' ExecutionTrigger (Maybe Text)
- executionTrigger_triggerType :: Lens' ExecutionTrigger (Maybe TriggerType)
- executorConfiguration_jobWorkerExecutorConfiguration :: Lens' ExecutorConfiguration (Maybe JobWorkerExecutorConfiguration)
- executorConfiguration_lambdaExecutorConfiguration :: Lens' ExecutorConfiguration (Maybe LambdaExecutorConfiguration)
- failureDetails_externalExecutionId :: Lens' FailureDetails (Maybe Text)
- failureDetails_type :: Lens' FailureDetails FailureType
- failureDetails_message :: Lens' FailureDetails Text
- inputArtifact_name :: Lens' InputArtifact Text
- job_accountId :: Lens' Job (Maybe Text)
- job_data :: Lens' Job (Maybe JobData)
- job_id :: Lens' Job (Maybe Text)
- job_nonce :: Lens' Job (Maybe Text)
- jobData_actionConfiguration :: Lens' JobData (Maybe ActionConfiguration)
- jobData_actionTypeId :: Lens' JobData (Maybe ActionTypeId)
- jobData_artifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials)
- jobData_continuationToken :: Lens' JobData (Maybe Text)
- jobData_encryptionKey :: Lens' JobData (Maybe EncryptionKey)
- jobData_inputArtifacts :: Lens' JobData (Maybe [Artifact])
- jobData_outputArtifacts :: Lens' JobData (Maybe [Artifact])
- jobData_pipelineContext :: Lens' JobData (Maybe PipelineContext)
- jobDetails_accountId :: Lens' JobDetails (Maybe Text)
- jobDetails_data :: Lens' JobDetails (Maybe JobData)
- jobDetails_id :: Lens' JobDetails (Maybe Text)
- jobWorkerExecutorConfiguration_pollingAccounts :: Lens' JobWorkerExecutorConfiguration (Maybe (NonEmpty Text))
- jobWorkerExecutorConfiguration_pollingServicePrincipals :: Lens' JobWorkerExecutorConfiguration (Maybe (NonEmpty Text))
- lambdaExecutorConfiguration_lambdaFunctionArn :: Lens' LambdaExecutorConfiguration Text
- listWebhookItem_arn :: Lens' ListWebhookItem (Maybe Text)
- listWebhookItem_errorCode :: Lens' ListWebhookItem (Maybe Text)
- listWebhookItem_errorMessage :: Lens' ListWebhookItem (Maybe Text)
- listWebhookItem_lastTriggered :: Lens' ListWebhookItem (Maybe UTCTime)
- listWebhookItem_tags :: Lens' ListWebhookItem (Maybe [Tag])
- listWebhookItem_definition :: Lens' ListWebhookItem WebhookDefinition
- listWebhookItem_url :: Lens' ListWebhookItem Text
- outputArtifact_name :: Lens' OutputArtifact Text
- pipelineContext_action :: Lens' PipelineContext (Maybe ActionContext)
- pipelineContext_pipelineArn :: Lens' PipelineContext (Maybe Text)
- pipelineContext_pipelineExecutionId :: Lens' PipelineContext (Maybe Text)
- pipelineContext_pipelineName :: Lens' PipelineContext (Maybe Text)
- pipelineContext_stage :: Lens' PipelineContext (Maybe StageContext)
- pipelineDeclaration_artifactStore :: Lens' PipelineDeclaration (Maybe ArtifactStore)
- pipelineDeclaration_artifactStores :: Lens' PipelineDeclaration (Maybe (HashMap Text ArtifactStore))
- pipelineDeclaration_version :: Lens' PipelineDeclaration (Maybe Natural)
- pipelineDeclaration_name :: Lens' PipelineDeclaration Text
- pipelineDeclaration_roleArn :: Lens' PipelineDeclaration Text
- pipelineDeclaration_stages :: Lens' PipelineDeclaration [StageDeclaration]
- pipelineExecution_artifactRevisions :: Lens' PipelineExecution (Maybe [ArtifactRevision])
- pipelineExecution_pipelineExecutionId :: Lens' PipelineExecution (Maybe Text)
- pipelineExecution_pipelineName :: Lens' PipelineExecution (Maybe Text)
- pipelineExecution_pipelineVersion :: Lens' PipelineExecution (Maybe Natural)
- pipelineExecution_status :: Lens' PipelineExecution (Maybe PipelineExecutionStatus)
- pipelineExecution_statusSummary :: Lens' PipelineExecution (Maybe Text)
- pipelineExecutionSummary_lastUpdateTime :: Lens' PipelineExecutionSummary (Maybe UTCTime)
- pipelineExecutionSummary_pipelineExecutionId :: Lens' PipelineExecutionSummary (Maybe Text)
- pipelineExecutionSummary_sourceRevisions :: Lens' PipelineExecutionSummary (Maybe [SourceRevision])
- pipelineExecutionSummary_startTime :: Lens' PipelineExecutionSummary (Maybe UTCTime)
- pipelineExecutionSummary_status :: Lens' PipelineExecutionSummary (Maybe PipelineExecutionStatus)
- pipelineExecutionSummary_stopTrigger :: Lens' PipelineExecutionSummary (Maybe StopExecutionTrigger)
- pipelineExecutionSummary_trigger :: Lens' PipelineExecutionSummary (Maybe ExecutionTrigger)
- pipelineMetadata_created :: Lens' PipelineMetadata (Maybe UTCTime)
- pipelineMetadata_pipelineArn :: Lens' PipelineMetadata (Maybe Text)
- pipelineMetadata_updated :: Lens' PipelineMetadata (Maybe UTCTime)
- pipelineSummary_created :: Lens' PipelineSummary (Maybe UTCTime)
- pipelineSummary_name :: Lens' PipelineSummary (Maybe Text)
- pipelineSummary_updated :: Lens' PipelineSummary (Maybe UTCTime)
- pipelineSummary_version :: Lens' PipelineSummary (Maybe Natural)
- s3ArtifactLocation_bucketName :: Lens' S3ArtifactLocation Text
- s3ArtifactLocation_objectKey :: Lens' S3ArtifactLocation Text
- s3Location_bucket :: Lens' S3Location (Maybe Text)
- s3Location_key :: Lens' S3Location (Maybe Text)
- sourceRevision_revisionId :: Lens' SourceRevision (Maybe Text)
- sourceRevision_revisionSummary :: Lens' SourceRevision (Maybe Text)
- sourceRevision_revisionUrl :: Lens' SourceRevision (Maybe Text)
- sourceRevision_actionName :: Lens' SourceRevision Text
- stageContext_name :: Lens' StageContext (Maybe Text)
- stageDeclaration_blockers :: Lens' StageDeclaration (Maybe [BlockerDeclaration])
- stageDeclaration_name :: Lens' StageDeclaration Text
- stageDeclaration_actions :: Lens' StageDeclaration [ActionDeclaration]
- stageExecution_pipelineExecutionId :: Lens' StageExecution Text
- stageExecution_status :: Lens' StageExecution StageExecutionStatus
- stageState_actionStates :: Lens' StageState (Maybe [ActionState])
- stageState_inboundExecution :: Lens' StageState (Maybe StageExecution)
- stageState_inboundTransitionState :: Lens' StageState (Maybe TransitionState)
- stageState_latestExecution :: Lens' StageState (Maybe StageExecution)
- stageState_stageName :: Lens' StageState (Maybe Text)
- stopExecutionTrigger_reason :: Lens' StopExecutionTrigger (Maybe Text)
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- thirdPartyJob_clientId :: Lens' ThirdPartyJob (Maybe Text)
- thirdPartyJob_jobId :: Lens' ThirdPartyJob (Maybe Text)
- thirdPartyJobData_actionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration)
- thirdPartyJobData_actionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId)
- thirdPartyJobData_artifactCredentials :: Lens' ThirdPartyJobData (Maybe AWSSessionCredentials)
- thirdPartyJobData_continuationToken :: Lens' ThirdPartyJobData (Maybe Text)
- thirdPartyJobData_encryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey)
- thirdPartyJobData_inputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact])
- thirdPartyJobData_outputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact])
- thirdPartyJobData_pipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext)
- thirdPartyJobDetails_data :: Lens' ThirdPartyJobDetails (Maybe ThirdPartyJobData)
- thirdPartyJobDetails_id :: Lens' ThirdPartyJobDetails (Maybe Text)
- thirdPartyJobDetails_nonce :: Lens' ThirdPartyJobDetails (Maybe Text)
- transitionState_disabledReason :: Lens' TransitionState (Maybe Text)
- transitionState_enabled :: Lens' TransitionState (Maybe Bool)
- transitionState_lastChangedAt :: Lens' TransitionState (Maybe UTCTime)
- transitionState_lastChangedBy :: Lens' TransitionState (Maybe Text)
- webhookAuthConfiguration_allowedIPRange :: Lens' WebhookAuthConfiguration (Maybe Text)
- webhookAuthConfiguration_secretToken :: Lens' WebhookAuthConfiguration (Maybe Text)
- webhookDefinition_name :: Lens' WebhookDefinition Text
- webhookDefinition_targetPipeline :: Lens' WebhookDefinition Text
- webhookDefinition_targetAction :: Lens' WebhookDefinition Text
- webhookDefinition_filters :: Lens' WebhookDefinition [WebhookFilterRule]
- webhookDefinition_authentication :: Lens' WebhookDefinition WebhookAuthenticationType
- webhookDefinition_authenticationConfiguration :: Lens' WebhookDefinition WebhookAuthConfiguration
- webhookFilterRule_matchEquals :: Lens' WebhookFilterRule (Maybe Text)
- webhookFilterRule_jsonPath :: Lens' WebhookFilterRule Text
Operations
AcknowledgeJob
acknowledgeJob_jobId :: Lens' AcknowledgeJob Text Source #
The unique system-generated ID of the job for which you want to confirm receipt.
acknowledgeJob_nonce :: Lens' AcknowledgeJob Text Source #
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.
acknowledgeJobResponse_status :: Lens' AcknowledgeJobResponse (Maybe JobStatus) Source #
Whether the job worker has received the specified job.
acknowledgeJobResponse_httpStatus :: Lens' AcknowledgeJobResponse Int Source #
The response's http status code.
AcknowledgeThirdPartyJob
acknowledgeThirdPartyJob_jobId :: Lens' AcknowledgeThirdPartyJob Text Source #
The unique system-generated ID of the job.
acknowledgeThirdPartyJob_nonce :: Lens' AcknowledgeThirdPartyJob Text Source #
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.
acknowledgeThirdPartyJob_clientToken :: Lens' AcknowledgeThirdPartyJob Text Source #
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
acknowledgeThirdPartyJobResponse_status :: Lens' AcknowledgeThirdPartyJobResponse (Maybe JobStatus) Source #
The status information for the third party job, if any.
acknowledgeThirdPartyJobResponse_httpStatus :: Lens' AcknowledgeThirdPartyJobResponse Int Source #
The response's http status code.
CreateCustomActionType
createCustomActionType_configurationProperties :: Lens' CreateCustomActionType (Maybe [ActionConfigurationProperty]) Source #
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_settings :: Lens' CreateCustomActionType (Maybe ActionTypeSettings) Source #
URLs that provide users information about this custom action.
createCustomActionType_tags :: Lens' CreateCustomActionType (Maybe [Tag]) Source #
The tags for the custom action.
createCustomActionType_category :: Lens' CreateCustomActionType ActionCategory Source #
The category of the custom action, such as a build action or a test action.
createCustomActionType_provider :: Lens' CreateCustomActionType Text Source #
The provider of the service used in the custom action, such as AWS CodeDeploy.
createCustomActionType_version :: Lens' CreateCustomActionType Text Source #
The version identifier of the custom action.
createCustomActionType_inputArtifactDetails :: Lens' CreateCustomActionType ArtifactDetails Source #
The details of the input artifact for the action, such as its commit ID.
createCustomActionType_outputArtifactDetails :: Lens' CreateCustomActionType ArtifactDetails Source #
The details of the output artifact of the action, such as its commit ID.
createCustomActionTypeResponse_tags :: Lens' CreateCustomActionTypeResponse (Maybe [Tag]) Source #
Specifies the tags applied to the custom action.
createCustomActionTypeResponse_httpStatus :: Lens' CreateCustomActionTypeResponse Int Source #
The response's http status code.
createCustomActionTypeResponse_actionType :: Lens' CreateCustomActionTypeResponse ActionType Source #
Returns information about the details of an action type.
CreatePipeline
createPipeline_tags :: Lens' CreatePipeline (Maybe [Tag]) Source #
The tags for the pipeline.
createPipeline_pipeline :: Lens' CreatePipeline PipelineDeclaration Source #
Represents the structure of actions and stages to be performed in the pipeline.
createPipelineResponse_pipeline :: Lens' CreatePipelineResponse (Maybe PipelineDeclaration) Source #
Represents the structure of actions and stages to be performed in the pipeline.
createPipelineResponse_tags :: Lens' CreatePipelineResponse (Maybe [Tag]) Source #
Specifies the tags applied to the pipeline.
createPipelineResponse_httpStatus :: Lens' CreatePipelineResponse Int Source #
The response's http status code.
DeleteCustomActionType
deleteCustomActionType_category :: Lens' DeleteCustomActionType ActionCategory Source #
The category of the custom action that you want to delete, such as source or deploy.
deleteCustomActionType_provider :: Lens' DeleteCustomActionType Text Source #
The provider of the service used in the custom action, such as AWS CodeDeploy.
deleteCustomActionType_version :: Lens' DeleteCustomActionType Text Source #
The version of the custom action to delete.
DeletePipeline
deletePipeline_name :: Lens' DeletePipeline Text Source #
The name of the pipeline to be deleted.
DeleteWebhook
deleteWebhook_name :: Lens' DeleteWebhook Text Source #
The name of the webhook you want to delete.
deleteWebhookResponse_httpStatus :: Lens' DeleteWebhookResponse Int Source #
The response's http status code.
DeregisterWebhookWithThirdParty
deregisterWebhookWithThirdParty_webhookName :: Lens' DeregisterWebhookWithThirdParty (Maybe Text) Source #
The name of the webhook you want to deregister.
deregisterWebhookWithThirdPartyResponse_httpStatus :: Lens' DeregisterWebhookWithThirdPartyResponse Int Source #
The response's http status code.
DisableStageTransition
disableStageTransition_pipelineName :: Lens' DisableStageTransition Text Source #
The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
disableStageTransition_stageName :: Lens' DisableStageTransition Text Source #
The name of the stage where you want to disable the inbound or outbound transition of artifacts.
disableStageTransition_transitionType :: Lens' DisableStageTransition StageTransitionType Source #
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_reason :: Lens' DisableStageTransition Text Source #
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.
EnableStageTransition
enableStageTransition_pipelineName :: Lens' EnableStageTransition Text Source #
The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
enableStageTransition_stageName :: Lens' EnableStageTransition Text Source #
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).
enableStageTransition_transitionType :: Lens' EnableStageTransition StageTransitionType Source #
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).
GetActionType
getActionType_category :: Lens' GetActionType ActionCategory Source #
Defines what kind of action can be taken in the stage. The following are the valid values:
Source
Build
Test
Deploy
Approval
Invoke
getActionType_owner :: Lens' GetActionType Text Source #
The creator of an action type that was created with any supported
integration model. There are two valid values: AWS
and ThirdParty
.
getActionType_provider :: Lens' GetActionType Text Source #
The provider of the action type being called. The provider name is specified when the action type is created.
getActionType_version :: Lens' GetActionType Text Source #
A string that describes the action type version.
getActionTypeResponse_actionType :: Lens' GetActionTypeResponse (Maybe ActionTypeDeclaration) Source #
The action type information for the requested action type, such as the action type ID.
getActionTypeResponse_httpStatus :: Lens' GetActionTypeResponse Int Source #
The response's http status code.
GetJobDetails
getJobDetails_jobId :: Lens' GetJobDetails Text Source #
The unique system-generated ID for the job.
getJobDetailsResponse_jobDetails :: Lens' GetJobDetailsResponse (Maybe JobDetails) Source #
The details of the job.
If AWSSessionCredentials is used, a long-running job can call
GetJobDetails
again to obtain new credentials.
getJobDetailsResponse_httpStatus :: Lens' GetJobDetailsResponse Int Source #
The response's http status code.
GetPipeline
getPipeline_version :: Lens' GetPipeline (Maybe Natural) Source #
The version number of the pipeline. If you do not specify a version, defaults to the current version.
getPipeline_name :: Lens' GetPipeline Text Source #
The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.
getPipelineResponse_metadata :: Lens' GetPipelineResponse (Maybe PipelineMetadata) Source #
Represents the pipeline metadata information returned as part of the
output of a GetPipeline
action.
getPipelineResponse_pipeline :: Lens' GetPipelineResponse (Maybe PipelineDeclaration) Source #
Represents the structure of actions and stages to be performed in the pipeline.
getPipelineResponse_httpStatus :: Lens' GetPipelineResponse Int Source #
The response's http status code.
GetPipelineExecution
getPipelineExecution_pipelineName :: Lens' GetPipelineExecution Text Source #
The name of the pipeline about which you want to get execution details.
getPipelineExecution_pipelineExecutionId :: Lens' GetPipelineExecution Text Source #
The ID of the pipeline execution about which you want to get execution details.
getPipelineExecutionResponse_pipelineExecution :: Lens' GetPipelineExecutionResponse (Maybe PipelineExecution) Source #
Represents information about the execution of a pipeline.
getPipelineExecutionResponse_httpStatus :: Lens' GetPipelineExecutionResponse Int Source #
The response's http status code.
GetPipelineState
getPipelineState_name :: Lens' GetPipelineState Text Source #
The name of the pipeline about which you want to get information.
getPipelineStateResponse_created :: Lens' GetPipelineStateResponse (Maybe UTCTime) Source #
The date and time the pipeline was created, in timestamp format.
getPipelineStateResponse_pipelineName :: Lens' GetPipelineStateResponse (Maybe Text) Source #
The name of the pipeline for which you want to get the state.
getPipelineStateResponse_pipelineVersion :: Lens' GetPipelineStateResponse (Maybe Natural) Source #
The version number of the pipeline.
A newly created pipeline is always assigned a version number of 1
.
getPipelineStateResponse_stageStates :: Lens' GetPipelineStateResponse (Maybe [StageState]) Source #
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_updated :: Lens' GetPipelineStateResponse (Maybe UTCTime) Source #
The date and time the pipeline was last updated, in timestamp format.
getPipelineStateResponse_httpStatus :: Lens' GetPipelineStateResponse Int Source #
The response's http status code.
GetThirdPartyJobDetails
getThirdPartyJobDetails_jobId :: Lens' GetThirdPartyJobDetails Text Source #
The unique system-generated ID used for identifying the job.
getThirdPartyJobDetails_clientToken :: Lens' GetThirdPartyJobDetails Text Source #
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
getThirdPartyJobDetailsResponse_jobDetails :: Lens' GetThirdPartyJobDetailsResponse (Maybe ThirdPartyJobDetails) Source #
The details of the job, including any protected values defined for the job.
getThirdPartyJobDetailsResponse_httpStatus :: Lens' GetThirdPartyJobDetailsResponse Int Source #
The response's http status code.
ListActionExecutions
listActionExecutions_filter :: Lens' ListActionExecutions (Maybe ActionExecutionFilter) Source #
Input information used to filter action execution history.
listActionExecutions_maxResults :: Lens' ListActionExecutions (Maybe Natural) Source #
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_nextToken :: Lens' ListActionExecutions (Maybe Text) Source #
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_pipelineName :: Lens' ListActionExecutions Text Source #
The name of the pipeline for which you want to list action execution history.
listActionExecutionsResponse_actionExecutionDetails :: Lens' ListActionExecutionsResponse (Maybe [ActionExecutionDetail]) Source #
The details for a list of recent executions, such as action execution ID.
listActionExecutionsResponse_nextToken :: Lens' ListActionExecutionsResponse (Maybe Text) Source #
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.
listActionExecutionsResponse_httpStatus :: Lens' ListActionExecutionsResponse Int Source #
The response's http status code.
ListActionTypes
listActionTypes_actionOwnerFilter :: Lens' ListActionTypes (Maybe ActionOwner) Source #
Filters the list of action types to those created by a specified entity.
listActionTypes_nextToken :: Lens' ListActionTypes (Maybe Text) Source #
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.
listActionTypes_regionFilter :: Lens' ListActionTypes (Maybe Text) Source #
The Region to filter on for the list of action types.
listActionTypesResponse_nextToken :: Lens' ListActionTypesResponse (Maybe Text) Source #
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.
listActionTypesResponse_httpStatus :: Lens' ListActionTypesResponse Int Source #
The response's http status code.
listActionTypesResponse_actionTypes :: Lens' ListActionTypesResponse [ActionType] Source #
Provides details of the action types.
ListPipelineExecutions
listPipelineExecutions_maxResults :: Lens' ListPipelineExecutions (Maybe Natural) Source #
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_nextToken :: Lens' ListPipelineExecutions (Maybe Text) Source #
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_pipelineName :: Lens' ListPipelineExecutions Text Source #
The name of the pipeline for which you want to get execution summary information.
listPipelineExecutionsResponse_nextToken :: Lens' ListPipelineExecutionsResponse (Maybe Text) Source #
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.
listPipelineExecutionsResponse_pipelineExecutionSummaries :: Lens' ListPipelineExecutionsResponse (Maybe [PipelineExecutionSummary]) Source #
A list of executions in the history of a pipeline.
listPipelineExecutionsResponse_httpStatus :: Lens' ListPipelineExecutionsResponse Int Source #
The response's http status code.
ListPipelines
listPipelines_maxResults :: Lens' ListPipelines (Maybe Natural) Source #
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_nextToken :: Lens' ListPipelines (Maybe Text) Source #
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.
listPipelinesResponse_nextToken :: Lens' ListPipelinesResponse (Maybe Text) Source #
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.
listPipelinesResponse_pipelines :: Lens' ListPipelinesResponse (Maybe [PipelineSummary]) Source #
The list of pipelines.
listPipelinesResponse_httpStatus :: Lens' ListPipelinesResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #
The maximum number of results to return in a single call.
listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #
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.
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the resource to get tags for.
listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
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_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
The tags for the resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListWebhooks
listWebhooks_maxResults :: Lens' ListWebhooks (Maybe Natural) Source #
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_nextToken :: Lens' ListWebhooks (Maybe Text) Source #
The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.
listWebhooksResponse_nextToken :: Lens' ListWebhooksResponse (Maybe Text) Source #
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.
listWebhooksResponse_webhooks :: Lens' ListWebhooksResponse (Maybe [ListWebhookItem]) Source #
The JSON detail returned for each webhook in the list output for the ListWebhooks call.
listWebhooksResponse_httpStatus :: Lens' ListWebhooksResponse Int Source #
The response's http status code.
PollForJobs
pollForJobs_maxBatchSize :: Lens' PollForJobs (Maybe Natural) Source #
The maximum number of jobs to return in a poll for jobs call.
pollForJobs_queryParam :: Lens' PollForJobs (Maybe (HashMap Text Text)) Source #
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_actionTypeId :: Lens' PollForJobs ActionTypeId Source #
Represents information about an action type.
pollForJobsResponse_jobs :: Lens' PollForJobsResponse (Maybe [Job]) Source #
Information about the jobs to take action on.
pollForJobsResponse_httpStatus :: Lens' PollForJobsResponse Int Source #
The response's http status code.
PollForThirdPartyJobs
pollForThirdPartyJobs_maxBatchSize :: Lens' PollForThirdPartyJobs (Maybe Natural) Source #
The maximum number of jobs to return in a poll for jobs call.
pollForThirdPartyJobs_actionTypeId :: Lens' PollForThirdPartyJobs ActionTypeId Source #
Represents information about an action type.
pollForThirdPartyJobsResponse_jobs :: Lens' PollForThirdPartyJobsResponse (Maybe [ThirdPartyJob]) Source #
Information about the jobs to take action on.
pollForThirdPartyJobsResponse_httpStatus :: Lens' PollForThirdPartyJobsResponse Int Source #
The response's http status code.
PutActionRevision
putActionRevision_pipelineName :: Lens' PutActionRevision Text Source #
The name of the pipeline that starts processing the revision to the source.
putActionRevision_stageName :: Lens' PutActionRevision Text Source #
The name of the stage that contains the action that acts on the revision.
putActionRevision_actionName :: Lens' PutActionRevision Text Source #
The name of the action that processes the revision.
putActionRevision_actionRevision :: Lens' PutActionRevision ActionRevision Source #
Represents information about the version (or revision) of an action.
putActionRevisionResponse_newRevision :: Lens' PutActionRevisionResponse (Maybe Bool) Source #
Indicates whether the artifact revision was previously used in an execution of the specified pipeline.
putActionRevisionResponse_pipelineExecutionId :: Lens' PutActionRevisionResponse (Maybe Text) Source #
The ID of the current workflow state of the pipeline.
putActionRevisionResponse_httpStatus :: Lens' PutActionRevisionResponse Int Source #
The response's http status code.
PutApprovalResult
putApprovalResult_pipelineName :: Lens' PutApprovalResult Text Source #
The name of the pipeline that contains the action.
putApprovalResult_stageName :: Lens' PutApprovalResult Text Source #
The name of the stage that contains the action.
putApprovalResult_actionName :: Lens' PutApprovalResult Text Source #
The name of the action for which approval is requested.
putApprovalResult_result :: Lens' PutApprovalResult ApprovalResult Source #
Represents information about the result of the approval request.
putApprovalResult_token :: Lens' PutApprovalResult Text Source #
The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.
putApprovalResultResponse_approvedAt :: Lens' PutApprovalResultResponse (Maybe UTCTime) Source #
The timestamp showing when the approval or rejection was submitted.
putApprovalResultResponse_httpStatus :: Lens' PutApprovalResultResponse Int Source #
The response's http status code.
PutJobFailureResult
putJobFailureResult_jobId :: Lens' PutJobFailureResult Text Source #
The unique system-generated ID of the job that failed. This is the same
ID returned from PollForJobs
.
putJobFailureResult_failureDetails :: Lens' PutJobFailureResult FailureDetails Source #
The details about the failure of a job.
PutJobSuccessResult
putJobSuccessResult_continuationToken :: Lens' PutJobSuccessResult (Maybe Text) Source #
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_currentRevision :: Lens' PutJobSuccessResult (Maybe CurrentRevision) Source #
The ID of the current revision of the artifact successfully worked on by the job.
putJobSuccessResult_executionDetails :: Lens' PutJobSuccessResult (Maybe ExecutionDetails) Source #
The execution details of the successful job, such as the actions taken by the job worker.
putJobSuccessResult_outputVariables :: Lens' PutJobSuccessResult (Maybe (HashMap Text Text)) Source #
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_jobId :: Lens' PutJobSuccessResult Text Source #
The unique system-generated ID of the job that succeeded. This is the
same ID returned from PollForJobs
.
PutThirdPartyJobFailureResult
putThirdPartyJobFailureResult_jobId :: Lens' PutThirdPartyJobFailureResult Text Source #
The ID of the job that failed. This is the same ID returned from
PollForThirdPartyJobs
.
putThirdPartyJobFailureResult_clientToken :: Lens' PutThirdPartyJobFailureResult Text Source #
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
putThirdPartyJobFailureResult_failureDetails :: Lens' PutThirdPartyJobFailureResult FailureDetails Source #
Represents information about failure details.
PutThirdPartyJobSuccessResult
putThirdPartyJobSuccessResult_continuationToken :: Lens' PutThirdPartyJobSuccessResult (Maybe Text) Source #
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_currentRevision :: Lens' PutThirdPartyJobSuccessResult (Maybe CurrentRevision) Source #
Represents information about a current revision.
putThirdPartyJobSuccessResult_executionDetails :: Lens' PutThirdPartyJobSuccessResult (Maybe ExecutionDetails) Source #
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
putThirdPartyJobSuccessResult_jobId :: Lens' PutThirdPartyJobSuccessResult Text Source #
The ID of the job that successfully completed. This is the same ID
returned from PollForThirdPartyJobs
.
putThirdPartyJobSuccessResult_clientToken :: Lens' PutThirdPartyJobSuccessResult Text Source #
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
PutWebhook
putWebhook_tags :: Lens' PutWebhook (Maybe [Tag]) Source #
The tags for the webhook.
putWebhook_webhook :: Lens' PutWebhook WebhookDefinition Source #
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.
putWebhookResponse_webhook :: Lens' PutWebhookResponse (Maybe ListWebhookItem) Source #
The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
putWebhookResponse_httpStatus :: Lens' PutWebhookResponse Int Source #
The response's http status code.
RegisterWebhookWithThirdParty
registerWebhookWithThirdParty_webhookName :: Lens' RegisterWebhookWithThirdParty (Maybe Text) Source #
The name of an existing webhook created with PutWebhook to register with a supported third party.
registerWebhookWithThirdPartyResponse_httpStatus :: Lens' RegisterWebhookWithThirdPartyResponse Int Source #
The response's http status code.
RetryStageExecution
retryStageExecution_pipelineName :: Lens' RetryStageExecution Text Source #
The name of the pipeline that contains the failed stage.
retryStageExecution_stageName :: Lens' RetryStageExecution Text Source #
The name of the failed stage to be retried.
retryStageExecution_pipelineExecutionId :: Lens' RetryStageExecution Text Source #
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
retryStageExecution_retryMode :: Lens' RetryStageExecution StageRetryMode Source #
The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.
retryStageExecutionResponse_pipelineExecutionId :: Lens' RetryStageExecutionResponse (Maybe Text) Source #
The ID of the current workflow execution in the failed stage.
retryStageExecutionResponse_httpStatus :: Lens' RetryStageExecutionResponse Int Source #
The response's http status code.
StartPipelineExecution
startPipelineExecution_clientRequestToken :: Lens' StartPipelineExecution (Maybe Text) Source #
The system-generated unique ID used to identify a unique execution request.
startPipelineExecution_name :: Lens' StartPipelineExecution Text Source #
The name of the pipeline to start.
startPipelineExecutionResponse_pipelineExecutionId :: Lens' StartPipelineExecutionResponse (Maybe Text) Source #
The unique system-generated ID of the pipeline execution that was started.
startPipelineExecutionResponse_httpStatus :: Lens' StartPipelineExecutionResponse Int Source #
The response's http status code.
StopPipelineExecution
stopPipelineExecution_abandon :: Lens' StopPipelineExecution (Maybe Bool) Source #
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_reason :: Lens' StopPipelineExecution (Maybe Text) Source #
Use this option to enter comments, such as the reason the pipeline was stopped.
stopPipelineExecution_pipelineName :: Lens' StopPipelineExecution Text Source #
The name of the pipeline to stop.
stopPipelineExecution_pipelineExecutionId :: Lens' StopPipelineExecution Text Source #
The ID of the pipeline execution to be stopped in the current stage. Use
the GetPipelineState
action to retrieve the current
pipelineExecutionId.
stopPipelineExecutionResponse_pipelineExecutionId :: Lens' StopPipelineExecutionResponse (Maybe Text) Source #
The unique system-generated ID of the pipeline execution that was stopped.
stopPipelineExecutionResponse_httpStatus :: Lens' StopPipelineExecutionResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the resource you want to add tags to.
tagResource_tags :: Lens' TagResource [Tag] Source #
The tags you want to modify or add to the resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the resource to remove tags from.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The list of keys for the tags to be removed from the resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateActionType
updateActionType_actionType :: Lens' UpdateActionType ActionTypeDeclaration Source #
The action type definition for the action type to be updated.
UpdatePipeline
updatePipeline_pipeline :: Lens' UpdatePipeline PipelineDeclaration Source #
The name of the pipeline to be updated.
updatePipelineResponse_pipeline :: Lens' UpdatePipelineResponse (Maybe PipelineDeclaration) Source #
The structure of the updated pipeline.
updatePipelineResponse_httpStatus :: Lens' UpdatePipelineResponse Int Source #
The response's http status code.
Types
AWSSessionCredentials
aWSSessionCredentials_accessKeyId :: Lens' AWSSessionCredentials Text Source #
The access key for the session.
aWSSessionCredentials_secretAccessKey :: Lens' AWSSessionCredentials Text Source #
The secret access key for the session.
aWSSessionCredentials_sessionToken :: Lens' AWSSessionCredentials Text Source #
The token for the session.
ActionConfiguration
actionConfiguration_configuration :: Lens' ActionConfiguration (Maybe (HashMap Text Text)) Source #
The configuration data for the action.
ActionConfigurationProperty
actionConfigurationProperty_description :: Lens' ActionConfigurationProperty (Maybe Text) Source #
The description of the action configuration property that is displayed to users.
actionConfigurationProperty_queryable :: Lens' ActionConfigurationProperty (Maybe Bool) Source #
Indicates that the property is used with PollForJobs
. When creating a
custom action, an action can have up to one queryable property. If it
has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
actionConfigurationProperty_type :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType) Source #
The type of the configuration property.
actionConfigurationProperty_name :: Lens' ActionConfigurationProperty Text Source #
The name of the action configuration property.
actionConfigurationProperty_required :: Lens' ActionConfigurationProperty Bool Source #
Whether the configuration property is a required value.
actionConfigurationProperty_key :: Lens' ActionConfigurationProperty Bool Source #
Whether the configuration property is a key.
actionConfigurationProperty_secret :: Lens' ActionConfigurationProperty Bool Source #
Whether the configuration property is secret. Secrets are hidden from
all calls except for GetJobDetails
, GetThirdPartyJobDetails
,
PollForJobs
, and PollForThirdPartyJobs
.
When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
ActionContext
actionContext_actionExecutionId :: Lens' ActionContext (Maybe Text) Source #
The system-generated unique ID that corresponds to an action's execution.
actionContext_name :: Lens' ActionContext (Maybe Text) Source #
The name of the action in the context of a job.
ActionDeclaration
actionDeclaration_configuration :: Lens' ActionDeclaration (Maybe (HashMap Text Text)) Source #
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
actionDeclaration_inputArtifacts :: Lens' ActionDeclaration (Maybe [InputArtifact]) Source #
The name or ID of the artifact consumed by the action, such as a test or build artifact.
actionDeclaration_namespace :: Lens' ActionDeclaration (Maybe Text) Source #
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
actionDeclaration_outputArtifacts :: Lens' ActionDeclaration (Maybe [OutputArtifact]) Source #
The name or ID of the result of the action declaration, such as a test or build artifact.
actionDeclaration_region :: Lens' ActionDeclaration (Maybe Text) Source #
The action declaration's AWS Region, such as us-east-1.
actionDeclaration_roleArn :: Lens' ActionDeclaration (Maybe Text) Source #
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
actionDeclaration_runOrder :: Lens' ActionDeclaration (Maybe Natural) Source #
The order in which actions are run.
actionDeclaration_name :: Lens' ActionDeclaration Text Source #
The action declaration's name.
actionDeclaration_actionTypeId :: Lens' ActionDeclaration ActionTypeId Source #
Specifies the action type and the provider of the action.
ActionExecution
actionExecution_actionExecutionId :: Lens' ActionExecution (Maybe Text) Source #
ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage.
For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.
actionExecution_errorDetails :: Lens' ActionExecution (Maybe ErrorDetails) Source #
The details of an error returned by a URL external to AWS.
actionExecution_externalExecutionId :: Lens' ActionExecution (Maybe Text) Source #
The external ID of the run of the action.
actionExecution_externalExecutionUrl :: Lens' ActionExecution (Maybe Text) Source #
The URL of a resource external to AWS that is used when running the action (for example, an external repository URL).
actionExecution_lastStatusChange :: Lens' ActionExecution (Maybe UTCTime) Source #
The last status change of the action.
actionExecution_lastUpdatedBy :: Lens' ActionExecution (Maybe Text) Source #
The ARN of the user who last changed the pipeline.
actionExecution_percentComplete :: Lens' ActionExecution (Maybe Natural) Source #
A percentage of completeness of the action as it runs.
actionExecution_status :: Lens' ActionExecution (Maybe ActionExecutionStatus) Source #
The status of the action, or for a completed action, the last status of the action.
actionExecution_summary :: Lens' ActionExecution (Maybe Text) Source #
A summary of the run of the action.
actionExecution_token :: Lens' ActionExecution (Maybe Text) Source #
The system-generated token used to identify a unique approval request.
The token for each open approval request can be obtained using the
GetPipelineState
command. It is used to validate that the approval
request corresponding to this token is still valid.
ActionExecutionDetail
actionExecutionDetail_actionExecutionId :: Lens' ActionExecutionDetail (Maybe Text) Source #
The action execution ID.
actionExecutionDetail_actionName :: Lens' ActionExecutionDetail (Maybe Text) Source #
The name of the action.
actionExecutionDetail_input :: Lens' ActionExecutionDetail (Maybe ActionExecutionInput) Source #
Input details for the action execution, such as role ARN, Region, and input artifacts.
actionExecutionDetail_lastUpdateTime :: Lens' ActionExecutionDetail (Maybe UTCTime) Source #
The last update time of the action execution.
actionExecutionDetail_output :: Lens' ActionExecutionDetail (Maybe ActionExecutionOutput) Source #
Output details for the action execution, such as the action execution result.
actionExecutionDetail_pipelineExecutionId :: Lens' ActionExecutionDetail (Maybe Text) Source #
The pipeline execution ID for the action execution.
actionExecutionDetail_pipelineVersion :: Lens' ActionExecutionDetail (Maybe Natural) Source #
The version of the pipeline where the action was run.
actionExecutionDetail_stageName :: Lens' ActionExecutionDetail (Maybe Text) Source #
The name of the stage that contains the action.
actionExecutionDetail_startTime :: Lens' ActionExecutionDetail (Maybe UTCTime) Source #
The start time of the action execution.
actionExecutionDetail_status :: Lens' ActionExecutionDetail (Maybe ActionExecutionStatus) Source #
The status of the action execution. Status categories are InProgress
,
Succeeded
, and Failed
.
ActionExecutionFilter
actionExecutionFilter_pipelineExecutionId :: Lens' ActionExecutionFilter (Maybe Text) Source #
The pipeline execution ID used to filter action execution history.
ActionExecutionInput
actionExecutionInput_actionTypeId :: Lens' ActionExecutionInput (Maybe ActionTypeId) Source #
Undocumented member.
actionExecutionInput_configuration :: Lens' ActionExecutionInput (Maybe (HashMap Text Text)) Source #
Configuration data for an action execution.
actionExecutionInput_inputArtifacts :: Lens' ActionExecutionInput (Maybe [ArtifactDetail]) Source #
Details of input artifacts of the action that correspond to the action execution.
actionExecutionInput_namespace :: Lens' ActionExecutionInput (Maybe Text) Source #
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
actionExecutionInput_region :: Lens' ActionExecutionInput (Maybe Text) Source #
The AWS Region for the action, such as us-east-1.
actionExecutionInput_resolvedConfiguration :: Lens' ActionExecutionInput (Maybe (HashMap Text Text)) Source #
Configuration data for an action execution with all variable references replaced with their real values for the execution.
actionExecutionInput_roleArn :: Lens' ActionExecutionInput (Maybe Text) Source #
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
ActionExecutionOutput
actionExecutionOutput_executionResult :: Lens' ActionExecutionOutput (Maybe ActionExecutionResult) Source #
Execution result information listed in the output details for an action execution.
actionExecutionOutput_outputArtifacts :: Lens' ActionExecutionOutput (Maybe [ArtifactDetail]) Source #
Details of output artifacts of the action that correspond to the action execution.
actionExecutionOutput_outputVariables :: Lens' ActionExecutionOutput (Maybe (HashMap Text Text)) Source #
The outputVariables field shows the key-value pairs that were output as part of that execution.
ActionExecutionResult
actionExecutionResult_externalExecutionId :: Lens' ActionExecutionResult (Maybe Text) Source #
The action provider's external ID for the action execution.
actionExecutionResult_externalExecutionSummary :: Lens' ActionExecutionResult (Maybe Text) Source #
The action provider's summary for the action execution.
actionExecutionResult_externalExecutionUrl :: Lens' ActionExecutionResult (Maybe Text) Source #
The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
ActionRevision
actionRevision_revisionId :: Lens' ActionRevision Text Source #
The system-generated unique ID that identifies the revision number of the action.
actionRevision_revisionChangeId :: Lens' ActionRevision Text Source #
The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
actionRevision_created :: Lens' ActionRevision UTCTime Source #
The date and time when the most recent version of the action was created, in timestamp format.
ActionState
actionState_actionName :: Lens' ActionState (Maybe Text) Source #
The name of the action.
actionState_currentRevision :: Lens' ActionState (Maybe ActionRevision) Source #
Represents information about the version (or revision) of an action.
actionState_entityUrl :: Lens' ActionState (Maybe Text) Source #
A URL link for more information about the state of the action, such as a deployment group details page.
actionState_latestExecution :: Lens' ActionState (Maybe ActionExecution) Source #
Represents information about the run of an action.
actionState_revisionUrl :: Lens' ActionState (Maybe Text) Source #
A URL link for more information about the revision, such as a commit details page.
ActionType
actionType_actionConfigurationProperties :: Lens' ActionType (Maybe [ActionConfigurationProperty]) Source #
The configuration properties for the action type.
actionType_settings :: Lens' ActionType (Maybe ActionTypeSettings) Source #
The settings for the action type.
actionType_id :: Lens' ActionType ActionTypeId Source #
Represents information about an action type.
actionType_inputArtifactDetails :: Lens' ActionType ArtifactDetails Source #
The details of the input artifact for the action, such as its commit ID.
actionType_outputArtifactDetails :: Lens' ActionType ArtifactDetails Source #
The details of the output artifact of the action, such as its commit ID.
ActionTypeArtifactDetails
actionTypeArtifactDetails_minimumCount :: Lens' ActionTypeArtifactDetails Natural Source #
The minimum number of artifacts that can be used with the action type.
For example, you should specify a minimum and maximum of zero input
artifacts for an action type with a category of source
.
actionTypeArtifactDetails_maximumCount :: Lens' ActionTypeArtifactDetails Natural Source #
The maximum number of artifacts that can be used with the actiontype.
For example, you should specify a minimum and maximum of zero input
artifacts for an action type with a category of source
.
ActionTypeDeclaration
actionTypeDeclaration_description :: Lens' ActionTypeDeclaration (Maybe Text) Source #
The description for the action type to be updated.
actionTypeDeclaration_permissions :: Lens' ActionTypeDeclaration (Maybe ActionTypePermissions) Source #
Details identifying the accounts with permissions to use the action type.
actionTypeDeclaration_properties :: Lens' ActionTypeDeclaration (Maybe [ActionTypeProperty]) Source #
The properties of the action type to be updated.
actionTypeDeclaration_urls :: Lens' ActionTypeDeclaration (Maybe ActionTypeUrls) Source #
The links associated with the action type to be updated.
actionTypeDeclaration_executor :: Lens' ActionTypeDeclaration ActionTypeExecutor Source #
Information about the executor for an action type that was created with any supported integration model.
actionTypeDeclaration_id :: Lens' ActionTypeDeclaration ActionTypeIdentifier Source #
The action category, owner, provider, and version of the action type to be updated.
actionTypeDeclaration_inputArtifactDetails :: Lens' ActionTypeDeclaration ActionTypeArtifactDetails Source #
Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.
actionTypeDeclaration_outputArtifactDetails :: Lens' ActionTypeDeclaration ActionTypeArtifactDetails Source #
Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.
ActionTypeExecutor
actionTypeExecutor_jobTimeout :: Lens' ActionTypeExecutor (Maybe Natural) Source #
The timeout in seconds for the job. An action execution can have multiple jobs. This is the timeout for a single job, not the entire action execution.
actionTypeExecutor_policyStatementsTemplate :: Lens' ActionTypeExecutor (Maybe Text) Source #
The policy statement that specifies the permissions in the CodePipeline customer’s account that are needed to successfully run an action.
To grant permission to another account, specify the account ID as the
Principal, a domain-style identifier defined by the service, for example
codepipeline.amazonaws.com
.
The size of the passed JSON policy document cannot exceed 2048 characters.
actionTypeExecutor_configuration :: Lens' ActionTypeExecutor ExecutorConfiguration Source #
The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.
actionTypeExecutor_type :: Lens' ActionTypeExecutor ExecutorType Source #
The integration model used to create and update the action type,
Lambda
or JobWorker
.
ActionTypeId
actionTypeId_category :: Lens' ActionTypeId ActionCategory Source #
A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.
- Source
- Build
- Test
- Deploy
- Invoke
- Approval
actionTypeId_owner :: Lens' ActionTypeId ActionOwner Source #
The creator of the action being called. There are three valid values for
the Owner
field in the action category section within your pipeline
structure: AWS
, ThirdParty
, and Custom
. For more information, see
Valid Action Types and Providers in CodePipeline.
actionTypeId_provider :: Lens' ActionTypeId Text Source #
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
actionTypeId_version :: Lens' ActionTypeId Text Source #
A string that describes the action version.
ActionTypeIdentifier
actionTypeIdentifier_category :: Lens' ActionTypeIdentifier ActionCategory Source #
Defines what kind of action can be taken in the stage, one of the following:
Source
Build
Test
Deploy
Approval
Invoke
actionTypeIdentifier_owner :: Lens' ActionTypeIdentifier Text Source #
The creator of the action type being called: AWS
or ThirdParty
.
actionTypeIdentifier_provider :: Lens' ActionTypeIdentifier Text Source #
The provider of the action type being called. The provider name is supplied when the action type is created.
actionTypeIdentifier_version :: Lens' ActionTypeIdentifier Text Source #
A string that describes the action type version.
ActionTypePermissions
actionTypePermissions_allowedAccounts :: Lens' ActionTypePermissions (NonEmpty Text) Source #
A list of AWS account IDs with access to use the action type in their pipelines.
ActionTypeProperty
actionTypeProperty_description :: Lens' ActionTypeProperty (Maybe Text) Source #
The description of the property that is displayed to users.
actionTypeProperty_queryable :: Lens' ActionTypeProperty (Maybe Bool) Source #
Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.
actionTypeProperty_name :: Lens' ActionTypeProperty Text Source #
The property name that is displayed to users.
actionTypeProperty_optional :: Lens' ActionTypeProperty Bool Source #
Whether the configuration property is an optional value.
actionTypeProperty_key :: Lens' ActionTypeProperty Bool Source #
Whether the configuration property is a key.
actionTypeProperty_noEcho :: Lens' ActionTypeProperty Bool Source #
Whether to omit the field value entered by the customer in the log. If
true
, the value is not saved in CloudTrail logs for the action
execution.
ActionTypeSettings
actionTypeSettings_entityUrlTemplate :: Lens' ActionTypeSettings (Maybe Text) Source #
The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
actionTypeSettings_executionUrlTemplate :: Lens' ActionTypeSettings (Maybe Text) Source #
The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
actionTypeSettings_revisionUrlTemplate :: Lens' ActionTypeSettings (Maybe Text) Source #
The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
actionTypeSettings_thirdPartyConfigurationUrl :: Lens' ActionTypeSettings (Maybe Text) Source #
The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
ActionTypeUrls
actionTypeUrls_configurationUrl :: Lens' ActionTypeUrls (Maybe Text) Source #
The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.
actionTypeUrls_entityUrlTemplate :: Lens' ActionTypeUrls (Maybe Text) Source #
The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as a status page. This link is provided as part of the action display in the pipeline.
actionTypeUrls_executionUrlTemplate :: Lens' ActionTypeUrls (Maybe Text) Source #
The link to an execution page for the action type in progress. For example, for a CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.
actionTypeUrls_revisionUrlTemplate :: Lens' ActionTypeUrls (Maybe Text) Source #
The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
ApprovalResult
approvalResult_summary :: Lens' ApprovalResult Text Source #
The summary of the current status of the approval request.
approvalResult_status :: Lens' ApprovalResult ApprovalStatus Source #
The response submitted by a reviewer assigned to an approval action request.
Artifact
artifact_location :: Lens' Artifact (Maybe ArtifactLocation) Source #
The location of an artifact.
artifact_revision :: Lens' Artifact (Maybe Text) Source #
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
ArtifactDetail
artifactDetail_name :: Lens' ArtifactDetail (Maybe Text) Source #
The artifact object name for the action execution.
artifactDetail_s3location :: Lens' ArtifactDetail (Maybe S3Location) Source #
The Amazon S3 artifact location for the action execution.
ArtifactDetails
artifactDetails_minimumCount :: Lens' ArtifactDetails Natural Source #
The minimum number of artifacts allowed for the action type.
artifactDetails_maximumCount :: Lens' ArtifactDetails Natural Source #
The maximum number of artifacts allowed for the action type.
ArtifactLocation
artifactLocation_s3Location :: Lens' ArtifactLocation (Maybe S3ArtifactLocation) Source #
The S3 bucket that contains the artifact.
artifactLocation_type :: Lens' ArtifactLocation (Maybe ArtifactLocationType) Source #
The type of artifact in the location.
ArtifactRevision
artifactRevision_created :: Lens' ArtifactRevision (Maybe UTCTime) Source #
The date and time when the most recent revision of the artifact was created, in timestamp format.
artifactRevision_name :: Lens' ArtifactRevision (Maybe Text) Source #
The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
artifactRevision_revisionChangeIdentifier :: Lens' ArtifactRevision (Maybe Text) Source #
An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
artifactRevision_revisionId :: Lens' ArtifactRevision (Maybe Text) Source #
The revision ID of the artifact.
artifactRevision_revisionSummary :: Lens' ArtifactRevision (Maybe Text) Source #
Summary information about the most recent revision of the artifact. For
GitHub and AWS CodeCommit repositories, the commit message. For Amazon
S3 buckets or actions, the user-provided content of a
codepipeline-artifact-revision-summary
key specified in the object
metadata.
artifactRevision_revisionUrl :: Lens' ArtifactRevision (Maybe Text) Source #
The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
ArtifactStore
artifactStore_encryptionKey :: Lens' ArtifactStore (Maybe EncryptionKey) Source #
The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
artifactStore_type :: Lens' ArtifactStore ArtifactStoreType Source #
The type of the artifact store, such as S3.
artifactStore_location :: Lens' ArtifactStore Text Source #
The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
BlockerDeclaration
blockerDeclaration_name :: Lens' BlockerDeclaration Text Source #
Reserved for future use.
blockerDeclaration_type :: Lens' BlockerDeclaration BlockerType Source #
Reserved for future use.
CurrentRevision
currentRevision_created :: Lens' CurrentRevision (Maybe UTCTime) Source #
The date and time when the most recent revision of the artifact was created, in timestamp format.
currentRevision_revisionSummary :: Lens' CurrentRevision (Maybe Text) Source #
The summary of the most recent revision of the artifact.
currentRevision_revision :: Lens' CurrentRevision Text Source #
The revision ID of the current version of an artifact.
currentRevision_changeIdentifier :: Lens' CurrentRevision Text Source #
The change identifier for the current revision.
EncryptionKey
encryptionKey_id :: Lens' EncryptionKey Text Source #
The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.
Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
encryptionKey_type :: Lens' EncryptionKey EncryptionKeyType Source #
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
ErrorDetails
errorDetails_code :: Lens' ErrorDetails (Maybe Text) Source #
The system ID or number code of the error.
errorDetails_message :: Lens' ErrorDetails (Maybe Text) Source #
The text of the error message.
ExecutionDetails
executionDetails_externalExecutionId :: Lens' ExecutionDetails (Maybe Text) Source #
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
executionDetails_percentComplete :: Lens' ExecutionDetails (Maybe Natural) Source #
The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
executionDetails_summary :: Lens' ExecutionDetails (Maybe Text) Source #
The summary of the current status of the actions.
ExecutionTrigger
executionTrigger_triggerDetail :: Lens' ExecutionTrigger (Maybe Text) Source #
Detail related to the event that started a pipeline execution, such as
the webhook ARN of the webhook that triggered the pipeline execution or
the user ARN for a user-initiated start-pipeline-execution
CLI
command.
executionTrigger_triggerType :: Lens' ExecutionTrigger (Maybe TriggerType) Source #
The type of change-detection method, command, or user interaction that started a pipeline execution.
ExecutorConfiguration
executorConfiguration_jobWorkerExecutorConfiguration :: Lens' ExecutorConfiguration (Maybe JobWorkerExecutorConfiguration) Source #
Details about the JobWorker
executor of the action type.
executorConfiguration_lambdaExecutorConfiguration :: Lens' ExecutorConfiguration (Maybe LambdaExecutorConfiguration) Source #
Details about the Lambda
executor of the action type.
FailureDetails
failureDetails_externalExecutionId :: Lens' FailureDetails (Maybe Text) Source #
The external ID of the run of the action that failed.
failureDetails_type :: Lens' FailureDetails FailureType Source #
The type of the failure.
failureDetails_message :: Lens' FailureDetails Text Source #
The message about the failure.
InputArtifact
inputArtifact_name :: Lens' InputArtifact Text Source #
The name of the artifact to be worked on (for example, "My App").
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Job
job_accountId :: Lens' Job (Maybe Text) Source #
The ID of the AWS account to use when performing the job.
job_nonce :: Lens' Job (Maybe Text) Source #
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.
JobData
jobData_actionConfiguration :: Lens' JobData (Maybe ActionConfiguration) Source #
Represents information about an action configuration.
jobData_actionTypeId :: Lens' JobData (Maybe ActionTypeId) Source #
Represents information about an action type.
jobData_artifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials) Source #
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in AWS CodePipeline.
jobData_continuationToken :: Lens' JobData (Maybe Text) Source #
A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.
jobData_encryptionKey :: Lens' JobData (Maybe EncryptionKey) Source #
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
jobData_inputArtifacts :: Lens' JobData (Maybe [Artifact]) Source #
The artifact supplied to the job.
jobData_pipelineContext :: Lens' JobData (Maybe PipelineContext) Source #
Represents information about a pipeline to a job worker.
Includes pipelineArn
and pipelineExecutionId
for custom jobs.
JobDetails
jobDetails_accountId :: Lens' JobDetails (Maybe Text) Source #
The AWS account ID associated with the job.
jobDetails_data :: Lens' JobDetails (Maybe JobData) Source #
Represents other information about a job required for a job worker to complete the job.
jobDetails_id :: Lens' JobDetails (Maybe Text) Source #
The unique system-generated ID of the job.
JobWorkerExecutorConfiguration
jobWorkerExecutorConfiguration_pollingAccounts :: Lens' JobWorkerExecutorConfiguration (Maybe (NonEmpty Text)) Source #
The accounts in which the job worker is configured and might poll for jobs as part of the action execution.
jobWorkerExecutorConfiguration_pollingServicePrincipals :: Lens' JobWorkerExecutorConfiguration (Maybe (NonEmpty Text)) Source #
The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.
LambdaExecutorConfiguration
lambdaExecutorConfiguration_lambdaFunctionArn :: Lens' LambdaExecutorConfiguration Text Source #
The ARN of the Lambda function used by the action engine.
ListWebhookItem
listWebhookItem_arn :: Lens' ListWebhookItem (Maybe Text) Source #
The Amazon Resource Name (ARN) of the webhook.
listWebhookItem_errorCode :: Lens' ListWebhookItem (Maybe Text) Source #
The number code of the error.
listWebhookItem_errorMessage :: Lens' ListWebhookItem (Maybe Text) Source #
The text of the error message about the webhook.
listWebhookItem_lastTriggered :: Lens' ListWebhookItem (Maybe UTCTime) Source #
The date and time a webhook was last successfully triggered, in timestamp format.
listWebhookItem_tags :: Lens' ListWebhookItem (Maybe [Tag]) Source #
Specifies the tags applied to the webhook.
listWebhookItem_definition :: Lens' ListWebhookItem WebhookDefinition Source #
The detail returned for each webhook, such as the webhook authentication type and filter rules.
listWebhookItem_url :: Lens' ListWebhookItem Text Source #
A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
OutputArtifact
outputArtifact_name :: Lens' OutputArtifact Text Source #
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
PipelineContext
pipelineContext_action :: Lens' PipelineContext (Maybe ActionContext) Source #
The context of an action to a job worker in the stage of a pipeline.
pipelineContext_pipelineArn :: Lens' PipelineContext (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pipeline.
pipelineContext_pipelineExecutionId :: Lens' PipelineContext (Maybe Text) Source #
The execution ID of the pipeline.
pipelineContext_pipelineName :: Lens' PipelineContext (Maybe Text) Source #
The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
pipelineContext_stage :: Lens' PipelineContext (Maybe StageContext) Source #
The stage of the pipeline.
PipelineDeclaration
pipelineDeclaration_artifactStore :: Lens' PipelineDeclaration (Maybe ArtifactStore) Source #
Represents information about the S3 bucket where artifacts are stored for the pipeline.
You must include either artifactStore
or artifactStores
in your
pipeline, but you cannot use both. If you create a cross-region action
in your pipeline, you must use artifactStores
.
pipelineDeclaration_artifactStores :: Lens' PipelineDeclaration (Maybe (HashMap Text ArtifactStore)) Source #
A mapping of artifactStore
objects and their corresponding AWS
Regions. There must be an artifact store for the pipeline Region and for
each cross-region action in the pipeline.
You must include either artifactStore
or artifactStores
in your
pipeline, but you cannot use both. If you create a cross-region action
in your pipeline, you must use artifactStores
.
pipelineDeclaration_version :: Lens' PipelineDeclaration (Maybe Natural) Source #
The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
pipelineDeclaration_name :: Lens' PipelineDeclaration Text Source #
The name of the pipeline.
pipelineDeclaration_roleArn :: Lens' PipelineDeclaration Text Source #
The Amazon Resource Name (ARN) for AWS CodePipeline to use to either
perform actions with no actionRoleArn
, or to use to assume roles for
actions with an actionRoleArn
.
pipelineDeclaration_stages :: Lens' PipelineDeclaration [StageDeclaration] Source #
The stage in which to perform the action.
PipelineExecution
pipelineExecution_artifactRevisions :: Lens' PipelineExecution (Maybe [ArtifactRevision]) Source #
A list of ArtifactRevision
objects included in a pipeline execution.
pipelineExecution_pipelineExecutionId :: Lens' PipelineExecution (Maybe Text) Source #
The ID of the pipeline execution.
pipelineExecution_pipelineName :: Lens' PipelineExecution (Maybe Text) Source #
The name of the pipeline with the specified pipeline execution.
pipelineExecution_pipelineVersion :: Lens' PipelineExecution (Maybe Natural) Source #
The version number of the pipeline with the specified pipeline execution.
pipelineExecution_status :: Lens' PipelineExecution (Maybe PipelineExecutionStatus) Source #
The status of the pipeline execution.
- Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
- InProgress: The pipeline execution is currently running.
- Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
- Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
- Succeeded: The pipeline execution was completed successfully.
- Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
- Failed: The pipeline execution was not completed successfully.
pipelineExecution_statusSummary :: Lens' PipelineExecution (Maybe Text) Source #
A summary that contains a description of the pipeline execution status.
PipelineExecutionSummary
pipelineExecutionSummary_lastUpdateTime :: Lens' PipelineExecutionSummary (Maybe UTCTime) Source #
The date and time of the last change to the pipeline execution, in timestamp format.
pipelineExecutionSummary_pipelineExecutionId :: Lens' PipelineExecutionSummary (Maybe Text) Source #
The ID of the pipeline execution.
pipelineExecutionSummary_sourceRevisions :: Lens' PipelineExecutionSummary (Maybe [SourceRevision]) Source #
A list of the source artifact revisions that initiated a pipeline execution.
pipelineExecutionSummary_startTime :: Lens' PipelineExecutionSummary (Maybe UTCTime) Source #
The date and time when the pipeline execution began, in timestamp format.
pipelineExecutionSummary_status :: Lens' PipelineExecutionSummary (Maybe PipelineExecutionStatus) Source #
The status of the pipeline execution.
- InProgress: The pipeline execution is currently running.
- Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
- Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
- Succeeded: The pipeline execution was completed successfully.
- Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
- Failed: The pipeline execution was not completed successfully.
pipelineExecutionSummary_stopTrigger :: Lens' PipelineExecutionSummary (Maybe StopExecutionTrigger) Source #
The interaction that stopped a pipeline execution.
pipelineExecutionSummary_trigger :: Lens' PipelineExecutionSummary (Maybe ExecutionTrigger) Source #
The interaction or event that started a pipeline execution, such as
automated change detection or a StartPipelineExecution
API call.
PipelineMetadata
pipelineMetadata_created :: Lens' PipelineMetadata (Maybe UTCTime) Source #
The date and time the pipeline was created, in timestamp format.
pipelineMetadata_pipelineArn :: Lens' PipelineMetadata (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pipeline.
pipelineMetadata_updated :: Lens' PipelineMetadata (Maybe UTCTime) Source #
The date and time the pipeline was last updated, in timestamp format.
PipelineSummary
pipelineSummary_created :: Lens' PipelineSummary (Maybe UTCTime) Source #
The date and time the pipeline was created, in timestamp format.
pipelineSummary_name :: Lens' PipelineSummary (Maybe Text) Source #
The name of the pipeline.
pipelineSummary_updated :: Lens' PipelineSummary (Maybe UTCTime) Source #
The date and time of the last update to the pipeline, in timestamp format.
pipelineSummary_version :: Lens' PipelineSummary (Maybe Natural) Source #
The version number of the pipeline.
S3ArtifactLocation
s3ArtifactLocation_bucketName :: Lens' S3ArtifactLocation Text Source #
The name of the S3 bucket.
s3ArtifactLocation_objectKey :: Lens' S3ArtifactLocation Text Source #
The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
S3Location
s3Location_bucket :: Lens' S3Location (Maybe Text) Source #
The Amazon S3 artifact bucket for an action's artifacts.
s3Location_key :: Lens' S3Location (Maybe Text) Source #
The artifact name.
SourceRevision
sourceRevision_revisionId :: Lens' SourceRevision (Maybe Text) Source #
The system-generated unique ID that identifies the revision number of the artifact.
sourceRevision_revisionSummary :: Lens' SourceRevision (Maybe Text) Source #
Summary information about the most recent revision of the artifact. For
GitHub and AWS CodeCommit repositories, the commit message. For Amazon
S3 buckets or actions, the user-provided content of a
codepipeline-artifact-revision-summary
key specified in the object
metadata.
sourceRevision_revisionUrl :: Lens' SourceRevision (Maybe Text) Source #
The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
sourceRevision_actionName :: Lens' SourceRevision Text Source #
The name of the action that processed the revision to the source artifact.
StageContext
stageContext_name :: Lens' StageContext (Maybe Text) Source #
The name of the stage.
StageDeclaration
stageDeclaration_blockers :: Lens' StageDeclaration (Maybe [BlockerDeclaration]) Source #
Reserved for future use.
stageDeclaration_name :: Lens' StageDeclaration Text Source #
The name of the stage.
stageDeclaration_actions :: Lens' StageDeclaration [ActionDeclaration] Source #
The actions included in a stage.
StageExecution
stageExecution_pipelineExecutionId :: Lens' StageExecution Text Source #
The ID of the pipeline execution associated with the stage.
stageExecution_status :: Lens' StageExecution StageExecutionStatus Source #
The status of the stage, or for a completed stage, the last status of the stage.
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
StageState
stageState_actionStates :: Lens' StageState (Maybe [ActionState]) Source #
The state of the stage.
stageState_inboundExecution :: Lens' StageState (Maybe StageExecution) Source #
Undocumented member.
stageState_inboundTransitionState :: Lens' StageState (Maybe TransitionState) Source #
The state of the inbound transition, which is either enabled or disabled.
stageState_latestExecution :: Lens' StageState (Maybe StageExecution) Source #
Information about the latest execution in the stage, including its ID and status.
stageState_stageName :: Lens' StageState (Maybe Text) Source #
The name of the stage.
StopExecutionTrigger
stopExecutionTrigger_reason :: Lens' StopExecutionTrigger (Maybe Text) Source #
The user-specified reason the pipeline was stopped.
Tag
ThirdPartyJob
thirdPartyJob_clientId :: Lens' ThirdPartyJob (Maybe Text) Source #
The clientToken
portion of the clientId
and clientToken
pair used
to verify that the calling entity is allowed access to the job and its
details.
thirdPartyJob_jobId :: Lens' ThirdPartyJob (Maybe Text) Source #
The identifier used to identify the job in AWS CodePipeline.
ThirdPartyJobData
thirdPartyJobData_actionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration) Source #
Represents information about an action configuration.
thirdPartyJobData_actionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId) Source #
Represents information about an action type.
thirdPartyJobData_artifactCredentials :: Lens' ThirdPartyJobData (Maybe AWSSessionCredentials) Source #
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
thirdPartyJobData_continuationToken :: Lens' ThirdPartyJobData (Maybe Text) Source #
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
thirdPartyJobData_encryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey) Source #
The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.
thirdPartyJobData_inputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact]) Source #
The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
thirdPartyJobData_outputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact]) Source #
The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
thirdPartyJobData_pipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext) Source #
Represents information about a pipeline to a job worker.
Does not include pipelineArn
and pipelineExecutionId
for ThirdParty
jobs.
ThirdPartyJobDetails
thirdPartyJobDetails_data :: Lens' ThirdPartyJobDetails (Maybe ThirdPartyJobData) Source #
The data to be returned by the third party job worker.
thirdPartyJobDetails_id :: Lens' ThirdPartyJobDetails (Maybe Text) Source #
The identifier used to identify the job details in AWS CodePipeline.
thirdPartyJobDetails_nonce :: Lens' ThirdPartyJobDetails (Maybe Text) Source #
A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.
TransitionState
transitionState_disabledReason :: Lens' TransitionState (Maybe Text) Source #
The user-specified reason why the transition between two stages of a pipeline was disabled.
transitionState_enabled :: Lens' TransitionState (Maybe Bool) Source #
Whether the transition between stages is enabled (true) or disabled (false).
transitionState_lastChangedAt :: Lens' TransitionState (Maybe UTCTime) Source #
The timestamp when the transition state was last changed.
transitionState_lastChangedBy :: Lens' TransitionState (Maybe Text) Source #
The ID of the user who last changed the transition state.
WebhookAuthConfiguration
webhookAuthConfiguration_allowedIPRange :: Lens' WebhookAuthConfiguration (Maybe Text) Source #
The property used to configure acceptance of webhooks in an IP address
range. For IP, only the AllowedIPRange
property must be set. This
property must be set to a valid CIDR range.
webhookAuthConfiguration_secretToken :: Lens' WebhookAuthConfiguration (Maybe Text) Source #
The property used to configure GitHub authentication. For GITHUB_HMAC,
only the SecretToken
property must be set.
WebhookDefinition
webhookDefinition_name :: Lens' WebhookDefinition Text Source #
The name of the webhook.
webhookDefinition_targetPipeline :: Lens' WebhookDefinition Text Source #
The name of the pipeline you want to connect to the webhook.
webhookDefinition_targetAction :: Lens' WebhookDefinition Text Source #
The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
webhookDefinition_filters :: Lens' WebhookDefinition [WebhookFilterRule] Source #
A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
webhookDefinition_authentication :: Lens' WebhookDefinition WebhookAuthenticationType Source #
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
- For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
- IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
- UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
webhookDefinition_authenticationConfiguration :: Lens' WebhookDefinition WebhookAuthConfiguration Source #
Properties that configure the authentication applied to incoming webhook
trigger requests. The required properties depend on the authentication
type. For GITHUB_HMAC, only the SecretToken
property must be set. For
IP, only the AllowedIPRange
property must be set to a valid CIDR
range. For UNAUTHENTICATED, no properties can be set.
WebhookFilterRule
webhookFilterRule_matchEquals :: Lens' WebhookFilterRule (Maybe Text) Source #
The value selected by the JsonPath
expression must match what is
supplied in the MatchEquals
field. Otherwise, the request is ignored.
Properties from the target action configuration can be included as
placeholders in this value by surrounding the action configuration key
with curly brackets. For example, if the value supplied here is
"refs/heads/{Branch}" and the target action has an action
configuration property called "Branch" with a value of "master", the
MatchEquals
value is evaluated as "refs/heads/master". For a list
of action configuration properties for built-in action types, see
Pipeline Structure Reference Action Requirements.
webhookFilterRule_jsonPath :: Lens' WebhookFilterRule Text Source #
A JsonPath expression that is applied to the body/payload of the
webhook. The value selected by the JsonPath expression must match the
value specified in the MatchEquals
field. Otherwise, the request is
ignored. For more information, see
Java JsonPath implementation in
GitHub.