ExAws.CodePipeline.Core

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:

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 ulink url="http://docs.aws.amazon.com/codepipeline/latest/UserGuide/pipeline-structure.html"AWS CodePipeline Pipeline Structure Reference.

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:

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:

Source

Summary

acknowledge_job!(client, input)

Same as acknowledge_job/2 but raise on error

acknowledge_job(client, input)

AcknowledgeJob

acknowledge_third_party_job!(client, input)

Same as acknowledge_third_party_job/2 but raise on error

acknowledge_third_party_job(client, input)

AcknowledgeThirdPartyJob

create_custom_action_type!(client, input)

Same as create_custom_action_type/2 but raise on error

create_custom_action_type(client, input)

CreateCustomActionType

create_pipeline!(client, input)

Same as create_pipeline/2 but raise on error

create_pipeline(client, input)

CreatePipeline

delete_custom_action_type!(client, input)

Same as delete_custom_action_type/2 but raise on error

delete_custom_action_type(client, input)

DeleteCustomActionType

delete_pipeline!(client, input)

Same as delete_pipeline/2 but raise on error

delete_pipeline(client, input)

DeletePipeline

disable_stage_transition!(client, input)

Same as disable_stage_transition/2 but raise on error

disable_stage_transition(client, input)

DisableStageTransition

enable_stage_transition!(client, input)

Same as enable_stage_transition/2 but raise on error

enable_stage_transition(client, input)

EnableStageTransition

get_job_details!(client, input)

Same as get_job_details/2 but raise on error

get_job_details(client, input)

GetJobDetails

get_pipeline!(client, input)

Same as get_pipeline/2 but raise on error

get_pipeline(client, input)

GetPipeline

get_pipeline_state!(client, input)

Same as get_pipeline_state/2 but raise on error

get_pipeline_state(client, input)

GetPipelineState

get_third_party_job_details!(client, input)

Same as get_third_party_job_details/2 but raise on error

get_third_party_job_details(client, input)

GetThirdPartyJobDetails

list_action_types!(client, input)

Same as list_action_types/2 but raise on error

list_action_types(client, input)

ListActionTypes

list_pipelines!(client, input)

Same as list_pipelines/2 but raise on error

list_pipelines(client, input)

ListPipelines

poll_for_jobs!(client, input)

Same as poll_for_jobs/2 but raise on error

poll_for_jobs(client, input)

PollForJobs

poll_for_third_party_jobs!(client, input)

Same as poll_for_third_party_jobs/2 but raise on error

poll_for_third_party_jobs(client, input)

PollForThirdPartyJobs

put_action_revision!(client, input)

Same as put_action_revision/2 but raise on error

put_action_revision(client, input)

PutActionRevision

put_job_failure_result!(client, input)

Same as put_job_failure_result/2 but raise on error

put_job_failure_result(client, input)

PutJobFailureResult

put_job_success_result!(client, input)

Same as put_job_success_result/2 but raise on error

put_job_success_result(client, input)

PutJobSuccessResult

put_third_party_job_failure_result!(client, input)

Same as put_third_party_job_failure_result/2 but raise on error

put_third_party_job_failure_result(client, input)

PutThirdPartyJobFailureResult

put_third_party_job_success_result!(client, input)

Same as put_third_party_job_success_result/2 but raise on error

put_third_party_job_success_result(client, input)

PutThirdPartyJobSuccessResult

start_pipeline_execution!(client, input)

Same as start_pipeline_execution/2 but raise on error

start_pipeline_execution(client, input)

StartPipelineExecution

update_pipeline!(client, input)

Same as update_pipeline/2 but raise on error

update_pipeline(client, input)

UpdatePipeline

Types

url :: binary

percentage :: integer

put_job_failure_result_input :: [failure_details: failure_details, job_id: job_id]

third_party_job_data :: [action_configuration: action_configuration, action_type_id: action_type_id, artifact_credentials: aws_session_credentials, continuation_token: continuation_token, encryption_key: encryption_key, input_artifacts: artifact_list, output_artifacts: artifact_list, pipeline_context: pipeline_context]

action_state :: [action_name: action_name, current_revision: action_revision, entity_url: url, latest_execution: action_execution, revision_url: url]

code :: binary

client_id :: binary

job :: [account_id: account_id, data: job_data, id: job_id, nonce: nonce]

action_owner :: binary

pipeline_summary :: [created: timestamp, name: pipeline_name, updated: timestamp, version: pipeline_version]

