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:
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 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:
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, andPutJobSuccessResult
, 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, andPutThirdPartyJobSuccessResult
, which provides details of a job success.
Summary↑
Types ↑
update_pipeline_output :: [{:pipeline, pipeline_declaration}]
stage_transition_type :: binary
invalid_job_exception :: []
url :: binary
invalid_nonce_exception :: []
delete_custom_action_type_input :: [category: action_category, provider: action_provider, version: version]
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]
acknowledge_job_output :: [{:status, job_status}]
pipeline_declaration :: [artifact_store: artifact_store, name: pipeline_name, role_arn: role_arn, stages: pipeline_stage_declaration_list, version: pipeline_version]
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_store_type :: binary
artifact :: [location: artifact_location, name: artifact_name, revision: revision]
third_party_job :: [client_id: client_id, job_id: job_id]
url_template :: binary
create_custom_action_type_output :: [{:action_type, action_type}]
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]
action_execution_status :: binary
third_party_job_id :: binary
pipeline_name :: binary
job_status :: binary
s3_object_key :: binary
pipeline_execution_id :: binary
maximum_artifact_count :: integer
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]
update_pipeline_input :: [{:pipeline, pipeline_declaration}]
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]
blocker_declaration :: [name: blocker_name, type: blocker_type]
get_job_details_output :: [{:job_details, job_details}]
acknowledge_job_input :: [job_id: job_id, nonce: nonce]
get_third_party_job_details_input :: [client_token: client_token, job_id: third_party_job_id]
get_pipeline_state_input :: [{:name, pipeline_name}]
artifact_location_type :: binary
last_changed_at :: integer
action_category :: binary
description :: binary
get_job_details_input :: [{:job_id, job_id}]
version :: binary
message :: binary
role_arn :: binary
artifact_list :: [artifact]
max_batch_size :: integer
action_configuration_queryable_value :: binary
action_configuration_key :: binary
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
stage_declaration :: [actions: stage_action_declaration_list, blockers: stage_blocker_declaration_list, name: stage_name]
acknowledge_third_party_job_output :: [{:status, job_status}]
action_configuration_value :: 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
artifact_location :: [s3_location: s3_artifact_location, type: artifact_location_type]
create_pipeline_output :: [{:pipeline, pipeline_declaration}]
action_run_order :: integer
minimum_artifact_count :: integer
validation_exception :: []
stage_context :: [{:name, stage_name}]
start_pipeline_execution_output :: [{:pipeline_execution_id, pipeline_execution_id}]
action_name :: binary
encryption_key_type :: binary
limit_exceeded_exception :: []
poll_for_jobs_output :: [{:jobs, job_list}]
poll_for_third_party_jobs_output :: [{:jobs, third_party_job_list}]
start_pipeline_execution_input :: [{:name, pipeline_name}]
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]
action_configuration_property_type :: binary
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]
artifact_store :: [encryption_key: encryption_key, location: artifact_store_location, type: artifact_store_type]
encryption_key :: [id: encryption_key_id, type: encryption_key_type]
job_not_found_exception :: []
access_key_id :: binary
get_pipeline_output :: [{:pipeline, pipeline_declaration}]
artifact_name :: binary
blocker_type :: binary
output_artifact :: [{:name, artifact_name}]
get_pipeline_input :: [name: pipeline_name, version: pipeline_version]
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]
get_third_party_job_details_output :: [{:job_details, third_party_job_details}]
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]
delete_pipeline_input :: [{:name, pipeline_name}]
third_party_job_details :: [data: third_party_job_data, id: third_party_job_id, nonce: nonce]
failure_details :: [external_execution_id: execution_id, message: message, type: failure_type]
acknowledge_third_party_job_input :: [client_token: client_token, job_id: third_party_job_id, nonce: nonce]
enabled :: boolean
action_configuration :: [{:configuration, action_configuration_map}]
encryption_key_id :: binary
put_third_party_job_failure_result_input :: [client_token: client_token, failure_details: failure_details, job_id: third_party_job_id]
nonce :: binary
revision_change_identifier :: binary
put_action_revision_output :: [new_revision: boolean, pipeline_execution_id: pipeline_execution_id]
artifact_store_location :: binary
action_type_id :: [category: action_category, owner: action_owner, provider: action_provider, version: version]
input_artifact :: [{:name, artifact_name}]
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]
create_pipeline_input :: [{:pipeline, pipeline_declaration}]
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
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.
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.
Specs:
- acknowledge_third_party_job(client :: ExAws.CodePipeline.t, input :: acknowledge_third_party_job_input) :: ExAws.Request.JSON.response_t
AcknowledgeThirdPartyJob
Confirms a job worker has received the specified job. Only used for partner actions.
Specs:
- acknowledge_third_party_job!(client :: ExAws.CodePipeline.t, input :: acknowledge_third_party_job_input) :: ExAws.Request.JSON.success_t | no_return
Same as acknowledge_third_party_job/2
but raise on error.
Specs:
- create_custom_action_type(client :: ExAws.CodePipeline.t, input :: create_custom_action_type_input) :: ExAws.Request.JSON.response_t
CreateCustomActionType
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
Specs:
- create_custom_action_type!(client :: ExAws.CodePipeline.t, input :: create_custom_action_type_input) :: ExAws.Request.JSON.success_t | no_return
Same as create_custom_action_type/2
but raise on error.
Specs:
- create_pipeline(client :: ExAws.CodePipeline.t, input :: create_pipeline_input) :: ExAws.Request.JSON.response_t
CreatePipeline
Creates a pipeline.
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.
Specs:
- delete_custom_action_type(client :: ExAws.CodePipeline.t, input :: delete_custom_action_type_input) :: ExAws.Request.JSON.response_t
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.
**
Specs:
- delete_custom_action_type!(client :: ExAws.CodePipeline.t, input :: delete_custom_action_type_input) :: ExAws.Request.JSON.success_t | no_return
Same as delete_custom_action_type/2
but raise on error.
Specs:
- delete_pipeline(client :: ExAws.CodePipeline.t, input :: delete_pipeline_input) :: ExAws.Request.JSON.response_t
DeletePipeline
Deletes the specified pipeline.
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.
Specs:
- disable_stage_transition(client :: ExAws.CodePipeline.t, input :: disable_stage_transition_input) :: ExAws.Request.JSON.response_t
DisableStageTransition
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
Specs:
- disable_stage_transition!(client :: ExAws.CodePipeline.t, input :: disable_stage_transition_input) :: ExAws.Request.JSON.success_t | no_return
Same as disable_stage_transition/2
but raise on error.
Specs:
- enable_stage_transition(client :: ExAws.CodePipeline.t, input :: enable_stage_transition_input) :: ExAws.Request.JSON.response_t
EnableStageTransition
Enables artifacts in a pipeline to transition to a stage in a pipeline.
Specs:
- enable_stage_transition!(client :: ExAws.CodePipeline.t, input :: enable_stage_transition_input) :: ExAws.Request.JSON.success_t | no_return
Same as enable_stage_transition/2
but raise on error.
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.
**
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.
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
.
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.
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.
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.
Specs:
- get_third_party_job_details(client :: ExAws.CodePipeline.t, input :: get_third_party_job_details_input) :: ExAws.Request.JSON.response_t
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.
**
Specs:
- get_third_party_job_details!(client :: ExAws.CodePipeline.t, input :: get_third_party_job_details_input) :: ExAws.Request.JSON.success_t | no_return
Same as get_third_party_job_details/2
but raise on error.
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.
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.
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.
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.
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.
**
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.
Specs:
- poll_for_third_party_jobs(client :: ExAws.CodePipeline.t, input :: poll_for_third_party_jobs_input) :: ExAws.Request.JSON.response_t
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.
**
Specs:
- poll_for_third_party_jobs!(client :: ExAws.CodePipeline.t, input :: poll_for_third_party_jobs_input) :: ExAws.Request.JSON.success_t | no_return
Same as poll_for_third_party_jobs/2
but raise on error.
Specs:
- put_action_revision(client :: ExAws.CodePipeline.t, input :: put_action_revision_input) :: ExAws.Request.JSON.response_t
PutActionRevision
Provides information to AWS CodePipeline about new revisions to a source.
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.
Specs:
- put_job_failure_result(client :: ExAws.CodePipeline.t, input :: put_job_failure_result_input) :: ExAws.Request.JSON.response_t
PutJobFailureResult
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
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.
Specs:
- put_job_success_result(client :: ExAws.CodePipeline.t, input :: put_job_success_result_input) :: ExAws.Request.JSON.response_t
PutJobSuccessResult
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
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.
Specs:
- put_third_party_job_failure_result(client :: ExAws.CodePipeline.t, input :: put_third_party_job_failure_result_input) :: ExAws.Request.JSON.response_t
PutThirdPartyJobFailureResult
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
Specs:
- put_third_party_job_failure_result!(client :: ExAws.CodePipeline.t, input :: put_third_party_job_failure_result_input) :: ExAws.Request.JSON.success_t | no_return
Same as put_third_party_job_failure_result/2
but raise on error.
Specs:
- put_third_party_job_success_result(client :: ExAws.CodePipeline.t, input :: put_third_party_job_success_result_input) :: ExAws.Request.JSON.response_t
PutThirdPartyJobSuccessResult
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
Specs:
- put_third_party_job_success_result!(client :: ExAws.CodePipeline.t, input :: put_third_party_job_success_result_input) :: ExAws.Request.JSON.success_t | no_return
Same as put_third_party_job_success_result/2
but raise on error.
Specs:
- start_pipeline_execution(client :: ExAws.CodePipeline.t, input :: start_pipeline_execution_input) :: ExAws.Request.JSON.response_t
StartPipelineExecution
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
Specs:
- start_pipeline_execution!(client :: ExAws.CodePipeline.t, input :: start_pipeline_execution_input) :: ExAws.Request.JSON.success_t | no_return
Same as start_pipeline_execution/2
but raise on error.
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.
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.