aws-elixir

v0.1.0

aws-elixir v0.1.0 AWS.CodePipeline

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 is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.

You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.

Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.

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 a pipeline structure.
  • `GetPipelineState`, which returns information about the current state of the stages and actions of a pipeline.
  • `ListPipelines`, which gets a summary of all of the pipelines associated with your account.
  • `StartPipelineExecution`, which runs the the most recent revision of an artifact through the pipeline.
  • `UpdatePipeline`, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include *stages*, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run 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, also refer to the [AWS CodePipeline Pipeline Structure Reference](http://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html). Pipeline stages include *actions*, which are categorized into categories such as source or build actions performed within 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`. 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. In order to integrate with AWS CodePipeline, developers will 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 upon,
  • `PutJobFailureResult`, which provides details of a job failure, and
  • `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 upon,
  • `PutThirdPartyJobFailureResult`, which provides details of a job failure, and
  • `PutThirdPartyJobSuccessResult`, which provides details of a job success.

Summary

Functions

acknowledge_job(client, input, options \\ [])

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions

acknowledge_third_party_job(client, input, options \\ [])

Confirms a job worker has received the specified job. Only used for partner actions

create_custom_action_type(client, input, options \\ [])

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions

create_pipeline(client, input, options \\ [])

Creates a pipeline

delete_custom_action_type(client, input, options \\ [])

Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions

delete_pipeline(client, input, options \\ [])

Deletes the specified pipeline

disable_stage_transition(client, input, options \\ [])

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline

enable_stage_transition(client, input, options \\ [])

Enables artifacts in a pipeline to transition to a stage in a pipeline

get_job_details(client, input, options \\ [])

Returns information about a job. Only used for custom actions

get_pipeline(client, input, options \\ [])

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

get_pipeline_state(client, input, options \\ [])

Returns information about the state of a pipeline, including the stages and actions

get_third_party_job_details(client, input, options \\ [])

Requests the details of a job for a third party action. Only used for partner actions

list_action_types(client, input, options \\ [])

Gets a summary of all AWS CodePipeline action types associated with your account

list_pipelines(client, input, options \\ [])

Gets a summary of all of the pipelines associated with your account

poll_for_jobs(client, input, options \\ [])

Returns information about any jobs for AWS CodePipeline to act upon

poll_for_third_party_jobs(client, input, options \\ [])

Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions

put_action_revision(client, input, options \\ [])

Provides information to AWS CodePipeline about new revisions to a source

put_approval_result(client, input, options \\ [])

Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected

put_job_failure_result(client, input, options \\ [])

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions

put_job_success_result(client, input, options \\ [])

Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions

put_third_party_job_failure_result(client, input, options \\ [])

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions

put_third_party_job_success_result(client, input, options \\ [])

Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions

retry_stage_execution(client, input, options \\ [])

Resumes the pipeline execution by retrying the last failed actions in a stage

start_pipeline_execution(client, input, options \\ [])

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline

update_pipeline(client, input, options \\ [])

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1

Functions

acknowledge_job(client, input, options \\ [])

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

acknowledge_third_party_job(client, input, options \\ [])

Confirms a job worker has received the specified job. Only used for partner actions.

create_custom_action_type(client, input, options \\ [])

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.

create_pipeline(client, input, options \\ [])

Creates a pipeline.

delete_custom_action_type(client, input, options \\ [])

Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.

You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
delete_pipeline(client, input, options \\ [])

Deletes the specified pipeline.

disable_stage_transition(client, input, options \\ [])

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

enable_stage_transition(client, input, options \\ [])

Enables artifacts in a pipeline to transition to a stage in a pipeline.

get_job_details(client, input, options \\ [])

Returns information about a job. Only used for custom actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
get_pipeline(client, input, options \\ [])

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.

get_pipeline_state(client, input, options \\ [])

Returns information about the state of a pipeline, including the stages and actions.

get_third_party_job_details(client, input, options \\ [])

Requests the details of a job for a third party action. Only used for partner actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
list_action_types(client, input, options \\ [])

Gets a summary of all AWS CodePipeline action types associated with your account.

list_pipelines(client, input, options \\ [])

Gets a summary of all of the pipelines associated with your account.

poll_for_jobs(client, input, options \\ [])

Returns information about any jobs for AWS CodePipeline to act upon.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
poll_for_third_party_jobs(client, input, options \\ [])

Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
put_action_revision(client, input, options \\ [])

Provides information to AWS CodePipeline about new revisions to a source.

put_approval_result(client, input, options \\ [])

Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.

put_job_failure_result(client, input, options \\ [])

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.

put_job_success_result(client, input, options \\ [])

Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.

put_third_party_job_failure_result(client, input, options \\ [])

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

put_third_party_job_success_result(client, input, options \\ [])

Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

retry_stage_execution(client, input, options \\ [])

Resumes the pipeline execution by retrying the last failed actions in a stage.

start_pipeline_execution(client, input, options \\ [])

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

update_pipeline(client, input, options \\ [])

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.