Client

codepipeline

R Documentation

AWS CodePipeline¶

Description¶

CodePipeline

Overview

This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.

You can use the 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:

create_pipeline, which creates a uniquely named pipeline.
delete_pipeline, which deletes the specified pipeline.
get_pipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
get_pipeline_execution, which returns information about a specific execution of a pipeline.
get_pipeline_state, which returns information about the current state of the stages and actions of a pipeline.
list_action_executions, 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.
list_pipelines, which gets a summary of all of the pipelines associated with your account.
list_pipeline_executions, which gets a summary of the most recent executions for a pipeline.
start_pipeline_execution, which runs the most recent revision of an artifact through the pipeline.
stop_pipeline_execution, which stops the specified pipeline execution from continuing through the pipeline.
update_pipeline, 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 get_pipeline_state, which displays the status of a pipeline, including the status of stages in the pipeline, or get_pipeline, 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 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 create_pipeline and get_pipeline_state. 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:

disable_stage_transition, which prevents artifacts from transitioning to the next stage in a pipeline.
enable_stage_transition, which enables transition of artifacts between stages in a pipeline.

Using the API to integrate with CodePipeline

For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with 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:

acknowledge_job, which confirms whether a job worker has received the specified job.
get_job_details, which returns the details of a job.
poll_for_jobs, which determines whether there are any jobs to act on.
put_job_failure_result, which provides details of a job failure.
put_job_success_result, which provides details of a job success.

Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.

You can work with third party jobs by calling:

acknowledge_third_party_job, which confirms whether a job worker has received the specified job.
get_third_party_job_details, which requests the details of a job for a partner action.
poll_for_third_party_jobs, which determines whether there are any jobs to act on.
put_third_party_job_failure_result, which provides details of a job failure.
put_third_party_job_success_result, which provides details of a job success.

Usage¶

codepipeline(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- codepipeline(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

acknowledge_job: Returns information about a specified job and whether that job has been received by the job worker
acknowledge_third_party_job: Confirms a job worker has received the specified job
create_custom_action_type: Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account
create_pipeline: Creates a pipeline
delete_custom_action_type: Marks a custom action as deleted
delete_pipeline: Deletes the specified pipeline
delete_webhook: Deletes a previously created webhook by name
deregister_webhook_with_third_party: Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected
disable_stage_transition: Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline
enable_stage_transition: Enables artifacts in a pipeline to transition to a stage in a pipeline
get_action_type: Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider
get_job_details: Returns information about a job
get_pipeline: Returns the metadata, structure, stages, and actions of a pipeline
get_pipeline_execution: 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
get_pipeline_state: Returns information about the state of a pipeline, including the stages and actions
get_third_party_job_details: Requests the details of a job for a third party action
list_action_executions: Lists the action executions that have occurred in a pipeline
list_action_types: Gets a summary of all CodePipeline action types associated with your account
list_pipeline_executions: Gets a summary of the most recent executions for a pipeline
list_pipelines: Gets a summary of all of the pipelines associated with your account
list_tags_for_resource: Gets the set of key-value pairs (metadata) that are used to manage the resource
list_webhooks: Gets a listing of all the webhooks in this Amazon Web Services Region for this account
poll_for_jobs: Returns information about any jobs for CodePipeline to act on
poll_for_third_party_jobs: Determines whether there are any third party jobs for a job worker to act on
put_action_revision: Provides information to CodePipeline about new revisions to a source
put_approval_result: Provides the response to a manual approval request to CodePipeline
put_job_failure_result: Represents the failure of a job as returned to the pipeline by a job worker
put_job_success_result: Represents the success of a job as returned to the pipeline by a job worker
put_third_party_job_failure_result: Represents the failure of a third party job as returned to the pipeline by a job worker
put_third_party_job_success_result: Represents the success of a third party job as returned to the pipeline by a job worker
put_webhook: Defines a webhook and returns a unique webhook URL generated by CodePipeline
register_webhook_with_third_party: Configures a connection between the webhook that was created and the external tool with events to be detected
retry_stage_execution: You can retry a stage that has failed without having to run a pipeline again from the beginning
start_pipeline_execution: Starts the specified pipeline
stop_pipeline_execution: Stops the specified pipeline execution
tag_resource: Adds to or modifies the tags of the given resource
untag_resource: Removes tags from an Amazon Web Services resource
update_action_type: 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
update_pipeline: Updates a specified pipeline with edits or changes to its structure

Examples¶

## Not run: 
svc <- codepipeline()
svc$acknowledge_job(
  Foo = 123
)

## End(Not run)