Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- InvalidClientTokenException
- ValidationException
- InvalidNonceException
- ActionNotFoundException
- InvalidBlockerDeclarationException
- InvalidJobStateException
- InvalidJobException
- PipelineVersionNotFoundException
- ActionTypeNotFoundException
- InvalidNextTokenException
- InvalidStageDeclarationException
- InvalidActionDeclarationException
- StageNotFoundException
- InvalidStructureException
- JobNotFoundException
- PipelineNameInUseException
- PipelineNotFoundException
- LimitExceededException
- Waiters
- Operations
- GetPipeline
- PutJobFailureResult
- AcknowledgeThirdPartyJob
- PutThirdPartyJobFailureResult
- PollForThirdPartyJobs
- PollForJobs
- StartPipelineExecution
- UpdatePipeline
- DeletePipeline
- GetPipelineState
- GetJobDetails
- ListPipelines
- PutJobSuccessResult
- DeleteCustomActionType
- PutActionRevision
- DisableStageTransition
- ListActionTypes
- AcknowledgeJob
- EnableStageTransition
- CreatePipeline
- GetThirdPartyJobDetails
- PutThirdPartyJobSuccessResult
- CreateCustomActionType
- Types
- ActionCategory
- ActionConfigurationPropertyType
- ActionExecutionStatus
- ActionOwner
- ArtifactLocationType
- ArtifactStoreType
- BlockerType
- EncryptionKeyType
- FailureType
- JobStatus
- StageTransitionType
- AWSSessionCredentials
- ActionConfiguration
- ActionConfigurationProperty
- ActionContext
- ActionDeclaration
- ActionExecution
- ActionRevision
- ActionState
- ActionType
- ActionTypeId
- ActionTypeSettings
- Artifact
- ArtifactDetails
- ArtifactLocation
- ArtifactStore
- BlockerDeclaration
- CurrentRevision
- EncryptionKey
- ErrorDetails
- ExecutionDetails
- FailureDetails
- InputArtifact
- Job
- JobData
- JobDetails
- OutputArtifact
- PipelineContext
- PipelineDeclaration
- PipelineSummary
- S3ArtifactLocation
- StageContext
- StageDeclaration
- StageState
- ThirdPartyJob
- ThirdPartyJobData
- ThirdPartyJobDetails
- TransitionState
AWS CodePipeline Overview
This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.
You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.
You can work with pipelines by calling:
- CreatePipeline, which creates a uniquely-named pipeline.
- DeletePipeline, which deletes the specified pipeline.
- GetPipeline, which returns information about a pipeline structure.
- GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
- ListPipelines, which gets a summary of all of the pipelines associated with your account.
- StartPipelineExecution, which runs the the most recent revision of an artifact through the pipeline.
- UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the AWS CodePipeline Pipeline Structure Reference.
Pipeline stages include actions, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState.
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
- DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
- EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with AWS CodePipeline
For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
- AcknowledgeJob, which confirms whether a job worker has received the specified job,
- GetJobDetails, which returns the details of a job,
- PollForJobs, which determines whether there are any jobs to act upon,
- PutJobFailureResult, which provides details of a job failure, and
- PutJobSuccessResult, which provides details of a job success. - Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.
You can work with third party jobs by calling:
- AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job,
- GetThirdPartyJobDetails, which requests the details of a job for a partner action,
- PollForThirdPartyJobs, which determines whether there are any jobs to act upon,
- PutThirdPartyJobFailureResult, which provides details of a job failure, and
- PutThirdPartyJobSuccessResult, which provides details of a job success.
See: AWS API Reference
- codePipeline :: Service
- _InvalidClientTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNonceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ActionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidBlockerDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidJobException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ActionTypeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStageDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidActionDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError
- _StageNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStructureException :: AsError a => Getting (First ServiceError) a ServiceError
- _JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.CodePipeline.GetPipeline
- module Network.AWS.CodePipeline.PutJobFailureResult
- module Network.AWS.CodePipeline.AcknowledgeThirdPartyJob
- module Network.AWS.CodePipeline.PutThirdPartyJobFailureResult
- module Network.AWS.CodePipeline.PollForThirdPartyJobs
- module Network.AWS.CodePipeline.PollForJobs
- module Network.AWS.CodePipeline.StartPipelineExecution
- module Network.AWS.CodePipeline.UpdatePipeline
- module Network.AWS.CodePipeline.DeletePipeline
- module Network.AWS.CodePipeline.GetPipelineState
- module Network.AWS.CodePipeline.GetJobDetails
- module Network.AWS.CodePipeline.ListPipelines
- module Network.AWS.CodePipeline.PutJobSuccessResult
- module Network.AWS.CodePipeline.DeleteCustomActionType
- module Network.AWS.CodePipeline.PutActionRevision
- module Network.AWS.CodePipeline.DisableStageTransition
- module Network.AWS.CodePipeline.ListActionTypes
- module Network.AWS.CodePipeline.AcknowledgeJob
- module Network.AWS.CodePipeline.EnableStageTransition
- module Network.AWS.CodePipeline.CreatePipeline
- module Network.AWS.CodePipeline.GetThirdPartyJobDetails
- module Network.AWS.CodePipeline.PutThirdPartyJobSuccessResult
- module Network.AWS.CodePipeline.CreateCustomActionType
- data ActionCategory
- data ActionConfigurationPropertyType
- data ActionExecutionStatus
- data ActionOwner
- = AWS
- | Custom
- | ThirdParty
- data ArtifactLocationType = ALTS3
- data ArtifactStoreType = S3
- data BlockerType = Schedule
- data EncryptionKeyType = KMS
- data FailureType
- data JobStatus
- data StageTransitionType
- data AWSSessionCredentials
- awsSessionCredentials :: Text -> Text -> Text -> AWSSessionCredentials
- ascAccessKeyId :: Lens' AWSSessionCredentials Text
- ascSecretAccessKey :: Lens' AWSSessionCredentials Text
- ascSessionToken :: Lens' AWSSessionCredentials Text
- data ActionConfiguration
- actionConfiguration :: ActionConfiguration
- acConfiguration :: Lens' ActionConfiguration (HashMap Text Text)
- data ActionConfigurationProperty
- actionConfigurationProperty :: Text -> Bool -> Bool -> Bool -> ActionConfigurationProperty
- acpQueryable :: Lens' ActionConfigurationProperty (Maybe Bool)
- acpType :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType)
- acpDescription :: Lens' ActionConfigurationProperty (Maybe Text)
- acpName :: Lens' ActionConfigurationProperty Text
- acpRequired :: Lens' ActionConfigurationProperty Bool
- acpKey :: Lens' ActionConfigurationProperty Bool
- acpSecret :: Lens' ActionConfigurationProperty Bool
- data ActionContext
- actionContext :: ActionContext
- acName :: Lens' ActionContext (Maybe Text)
- data ActionDeclaration
- actionDeclaration :: Text -> ActionTypeId -> ActionDeclaration
- adOutputArtifacts :: Lens' ActionDeclaration [OutputArtifact]
- adRunOrder :: Lens' ActionDeclaration (Maybe Natural)
- adConfiguration :: Lens' ActionDeclaration (HashMap Text Text)
- adInputArtifacts :: Lens' ActionDeclaration [InputArtifact]
- adRoleARN :: Lens' ActionDeclaration (Maybe Text)
- adName :: Lens' ActionDeclaration Text
- adActionTypeId :: Lens' ActionDeclaration ActionTypeId
- data ActionExecution
- actionExecution :: ActionExecution
- aeSummary :: Lens' ActionExecution (Maybe Text)
- aeStatus :: Lens' ActionExecution (Maybe ActionExecutionStatus)
- aeLastStatusChange :: Lens' ActionExecution (Maybe UTCTime)
- aeExternalExecutionURL :: Lens' ActionExecution (Maybe Text)
- aeExternalExecutionId :: Lens' ActionExecution (Maybe Text)
- aeErrorDetails :: Lens' ActionExecution (Maybe ErrorDetails)
- aePercentComplete :: Lens' ActionExecution (Maybe Natural)
- data ActionRevision
- actionRevision :: Text -> UTCTime -> ActionRevision
- arRevisionChangeId :: Lens' ActionRevision (Maybe Text)
- arRevisionId :: Lens' ActionRevision Text
- arCreated :: Lens' ActionRevision UTCTime
- data ActionState
- actionState :: ActionState
- asRevisionURL :: Lens' ActionState (Maybe Text)
- asEntityURL :: Lens' ActionState (Maybe Text)
- asActionName :: Lens' ActionState (Maybe Text)
- asCurrentRevision :: Lens' ActionState (Maybe ActionRevision)
- asLatestExecution :: Lens' ActionState (Maybe ActionExecution)
- data ActionType
- actionType :: ActionTypeId -> ArtifactDetails -> ArtifactDetails -> ActionType
- atSettings :: Lens' ActionType (Maybe ActionTypeSettings)
- atActionConfigurationProperties :: Lens' ActionType [ActionConfigurationProperty]
- atId :: Lens' ActionType ActionTypeId
- atInputArtifactDetails :: Lens' ActionType ArtifactDetails
- atOutputArtifactDetails :: Lens' ActionType ArtifactDetails
- data ActionTypeId
- actionTypeId :: ActionCategory -> ActionOwner -> Text -> Text -> ActionTypeId
- atiCategory :: Lens' ActionTypeId ActionCategory
- atiOwner :: Lens' ActionTypeId ActionOwner
- atiProvider :: Lens' ActionTypeId Text
- atiVersion :: Lens' ActionTypeId Text
- data ActionTypeSettings
- actionTypeSettings :: ActionTypeSettings
- atsThirdPartyConfigurationURL :: Lens' ActionTypeSettings (Maybe Text)
- atsExecutionURLTemplate :: Lens' ActionTypeSettings (Maybe Text)
- atsRevisionURLTemplate :: Lens' ActionTypeSettings (Maybe Text)
- atsEntityURLTemplate :: Lens' ActionTypeSettings (Maybe Text)
- data Artifact
- artifact :: Artifact
- aLocation :: Lens' Artifact (Maybe ArtifactLocation)
- aName :: Lens' Artifact (Maybe Text)
- aRevision :: Lens' Artifact (Maybe Text)
- data ArtifactDetails
- artifactDetails :: Natural -> Natural -> ArtifactDetails
- adMinimumCount :: Lens' ArtifactDetails Natural
- adMaximumCount :: Lens' ArtifactDetails Natural
- data ArtifactLocation
- artifactLocation :: ArtifactLocation
- alS3Location :: Lens' ArtifactLocation (Maybe S3ArtifactLocation)
- alType :: Lens' ArtifactLocation (Maybe ArtifactLocationType)
- data ArtifactStore
- artifactStore :: ArtifactStoreType -> Text -> ArtifactStore
- asEncryptionKey :: Lens' ArtifactStore (Maybe EncryptionKey)
- asType :: Lens' ArtifactStore ArtifactStoreType
- asLocation :: Lens' ArtifactStore Text
- data BlockerDeclaration
- blockerDeclaration :: Text -> BlockerType -> BlockerDeclaration
- bdName :: Lens' BlockerDeclaration Text
- bdType :: Lens' BlockerDeclaration BlockerType
- data CurrentRevision
- currentRevision :: Text -> Text -> CurrentRevision
- crRevision :: Lens' CurrentRevision Text
- crChangeIdentifier :: Lens' CurrentRevision Text
- data EncryptionKey
- encryptionKey :: Text -> EncryptionKeyType -> EncryptionKey
- ekId :: Lens' EncryptionKey Text
- ekType :: Lens' EncryptionKey EncryptionKeyType
- data ErrorDetails
- errorDetails :: ErrorDetails
- edCode :: Lens' ErrorDetails (Maybe Text)
- edMessage :: Lens' ErrorDetails (Maybe Text)
- data ExecutionDetails
- executionDetails :: ExecutionDetails
- edSummary :: Lens' ExecutionDetails (Maybe Text)
- edExternalExecutionId :: Lens' ExecutionDetails (Maybe Text)
- edPercentComplete :: Lens' ExecutionDetails (Maybe Natural)
- data FailureDetails
- failureDetails :: FailureType -> Text -> FailureDetails
- fdExternalExecutionId :: Lens' FailureDetails (Maybe Text)
- fdType :: Lens' FailureDetails FailureType
- fdMessage :: Lens' FailureDetails Text
- data InputArtifact
- inputArtifact :: Text -> InputArtifact
- iaName :: Lens' InputArtifact Text
- data Job
- job :: Job
- jData :: Lens' Job (Maybe JobData)
- jAccountId :: Lens' Job (Maybe Text)
- jId :: Lens' Job (Maybe Text)
- jNonce :: Lens' Job (Maybe Text)
- data JobData
- jobData :: JobData
- jdContinuationToken :: Lens' JobData (Maybe Text)
- jdOutputArtifacts :: Lens' JobData [Artifact]
- jdArtifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials)
- jdPipelineContext :: Lens' JobData (Maybe PipelineContext)
- jdEncryptionKey :: Lens' JobData (Maybe EncryptionKey)
- jdActionTypeId :: Lens' JobData (Maybe ActionTypeId)
- jdInputArtifacts :: Lens' JobData [Artifact]
- jdActionConfiguration :: Lens' JobData (Maybe ActionConfiguration)
- data JobDetails
- jobDetails :: JobDetails
- jdData :: Lens' JobDetails (Maybe JobData)
- jdAccountId :: Lens' JobDetails (Maybe Text)
- jdId :: Lens' JobDetails (Maybe Text)
- data OutputArtifact
- outputArtifact :: Text -> OutputArtifact
- oaName :: Lens' OutputArtifact Text
- data PipelineContext
- pipelineContext :: PipelineContext
- pcStage :: Lens' PipelineContext (Maybe StageContext)
- pcPipelineName :: Lens' PipelineContext (Maybe Text)
- pcAction :: Lens' PipelineContext (Maybe ActionContext)
- data PipelineDeclaration
- pipelineDeclaration :: Text -> Text -> ArtifactStore -> PipelineDeclaration
- pdVersion :: Lens' PipelineDeclaration (Maybe Natural)
- pdName :: Lens' PipelineDeclaration Text
- pdRoleARN :: Lens' PipelineDeclaration Text
- pdArtifactStore :: Lens' PipelineDeclaration ArtifactStore
- pdStages :: Lens' PipelineDeclaration [StageDeclaration]
- data PipelineSummary
- pipelineSummary :: PipelineSummary
- psCreated :: Lens' PipelineSummary (Maybe UTCTime)
- psName :: Lens' PipelineSummary (Maybe Text)
- psVersion :: Lens' PipelineSummary (Maybe Natural)
- psUpdated :: Lens' PipelineSummary (Maybe UTCTime)
- data S3ArtifactLocation
- s3ArtifactLocation :: Text -> Text -> S3ArtifactLocation
- salBucketName :: Lens' S3ArtifactLocation Text
- salObjectKey :: Lens' S3ArtifactLocation Text
- data StageContext
- stageContext :: StageContext
- scName :: Lens' StageContext (Maybe Text)
- data StageDeclaration
- stageDeclaration :: Text -> StageDeclaration
- sdBlockers :: Lens' StageDeclaration [BlockerDeclaration]
- sdName :: Lens' StageDeclaration Text
- sdActions :: Lens' StageDeclaration [ActionDeclaration]
- data StageState
- stageState :: StageState
- ssInboundTransitionState :: Lens' StageState (Maybe TransitionState)
- ssActionStates :: Lens' StageState [ActionState]
- ssStageName :: Lens' StageState (Maybe Text)
- data ThirdPartyJob
- thirdPartyJob :: ThirdPartyJob
- tpjClientId :: Lens' ThirdPartyJob (Maybe Text)
- tpjJobId :: Lens' ThirdPartyJob (Maybe Text)
- data ThirdPartyJobData
- thirdPartyJobData :: ThirdPartyJobData
- tpjdContinuationToken :: Lens' ThirdPartyJobData (Maybe Text)
- tpjdOutputArtifacts :: Lens' ThirdPartyJobData [Artifact]
- tpjdArtifactCredentials :: Lens' ThirdPartyJobData (Maybe AWSSessionCredentials)
- tpjdPipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext)
- tpjdEncryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey)
- tpjdActionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId)
- tpjdInputArtifacts :: Lens' ThirdPartyJobData [Artifact]
- tpjdActionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration)
- data ThirdPartyJobDetails
- thirdPartyJobDetails :: ThirdPartyJobDetails
- tpjdData :: Lens' ThirdPartyJobDetails (Maybe ThirdPartyJobData)
- tpjdId :: Lens' ThirdPartyJobDetails (Maybe Text)
- tpjdNonce :: Lens' ThirdPartyJobDetails (Maybe Text)
- data TransitionState
- transitionState :: TransitionState
- tsEnabled :: Lens' TransitionState (Maybe Bool)
- tsDisabledReason :: Lens' TransitionState (Maybe Text)
- tsLastChangedAt :: Lens' TransitionState (Maybe UTCTime)
- tsLastChangedBy :: Lens' TransitionState (Maybe Text)
Service Configuration
codePipeline :: Service Source
API version '2015-07-09' of the Amazon CodePipeline SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CodePipeline
.
InvalidClientTokenException
_InvalidClientTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source
The client token was specified in an invalid format
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source
The validation was specified in an invalid format.
InvalidNonceException
_InvalidNonceException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified nonce was specified in an invalid format.
ActionNotFoundException
_ActionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified action cannot be found.
InvalidBlockerDeclarationException
_InvalidBlockerDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified gate declaration was specified in an invalid format.
InvalidJobStateException
_InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified job state was specified in an invalid format.
InvalidJobException
_InvalidJobException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified job was specified in an invalid format or cannot be found.
PipelineVersionNotFoundException
_PipelineVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified pipeline version was specified in an invalid format or cannot be found.
ActionTypeNotFoundException
_ActionTypeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified action type cannot be found.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source
The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.
InvalidStageDeclarationException
_InvalidStageDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified stage declaration was specified in an invalid format.
InvalidActionDeclarationException
_InvalidActionDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified action declaration was specified in an invalid format.
StageNotFoundException
_StageNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified stage was specified in an invalid format or cannot be found.
InvalidStructureException
_InvalidStructureException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified structure was specified in an invalid format.
JobNotFoundException
_JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified job was specified in an invalid format or cannot be found.
PipelineNameInUseException
_PipelineNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified pipeline name is already in use.
PipelineNotFoundException
_PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified pipeline was specified in an invalid format or cannot be found.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetPipeline
PutJobFailureResult
AcknowledgeThirdPartyJob
PutThirdPartyJobFailureResult
PollForThirdPartyJobs
PollForJobs
StartPipelineExecution
UpdatePipeline
DeletePipeline
GetPipelineState
GetJobDetails
ListPipelines
PutJobSuccessResult
DeleteCustomActionType
PutActionRevision
DisableStageTransition
ListActionTypes
AcknowledgeJob
EnableStageTransition
CreatePipeline
GetThirdPartyJobDetails
PutThirdPartyJobSuccessResult
CreateCustomActionType
Types
ActionCategory
data ActionCategory Source
ActionConfigurationPropertyType
data ActionConfigurationPropertyType Source
ActionExecutionStatus
data ActionExecutionStatus Source
ActionOwner
data ActionOwner Source
ArtifactLocationType
data ArtifactLocationType Source
ArtifactStoreType
data ArtifactStoreType Source
BlockerType
data BlockerType Source
EncryptionKeyType
data EncryptionKeyType Source
FailureType
data FailureType Source
ConfigurationError | |
JobFailed | |
PermissionError | |
RevisionOutOfSync | |
RevisionUnavailable | |
SystemUnavailable |
JobStatus
StageTransitionType
data StageTransitionType Source
AWSSessionCredentials
data AWSSessionCredentials Source
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
See: awsSessionCredentials
smart constructor.
Creates a value of AWSSessionCredentials
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ascAccessKeyId :: Lens' AWSSessionCredentials Text Source
The access key for the session.
ascSecretAccessKey :: Lens' AWSSessionCredentials Text Source
The secret access key for the session.
ascSessionToken :: Lens' AWSSessionCredentials Text Source
The token for the session.
ActionConfiguration
data ActionConfiguration Source
Represents information about an action configuration.
See: actionConfiguration
smart constructor.
actionConfiguration :: ActionConfiguration Source
Creates a value of ActionConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acConfiguration :: Lens' ActionConfiguration (HashMap Text Text) Source
The configuration data for the action.
ActionConfigurationProperty
data ActionConfigurationProperty Source
Represents information about an action configuration property.
See: actionConfigurationProperty
smart constructor.
actionConfigurationProperty Source
Creates a value of ActionConfigurationProperty
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acpQueryable :: Lens' ActionConfigurationProperty (Maybe Bool) Source
Indicates that the proprety will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
acpType :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType) Source
The type of the configuration property.
acpDescription :: Lens' ActionConfigurationProperty (Maybe Text) Source
The description of the action configuration property that will be displayed to users.
acpName :: Lens' ActionConfigurationProperty Text Source
The name of the action configuration property.
acpRequired :: Lens' ActionConfigurationProperty Bool Source
Whether the configuration property is a required value.
acpKey :: Lens' ActionConfigurationProperty Bool Source
Whether the configuration property is a key.
acpSecret :: Lens' ActionConfigurationProperty Bool Source
Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.
ActionContext
data ActionContext Source
Represents the context of an action within the stage of a pipeline to a job worker.
See: actionContext
smart constructor.
actionContext :: ActionContext Source
Creates a value of ActionContext
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acName :: Lens' ActionContext (Maybe Text) Source
The name of the action within the context of a job.
ActionDeclaration
data ActionDeclaration Source
Represents information about an action declaration.
See: actionDeclaration
smart constructor.
Creates a value of ActionDeclaration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
adOutputArtifacts :: Lens' ActionDeclaration [OutputArtifact] Source
The name or ID of the result of the action declaration, such as a test or build artifact.
adRunOrder :: Lens' ActionDeclaration (Maybe Natural) Source
The order in which actions are run.
adConfiguration :: Lens' ActionDeclaration (HashMap Text Text) Source
The action declaration's configuration.
adInputArtifacts :: Lens' ActionDeclaration [InputArtifact] Source
The name or ID of the artifact consumed by the action, such as a test or build artifact.
adRoleARN :: Lens' ActionDeclaration (Maybe Text) Source
The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.
adName :: Lens' ActionDeclaration Text Source
The action declaration's name.
adActionTypeId :: Lens' ActionDeclaration ActionTypeId Source
The configuration information for the action type.
ActionExecution
data ActionExecution Source
Represents information about how an action runs.
See: actionExecution
smart constructor.
actionExecution :: ActionExecution Source
Creates a value of ActionExecution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aeStatus :: Lens' ActionExecution (Maybe ActionExecutionStatus) Source
The status of the action, or for a completed action, the last status of the action.
aeLastStatusChange :: Lens' ActionExecution (Maybe UTCTime) Source
The last status change of the action.
aeExternalExecutionURL :: Lens' ActionExecution (Maybe Text) Source
The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.
aeExternalExecutionId :: Lens' ActionExecution (Maybe Text) Source
The external ID of the run of the action.
aeErrorDetails :: Lens' ActionExecution (Maybe ErrorDetails) Source
The details of an error returned by a URL external to AWS.
aePercentComplete :: Lens' ActionExecution (Maybe Natural) Source
A percentage of completeness of the action as it runs.
ActionRevision
data ActionRevision Source
Represents information about the version (or revision) of an action.
See: actionRevision
smart constructor.
Creates a value of ActionRevision
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arRevisionChangeId :: Lens' ActionRevision (Maybe Text) Source
The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.
arRevisionId :: Lens' ActionRevision Text Source
The system-generated unique ID that identifies the revision number of the action.
arCreated :: Lens' ActionRevision UTCTime Source
The date and time when the most recent version of the action was created, in timestamp format.
ActionState
data ActionState Source
Represents information about the state of an action.
See: actionState
smart constructor.
actionState :: ActionState Source
Creates a value of ActionState
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asRevisionURL :: Lens' ActionState (Maybe Text) Source
A URL link for more information about the revision, such as a commit details page.
asEntityURL :: Lens' ActionState (Maybe Text) Source
A URL link for more information about the state of the action, such as a deployment group details page.
asActionName :: Lens' ActionState (Maybe Text) Source
The name of the action.
asCurrentRevision :: Lens' ActionState (Maybe ActionRevision) Source
Undocumented member.
asLatestExecution :: Lens' ActionState (Maybe ActionExecution) Source
Undocumented member.
ActionType
data ActionType Source
Returns information about the details of an action type.
See: actionType
smart constructor.
Creates a value of ActionType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atSettings :: Lens' ActionType (Maybe ActionTypeSettings) Source
The settings for the action type.
atActionConfigurationProperties :: Lens' ActionType [ActionConfigurationProperty] Source
The configuration properties for the action type.
atId :: Lens' ActionType ActionTypeId Source
Undocumented member.
atInputArtifactDetails :: Lens' ActionType ArtifactDetails Source
The details of the input artifact for the action, such as its commit ID.
atOutputArtifactDetails :: Lens' ActionType ArtifactDetails Source
The details of the output artifact of the action, such as its commit ID.
ActionTypeId
data ActionTypeId Source
Represents information about an action type.
See: actionTypeId
smart constructor.
:: ActionCategory | |
-> ActionOwner | |
-> Text | |
-> Text | |
-> ActionTypeId |
Creates a value of ActionTypeId
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atiCategory :: 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 values below.
atiOwner :: Lens' ActionTypeId ActionOwner Source
The creator of the action being called.
atiProvider :: 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.
atiVersion :: Lens' ActionTypeId Text Source
A string that identifies the action type.
ActionTypeSettings
data ActionTypeSettings Source
Returns information about the settings for an action type.
See: actionTypeSettings
smart constructor.
actionTypeSettings :: ActionTypeSettings Source
Creates a value of ActionTypeSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atsThirdPartyConfigurationURL :: 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.
atsExecutionURLTemplate :: 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 console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
atsRevisionURLTemplate :: Lens' ActionTypeSettings (Maybe Text) 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.
atsEntityURLTemplate :: 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 within the pipeline.
Artifact
Represents information about an artifact that will be worked upon by actions in the pipeline.
See: artifact
smart constructor.
aRevision :: 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).
ArtifactDetails
data ArtifactDetails Source
Returns information about the details of an artifact.
See: artifactDetails
smart constructor.
Creates a value of ArtifactDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
adMinimumCount :: Lens' ArtifactDetails Natural Source
The minimum number of artifacts allowed for the action type.
adMaximumCount :: Lens' ArtifactDetails Natural Source
The maximum number of artifacts allowed for the action type.
ArtifactLocation
data ArtifactLocation Source
Represents information about the location of an artifact.
See: artifactLocation
smart constructor.
artifactLocation :: ArtifactLocation Source
Creates a value of ArtifactLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alS3Location :: Lens' ArtifactLocation (Maybe S3ArtifactLocation) Source
The Amazon S3 bucket that contains the artifact.
alType :: Lens' ArtifactLocation (Maybe ArtifactLocationType) Source
The type of artifact in the location.
ArtifactStore
data ArtifactStore Source
The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.
See: artifactStore
smart constructor.
Creates a value of ArtifactStore
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asEncryptionKey :: Lens' ArtifactStore (Maybe EncryptionKey) Source
The AWS Key Management Service (AWS KMS) key used to encrypt the data in the artifact store. If this is undefined, the default key for Amazon S3 is used.
asType :: Lens' ArtifactStore ArtifactStoreType Source
The type of the artifact store, such as S3.
asLocation :: Lens' ArtifactStore Text Source
The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
BlockerDeclaration
data BlockerDeclaration Source
Represents information about a gate declaration.
See: blockerDeclaration
smart constructor.
Creates a value of BlockerDeclaration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdName :: Lens' BlockerDeclaration Text Source
The name of the gate declaration.
bdType :: Lens' BlockerDeclaration BlockerType Source
The type of the gate declaration.
CurrentRevision
data CurrentRevision Source
Represents information about a current revision.
See: currentRevision
smart constructor.
Creates a value of CurrentRevision
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crRevision :: Lens' CurrentRevision Text Source
The revision ID of the current version of an artifact.
crChangeIdentifier :: Lens' CurrentRevision Text Source
The change identifier for the current revision.
EncryptionKey
data EncryptionKey Source
Represents information about the AWS Key Management Service (AWS KMS) key used to encrypt data in the artifact store.
See: encryptionKey
smart constructor.
Creates a value of EncryptionKey
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ekId :: Lens' EncryptionKey Text Source
The ID of the AWS KMS key.
ekType :: Lens' EncryptionKey EncryptionKeyType Source
The type of AWS KMS key, such as a customer master key.
ErrorDetails
data ErrorDetails Source
Represents information about an error in AWS CodePipeline.
See: errorDetails
smart constructor.
errorDetails :: ErrorDetails Source
Creates a value of ErrorDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ExecutionDetails
data ExecutionDetails Source
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
See: executionDetails
smart constructor.
executionDetails :: ExecutionDetails Source
Creates a value of ExecutionDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edSummary :: Lens' ExecutionDetails (Maybe Text) Source
The summary of the current status of the actions.
edExternalExecutionId :: 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.
edPercentComplete :: Lens' ExecutionDetails (Maybe Natural) Source
The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
FailureDetails
data FailureDetails Source
Represents information about failure details.
See: failureDetails
smart constructor.
Creates a value of FailureDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fdExternalExecutionId :: Lens' FailureDetails (Maybe Text) Source
The external ID of the run of the action that failed.
fdType :: Lens' FailureDetails FailureType Source
The type of the failure.
fdMessage :: Lens' FailureDetails Text Source
The message about the failure.
InputArtifact
data InputArtifact Source
Represents information about an artifact to be worked on, such as a test or build artifact.
See: inputArtifact
smart constructor.
:: Text | |
-> InputArtifact |
Creates a value of InputArtifact
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaName :: Lens' InputArtifact Text Source
The name of the artifact to be worked on, for example, "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Job
Represents information about a job.
See: job
smart constructor.
Creates a value of Job
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jAccountId :: Lens' Job (Maybe Text) Source
The ID of the AWS account to use when performing the job.
jNonce :: 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. This number must be returned in the response.
JobData
Represents additional information about a job required for a job worker to complete the job.
See: jobData
smart constructor.
Creates a value of JobData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jdContinuationToken :: Lens' JobData (Maybe Text) Source
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
jdOutputArtifacts :: Lens' JobData [Artifact] Source
The output of the job.
jdArtifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials) Source
Undocumented member.
jdPipelineContext :: Lens' JobData (Maybe PipelineContext) Source
Undocumented member.
jdEncryptionKey :: Lens' JobData (Maybe EncryptionKey) Source
Undocumented member.
jdActionTypeId :: Lens' JobData (Maybe ActionTypeId) Source
Undocumented member.
jdInputArtifacts :: Lens' JobData [Artifact] Source
The artifact supplied to the job.
jdActionConfiguration :: Lens' JobData (Maybe ActionConfiguration) Source
Undocumented member.
JobDetails
data JobDetails Source
Represents information about the details of a job.
See: jobDetails
smart constructor.
jobDetails :: JobDetails Source
Creates a value of JobDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jdAccountId :: Lens' JobDetails (Maybe Text) Source
The AWS account ID associated with the job.
OutputArtifact
data OutputArtifact Source
Represents information about the output of an action.
See: outputArtifact
smart constructor.
:: Text | |
-> OutputArtifact |
Creates a value of OutputArtifact
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oaName :: Lens' OutputArtifact Text Source
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
PipelineContext
data PipelineContext Source
Represents information about a pipeline to a job worker.
See: pipelineContext
smart constructor.
pipelineContext :: PipelineContext Source
Creates a value of PipelineContext
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcStage :: Lens' PipelineContext (Maybe StageContext) Source
The stage of the pipeline.
pcPipelineName :: 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.
pcAction :: Lens' PipelineContext (Maybe ActionContext) Source
Undocumented member.
PipelineDeclaration
data PipelineDeclaration Source
Represents the structure of actions and stages to be performed in the pipeline.
See: pipelineDeclaration
smart constructor.
Creates a value of PipelineDeclaration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdVersion :: Lens' PipelineDeclaration (Maybe Natural) Source
The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.
pdName :: Lens' PipelineDeclaration Text Source
The name of the action to be performed.
pdRoleARN :: 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.
pdArtifactStore :: Lens' PipelineDeclaration ArtifactStore Source
Undocumented member.
pdStages :: Lens' PipelineDeclaration [StageDeclaration] Source
The stage in which to perform the action.
PipelineSummary
data PipelineSummary Source
Returns a summary of a pipeline.
See: pipelineSummary
smart constructor.
pipelineSummary :: PipelineSummary Source
Creates a value of PipelineSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psCreated :: Lens' PipelineSummary (Maybe UTCTime) Source
The date and time the pipeline was created, in timestamp format.
psUpdated :: Lens' PipelineSummary (Maybe UTCTime) Source
The date and time of the last update to the pipeline, in timestamp format.
S3ArtifactLocation
data S3ArtifactLocation Source
The location of the Amazon S3 bucket that contains a revision.
See: s3ArtifactLocation
smart constructor.
Creates a value of S3ArtifactLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
salBucketName :: Lens' S3ArtifactLocation Text Source
The name of the Amazon S3 bucket.
salObjectKey :: Lens' S3ArtifactLocation Text Source
The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.
StageContext
data StageContext Source
Represents information about a stage to a job worker.
See: stageContext
smart constructor.
stageContext :: StageContext Source
Creates a value of StageContext
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
StageDeclaration
data StageDeclaration Source
Represents information about a stage and its definition.
See: stageDeclaration
smart constructor.
Creates a value of StageDeclaration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdBlockers :: Lens' StageDeclaration [BlockerDeclaration] Source
The gates included in a stage.
sdName :: Lens' StageDeclaration Text Source
The name of the stage.
sdActions :: Lens' StageDeclaration [ActionDeclaration] Source
The actions included in a stage.
StageState
data StageState Source
Represents information about the state of the stage.
See: stageState
smart constructor.
stageState :: StageState Source
Creates a value of StageState
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssInboundTransitionState :: Lens' StageState (Maybe TransitionState) Source
The state of the inbound transition, which is either enabled or disabled.
ssActionStates :: Lens' StageState [ActionState] Source
The state of the stage.
ssStageName :: Lens' StageState (Maybe Text) Source
The name of the stage.
ThirdPartyJob
data ThirdPartyJob Source
A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked upon by a partner action.
See: thirdPartyJob
smart constructor.
thirdPartyJob :: ThirdPartyJob Source
Creates a value of ThirdPartyJob
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpjClientId :: 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.
tpjJobId :: Lens' ThirdPartyJob (Maybe Text) Source
The identifier used to identify the job in AWS CodePipeline.
ThirdPartyJobData
data ThirdPartyJobData Source
Represents information about the job data for a partner action.
See: thirdPartyJobData
smart constructor.
thirdPartyJobData :: ThirdPartyJobData Source
Creates a value of ThirdPartyJobData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpjdContinuationToken :: Lens' ThirdPartyJobData (Maybe Text) Source
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
tpjdOutputArtifacts :: Lens' ThirdPartyJobData [Artifact] Source
The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
tpjdArtifactCredentials :: Lens' ThirdPartyJobData (Maybe AWSSessionCredentials) Source
Undocumented member.
tpjdPipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext) Source
Undocumented member.
tpjdEncryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey) Source
The AWS Key Management Service (AWS KMS) key used to encrypt and decrypt data in the artifact store for the pipeline.
tpjdActionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId) Source
Undocumented member.
tpjdInputArtifacts :: Lens' ThirdPartyJobData [Artifact] Source
The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
tpjdActionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration) Source
Undocumented member.
ThirdPartyJobDetails
data ThirdPartyJobDetails Source
The details of a job sent in response to a GetThirdPartyJobDetails request.
See: thirdPartyJobDetails
smart constructor.
thirdPartyJobDetails :: ThirdPartyJobDetails Source
Creates a value of ThirdPartyJobDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpjdData :: Lens' ThirdPartyJobDetails (Maybe ThirdPartyJobData) Source
The data to be returned by the third party job worker.
tpjdId :: Lens' ThirdPartyJobDetails (Maybe Text) Source
The identifier used to identify the job details in AWS CodePipeline.
tpjdNonce :: 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. This number must be returned in the response.
TransitionState
data TransitionState Source
Represents information about the state of transitions between one stage and another stage.
See: transitionState
smart constructor.
transitionState :: TransitionState Source
Creates a value of TransitionState
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsEnabled :: Lens' TransitionState (Maybe Bool) Source
Whether the transition between stages is enabled (true) or disabled (false).
tsDisabledReason :: Lens' TransitionState (Maybe Text) Source
The user-specified reason why the transition between two stages of a pipeline was disabled.
tsLastChangedAt :: Lens' TransitionState (Maybe UTCTime) Source
The timestamp when the transition state was last changed.
tsLastChangedBy :: Lens' TransitionState (Maybe Text) Source
The ID of the user who last changed the transition state.