Crate rusoto_codepipeline
source · [−]Expand description
Overview
This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the AWS CodePipeline User Guide.
You can use the AWS CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
-
CreatePipeline, which creates a uniquely named pipeline.
-
DeletePipeline, which deletes the specified pipeline.
-
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
-
GetPipelineExecution, which returns information about a specific execution of a pipeline.
-
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
-
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
-
ListPipelines, which gets a summary of all of the pipelines associated with your account.
-
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
-
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
-
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
-
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see AWS CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
-
Source
-
Build
-
Test
-
Deploy
-
Approval
-
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
-
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
-
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with AWS CodePipeline
For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. To integrate with AWS CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
-
AcknowledgeJob, which confirms whether a job worker has received the specified job.
-
GetJobDetails, which returns the details of a job.
-
PollForJobs, which determines whether there are any jobs to act on.
-
PutJobFailureResult, which provides details of a job failure.
-
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.
You can work with third party jobs by calling:
-
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
-
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
-
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
-
PutThirdPartyJobFailureResult, which provides details of a job failure.
-
PutThirdPartyJobSuccessResult, which provides details of a job success.
If you’re using the service, you’re probably looking for CodePipelineClient and CodePipeline.
Structs
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
Represents the input of an AcknowledgeJob action.
Represents the output of an AcknowledgeJob action.
Represents the input of an AcknowledgeThirdPartyJob action.
Represents the output of an AcknowledgeThirdPartyJob action.
Represents information about an action configuration.
Represents information about an action configuration property.
Represents the context of an action in the stage of a pipeline to a job worker.
Represents information about an action declaration.
Represents information about the run of an action.
Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.
Filter values for the action execution.
Input information used for an action execution.
Output details listed for an action execution, such as the action execution result.
Execution result information, such as the external execution ID.
Represents information about the version (or revision) of an action.
Represents information about the state of an action.
Returns information about the details of an action type.
Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.
The parameters for the action type definition that are provided when the action type is created or updated.
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.
Represents information about an action type.
Specifies the category, owner, provider, and version of the action type.
Details identifying the users with permissions to use the action type.
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.
Returns information about the settings for an action type.
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.
Represents information about the result of an approval request.
Represents information about an artifact that is worked on by actions in the pipeline.
Artifact details for the action execution, such as the artifact location.
Returns information about the details of an artifact.
Represents information about the location of an artifact.
Represents revision details of an artifact.
The S3 bucket where artifacts for the pipeline are stored.
You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
Reserved for future use.
A client for the CodePipeline API.
Represents the input of a CreateCustomActionType operation.
Represents the output of a CreateCustomActionType operation.
Represents the input of a CreatePipeline action.
Represents the output of a CreatePipeline action.
Represents information about a current revision.
Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.
Represents the input of a DeletePipeline action.
Represents the input of a DisableStageTransition action.
Represents the input of an EnableStageTransition action.
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
Represents information about an error in AWS CodePipeline.
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
The interaction or event that started a pipeline execution.
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.
Represents information about failure details.
Represents the input of a GetJobDetails action.
Represents the output of a GetJobDetails action.
Represents the input of a GetPipelineExecution action.
Represents the output of a GetPipelineExecution action.
Represents the input of a GetPipeline action.
Represents the output of a GetPipeline action.
Represents the input of a GetPipelineState action.
Represents the output of a GetPipelineState action.
Represents the input of a GetThirdPartyJobDetails action.
Represents the output of a GetThirdPartyJobDetails action.
Represents information about an artifact to be worked on, such as a test or build artifact.
Represents information about a job.
Represents other information about a job required for a job worker to complete the job.
Represents information about the details of a job.
Details about the polling configuration for the JobWorker action engine, or executor.
Details about the configuration for the Lambda action engine, or executor.
Represents the input of a ListActionTypes action.
Represents the output of a ListActionTypes action.
Represents the input of a ListPipelineExecutions action.
Represents the output of a ListPipelineExecutions action.
Represents the input of a ListPipelines action.
Represents the output of a ListPipelines action.
The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
Represents information about the output of an action.
Represents information about a pipeline to a job worker.
PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.
Represents the structure of actions and stages to be performed in the pipeline.
Represents information about an execution of a pipeline.
Summary information about a pipeline execution.
Information about a pipeline.
Returns a summary of a pipeline.
Represents the input of a PollForJobs action.
Represents the output of a PollForJobs action.
Represents the input of a PollForThirdPartyJobs action.
Represents the output of a PollForThirdPartyJobs action.
Represents the input of a PutActionRevision action.
Represents the output of a PutActionRevision action.
Represents the input of a PutApprovalResult action.
Represents the output of a PutApprovalResult action.
Represents the input of a PutJobFailureResult action.
Represents the input of a PutJobSuccessResult action.
Represents the input of a PutThirdPartyJobFailureResult action.
Represents the input of a PutThirdPartyJobSuccessResult action.
Represents the input of a RetryStageExecution action.
Represents the output of a RetryStageExecution action.
The location of the S3 bucket that contains a revision.
The Amazon S3 artifact location for an action's artifacts.
Information about the version (or revision) of a source artifact that initiated a pipeline execution.
Represents information about a stage to a job worker.
Represents information about a stage and its definition.
Represents information about the run of a stage.
Represents information about the state of the stage.
Represents the input of a StartPipelineExecution action.
Represents the output of a StartPipelineExecution action.
The interaction that stopped a pipeline execution.
A tag is a key-value pair that is used to manage the resource.
A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked on by a partner action.
Represents information about the job data for a partner action.
The details of a job sent in response to a GetThirdPartyJobDetails request.
Represents information about the state of transitions between one stage and another stage.
Represents the input of an UpdatePipeline action.
Represents the output of an UpdatePipeline action.
The authentication applied to incoming webhook trigger requests.
Represents information about a webhook and its definition.
The event criteria that specify when a webhook notification is sent to your URL.
Enums
Errors returned by AcknowledgeJob
Errors returned by AcknowledgeThirdPartyJob
Errors returned by CreateCustomActionType
Errors returned by CreatePipeline
Errors returned by DeleteCustomActionType
Errors returned by DeletePipeline
Errors returned by DeleteWebhook
Errors returned by DeregisterWebhookWithThirdParty
Errors returned by DisableStageTransition
Errors returned by EnableStageTransition
Errors returned by GetActionType
Errors returned by GetJobDetails
Errors returned by GetPipeline
Errors returned by GetPipelineExecution
Errors returned by GetPipelineState
Errors returned by GetThirdPartyJobDetails
Errors returned by ListActionExecutions
Errors returned by ListActionTypes
Errors returned by ListPipelineExecutions
Errors returned by ListPipelines
Errors returned by ListTagsForResource
Errors returned by ListWebhooks
Errors returned by PollForJobs
Errors returned by PollForThirdPartyJobs
Errors returned by PutActionRevision
Errors returned by PutApprovalResult
Errors returned by PutJobFailureResult
Errors returned by PutJobSuccessResult
Errors returned by PutThirdPartyJobFailureResult
Errors returned by PutThirdPartyJobSuccessResult
Errors returned by PutWebhook
Errors returned by RegisterWebhookWithThirdParty
Errors returned by RetryStageExecution
Errors returned by StartPipelineExecution
Errors returned by StopPipelineExecution
Errors returned by TagResource
Errors returned by UntagResource
Errors returned by UpdateActionType
Errors returned by UpdatePipeline
Traits
Trait representing the capabilities of the CodePipeline API. CodePipeline clients implement this trait.