Package-level declarations

Types

Link copied to clipboard

Represents the input of an AcknowledgeJob action.

Link copied to clipboard

Represents the output of an AcknowledgeJob action.

Link copied to clipboard

Represents the input of an AcknowledgeThirdPartyJob action.

Link copied to clipboard

Represents the output of an AcknowledgeThirdPartyJob action.

Link copied to clipboard
sealed class ActionCategory
Link copied to clipboard

Represents information about an action configuration.

Link copied to clipboard

Represents information about an action configuration property.

Link copied to clipboard

Represents the context of an action in the stage of a pipeline to a job worker.

Link copied to clipboard

Represents information about an action declaration.

Link copied to clipboard

Represents information about the run of an action.

Link copied to clipboard

Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.

Link copied to clipboard

Filter values for the action execution.

Link copied to clipboard

Input information used for an action execution.

Link copied to clipboard

The action execution was not found.

Link copied to clipboard

Output details listed for an action execution, such as the action execution result.

Link copied to clipboard

Execution result information, such as the external execution ID.

Link copied to clipboard
Link copied to clipboard

The specified action cannot be found.

Link copied to clipboard
sealed class ActionOwner
Link copied to clipboard

Represents information about the version (or revision) of an action.

Link copied to clipboard

Represents information about the state of an action.

Link copied to clipboard

Returns information about the details of an action type.

Link copied to clipboard

Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.

Link copied to clipboard

The parameters for the action type definition that are provided when the action type is created or updated.

Link copied to clipboard

The action engine, or executor, for an action type created for a provider, where the action is to be used by customers of the provider. The action engine is associated with the model used to create and update the action, such as the Lambda integration model.

Link copied to clipboard

Represents information about an action type.

Link copied to clipboard

Specifies the category, owner, provider, and version of the action type.

Link copied to clipboard

The specified action type cannot be found.

Link copied to clipboard

Details identifying the users with permissions to use the action type.

Link copied to clipboard

Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.

Link copied to clipboard

Returns information about the settings for an action type.

Link copied to clipboard

Returns information about URLs for web pages that display to customers as links on the pipeline view, such as an external configuration page for the action type.

Link copied to clipboard

The approval action has already been approved or rejected.

Link copied to clipboard

Represents information about the result of an approval request.

Link copied to clipboard
sealed class ApprovalStatus
Link copied to clipboard
class Artifact

Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip

Link copied to clipboard

Artifact details for the action execution, such as the artifact location.

Link copied to clipboard

Returns information about the details of an artifact.

Link copied to clipboard

Represents information about the location of an artifact.

Link copied to clipboard
Link copied to clipboard

Represents revision details of an artifact.

Link copied to clipboard

The S3 bucket where artifacts for the pipeline are stored.

Link copied to clipboard
sealed class ArtifactStoreType
Link copied to clipboard

Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in CodePipeline.

Link copied to clipboard

The conditions for making checks for entry to a stage. For more information about conditions, see Stage conditions and How do stage conditions work?.

Link copied to clipboard

Reserved for future use.

Link copied to clipboard
sealed class BlockerType
Link copied to clipboard

Base class for all service related exceptions thrown by the CodePipeline client

Link copied to clipboard

Unable to modify the tag due to a simultaneous update request.

The pipeline has reached the limit for concurrent pipeline executions.

Link copied to clipboard
class Condition

The condition for the stage. A condition is made up of the rules and the result for the condition. For more information about conditions, see Stage conditions and How do stage conditions work?.. For more information about rules, see the CodePipeline rule reference.

Link copied to clipboard

The run of a condition.

Link copied to clipboard
Link copied to clipboard

Unable to override because the condition does not allow overrides.

Link copied to clipboard

Information about the state of the condition.

Link copied to clipboard
sealed class ConditionType
Link copied to clipboard

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

Link copied to clipboard

Represents the input of a CreateCustomActionType operation.