disabled_reason :: binary

s3_bucket_name :: binary

disable_stage_transition_input :: [pipeline_name: pipeline_name, reason: disabled_reason, stage_name: stage_name, transition_type: stage_transition_type]

action_type :: [action_configuration_properties: action_configuration_property_list, id: action_type_id, input_artifact_details: artifact_details, output_artifact_details: artifact_details, settings: action_type_settings]

action_declaration :: [action_type_id: action_type_id, configuration: action_configuration_map, input_artifacts: input_artifact_list, name: action_name, output_artifacts: output_artifact_list, role_arn: role_arn, run_order: action_run_order]

artifact :: [location: artifact_location, name: artifact_name, revision: revision]

third_party_job :: [client_id: client_id, job_id: job_id]

url_template :: binary

list_action_types_input :: [action_owner_filter: action_owner, next_token: next_token]

last_changed_by :: binary

poll_for_third_party_jobs_input :: [action_type_id: action_type_id, max_batch_size: max_batch_size]

third_party_job_id :: binary

pipeline_name :: binary

job_status :: binary

s3_object_key :: binary

client_token :: binary

revision_change_id :: binary

account_id :: binary

action_revision :: [created: timestamp, revision_change_id: revision_change_id, revision_id: revision_id]

pipeline_context :: [action: action_context, pipeline_name: pipeline_name, stage: stage_context]

action_type_settings :: [entity_url_template: url_template, execution_url_template: url_template, revision_url_template: url_template, third_party_configuration_url: url]

failure_type :: binary

create_custom_action_type_input :: [category: action_category, configuration_properties: action_configuration_property_list, input_artifact_details: artifact_details, output_artifact_details: artifact_details, provider: action_provider, settings: action_type_settings, version: version]

get_job_details_output :: [{:job_details, job_details}]

acknowledge_job_input :: [job_id: job_id, nonce: nonce]

last_changed_at :: integer

action_category :: binary

description :: binary

get_job_details_input :: [{:job_id, job_id}]

version :: binary

message :: binary

role_arn :: binary

max_batch_size :: integer

put_third_party_job_success_result_input :: [client_token: client_token, continuation_token: continuation_token, current_revision: current_revision, execution_details: execution_details, job_id: third_party_job_id]

blocker_name :: binary

job_details :: [account_id: account_id, data: job_data, id: job_id]

session_token :: binary

timestamp :: integer

action_provider :: binary

job_data :: [action_configuration: action_configuration, action_type_id: action_type_id, artifact_credentials: aws_session_credentials, continuation_token: continuation_token, encryption_key: encryption_key, input_artifacts: artifact_list, output_artifacts: artifact_list, pipeline_context: pipeline_context]

current_revision :: [change_identifier: revision_change_identifier, revision: revision]

stage_name :: binary

pipeline_version :: integer

action_run_order :: integer

stage_context :: [{:name, stage_name}]

action_name :: binary

error_details :: [code: code, message: message]

aws_session_credentials :: [access_key_id: access_key_id, secret_access_key: secret_access_key, session_token: session_token]

execution_summary :: binary

get_pipeline_state_output :: [created: timestamp, pipeline_name: pipeline_name, pipeline_version: pipeline_version, stage_states: stage_state_list, updated: timestamp]

list_pipelines_input :: [{:next_token, next_token}]

action_configuration_property :: [description: description, key: boolean, name: action_configuration_key, queryable: boolean, required: boolean, secret: boolean, type: action_configuration_property_type]

access_key_id :: binary

job_list :: [job]

artifact_name :: binary

blocker_type :: binary

s3_artifact_location :: [bucket_name: s3_bucket_name, object_key: s3_object_key]

revision_id :: binary

continuation_token :: binary

put_action_revision_input :: [action_name: action_name, action_revision: action_revision, pipeline_name: pipeline_name, stage_name: stage_name]

transition_state :: [disabled_reason: disabled_reason, enabled: enabled, last_changed_at: last_changed_at, last_changed_by: last_changed_by]

stage_state :: [action_states: action_state_list, inbound_transition_state: transition_state, stage_name: stage_name]

list_pipelines_output :: [next_token: next_token, pipelines: pipeline_list]

enable_stage_transition_input :: [pipeline_name: pipeline_name, stage_name: stage_name, transition_type: stage_transition_type]

failure_details :: [external_execution_id: execution_id, message: message, type: failure_type]

enabled :: boolean

encryption_key_id :: binary

