| Copyright | (c) 2013-2016 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 |
Network.AWS.CodePipeline.Types
Contents
- Service Configuration
- Errors
- ActionCategory
- ActionConfigurationPropertyType
- ActionExecutionStatus
- ActionOwner
- ApprovalStatus
- ArtifactLocationType
- ArtifactStoreType
- BlockerType
- EncryptionKeyType
- FailureType
- JobStatus
- PipelineExecutionStatus
- StageExecutionStatus
- StageRetryMode
- StageTransitionType
- AWSSessionCredentials
- ActionConfiguration
- ActionConfigurationProperty
- ActionContext
- ActionDeclaration
- ActionExecution
- ActionRevision
- ActionState
- ActionType
- ActionTypeId
- ActionTypeSettings
- ApprovalResult
- Artifact
- ArtifactDetails
- ArtifactLocation
- ArtifactRevision
- ArtifactStore
- BlockerDeclaration
- CurrentRevision
- EncryptionKey
- ErrorDetails
- ExecutionDetails
- FailureDetails
- InputArtifact
- Job
- JobData
- JobDetails
- OutputArtifact
- PipelineContext
- PipelineDeclaration
- PipelineExecution
- PipelineSummary
- S3ArtifactLocation
- StageContext
- StageDeclaration
- StageExecution
- StageState
- ThirdPartyJob
- ThirdPartyJobData
- ThirdPartyJobDetails
- TransitionState
Description
- codePipeline :: Service
- _InvalidClientTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNonceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ActionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidApprovalTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidBlockerDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidJobException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _StageNotRetryableException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineExecutionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _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
- _ApprovalAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotLatestPipelineExecutionException :: AsError a => Getting (First ServiceError) a ServiceError
- data ActionCategory
- data ActionConfigurationPropertyType
- data ActionExecutionStatus
- data ActionOwner
- = AWS
- | Custom
- | ThirdParty
- data ApprovalStatus
- data ArtifactLocationType = ALTS3
- data ArtifactStoreType = S3
- data BlockerType = Schedule
- data EncryptionKeyType = KMS
- data FailureType
- data JobStatus
- data PipelineExecutionStatus
- data StageExecutionStatus
- data StageRetryMode = FailedActions
- data StageTransitionType
- data AWSSessionCredentials
- awsSessionCredentials :: Text -> Text -> Text -> AWSSessionCredentials
- ascAccessKeyId :: Lens' AWSSessionCredentials Text
- ascSecretAccessKey :: Lens' AWSSessionCredentials Text
- ascSessionToken :: Lens' AWSSessionCredentials Text
- data ActionConfiguration
- actionConfiguration :: ActionConfiguration
- acConfiguration :: Lens' ActionConfiguration (HashMap Text Text)
- data ActionConfigurationProperty
- actionConfigurationProperty :: Text -> Bool -> Bool -> Bool -> ActionConfigurationProperty
- acpQueryable :: Lens' ActionConfigurationProperty (Maybe Bool)
- acpType :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType)
- acpDescription :: Lens' ActionConfigurationProperty (Maybe Text)
- acpName :: Lens' ActionConfigurationProperty Text
- acpRequired :: Lens' ActionConfigurationProperty Bool
- acpKey :: Lens' ActionConfigurationProperty Bool
- acpSecret :: Lens' ActionConfigurationProperty Bool
- data ActionContext
- actionContext :: ActionContext
- acName :: Lens' ActionContext (Maybe Text)
- data ActionDeclaration
- actionDeclaration :: Text -> ActionTypeId -> ActionDeclaration
- adOutputArtifacts :: Lens' ActionDeclaration [OutputArtifact]
- adRunOrder :: Lens' ActionDeclaration (Maybe Natural)
- adConfiguration :: Lens' ActionDeclaration (HashMap Text Text)
- adInputArtifacts :: Lens' ActionDeclaration [InputArtifact]
- adRoleARN :: Lens' ActionDeclaration (Maybe Text)
- adName :: Lens' ActionDeclaration Text
- adActionTypeId :: Lens' ActionDeclaration ActionTypeId
- data ActionExecution
- actionExecution :: ActionExecution
- aeLastUpdatedBy :: Lens' ActionExecution (Maybe Text)
- aeSummary :: Lens' ActionExecution (Maybe Text)
- aeStatus :: Lens' ActionExecution (Maybe ActionExecutionStatus)
- aeLastStatusChange :: Lens' ActionExecution (Maybe UTCTime)
- aeToken :: Lens' ActionExecution (Maybe Text)
- aeExternalExecutionURL :: Lens' ActionExecution (Maybe Text)
- aeExternalExecutionId :: Lens' ActionExecution (Maybe Text)
- aeErrorDetails :: Lens' ActionExecution (Maybe ErrorDetails)
- aePercentComplete :: Lens' ActionExecution (Maybe Natural)
- data ActionRevision
- actionRevision :: Text -> Text -> UTCTime -> ActionRevision
- aRevisionId :: Lens' ActionRevision Text
- aRevisionChangeId :: Lens' ActionRevision Text
- aCreated :: Lens' ActionRevision UTCTime
- data ActionState
- actionState :: ActionState
- asRevisionURL :: Lens' ActionState (Maybe Text)
- asEntityURL :: Lens' ActionState (Maybe Text)
- asActionName :: Lens' ActionState (Maybe Text)
- asCurrentRevision :: Lens' ActionState (Maybe ActionRevision)
- asLatestExecution :: Lens' ActionState (Maybe ActionExecution)
- data ActionType
- actionType :: ActionTypeId -> ArtifactDetails -> ArtifactDetails -> ActionType
- atSettings :: Lens' ActionType (Maybe ActionTypeSettings)
- atActionConfigurationProperties :: Lens' ActionType [ActionConfigurationProperty]
- atId :: Lens' ActionType ActionTypeId
- atInputArtifactDetails :: Lens' ActionType ArtifactDetails
- atOutputArtifactDetails :: Lens' ActionType ArtifactDetails
- data ActionTypeId
- actionTypeId :: ActionCategory -> ActionOwner -> Text -> Text -> ActionTypeId
- atiCategory :: Lens' ActionTypeId ActionCategory
- atiOwner :: Lens' ActionTypeId ActionOwner
- atiProvider :: Lens' ActionTypeId Text
- atiVersion :: Lens' ActionTypeId Text
- data ActionTypeSettings
- actionTypeSettings :: ActionTypeSettings
- atsThirdPartyConfigurationURL :: Lens' ActionTypeSettings (Maybe Text)
- atsExecutionURLTemplate :: Lens' ActionTypeSettings (Maybe Text)
- atsRevisionURLTemplate :: Lens' ActionTypeSettings (Maybe Text)
- atsEntityURLTemplate :: Lens' ActionTypeSettings (Maybe Text)
- data ApprovalResult
- approvalResult :: Text -> ApprovalStatus -> ApprovalResult
- arSummary :: Lens' ApprovalResult Text
- arStatus :: Lens' ApprovalResult ApprovalStatus
- data Artifact
- artifact :: Artifact
- aLocation :: Lens' Artifact (Maybe ArtifactLocation)
- aName :: Lens' Artifact (Maybe Text)
- aRevision :: Lens' Artifact (Maybe Text)
- data ArtifactDetails
- artifactDetails :: Natural -> Natural -> ArtifactDetails
- adMinimumCount :: Lens' ArtifactDetails Natural
- adMaximumCount :: Lens' ArtifactDetails Natural
- data ArtifactLocation
- artifactLocation :: ArtifactLocation
- alS3Location :: Lens' ArtifactLocation (Maybe S3ArtifactLocation)
- alType :: Lens' ArtifactLocation (Maybe ArtifactLocationType)
- data ArtifactRevision
- artifactRevision :: ArtifactRevision
- arRevisionSummary :: Lens' ArtifactRevision (Maybe Text)
- arRevisionURL :: Lens' ArtifactRevision (Maybe Text)
- arCreated :: Lens' ArtifactRevision (Maybe UTCTime)
- arName :: Lens' ArtifactRevision (Maybe Text)
- arRevisionId :: Lens' ArtifactRevision (Maybe Text)
- arRevisionChangeIdentifier :: Lens' ArtifactRevision (Maybe Text)
- data ArtifactStore
- artifactStore :: ArtifactStoreType -> Text -> ArtifactStore
- asEncryptionKey :: Lens' ArtifactStore (Maybe EncryptionKey)
- asType :: Lens' ArtifactStore ArtifactStoreType
- asLocation :: Lens' ArtifactStore Text
- data BlockerDeclaration
- blockerDeclaration :: Text -> BlockerType -> BlockerDeclaration
- bdName :: Lens' BlockerDeclaration Text
- bdType :: Lens' BlockerDeclaration BlockerType
- data CurrentRevision
- currentRevision :: Text -> Text -> CurrentRevision
- crRevisionSummary :: Lens' CurrentRevision (Maybe Text)
- crCreated :: Lens' CurrentRevision (Maybe UTCTime)
- crRevision :: Lens' CurrentRevision Text
- crChangeIdentifier :: Lens' CurrentRevision Text
- data EncryptionKey
- encryptionKey :: Text -> EncryptionKeyType -> EncryptionKey
- ekId :: Lens' EncryptionKey Text
- ekType :: Lens' EncryptionKey EncryptionKeyType
- data ErrorDetails
- errorDetails :: ErrorDetails
- edCode :: Lens' ErrorDetails (Maybe Text)
- edMessage :: Lens' ErrorDetails (Maybe Text)
- data ExecutionDetails
- executionDetails :: ExecutionDetails
- edSummary :: Lens' ExecutionDetails (Maybe Text)
- edExternalExecutionId :: Lens' ExecutionDetails (Maybe Text)
- edPercentComplete :: Lens' ExecutionDetails (Maybe Natural)
- data FailureDetails
- failureDetails :: FailureType -> Text -> FailureDetails
- fdExternalExecutionId :: Lens' FailureDetails (Maybe Text)
- fdType :: Lens' FailureDetails FailureType
- fdMessage :: Lens' FailureDetails Text
- data InputArtifact
- inputArtifact :: Text -> InputArtifact
- iaName :: Lens' InputArtifact Text
- data Job
- job :: Job
- jData :: Lens' Job (Maybe JobData)
- jAccountId :: Lens' Job (Maybe Text)
- jId :: Lens' Job (Maybe Text)
- jNonce :: Lens' Job (Maybe Text)
- data JobData
- jobData :: JobData
- jdContinuationToken :: Lens' JobData (Maybe Text)
- jdOutputArtifacts :: Lens' JobData [Artifact]
- jdArtifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials)
- jdPipelineContext :: Lens' JobData (Maybe PipelineContext)
- jdEncryptionKey :: Lens' JobData (Maybe EncryptionKey)
- jdActionTypeId :: Lens' JobData (Maybe ActionTypeId)
- jdInputArtifacts :: Lens' JobData [Artifact]
- jdActionConfiguration :: Lens' JobData (Maybe ActionConfiguration)
- data JobDetails
- jobDetails :: JobDetails
- jdData :: Lens' JobDetails (Maybe JobData)
- jdAccountId :: Lens' JobDetails (Maybe Text)
- jdId :: Lens' JobDetails (Maybe Text)
- data OutputArtifact
- outputArtifact :: Text -> OutputArtifact
- oaName :: Lens' OutputArtifact Text
- data PipelineContext
- pipelineContext :: PipelineContext
- pcStage :: Lens' PipelineContext (Maybe StageContext)
- pcPipelineName :: Lens' PipelineContext (Maybe Text)
- pcAction :: Lens' PipelineContext (Maybe ActionContext)
- data PipelineDeclaration
- pipelineDeclaration :: Text -> Text -> ArtifactStore -> PipelineDeclaration
- pdVersion :: Lens' PipelineDeclaration (Maybe Natural)
- pdName :: Lens' PipelineDeclaration Text
- pdRoleARN :: Lens' PipelineDeclaration Text
- pdArtifactStore :: Lens' PipelineDeclaration ArtifactStore
- pdStages :: Lens' PipelineDeclaration [StageDeclaration]
- data PipelineExecution
- pipelineExecution :: PipelineExecution
- peStatus :: Lens' PipelineExecution (Maybe PipelineExecutionStatus)
- pePipelineName :: Lens' PipelineExecution (Maybe Text)
- pePipelineVersion :: Lens' PipelineExecution (Maybe Natural)
- pePipelineExecutionId :: Lens' PipelineExecution (Maybe Text)
- peArtifactRevisions :: Lens' PipelineExecution [ArtifactRevision]
- data 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 StageExecution
- stageExecution :: Text -> StageExecutionStatus -> StageExecution
- sePipelineExecutionId :: Lens' StageExecution Text
- seStatus :: Lens' StageExecution StageExecutionStatus
- data StageState
- stageState :: StageState
- ssInboundTransitionState :: Lens' StageState (Maybe TransitionState)
- ssActionStates :: Lens' StageState [ActionState]
- ssStageName :: Lens' StageState (Maybe Text)
- ssLatestExecution :: Lens' StageState (Maybe StageExecution)
- data ThirdPartyJob
- thirdPartyJob :: ThirdPartyJob
- tpjClientId :: Lens' ThirdPartyJob (Maybe Text)
- tpjJobId :: Lens' ThirdPartyJob (Maybe Text)
- data ThirdPartyJobData
- thirdPartyJobData :: ThirdPartyJobData
- tpjdContinuationToken :: Lens' ThirdPartyJobData (Maybe Text)
- tpjdOutputArtifacts :: Lens' ThirdPartyJobData [Artifact]
- tpjdArtifactCredentials :: Lens' ThirdPartyJobData (Maybe AWSSessionCredentials)
- tpjdPipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext)
- tpjdEncryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey)
- tpjdActionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId)
- tpjdInputArtifacts :: Lens' ThirdPartyJobData [Artifact]
- tpjdActionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration)
- data ThirdPartyJobDetails
- thirdPartyJobDetails :: ThirdPartyJobDetails
- tpjdData :: Lens' ThirdPartyJobDetails (Maybe ThirdPartyJobData)
- tpjdId :: Lens' ThirdPartyJobDetails (Maybe Text)
- tpjdNonce :: Lens' ThirdPartyJobDetails (Maybe Text)
- data TransitionState
- transitionState :: TransitionState
- tsEnabled :: Lens' TransitionState (Maybe Bool)
- tsDisabledReason :: Lens' TransitionState (Maybe Text)
- tsLastChangedAt :: Lens' TransitionState (Maybe UTCTime)
- tsLastChangedBy :: Lens' TransitionState (Maybe Text)
Service Configuration
codePipeline :: Service Source #
API version 2015-07-09 of the Amazon CodePipeline SDK configuration.
Errors
_InvalidClientTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client token was specified in an invalid format
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The validation was specified in an invalid format.
_InvalidNonceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified nonce was specified in an invalid format.
_ActionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified action cannot be found.
_InvalidApprovalTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The approval request already received a response or has expired.
_InvalidBlockerDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Reserved for future use.
_InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified job state was specified in an invalid format.
_InvalidJobException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified job was specified in an invalid format or cannot be found.
_PipelineVersionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pipeline version was specified in an invalid format or cannot be found.
_StageNotRetryableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified stage can't be retried because the pipeline structure or stage state changed after the stage was not completed; the stage contains no failed actions; one or more actions are still in progress; or another retry attempt is already in progress.
_PipelineExecutionNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
_ActionTypeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified action type cannot be found.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified stage declaration was specified in an invalid format.
_InvalidActionDeclarationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified action declaration was specified in an invalid format.
_StageNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified stage was specified in an invalid format or cannot be found.
_InvalidStructureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified structure was specified in an invalid format.
_JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified job was specified in an invalid format or cannot be found.
_ApprovalAlreadyCompletedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The approval action has already been approved or rejected.
_PipelineNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pipeline name is already in use.
_PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pipeline was specified in an invalid format or cannot be found.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
_NotLatestPipelineExecutionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.
ActionCategory
data ActionCategory Source #
Instances
ActionConfigurationPropertyType
data ActionConfigurationPropertyType Source #
Instances
ActionExecutionStatus
data ActionExecutionStatus Source #
Constructors
| AESFailed | |
| AESInProgress | |
| AESSucceeded |
Instances
ActionOwner
data ActionOwner Source #
Constructors
| AWS | |
| Custom | |
| ThirdParty |
Instances
ApprovalStatus
data ApprovalStatus Source #
Instances
ArtifactLocationType
data ArtifactLocationType Source #
Constructors
| ALTS3 |
Instances
ArtifactStoreType
data ArtifactStoreType Source #
Constructors
| S3 |
Instances
BlockerType
data BlockerType Source #
Constructors
| Schedule |
Instances
EncryptionKeyType
data EncryptionKeyType Source #
Constructors
| KMS |
Instances
FailureType
data FailureType Source #
Constructors
| ConfigurationError | |
| JobFailed | |
| PermissionError | |
| RevisionOutOfSync | |
| RevisionUnavailable | |
| SystemUnavailable |
Instances
JobStatus
Constructors
| JSCreated | |
| JSDispatched | |
| JSFailed | |
| JSInProgress | |
| JSQueued | |
| JSSucceeded | |
| JSTimedOut |
Instances
PipelineExecutionStatus
data PipelineExecutionStatus Source #
Constructors
| Failed | |
| InProgress | |
| Succeeded | |
| Superseded |
Instances
StageExecutionStatus
data StageExecutionStatus Source #
Constructors
| SESFailed | |
| SESInProgress | |
| SESSucceeded |
Instances
StageRetryMode
data StageRetryMode Source #
Constructors
| FailedActions |
Instances
StageTransitionType
data StageTransitionType Source #
Instances
AWSSessionCredentials
data AWSSessionCredentials Source #
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
See: awsSessionCredentials smart constructor.
Instances
awsSessionCredentials Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AWSSessionCredentials |
Creates a value of AWSSessionCredentials with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ascAccessKeyId- The access key for the session.ascSecretAccessKey- The secret access key for the session.ascSessionToken- The token for the session.
ascAccessKeyId :: Lens' AWSSessionCredentials Text 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.
Instances
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- The configuration data for the action.
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.
Instances
actionConfigurationProperty Source #
Arguments
| :: Text | |
| -> Bool | |
| -> Bool | |
| -> Bool | |
| -> ActionConfigurationProperty |
Creates a value of ActionConfigurationProperty with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acpQueryable- Indicates that the 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- The type of the configuration property.acpDescription- The description of the action configuration property that will be displayed to users.acpName- The name of the action configuration property.acpRequired- Whether the configuration property is a required value.acpKey- Whether the configuration property is a key.acpSecret- Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.
acpQueryable :: Lens' ActionConfigurationProperty (Maybe Bool) 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- The name of the action within the context of a job.
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.
Instances
Arguments
| :: Text | |
| -> ActionTypeId | |
| -> ActionDeclaration |
Creates a value of ActionDeclaration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
adOutputArtifacts- The name or ID of the result of the action declaration, such as a test or build artifact.adRunOrder- The order in which actions are run.adConfiguration- The action declaration's configuration.adInputArtifacts- The name or ID of the artifact consumed by the action, such as a test or build artifact.adRoleARN- The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.adName- The action declaration's name.adActionTypeId- The configuration information for the action type.
adOutputArtifacts :: Lens' ActionDeclaration [OutputArtifact] 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.
adActionTypeId :: Lens' ActionDeclaration ActionTypeId Source #
The configuration information for the action type.
ActionExecution
data ActionExecution Source #
Represents information about the run of an action.
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:
aeLastUpdatedBy- The ARN of the user who last changed the pipeline.aeSummary- A summary of the run of the action.aeStatus- The status of the action, or for a completed action, the last status of the action.aeLastStatusChange- The last status change of the action.aeToken- The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command and is used to validate that the approval request corresponding to this token is still valid.aeExternalExecutionURL- The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.aeExternalExecutionId- The external ID of the run of the action.aeErrorDetails- The details of an error returned by a URL external to AWS.aePercentComplete- A percentage of completeness of the action as it runs.
aeLastUpdatedBy :: Lens' ActionExecution (Maybe Text) Source #
The ARN of the user who last changed the pipeline.
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.
aeToken :: 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 and is used to validate that the approval request corresponding to this token is still valid.
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.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ActionRevision |
Creates a value of ActionRevision with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aRevisionId- The system-generated unique ID that identifies the revision number of the action.aRevisionChangeId- The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.aCreated- The date and time when the most recent version of the action was created, in timestamp format.
aRevisionId :: Lens' ActionRevision Text Source #
The system-generated unique ID that identifies the revision number of the action.
aRevisionChangeId :: Lens' ActionRevision Text Source #
The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.
aCreated :: 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- A URL link for more information about the revision, such as a commit details page.asEntityURL- A URL link for more information about the state of the action, such as a deployment group details page.asActionName- The name of the action.asCurrentRevision- Undocumented member.asLatestExecution- Undocumented member.
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.
Instances
Arguments
| :: ActionTypeId | |
| -> ArtifactDetails | |
| -> ArtifactDetails | |
| -> ActionType |
Creates a value of ActionType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atSettings- The settings for the action type.atActionConfigurationProperties- The configuration properties for the action type.atId- Undocumented member.atInputArtifactDetails- The details of the input artifact for the action, such as its commit ID.atOutputArtifactDetails- The details of the output artifact of the action, such as its commit ID.
atSettings :: Lens' ActionType (Maybe ActionTypeSettings) 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.
Arguments
| :: ActionCategory | |
| -> ActionOwner | |
| -> Text | |
| -> Text | |
| -> ActionTypeId |
Creates a value of ActionTypeId with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
atiCategory- A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.atiOwner- The creator of the action being called.atiProvider- The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.atiVersion- A string that identifies the action type.
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.
Instances
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- The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.atsExecutionURLTemplate- The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.atsRevisionURLTemplate- The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.atsEntityURLTemplate- The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.
atsThirdPartyConfigurationURL :: Lens' ActionTypeSettings (Maybe Text) 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.
ApprovalResult
data ApprovalResult Source #
Represents information about the result of an approval request.
See: approvalResult smart constructor.
Arguments
| :: Text | |
| -> ApprovalStatus | |
| -> ApprovalResult |
Creates a value of ApprovalResult with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arSummary :: Lens' ApprovalResult Text Source #
The summary of the current status of the approval request.
arStatus :: Lens' ApprovalResult ApprovalStatus Source #
The response submitted by a reviewer assigned to an approval action request.
Artifact
Represents information about an artifact that will be worked upon by actions in the pipeline.
See: artifact smart constructor.
Creates a value of Artifact with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aRevision :: Lens' Artifact (Maybe Text) 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.
Instances
Arguments
| :: Natural | |
| -> Natural | |
| -> ArtifactDetails |
Creates a value of ArtifactDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
adMinimumCount- The minimum number of artifacts allowed for the action type.adMaximumCount- The maximum number of artifacts allowed for the action type.
adMinimumCount :: Lens' ArtifactDetails Natural 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.
Instances
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- The Amazon S3 bucket that contains the artifact.alType- The type of artifact in the location.
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.
ArtifactRevision
data ArtifactRevision Source #
Represents revision details of an artifact.
See: artifactRevision smart constructor.
Instances
artifactRevision :: ArtifactRevision Source #
Creates a value of ArtifactRevision with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arRevisionSummary- Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of acodepipeline-artifact-revision-summarykey specified in the object metadata.arRevisionURL- The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.arCreated- The date and time when the most recent revision of the artifact was created, in timestamp format.arName- The name of an artifact. This name might be system-generated, such as MyApp, or might be defined by the user when an action is created.arRevisionId- The revision ID of the artifact.arRevisionChangeIdentifier- An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
arRevisionSummary :: Lens' ArtifactRevision (Maybe Text) 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.
arRevisionURL :: 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.
arCreated :: Lens' ArtifactRevision (Maybe UTCTime) Source #
The date and time when the most recent revision of the artifact was created, in timestamp format.
arName :: Lens' ArtifactRevision (Maybe Text) Source #
The name of an artifact. This name might be system-generated, such as MyApp, or might be defined by the user when an action is created.
arRevisionId :: Lens' ArtifactRevision (Maybe Text) Source #
The revision ID of the artifact.
arRevisionChangeIdentifier :: Lens' ArtifactRevision (Maybe Text) Source #
An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
ArtifactStore
data ArtifactStore Source #
The 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.
Instances
Arguments
| :: ArtifactStoreType | |
| -> Text | |
| -> ArtifactStore |
Creates a value of ArtifactStore with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asEncryptionKey- The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.asType- The type of the artifact store, such as S3.asLocation- The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
asEncryptionKey :: 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.
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 #
Reserved for future use.
See: blockerDeclaration smart constructor.
Instances
Arguments
| :: Text | |
| -> BlockerType | |
| -> BlockerDeclaration |
Creates a value of BlockerDeclaration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdType :: Lens' BlockerDeclaration BlockerType Source #
Reserved for future use.
CurrentRevision
data CurrentRevision Source #
Represents information about a current revision.
See: currentRevision smart constructor.
Arguments
| :: Text | |
| -> Text | |
| -> CurrentRevision |
Creates a value of CurrentRevision with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crRevisionSummary- The summary of the most recent revision of the artifact.crCreated- The date and time when the most recent revision of the artifact was created, in timestamp format.crRevision- The revision ID of the current version of an artifact.crChangeIdentifier- The change identifier for the current revision.
crRevisionSummary :: Lens' CurrentRevision (Maybe Text) Source #
The summary of the most recent revision of the artifact.
crCreated :: Lens' CurrentRevision (Maybe UTCTime) Source #
The date and time when the most recent revision of the artifact was created, in timestamp format.
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 key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
See: encryptionKey smart constructor.
Instances
Arguments
| :: Text | |
| -> EncryptionKeyType | |
| -> EncryptionKey |
Creates a value of EncryptionKey with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ekId :: Lens' EncryptionKey Text Source #
The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.
ekType :: Lens' EncryptionKey EncryptionKeyType Source #
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to KMS.
ErrorDetails
data ErrorDetails Source #
Represents information about an error in AWS CodePipeline.
See: 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.
Instances
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- The summary of the current status of the actions.edExternalExecutionId- The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.edPercentComplete- The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
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.
Arguments
| :: FailureType | |
| -> Text | |
| -> FailureDetails |
Creates a value of FailureDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fdExternalExecutionId- The external ID of the run of the action that failed.fdType- The type of the failure.fdMessage- The message about the failure.
fdExternalExecutionId :: Lens' FailureDetails (Maybe Text) Source #
The external ID of the run of the action that failed.
fdType :: Lens' FailureDetails FailureType Source #
The type of 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.
Instances
Arguments
| :: Text | |
| -> InputArtifact |
Creates a value of InputArtifact with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaName- The name of the artifact to be worked on, for example, "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
iaName :: Lens' InputArtifact Text 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:
jData- Additional data about a job.jAccountId- The ID of the AWS account to use when performing the job.jId- The unique system-generated ID of the job.jNonce- A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
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- A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.jdOutputArtifacts- The output of the job.jdArtifactCredentials- Undocumented member.jdPipelineContext- Undocumented member.jdEncryptionKey- Undocumented member.jdActionTypeId- Undocumented member.jdInputArtifacts- The artifact supplied to the job.jdActionConfiguration- Undocumented member.
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.
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.
jdActionConfiguration :: Lens' JobData (Maybe ActionConfiguration) Source #
Undocumented member.
JobDetails
data JobDetails Source #
Represents information about the details of a job.
See: jobDetails smart constructor.
Instances
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:
jdData- Undocumented member.jdAccountId- The AWS account ID associated with the job.jdId- The unique system-generated ID of the job.
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.
Instances
Arguments
| :: Text | |
| -> OutputArtifact |
Creates a value of OutputArtifact with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oaName- The name of the output of an artifact, such as "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. Output artifact names must be unique within a pipeline.
oaName :: Lens' OutputArtifact Text 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- The stage of the pipeline.pcPipelineName- The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.pcAction- Undocumented member.
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.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ArtifactStore | |
| -> PipelineDeclaration |
Creates a value of PipelineDeclaration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdVersion- The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.pdName- The name of the action to be performed.pdRoleARN- The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.pdArtifactStore- Undocumented member.pdStages- The stage in which to perform the action.
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.
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.
PipelineExecution
data PipelineExecution Source #
Represents information about an execution of a pipeline.
See: pipelineExecution smart constructor.
Instances
pipelineExecution :: PipelineExecution Source #
Creates a value of PipelineExecution with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
peStatus- The status of the pipeline execution. * InProgress: The pipeline execution is currently running. * Succeeded: The pipeline execution completed successfully. * Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution caught up and continued through the pipeline instead. * Failed: The pipeline did not complete successfully.pePipelineName- The name of the pipeline that was executed.pePipelineVersion- The version number of the pipeline that was executed.pePipelineExecutionId- The ID of the pipeline execution.peArtifactRevisions- A list of ArtifactRevision objects included in a pipeline execution.
peStatus :: Lens' PipelineExecution (Maybe PipelineExecutionStatus) Source #
The status of the pipeline execution. * InProgress: The pipeline execution is currently running. * Succeeded: The pipeline execution completed successfully. * Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution caught up and continued through the pipeline instead. * Failed: The pipeline did not complete successfully.
pePipelineName :: Lens' PipelineExecution (Maybe Text) Source #
The name of the pipeline that was executed.
pePipelineVersion :: Lens' PipelineExecution (Maybe Natural) Source #
The version number of the pipeline that was executed.
pePipelineExecutionId :: Lens' PipelineExecution (Maybe Text) Source #
The ID of the pipeline execution.
peArtifactRevisions :: Lens' PipelineExecution [ArtifactRevision] Source #
A list of ArtifactRevision objects included in a pipeline execution.
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.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> S3ArtifactLocation |
Creates a value of S3ArtifactLocation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
salBucketName- The name of the Amazon S3 bucket.salObjectKey- The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.
salBucketName :: Lens' S3ArtifactLocation Text 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:
scName- The name of the stage.
StageDeclaration
data StageDeclaration Source #
Represents information about a stage and its definition.
See: stageDeclaration smart constructor.
Instances
Arguments
| :: Text | |
| -> StageDeclaration |
Creates a value of StageDeclaration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdBlockers- Reserved for future use.sdName- The name of the stage.sdActions- The actions included in a stage.
sdBlockers :: Lens' StageDeclaration [BlockerDeclaration] Source #
Reserved for future use.
sdActions :: Lens' StageDeclaration [ActionDeclaration] Source #
The actions included in a stage.
StageExecution
data StageExecution Source #
Represents information about the run of a stage.
See: stageExecution smart constructor.
Arguments
| :: Text | |
| -> StageExecutionStatus | |
| -> StageExecution |
Creates a value of StageExecution with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sePipelineExecutionId- The ID of the pipeline execution associated with the stage.seStatus- The status of the stage, or for a completed stage, the last status of the stage.
sePipelineExecutionId :: Lens' StageExecution Text Source #
The ID of the pipeline execution associated with the stage.
seStatus :: Lens' StageExecution StageExecutionStatus Source #
The status of the stage, or for a completed stage, the last status of the stage.
StageState
data StageState Source #
Represents information about the state of the stage.
See: stageState smart constructor.
Instances
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- The state of the inbound transition, which is either enabled or disabled.ssActionStates- The state of the stage.ssStageName- The name of the stage.ssLatestExecution- Information about the latest execution in the stage, including its ID and status.
ssInboundTransitionState :: Lens' StageState (Maybe TransitionState) 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.
ssLatestExecution :: Lens' StageState (Maybe StageExecution) Source #
Information about the latest execution in the stage, including its ID and status.
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- The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.tpjJobId- The identifier used to identify the job in AWS CodePipeline.
tpjClientId :: Lens' ThirdPartyJob (Maybe Text) 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.
Instances
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- A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.tpjdOutputArtifacts- The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as MyBuiltApp, or might be defined by the user when the action is created.tpjdArtifactCredentials- Undocumented member.tpjdPipelineContext- Undocumented member.tpjdEncryptionKey- The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.tpjdActionTypeId- Undocumented member.tpjdInputArtifacts- The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as MyApp, or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.tpjdActionConfiguration- Undocumented member.
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 encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.
tpjdActionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId) 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.
Instances
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- The data to be returned by the third party job worker.tpjdId- The identifier used to identify the job details in AWS CodePipeline.tpjdNonce- A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.
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- Whether the transition between stages is enabled (true) or disabled (false).tsDisabledReason- The user-specified reason why the transition between two stages of a pipeline was disabled.tsLastChangedAt- The timestamp when the transition state was last changed.tsLastChangedBy- The ID of the user who last changed the transition state.
tsEnabled :: Lens' TransitionState (Maybe Bool) 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.