Link copied to clipboard

Represents the output of a CreateCustomActionType operation.

Link copied to clipboard

Represents the input of a CreatePipeline action.

Link copied to clipboard

Represents the output of a CreatePipeline action.

Link copied to clipboard

Represents information about a current revision.

Link copied to clipboard

Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.

Link copied to clipboard

Represents the input of a DeletePipeline action.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The target for the deploy action.

Link copied to clipboard

A lifecycle event for the deploy action.

Link copied to clipboard

The context for the event for the deploy action.

Link copied to clipboard

Represents the input of a DisableStageTransition action.

Link copied to clipboard

The pipeline execution is already in a Stopping state. If you already chose to stop and wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you cannot make that request again.

Link copied to clipboard

Represents the input of an EnableStageTransition action.

Link copied to clipboard

Represents information about the key used to encrypt data in the artifact store, such as an Amazon Web Services Key Management Service (Key Management Service) key.

Link copied to clipboard
sealed class EncryptionKeyType
Link copied to clipboard

The environment variables for the action.

Link copied to clipboard
Link copied to clipboard

Represents information about an error in CodePipeline.

Link copied to clipboard

The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

Link copied to clipboard
sealed class ExecutionMode
Link copied to clipboard

The interaction or event that started a pipeline execution.

Link copied to clipboard
sealed class ExecutionType
Link copied to clipboard

The action engine, or executor, related to the supported integration model used to create and update the action type. The available executor types are Lambda and JobWorker.

Link copied to clipboard
sealed class ExecutorType
Link copied to clipboard

The configuration that specifies the result, such as rollback, to occur upon stage failure. For more information about conditions, see Stage conditions and How do stage conditions work?.

Link copied to clipboard

Represents information about failure details.

Link copied to clipboard
sealed class FailureType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents the input of a GetJobDetails action.

Link copied to clipboard

Represents the output of a GetJobDetails action.

Link copied to clipboard

Represents the input of a GetPipelineExecution action.

Link copied to clipboard

Represents the output of a GetPipelineExecution action.

Link copied to clipboard

Represents the input of a GetPipeline action.

Link copied to clipboard

Represents the output of a GetPipeline action.

Link copied to clipboard

Represents the input of a GetPipelineState action.

Link copied to clipboard

Represents the output of a GetPipelineState action.

Link copied to clipboard

Represents the input of a GetThirdPartyJobDetails action.

Link copied to clipboard

Represents the output of a GetThirdPartyJobDetails action.

Link copied to clipboard

The Git repository branches specified as filter criteria to start the pipeline.

Link copied to clipboard

A type of trigger configuration for Git-based source actions.

Link copied to clipboard

The Git repository file paths specified as filter criteria to start the pipeline.

Link copied to clipboard
Link copied to clipboard

The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.

Link copied to clipboard

The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.

Link copied to clipboard

The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.

Link copied to clipboard

Represents information about an artifact to be worked on, such as a test or build artifact.

Link copied to clipboard

The action declaration was specified in an invalid format.

Link copied to clipboard

The approval request already received a response or has expired.

Link copied to clipboard

The specified resource ARN is invalid.

Link copied to clipboard
Link copied to clipboard

The client token was specified in an invalid format

Link copied to clipboard

The job was specified in an invalid format or cannot be found.

Link copied to clipboard

The job state was specified in an invalid format.

Link copied to clipboard

The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.

Link copied to clipboard

The nonce was specified in an invalid format.

Link copied to clipboard

The stage declaration was specified in an invalid format.

Link copied to clipboard

The structure was specified in an invalid format.

Link copied to clipboard

The specified resource tags are invalid.

The specified authentication type is in an invalid format.

Link copied to clipboard

The specified event filter rule is in an invalid format.

Link copied to clipboard
class Job

Represents information about a job.

Link copied to clipboard
class JobData

Represents other information about a job required for a job worker to complete the job.