nonce :: binary

put_action_revision_output :: [new_revision: boolean, pipeline_execution_id: pipeline_execution_id]

action_type_id :: [category: action_category, owner: action_owner, provider: action_provider, version: version]

artifact_details :: [maximum_count: maximum_artifact_count, minimum_count: minimum_artifact_count]

execution_id :: binary

job_id :: binary

poll_for_jobs_input :: [action_type_id: action_type_id, max_batch_size: max_batch_size, query_param: query_param_map]

action_execution :: [error_details: error_details, external_execution_id: execution_id, external_execution_url: url, last_status_change: timestamp, percent_complete: percentage, status: action_execution_status, summary: execution_summary]

list_action_types_output :: [action_types: action_type_list, next_token: next_token]

put_job_success_result_input :: [continuation_token: continuation_token, current_revision: current_revision, execution_details: execution_details, job_id: job_id]

secret_access_key :: binary

next_token :: binary

execution_details :: [external_execution_id: execution_id, percent_complete: percentage, summary: execution_summary]

revision :: binary

action_context :: [{:name, action_name}]

Functions

acknowledge_job(client, input)

Specs:

  • acknowledge_job(client :: ExAws.CodePipeline.t, input :: acknowledge_job_input) :: ExAws.Request.JSON.response_t

AcknowledgeJob

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

Source
acknowledge_job!(client, input)

Specs:

  • acknowledge_job!(client :: ExAws.CodePipeline.t, input :: acknowledge_job_input) :: ExAws.Request.JSON.success_t | no_return

Same as acknowledge_job/2 but raise on error.

Source
acknowledge_third_party_job(client, input)

Specs:

AcknowledgeThirdPartyJob

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

Source
acknowledge_third_party_job!(client, input)

Specs:

Same as acknowledge_third_party_job/2 but raise on error.

Source
create_custom_action_type(client, input)

Specs:

CreateCustomActionType

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

Source
create_custom_action_type!(client, input)

Specs:

Same as create_custom_action_type/2 but raise on error.

Source
create_pipeline(client, input)

Specs:

  • create_pipeline(client :: ExAws.CodePipeline.t, input :: create_pipeline_input) :: ExAws.Request.JSON.response_t

CreatePipeline

Creates a pipeline.

Source
create_pipeline!(client, input)

Specs:

  • create_pipeline!(client :: ExAws.CodePipeline.t, input :: create_pipeline_input) :: ExAws.Request.JSON.success_t | no_return

Same as create_pipeline/2 but raise on error.

Source
delete_custom_action_type(client, input)

Specs:

DeleteCustomActionType

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.

**

Source
delete_custom_action_type!(client, input)

Specs:

Same as delete_custom_action_type/2 but raise on error.

Source
delete_pipeline(client, input)

Specs:

  • delete_pipeline(client :: ExAws.CodePipeline.t, input :: delete_pipeline_input) :: ExAws.Request.JSON.response_t

DeletePipeline

Deletes the specified pipeline.

Source
delete_pipeline!(client, input)

Specs:

  • delete_pipeline!(client :: ExAws.CodePipeline.t, input :: delete_pipeline_input) :: ExAws.Request.JSON.success_t | no_return

Same as delete_pipeline/2 but raise on error.

Source
disable_stage_transition(client, input)

Specs:

DisableStageTransition

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

Source
disable_stage_transition!(client, input)

Specs:

Same as disable_stage_transition/2 but raise on error.

Source
enable_stage_transition(client, input)

Specs:

EnableStageTransition

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

Source
enable_stage_transition!(client, input)

Specs:

Same as enable_stage_transition/2 but raise on error.

Source
get_job_details(client, input)

Specs:

  • get_job_details(client :: ExAws.CodePipeline.t, input :: get_job_details_input) :: ExAws.Request.JSON.response_t

GetJobDetails

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.

**

Source
get_job_details!(client, input)

