Paws::CodePipeline - Perl Interface to AWS AWS CodePipeline
use Paws; my $obj = Paws->service('CodePipeline'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], );
AWS CodePipeline
Overview
This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the AWS CodePipeline User Guide (https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html).
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 (https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html).
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.
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09
Each argument is described in detail in: Paws::CodePipeline::AcknowledgeJob
Returns: a Paws::CodePipeline::AcknowledgeJobOutput instance
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
Each argument is described in detail in: Paws::CodePipeline::AcknowledgeThirdPartyJob
Returns: a Paws::CodePipeline::AcknowledgeThirdPartyJobOutput instance
Confirms a job worker has received the specified job. Used for partner actions only.
Each argument is described in detail in: Paws::CodePipeline::CreateCustomActionType
Returns: a Paws::CodePipeline::CreateCustomActionTypeOutput instance
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
Each argument is described in detail in: Paws::CodePipeline::CreatePipeline
Returns: a Paws::CodePipeline::CreatePipelineOutput instance
Creates a pipeline.
In the pipeline structure, 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.
artifactStore
artifactStores
Each argument is described in detail in: Paws::CodePipeline::DeleteCustomActionType
Returns: nothing
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.
PollForJobs
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.
Each argument is described in detail in: Paws::CodePipeline::DeletePipeline
Deletes the specified pipeline.
Each argument is described in detail in: Paws::CodePipeline::DeleteWebhook
Returns: a Paws::CodePipeline::DeleteWebhookOutput instance
Deletes a previously created webhook by name. Deleting the webhook stops AWS 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.
Each argument is described in detail in: Paws::CodePipeline::DeregisterWebhookWithThirdParty
Returns: a Paws::CodePipeline::DeregisterWebhookWithThirdPartyOutput instance
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.
Each argument is described in detail in: Paws::CodePipeline::DisableStageTransition
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
Each argument is described in detail in: Paws::CodePipeline::EnableStageTransition
Enables artifacts in a pipeline to transition to a stage in a pipeline.
Each argument is described in detail in: Paws::CodePipeline::GetActionType
Returns: a Paws::CodePipeline::GetActionTypeOutput instance
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.
Each argument is described in detail in: Paws::CodePipeline::GetJobDetails
Returns: a Paws::CodePipeline::GetJobDetailsOutput instance
Returns information about a job. Used for custom actions only.
When this API is called, AWS 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.
Each argument is described in detail in: Paws::CodePipeline::GetPipeline
Returns: a Paws::CodePipeline::GetPipelineOutput instance
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.
Each argument is described in detail in: Paws::CodePipeline::GetPipelineExecution
Returns: a Paws::CodePipeline::GetPipelineExecutionOutput instance
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.
Each argument is described in detail in: Paws::CodePipeline::GetPipelineState
Returns: a Paws::CodePipeline::GetPipelineStateOutput instance
Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.
revisionId
revisionUrl
Each argument is described in detail in: Paws::CodePipeline::GetThirdPartyJobDetails
Returns: a Paws::CodePipeline::GetThirdPartyJobDetailsOutput instance
Requests the details of a job for a third party action. Used for partner actions only.
Each argument is described in detail in: Paws::CodePipeline::ListActionExecutions
Returns: a Paws::CodePipeline::ListActionExecutionsOutput instance
Lists the action executions that have occurred in a pipeline.
Each argument is described in detail in: Paws::CodePipeline::ListActionTypes
Returns: a Paws::CodePipeline::ListActionTypesOutput instance
Gets a summary of all AWS CodePipeline action types associated with your account.
Each argument is described in detail in: Paws::CodePipeline::ListPipelineExecutions
Returns: a Paws::CodePipeline::ListPipelineExecutionsOutput instance
Gets a summary of the most recent executions for a pipeline.
Each argument is described in detail in: Paws::CodePipeline::ListPipelines
Returns: a Paws::CodePipeline::ListPipelinesOutput instance
Gets a summary of all of the pipelines associated with your account.
Each argument is described in detail in: Paws::CodePipeline::ListTagsForResource
Returns: a Paws::CodePipeline::ListTagsForResourceOutput instance
Gets the set of key-value pairs (metadata) that are used to manage the resource.
Each argument is described in detail in: Paws::CodePipeline::ListWebhooks
Returns: a Paws::CodePipeline::ListWebhooksOutput instance
Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
Each argument is described in detail in: Paws::CodePipeline::PollForJobs
Returns: a Paws::CodePipeline::PollForJobsOutput instance
Returns information about any jobs for AWS CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error.
Each argument is described in detail in: Paws::CodePipeline::PollForThirdPartyJobs
Returns: a Paws::CodePipeline::PollForThirdPartyJobsOutput instance
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, AWS 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.
Each argument is described in detail in: Paws::CodePipeline::PutActionRevision
Returns: a Paws::CodePipeline::PutActionRevisionOutput instance
Provides information to AWS CodePipeline about new revisions to a source.
Each argument is described in detail in: Paws::CodePipeline::PutApprovalResult
Returns: a Paws::CodePipeline::PutApprovalResultOutput instance
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
Each argument is described in detail in: Paws::CodePipeline::PutJobFailureResult
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
Each argument is described in detail in: Paws::CodePipeline::PutJobSuccessResult
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
Each argument is described in detail in: Paws::CodePipeline::PutThirdPartyJobFailureResult
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
Each argument is described in detail in: Paws::CodePipeline::PutThirdPartyJobSuccessResult
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
Each argument is described in detail in: Paws::CodePipeline::PutWebhook
Returns: a Paws::CodePipeline::PutWebhookOutput instance
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.
Each argument is described in detail in: Paws::CodePipeline::RegisterWebhookWithThirdParty
Returns: a Paws::CodePipeline::RegisterWebhookWithThirdPartyOutput instance
Configures a connection between the webhook that was created and the external tool with events to be detected.
Each argument is described in detail in: Paws::CodePipeline::RetryStageExecution
Returns: a Paws::CodePipeline::RetryStageExecutionOutput instance
Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.
Each argument is described in detail in: Paws::CodePipeline::StartPipelineExecution
Returns: a Paws::CodePipeline::StartPipelineExecutionOutput instance
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
Each argument is described in detail in: Paws::CodePipeline::StopPipelineExecution
Returns: a Paws::CodePipeline::StopPipelineExecutionOutput instance
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 Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
Stopping
Stopped
Each argument is described in detail in: Paws::CodePipeline::TagResource
Returns: a Paws::CodePipeline::TagResourceOutput instance
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
Each argument is described in detail in: Paws::CodePipeline::UntagResource
Returns: a Paws::CodePipeline::UntagResourceOutput instance
Removes tags from an AWS resource.
Each argument is described in detail in: Paws::CodePipeline::UpdateActionType
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 UpdateActionType to provide the full structure.
UpdateActionType
Each argument is described in detail in: Paws::CodePipeline::UpdatePipeline
Returns: a Paws::CodePipeline::UpdatePipelineOutput instance
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
UpdatePipeline
Paginator methods are helpers that repetively call methods that return partial results
If passed a sub as first parameter, it will call the sub for each element found in :
- actionExecutionDetails, passing the object as the first parameter, and the string 'actionExecutionDetails' as the second parameter
If not, it will return a a Paws::CodePipeline::ListActionExecutionsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
param
- actionTypes, passing the object as the first parameter, and the string 'actionTypes' as the second parameter
If not, it will return a a Paws::CodePipeline::ListActionTypesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- pipelineExecutionSummaries, passing the object as the first parameter, and the string 'pipelineExecutionSummaries' as the second parameter
If not, it will return a a Paws::CodePipeline::ListPipelineExecutionsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- pipelines, passing the object as the first parameter, and the string 'pipelines' as the second parameter
If not, it will return a a Paws::CodePipeline::ListPipelinesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- tags, passing the object as the first parameter, and the string 'tags' as the second parameter
If not, it will return a a Paws::CodePipeline::ListTagsForResourceOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
- webhooks, passing the object as the first parameter, and the string 'webhooks' as the second parameter
If not, it will return a a Paws::CodePipeline::ListWebhooksOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
This service class forms part of Paws
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.