Link copied to clipboard

Represents information about the details of a job.

Link copied to clipboard

The job was specified in an invalid format or cannot be found.

Link copied to clipboard
sealed class JobStatus
Link copied to clipboard

Details about the polling configuration for the JobWorker action engine, or executor.

Link copied to clipboard

Details about the configuration for the Lambda action engine, or executor.

Link copied to clipboard

The field that specifies to filter on the latest execution in the pipeline.

Link copied to clipboard

The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.

Link copied to clipboard

Represents the input of a ListActionTypes action.

Link copied to clipboard

Represents the output of a ListActionTypes action.

Link copied to clipboard

Represents the input of a ListPipelineExecutions action.

Link copied to clipboard

Represents the output of a ListPipelineExecutions action.

Link copied to clipboard

Represents the input of a ListPipelines action.

Link copied to clipboard

Represents the output of a ListPipelines action.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

Link copied to clipboard

Represents information about the output of an action.

Link copied to clipboard

Exceeded the total size limit for all variables in the pipeline.

Link copied to clipboard

Represents information about a pipeline to a job worker.

Link copied to clipboard

Represents the structure of actions and stages to be performed in the pipeline.

Link copied to clipboard

Represents information about an execution of a pipeline.

Link copied to clipboard

The pipeline execution to filter on.

Link copied to clipboard

The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.

Link copied to clipboard

Unable to stop the pipeline execution. The execution might already be in a Stopped state, or it might no longer be in progress.

Link copied to clipboard

The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.

Link copied to clipboard
Link copied to clipboard

Summary information about a pipeline execution.

Link copied to clipboard

Information about a pipeline.

Link copied to clipboard

The specified pipeline name is already in use.

Link copied to clipboard

The pipeline was specified in an invalid format or cannot be found.

Link copied to clipboard

The metadata for the stage execution to be rolled back.

Link copied to clipboard

Returns a summary of a pipeline.

Link copied to clipboard

Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.

Link copied to clipboard
Link copied to clipboard
sealed class PipelineType
Link copied to clipboard

A pipeline-level variable used for a pipeline execution.

Link copied to clipboard

A variable declared at the pipeline level.

Link copied to clipboard

The pipeline version was specified in an invalid format or cannot be found.

Link copied to clipboard

Represents the input of a PollForJobs action.

Link copied to clipboard

Represents the output of a PollForJobs action.

Link copied to clipboard

Represents the input of a PollForThirdPartyJobs action.

Link copied to clipboard

Represents the output of a PollForThirdPartyJobs action.

Link copied to clipboard

Represents the input of a PutActionRevision action.

Link copied to clipboard

Represents the output of a PutActionRevision action.

Link copied to clipboard

Represents the input of a PutApprovalResult action.

Link copied to clipboard

Represents the output of a PutApprovalResult action.

Link copied to clipboard

Represents the input of a PutJobFailureResult action.

Link copied to clipboard

Represents the input of a PutJobSuccessResult action.

Link copied to clipboard

Represents the input of a PutThirdPartyJobFailureResult action.

Link copied to clipboard

Represents the input of a PutThirdPartyJobSuccessResult action.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request failed because of an unknown error, exception, or failure.

Link copied to clipboard

A pipeline-level variable used for a pipeline execution.

Link copied to clipboard

The resource was specified in an invalid format.

Link copied to clipboard
sealed class Result
Link copied to clipboard

The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.

Link copied to clipboard

Represents the input of a RetryStageExecution action.

Link copied to clipboard

Represents the output of a RetryStageExecution action.

Link copied to clipboard

The details of a specific automatic retry on stage failure, including the attempt number and trigger.

Link copied to clipboard
sealed class RetryTrigger
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class RuleCategory
Link copied to clipboard

Represents information about a rule configuration property.

Link copied to clipboard
Link copied to clipboard

Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. For more information about conditions, see Stage conditions and How do stage conditions work?. For more information about rules, see the CodePipeline rule reference.