Specs:

  • get_job_details!(client :: ExAws.CodePipeline.t, input :: get_job_details_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_job_details/2 but raise on error.

Source
get_pipeline(client, input)

Specs:

  • get_pipeline(client :: ExAws.CodePipeline.t, input :: get_pipeline_input) :: ExAws.Request.JSON.response_t

GetPipeline

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.

Source
get_pipeline!(client, input)

Specs:

  • get_pipeline!(client :: ExAws.CodePipeline.t, input :: get_pipeline_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_pipeline/2 but raise on error.

Source
get_pipeline_state(client, input)

Specs:

  • get_pipeline_state(client :: ExAws.CodePipeline.t, input :: get_pipeline_state_input) :: ExAws.Request.JSON.response_t

GetPipelineState

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

Source
get_pipeline_state!(client, input)

Specs:

  • get_pipeline_state!(client :: ExAws.CodePipeline.t, input :: get_pipeline_state_input) :: ExAws.Request.JSON.success_t | no_return

Same as get_pipeline_state/2 but raise on error.

Source
get_third_party_job_details(client, input)

Specs:

GetThirdPartyJobDetails

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.

**

Source
get_third_party_job_details!(client, input)

Specs:

Same as get_third_party_job_details/2 but raise on error.

Source
list_action_types(client, input)

Specs:

  • list_action_types(client :: ExAws.CodePipeline.t, input :: list_action_types_input) :: ExAws.Request.JSON.response_t

ListActionTypes

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

Source
list_action_types!(client, input)

Specs:

  • list_action_types!(client :: ExAws.CodePipeline.t, input :: list_action_types_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_action_types/2 but raise on error.

Source
list_pipelines(client, input)

Specs:

  • list_pipelines(client :: ExAws.CodePipeline.t, input :: list_pipelines_input) :: ExAws.Request.JSON.response_t

ListPipelines

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

Source
list_pipelines!(client, input)

Specs:

  • list_pipelines!(client :: ExAws.CodePipeline.t, input :: list_pipelines_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_pipelines/2 but raise on error.

Source
poll_for_jobs(client, input)

Specs:

  • poll_for_jobs(client :: ExAws.CodePipeline.t, input :: poll_for_jobs_input) :: ExAws.Request.JSON.response_t

PollForJobs

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.

**

Source
poll_for_jobs!(client, input)

Specs:

  • poll_for_jobs!(client :: ExAws.CodePipeline.t, input :: poll_for_jobs_input) :: ExAws.Request.JSON.success_t | no_return

Same as poll_for_jobs/2 but raise on error.

Source
poll_for_third_party_jobs(client, input)

Specs:

PollForThirdPartyJobs

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.

**

Source
poll_for_third_party_jobs!(client, input)

Specs:

Same as poll_for_third_party_jobs/2 but raise on error.

Source
put_action_revision(client, input)

Specs:

PutActionRevision

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

Source
put_action_revision!(client, input)

Specs:

  • put_action_revision!(client :: ExAws.CodePipeline.t, input :: put_action_revision_input) :: ExAws.Request.JSON.success_t | no_return

Same as put_action_revision/2 but raise on error.

Source
put_job_failure_result(client, input)

Specs:

PutJobFailureResult

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

Source
put_job_failure_result!(client, input)

Specs:

  • put_job_failure_result!(client :: ExAws.CodePipeline.t, input :: put_job_failure_result_input) :: ExAws.Request.JSON.success_t | no_return

Same as put_job_failure_result/2 but raise on error.

Source
put_job_success_result(client, input)

Specs:

PutJobSuccessResult

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

Source
put_job_success_result!(client, input)

Specs:

  • put_job_success_result!(client :: ExAws.CodePipeline.t, input :: put_job_success_result_input) :: ExAws.Request.JSON.success_t | no_return

Same as put_job_success_result/2 but raise on error.

Source
put_third_party_job_failure_result(client, input)

Specs:

PutThirdPartyJobFailureResult

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

Source
put_third_party_job_failure_result!(client, input)

Specs:

Same as put_third_party_job_failure_result/2 but raise on error.

Source
put_third_party_job_success_result(client, input)

Specs:

PutThirdPartyJobSuccessResult

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

Source
put_third_party_job_success_result!(client, input)

Specs:

Same as put_third_party_job_success_result/2 but raise on error.

Source
start_pipeline_execution(client, input)

Specs:

StartPipelineExecution

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

Source
start_pipeline_execution!(client, input)

Specs:

Same as start_pipeline_execution/2 but raise on error.

Source
update_pipeline(client, input)

Specs:

  • update_pipeline(client :: ExAws.CodePipeline.t, input :: update_pipeline_input) :: ExAws.Request.JSON.response_t

UpdatePipeline

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.

Source
update_pipeline!(client, input)

Specs:

  • update_pipeline!(client :: ExAws.CodePipeline.t, input :: update_pipeline_input) :: ExAws.Request.JSON.success_t | no_return

Same as update_pipeline/2 but raise on error.

Source