AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AcknowledgeJobRequest |
Container for the parameters to the AcknowledgeJob operation. Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only. |
|
AcknowledgeJobResponse |
Represents the output of an AcknowledgeJob action. |
|
AcknowledgeThirdPartyJobRequest |
Container for the parameters to the AcknowledgeThirdPartyJob operation. Confirms a job worker has received the specified job. Used for partner actions only. |
|
AcknowledgeThirdPartyJobResponse |
Represents the output of an AcknowledgeThirdPartyJob action. |
|
ActionConfiguration |
Represents information about an action configuration. |
|
ActionConfigurationProperty |
Represents information about an action configuration property. |
|
ActionContext |
Represents the context of an action in the stage of a pipeline to a job worker. |
|
ActionDeclaration |
Represents information about an action declaration. |
|
ActionExecution |
Represents information about the run of an action. |
|
ActionExecutionDetail |
Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action. |
|
ActionExecutionFilter |
Filter values for the action execution. |
|
ActionExecutionInput |
Input information used for an action execution. |
|
ActionExecutionOutput |
Output details listed for an action execution, such as the action execution result. |
|
ActionExecutionResult |
Execution result information, such as the external execution ID. |
|
ActionNotFoundException |
The specified action cannot be found. |
|
ActionRevision |
Represents information about the version (or revision) of an action. |
|
ActionState |
Represents information about the state of an action. |
|
ActionType |
Returns information about the details of an action type. |
|
ActionTypeArtifactDetails |
Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed. |
|
ActionTypeDeclaration |
The parameters for the action type definition that are provided when the action type is created or updated. |
|
ActionTypeExecutor |
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. |
|
ActionTypeId |
Represents information about an action type. |
|
ActionTypeIdentifier |
Specifies the category, owner, provider, and version of the action type. |
|
ActionTypeNotFoundException |
The specified action type cannot be found. |
|
ActionTypePermissions |
Details identifying the users with permissions to use the action type. |
|
ActionTypeProperty |
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. |
|
ActionTypeSettings |
Returns information about the settings for an action type. |
|
ActionTypeUrls |
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. |
|
ApprovalAlreadyCompletedException |
The approval action has already been approved or rejected. |
|
ApprovalResult |
Represents information about the result of an approval request. |
|
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 |
|
ArtifactDetail |
Artifact details for the action execution, such as the artifact location. |
|
ArtifactDetails |
Returns information about the details of an artifact. |
|
ArtifactLocation |
Represents information about the location of an artifact. |
|
ArtifactRevision |
Represents revision details of an artifact. |
|
ArtifactStore |
The S3 bucket where artifacts for the pipeline are stored.
You must include either |
|
AWSSessionCredentials |
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. |
|
BlockerDeclaration |
Reserved for future use. |
|
CodePipelinePaginatorFactory |
Paginators for the CodePipeline service |
|
ConcurrentModificationException |
Unable to modify the tag due to a simultaneous update request. |
|
ConcurrentPipelineExecutionsLimitExceededException |
The pipeline has reached the limit for concurrent pipeline executions. |
|
ConflictException |
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later. |
|
CreateCustomActionTypeRequest |
Container for the parameters to the CreateCustomActionType operation. Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions. |
|
CreateCustomActionTypeResponse |
Represents the output of a |
|
CreatePipelineRequest |
Container for the parameters to the CreatePipeline operation.
Creates a pipeline.
In the pipeline structure, you must include either |
|
CreatePipelineResponse |
Represents the output of a |
|
CurrentRevision |
Represents information about a current revision. |
|
DeleteCustomActionTypeRequest |
Container for the parameters to the DeleteCustomActionType operation.
Marks a custom action as deleted.
To re-create a custom action after it has been deleted you must use a string in the
version field that has never been used before. This string can be an incremented version
number, for example. To restore a deleted custom action, use a JSON file that is identical
to the deleted action, including the original string in the version field.
|
|
DeleteCustomActionTypeResponse |
This is the response object from the DeleteCustomActionType operation. |
|
DeletePipelineRequest |
Container for the parameters to the DeletePipeline operation. Deletes the specified pipeline. |
|
DeletePipelineResponse |
This is the response object from the DeletePipeline operation. |
|
DeleteWebhookRequest |
Container for the parameters to the DeleteWebhook operation. Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL. |
|
DeleteWebhookResponse |
This is the response object from the DeleteWebhook operation. |
|
DeregisterWebhookWithThirdPartyRequest |
Container for the parameters to the DeregisterWebhookWithThirdParty operation. Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub. |
|
DeregisterWebhookWithThirdPartyResponse |
This is the response object from the DeregisterWebhookWithThirdParty operation. |
|
DisableStageTransitionRequest |
Container for the parameters to the DisableStageTransition operation. Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. |
|
DisableStageTransitionResponse |
This is the response object from the DisableStageTransition operation. |
|
DuplicatedStopRequestException |
The pipeline execution is already in a |
|
EnableStageTransitionRequest |
Container for the parameters to the EnableStageTransition operation. Enables artifacts in a pipeline to transition to a stage in a pipeline. |
|
EnableStageTransitionResponse |
This is the response object from the EnableStageTransition operation. |
|
EncryptionKey |
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. |
|
ErrorDetails |
Represents information about an error in CodePipeline. |
|
ExecutionDetails |
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline. |
|
ExecutionTrigger |
The interaction or event that started a pipeline execution. |
|
ExecutorConfiguration |
The action engine, or executor, related to the supported integration model used to
create and update the action type. The available executor types are |
|
FailureDetails |
Represents information about failure details. |
|
GetActionTypeRequest |
Container for the parameters to the GetActionType operation. Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model. |
|
GetActionTypeResponse |
This is the response object from the GetActionType operation. |
|
GetJobDetailsRequest |
Container for the parameters to the GetJobDetails operation.
Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket
used to store artifacts for the pipeline, if the action requires access to that S3
bucket for input or output artifacts. This API also returns any secret values defined
for the action.
|
|
GetJobDetailsResponse |
Represents the output of a |
|
GetPipelineExecutionRequest |
Container for the parameters to the GetPipelineExecution operation. Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline. |
|
GetPipelineExecutionResponse |
Represents the output of a |
|
GetPipelineRequest |
Container for the parameters to the GetPipeline operation. Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline. |
|
GetPipelineResponse |
Represents the output of a |
|
GetPipelineStateRequest |
Container for the parameters to the GetPipelineState operation.
Returns information about the state of a pipeline, including the stages and actions.
Values returned in the |
|
GetPipelineStateResponse |
Represents the output of a |
|
GetThirdPartyJobDetailsRequest |
Container for the parameters to the GetThirdPartyJobDetails operation.
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket
used to store artifacts for the pipeline, if the action requires access to that S3
bucket for input or output artifacts. This API also returns any secret values defined
for the action.
|
|
GetThirdPartyJobDetailsResponse |
Represents the output of a |
|
GitBranchFilterCriteria |
The Git repository branches specified as filter criteria to start the pipeline. |
|
GitConfiguration |
A type of trigger configuration for Git-based source actions.
You can specify the Git configuration trigger type for all third-party Git-based source
actions that are supported by the |
|
GitFilePathFilterCriteria |
The Git repository file paths specified as filter criteria to start the pipeline. |
|
GitPullRequestFilter |
The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude. |
|
GitPushFilter |
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. |
|
GitTagFilterCriteria |
The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline. |
|
InputArtifact |
Represents information about an artifact to be worked on, such as a test or build artifact. |
|
InvalidActionDeclarationException |
The action declaration was specified in an invalid format. |
|
InvalidApprovalTokenException |
The approval request already received a response or has expired. |
|
InvalidArnException |
The specified resource ARN is invalid. |
|
InvalidBlockerDeclarationException |
Reserved for future use. |
|
InvalidClientTokenException |
The client token was specified in an invalid format |
|
InvalidJobException |
The job was specified in an invalid format or cannot be found. |
|
InvalidJobStateException |
The job state was specified in an invalid format. |
|
InvalidNextTokenException |
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call. |
|
InvalidNonceException |
The nonce was specified in an invalid format. |
|
InvalidStageDeclarationException |
The stage declaration was specified in an invalid format. |
|
InvalidStructureException |
The structure was specified in an invalid format. |
|
InvalidTagsException |
The specified resource tags are invalid. |
|
InvalidWebhookAuthenticationParametersException |
The specified authentication type is in an invalid format. |
|
InvalidWebhookFilterPatternException |
The specified event filter rule is in an invalid format. |
|
Job |
Represents information about a job. |
|
JobData |
Represents other information about a job required for a job worker to complete the job. |
|
JobDetails |
Represents information about the details of a job. |
|
JobNotFoundException |
The job was specified in an invalid format or cannot be found. |
|
JobWorkerExecutorConfiguration |
Details about the polling configuration for the |
|
LambdaExecutorConfiguration |
Details about the configuration for the |
|
LatestInPipelineExecutionFilter |
The field that specifies to filter on the latest execution in the pipeline.
Filtering on the latest execution is available for executions run on or after February
08, 2024.
|
|
LimitExceededException |
The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account. |
|
ListActionExecutionsRequest |
Container for the parameters to the ListActionExecutions operation. Lists the action executions that have occurred in a pipeline. |
|
ListActionExecutionsResponse |
This is the response object from the ListActionExecutions operation. |
|
ListActionTypesRequest |
Container for the parameters to the ListActionTypes operation. Gets a summary of all CodePipeline action types associated with your account. |
|
ListActionTypesResponse |
Represents the output of a |
|
ListPipelineExecutionsRequest |
Container for the parameters to the ListPipelineExecutions operation. Gets a summary of the most recent executions for a pipeline. |
|
ListPipelineExecutionsResponse |
Represents the output of a |
|
ListPipelinesRequest |
Container for the parameters to the ListPipelines operation. Gets a summary of all of the pipelines associated with your account. |
|
ListPipelinesResponse |
Represents the output of a |
|
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. Gets the set of key-value pairs (metadata) that are used to manage the resource. |
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
|
ListWebhookItem |
The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN. |
|
ListWebhooksRequest |
Container for the parameters to the ListWebhooks operation. Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook. |
|
ListWebhooksResponse |
This is the response object from the ListWebhooks operation. |
|
NotLatestPipelineExecutionException |
The stage has failed in a later run of the pipeline and the |
|
OutputArtifact |
Represents information about the output of an action. |
|
OutputVariablesSizeExceededException |
Exceeded the total size limit for all variables in the pipeline. |
|
PipelineContext |
Represents information about a pipeline to a job worker.
PipelineContext contains |
|
PipelineDeclaration |
Represents the structure of actions and stages to be performed in the pipeline. |
|
PipelineExecution |
Represents information about an execution of a pipeline. |
|
PipelineExecutionNotFoundException |
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline. |
|
PipelineExecutionNotStoppableException |
Unable to stop the pipeline execution. The execution might already be in a |
|
PipelineExecutionSummary |
Summary information about a pipeline execution. |
|
PipelineMetadata |
Information about a pipeline. |
|
PipelineNameInUseException |
The specified pipeline name is already in use. |
|
PipelineNotFoundException |
The pipeline was specified in an invalid format or cannot be found. |
|
PipelineSummary |
Returns a summary of a pipeline. |
|
PipelineTriggerDeclaration |
Represents information about the specified trigger configuration, such as the filter
criteria and the source stage for the action that contains the trigger.
This is only supported for the
When a trigger configuration is specified, default change detection for repository
and branch commits is disabled.
|
|
PipelineVariable |
A pipeline-level variable used for a pipeline execution. |
|
PipelineVariableDeclaration |
A variable declared at the pipeline level. |
|
PipelineVersionNotFoundException |
The pipeline version was specified in an invalid format or cannot be found. |
|
PollForJobsRequest |
Container for the parameters to the PollForJobs operation.
Returns information about any jobs for CodePipeline to act on.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket
used to store artifacts for the pipeline, if the action requires access to that S3
bucket for input or output artifacts. This API also returns any secret values defined
for the action.
|
|
PollForJobsResponse |
Represents the output of a |
|
PollForThirdPartyJobsRequest |
Container for the parameters to the PollForThirdPartyJobs operation.
Determines whether there are any third party jobs for a job worker to act on. Used
for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket
used to store artifacts for the pipeline, if the action requires access to that S3
bucket for input or output artifacts.
|
|
PollForThirdPartyJobsResponse |
Represents the output of a |
|
PutActionRevisionRequest |
Container for the parameters to the PutActionRevision operation. Provides information to CodePipeline about new revisions to a source. |
|
PutActionRevisionResponse |
Represents the output of a |
|
PutApprovalResultRequest |
Container for the parameters to the PutApprovalResult operation. Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected. |
|
PutApprovalResultResponse |
Represents the output of a |
|
PutJobFailureResultRequest |
Container for the parameters to the PutJobFailureResult operation. Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only. |
|
PutJobFailureResultResponse |
This is the response object from the PutJobFailureResult operation. |
|
PutJobSuccessResultRequest |
Container for the parameters to the PutJobSuccessResult operation. Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only. |
|
PutJobSuccessResultResponse |
This is the response object from the PutJobSuccessResult operation. |
|
PutThirdPartyJobFailureResultRequest |
Container for the parameters to the PutThirdPartyJobFailureResult operation. Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only. |
|
PutThirdPartyJobFailureResultResponse |
This is the response object from the PutThirdPartyJobFailureResult operation. |
|
PutThirdPartyJobSuccessResultRequest |
Container for the parameters to the PutThirdPartyJobSuccessResult operation. Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only. |
|
PutThirdPartyJobSuccessResultResponse |
This is the response object from the PutThirdPartyJobSuccessResult operation. |
|
PutWebhookRequest |
Container for the parameters to the PutWebhook operation. Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL. |
|
PutWebhookResponse |
This is the response object from the PutWebhook operation. |
|
RegisterWebhookWithThirdPartyRequest |
Container for the parameters to the RegisterWebhookWithThirdParty operation. Configures a connection between the webhook that was created and the external tool with events to be detected. |
|
RegisterWebhookWithThirdPartyResponse |
This is the response object from the RegisterWebhookWithThirdParty operation. |
|
RequestFailedException |
The request failed because of an unknown error, exception, or failure. |
|
ResolvedPipelineVariable |
A pipeline-level variable used for a pipeline execution. |
|
ResourceNotFoundException |
The resource was specified in an invalid format. |
|
RetryStageExecutionRequest |
Container for the parameters to the RetryStageExecution operation. You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded. |
|
RetryStageExecutionResponse |
Represents the output of a |
|
S3ArtifactLocation |
The location of the S3 bucket that contains a revision. |
|
S3Location |
The Amazon S3 artifact location for an action's artifacts. |
|
SourceRevision |
Information about the version (or revision) of a source artifact that initiated a pipeline execution. |
|
SourceRevisionOverride |
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. |
|
StageContext |
Represents information about a stage to a job worker. |
|
StageDeclaration |
Represents information about a stage and its definition. |
|
StageExecution |
Represents information about the run of a stage. |
|
StageNotFoundException |
The stage was specified in an invalid format or cannot be found. |
|
StageNotRetryableException |
Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions. |
|
StageState |
Represents information about the state of the stage. |
|
StartPipelineExecutionRequest |
Container for the parameters to the StartPipelineExecution operation. Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. |
|
StartPipelineExecutionResponse |
Represents the output of a |
|
StopExecutionTrigger |
The interaction that stopped a pipeline execution. |
|
StopPipelineExecutionRequest |
Container for the parameters to the StopPipelineExecution operation.
Stops the specified pipeline execution. You choose to either stop the pipeline execution
by completing in-progress actions without starting subsequent actions, or by abandoning
in-progress actions. While completing or abandoning in-progress actions, the pipeline
execution is in a |
|
StopPipelineExecutionResponse |
This is the response object from the StopPipelineExecution operation. |
|
Tag |
A tag is a key-value pair that is used to manage the resource. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
ThirdPartyJob |
A response to a |
|
ThirdPartyJobData |
Represents information about the job data for a partner action. |
|
ThirdPartyJobDetails |
The details of a job sent in response to a |
|
TooManyTagsException |
The tags limit for a resource has been exceeded. |
|
TransitionState |
Represents information about the state of transitions between one stage and another stage. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Removes tags from an Amazon Web Services resource. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdateActionTypeRequest |
Container for the parameters to the UpdateActionType operation.
Updates an action type that was created with any supported integration model, where
the action type is to be used by customers of the action type provider. Use a JSON
file with the action definition and |
|
UpdateActionTypeResponse |
This is the response object from the UpdateActionType operation. |
|
UpdatePipelineRequest |
Container for the parameters to the UpdatePipeline operation.
Updates a specified pipeline with edits or changes to its structure. Use a JSON file
with the pipeline structure and |
|
UpdatePipelineResponse |
Represents the output of an |
|
ValidationException |
The validation was specified in an invalid format. |
|
WebhookAuthConfiguration |
The authentication applied to incoming webhook trigger requests. |
|
WebhookDefinition |
Represents information about a webhook and its definition. |
|
WebhookFilterRule |
The event criteria that specify when a webhook notification is sent to your URL. |
|
WebhookNotFoundException |
The specified webhook was entered in an invalid format or cannot be found. |
Name | Description | |
---|---|---|
ICodePipelinePaginatorFactory |
Paginators for the CodePipeline service |
|
IListActionExecutionsPaginator |
Paginator for the ListActionExecutions operation |
|
IListActionTypesPaginator |
Paginator for the ListActionTypes operation |
|
IListPipelineExecutionsPaginator |
Paginator for the ListPipelineExecutions operation |
|
IListPipelinesPaginator |
Paginator for the ListPipelines operation |
|
IListTagsForResourcePaginator |
Paginator for the ListTagsForResource operation |
|
IListWebhooksPaginator |
Paginator for the ListWebhooks operation |