Link copied to clipboard

Represents information about each time a rule is run as part of the pipeline execution for a pipeline configured with conditions.

Link copied to clipboard

The details of the runs for a rule and the results produced on an artifact as it passes through stages in the pipeline.

Link copied to clipboard

Filter values for the rule execution.

Link copied to clipboard

Input information used for a rule execution.

Link copied to clipboard

Output details listed for a rule execution, such as the rule execution result.

Link copied to clipboard

Execution result information, such as the external execution ID.

Link copied to clipboard
sealed class RuleExecutionStatus
Link copied to clipboard
sealed class RuleOwner
Link copied to clipboard

The change to a rule that creates a revision of the rule.

Link copied to clipboard
class RuleState

Returns information about the state of a rule.

Link copied to clipboard
class RuleType

The rule type, which is made up of the combined values for category, owner, provider, and version.

Link copied to clipboard

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. For more information about conditions, see Stage conditions. For more information about rules, see the CodePipeline rule reference.

Link copied to clipboard

Returns information about the settings for a rule type.

Link copied to clipboard

The location of the S3 bucket that contains a revision.

Link copied to clipboard

The Amazon S3 artifact location for an action's artifacts.

Link copied to clipboard

Information about the version (or revision) of a source artifact that initiated a pipeline execution.

Link copied to clipboard

A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

Link copied to clipboard
sealed class SourceRevisionType
Link copied to clipboard

Represents information about the run of a condition for a stage.

Link copied to clipboard

The state of a run of a condition for a stage.

Link copied to clipboard

Represents information about a stage to a job worker.

Link copied to clipboard

Represents information about a stage and its definition.

Link copied to clipboard

Represents information about the run of a stage.

Link copied to clipboard
Link copied to clipboard

The stage was specified in an invalid format or cannot be found.

Link copied to clipboard

Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.

Link copied to clipboard
sealed class StageRetryMode
Link copied to clipboard

Represents information about the state of the stage.

Link copied to clipboard
sealed class StageTransitionType
Link copied to clipboard

Represents the input of a StartPipelineExecution action.

Link copied to clipboard

Represents the output of a StartPipelineExecution action.

Link copied to clipboard
sealed class StartTimeRange
Link copied to clipboard

The interaction that stopped a pipeline execution.

Link copied to clipboard

Filter for pipeline executions that have successfully completed the stage in the current pipeline version.

Link copied to clipboard

The conditions for making checks that, if met, succeed a stage. For more information about conditions, see Stage conditions and How do stage conditions work?.

Link copied to clipboard
class Tag

A tag is a key-value pair that is used to manage the resource.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Filters the list of targets.

Link copied to clipboard
sealed class TargetFilterName
Link copied to clipboard

A response to a PollForThirdPartyJobs request returned by CodePipeline when there is a job to be worked on by a partner action.

Link copied to clipboard

Represents information about the job data for a partner action.

Link copied to clipboard

The details of a job sent in response to a GetThirdPartyJobDetails request.

Link copied to clipboard

The tags limit for a resource has been exceeded.

Link copied to clipboard

Represents information about the state of transitions between one stage and another stage.

Link copied to clipboard
sealed class TriggerType
Link copied to clipboard

Unable to roll back the stage. The cause might be if the pipeline version has changed since the target pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline execution ID was provided.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents the input of an UpdatePipeline action.

Link copied to clipboard

Represents the output of an UpdatePipeline action.

Link copied to clipboard

The validation was specified in an invalid format.

Link copied to clipboard

The authentication applied to incoming webhook trigger requests.

Link copied to clipboard
Link copied to clipboard

Represents information about a webhook and its definition.

Link copied to clipboard

The event criteria that specify when a webhook notification is sent to your URL.

Link copied to clipboard

The specified webhook was entered in an invalid format or cannot be found.