Codepipeline

This page documents function available when using the Codepipeline module, created with @service Codepipeline.

Index

Documentation

Main.Codepipeline.acknowledge_jobMethod
acknowledge_job(job_id, nonce)
acknowledge_job(job_id, nonce, params::Dict{String,<:Any})

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

Arguments

  • job_id: The unique system-generated ID of the job for which you want to confirm receipt.
  • nonce: A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.
Main.Codepipeline.acknowledge_third_party_jobMethod
acknowledge_third_party_job(client_token, job_id, nonce)
acknowledge_third_party_job(client_token, job_id, nonce, params::Dict{String,<:Any})

Confirms a job worker has received the specified job. Used for partner actions only.

Arguments

  • client_token: The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
  • job_id: The unique system-generated ID of the job.
  • nonce: A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.
Main.Codepipeline.create_custom_action_typeMethod
create_custom_action_type(category, input_artifact_details, output_artifact_details, provider, version)
create_custom_action_type(category, input_artifact_details, output_artifact_details, provider, version, params::Dict{String,<:Any})

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

Arguments

  • category: The category of the custom action, such as a build action or a test action.
  • input_artifact_details: The details of the input artifact for the action, such as its commit ID.
  • output_artifact_details: The details of the output artifact of the action, such as its commit ID.
  • provider: The provider of the service used in the custom action, such as CodeDeploy.
  • version: The version identifier of the custom action.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "configurationProperties": The configuration properties for the custom action. You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.
  • "settings": URLs that provide users information about this custom action.
  • "tags": The tags for the custom action.
Main.Codepipeline.create_pipelineMethod
create_pipeline(pipeline)
create_pipeline(pipeline, params::Dict{String,<:Any})

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.

Arguments

  • pipeline: Represents the structure of actions and stages to be performed in the pipeline.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": The tags for the pipeline.
Main.Codepipeline.delete_custom_action_typeMethod
delete_custom_action_type(category, provider, version)
delete_custom_action_type(category, provider, version, params::Dict{String,<:Any})

Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only. 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.

Arguments

  • category: The category of the custom action that you want to delete, such as source or deploy.
  • provider: The provider of the service used in the custom action, such as CodeDeploy.
  • version: The version of the custom action to delete.
Main.Codepipeline.delete_pipelineMethod
delete_pipeline(name)
delete_pipeline(name, params::Dict{String,<:Any})

Deletes the specified pipeline.

Arguments

  • name: The name of the pipeline to be deleted.
Main.Codepipeline.delete_webhookMethod
delete_webhook(name)
delete_webhook(name, params::Dict{String,<:Any})

Deletes a previously created webhook by name. Deleting the webhook stops 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.

Arguments

  • name: The name of the webhook you want to delete.
Main.Codepipeline.deregister_webhook_with_third_partyMethod
deregister_webhook_with_third_party()
deregister_webhook_with_third_party(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "webhookName": The name of the webhook you want to deregister.
Main.Codepipeline.disable_stage_transitionMethod
disable_stage_transition(pipeline_name, reason, stage_name, transition_type)
disable_stage_transition(pipeline_name, reason, stage_name, transition_type, params::Dict{String,<:Any})

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

Arguments

  • pipeline_name: The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
  • reason: The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
  • stage_name: The name of the stage where you want to disable the inbound or outbound transition of artifacts.
  • transition_type: Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).
Main.Codepipeline.enable_stage_transitionMethod
enable_stage_transition(pipeline_name, stage_name, transition_type)
enable_stage_transition(pipeline_name, stage_name, transition_type, params::Dict{String,<:Any})

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

Arguments

  • pipeline_name: The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
  • stage_name: The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).
  • transition_type: Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).
Main.Codepipeline.get_action_typeMethod
get_action_type(category, owner, provider, version)
get_action_type(category, owner, provider, version, params::Dict{String,<:Any})

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.

Arguments

  • category: Defines what kind of action can be taken in the stage. The following are the valid values: Source Build Test Deploy Approval Invoke
  • owner: The creator of an action type that was created with any supported integration model. There are two valid values: AWS and ThirdParty.
  • provider: The provider of the action type being called. The provider name is specified when the action type is created.
  • version: A string that describes the action type version.
Main.Codepipeline.get_job_detailsMethod
get_job_details(job_id)
get_job_details(job_id, params::Dict{String,<:Any})

Returns information about a job. Used for custom actions only. When this API is called, 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.

Arguments

  • job_id: The unique system-generated ID for the job.
Main.Codepipeline.get_pipelineMethod
get_pipeline(name)
get_pipeline(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "version": The version number of the pipeline. If you do not specify a version, defaults to the current version.
Main.Codepipeline.get_pipeline_executionMethod
get_pipeline_execution(pipeline_execution_id, pipeline_name)
get_pipeline_execution(pipeline_execution_id, pipeline_name, params::Dict{String,<:Any})

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.

Arguments

  • pipeline_execution_id: The ID of the pipeline execution about which you want to get execution details.
  • pipeline_name: The name of the pipeline about which you want to get execution details.
Main.Codepipeline.get_pipeline_stateMethod
get_pipeline_state(name)
get_pipeline_state(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the pipeline about which you want to get information.
Main.Codepipeline.get_third_party_job_detailsMethod
get_third_party_job_details(client_token, job_id)
get_third_party_job_details(client_token, job_id, params::Dict{String,<:Any})

Requests the details of a job for a third party action. Used for partner actions only. When this API is called, 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.

Arguments

  • client_token: The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
  • job_id: The unique system-generated ID used for identifying the job.
Main.Codepipeline.list_action_executionsMethod
list_action_executions(pipeline_name)
list_action_executions(pipeline_name, params::Dict{String,<:Any})

Lists the action executions that have occurred in a pipeline.

Arguments

  • pipeline_name: The name of the pipeline for which you want to list action execution history.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": Input information used to filter action execution history.
  • "maxResults": The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100. Detailed execution history is available for executions run on or after February 21, 2019.
  • "nextToken": The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list.
Main.Codepipeline.list_action_typesMethod
list_action_types()
list_action_types(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "actionOwnerFilter": Filters the list of action types to those created by a specified entity.
  • "nextToken": An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
  • "regionFilter": The Region to filter on for the list of action types.
Main.Codepipeline.list_pipeline_executionsMethod
list_pipeline_executions(pipeline_name)
list_pipeline_executions(pipeline_name, params::Dict{String,<:Any})

Gets a summary of the most recent executions for a pipeline.

Arguments

  • pipeline_name: The name of the pipeline for which you want to get execution summary information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.
  • "nextToken": The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.
Main.Codepipeline.list_pipelinesMethod
list_pipelines()
list_pipelines(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can specify is 1. The maximum accepted value is 1000.
  • "nextToken": An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.
Main.Codepipeline.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Gets the set of key-value pairs (metadata) that are used to manage the resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource to get tags for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in a single call.
  • "nextToken": The token that was returned from the previous API call, which would be used to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.
Main.Codepipeline.list_webhooksMethod
list_webhooks()
list_webhooks(params::Dict{String,<:Any})

Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • "NextToken": The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.
Main.Codepipeline.poll_for_jobsMethod
poll_for_jobs(action_type_id)
poll_for_jobs(action_type_id, params::Dict{String,<:Any})

Returns information about any jobs for 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. When this API is called, 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.

Arguments

  • action_type_id: Represents information about an action type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxBatchSize": The maximum number of jobs to return in a poll for jobs call.
  • "queryParam": A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.
Main.Codepipeline.poll_for_third_party_jobsMethod
poll_for_third_party_jobs(action_type_id)
poll_for_third_party_jobs(action_type_id, params::Dict{String,<:Any})

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, 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.

Arguments

  • action_type_id: Represents information about an action type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxBatchSize": The maximum number of jobs to return in a poll for jobs call.
Main.Codepipeline.put_action_revisionMethod
put_action_revision(action_name, action_revision, pipeline_name, stage_name)
put_action_revision(action_name, action_revision, pipeline_name, stage_name, params::Dict{String,<:Any})

Provides information to CodePipeline about new revisions to a source.

Arguments

  • action_name: The name of the action that processes the revision.
  • action_revision: Represents information about the version (or revision) of an action.
  • pipeline_name: The name of the pipeline that starts processing the revision to the source.
  • stage_name: The name of the stage that contains the action that acts on the revision.
Main.Codepipeline.put_approval_resultMethod
put_approval_result(action_name, pipeline_name, result, stage_name, token)
put_approval_result(action_name, pipeline_name, result, stage_name, token, params::Dict{String,<:Any})

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

Arguments

  • action_name: The name of the action for which approval is requested.
  • pipeline_name: The name of the pipeline that contains the action.
  • result: Represents information about the result of the approval request.
  • stage_name: The name of the stage that contains the action.
  • token: The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.
Main.Codepipeline.put_job_failure_resultMethod
put_job_failure_result(failure_details, job_id)
put_job_failure_result(failure_details, job_id, params::Dict{String,<:Any})

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

Arguments

  • failure_details: The details about the failure of a job.
  • job_id: The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
Main.Codepipeline.put_job_success_resultMethod
put_job_success_result(job_id)
put_job_success_result(job_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "continuationToken": A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.
  • "currentRevision": The ID of the current revision of the artifact successfully worked on by the job.
  • "executionDetails": The execution details of the successful job, such as the actions taken by the job worker.
  • "outputVariables": Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.
Main.Codepipeline.put_third_party_job_failure_resultMethod
put_third_party_job_failure_result(client_token, failure_details, job_id)
put_third_party_job_failure_result(client_token, failure_details, job_id, params::Dict{String,<:Any})

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

Arguments

  • client_token: The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
  • failure_details: Represents information about failure details.
  • job_id: The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
Main.Codepipeline.put_third_party_job_success_resultMethod
put_third_party_job_success_result(client_token, job_id)
put_third_party_job_success_result(client_token, job_id, params::Dict{String,<:Any})

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

Arguments

  • client_token: The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
  • job_id: The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "continuationToken": A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.
  • "currentRevision": Represents information about a current revision.
  • "executionDetails": The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
Main.Codepipeline.put_webhookMethod
put_webhook(webhook)
put_webhook(webhook, params::Dict{String,<:Any})

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.

Arguments

  • webhook: The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": The tags for the webhook.
Main.Codepipeline.register_webhook_with_third_partyMethod
register_webhook_with_third_party()
register_webhook_with_third_party(params::Dict{String,<:Any})

Configures a connection between the webhook that was created and the external tool with events to be detected.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "webhookName": The name of an existing webhook created with PutWebhook to register with a supported third party.
Main.Codepipeline.retry_stage_executionMethod
retry_stage_execution(pipeline_execution_id, pipeline_name, retry_mode, stage_name)
retry_stage_execution(pipeline_execution_id, pipeline_name, retry_mode, stage_name, params::Dict{String,<:Any})

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.

Arguments

  • pipeline_execution_id: The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage
  • pipeline_name: The name of the pipeline that contains the failed stage.
  • retry_mode: The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.
  • stage_name: The name of the failed stage to be retried.
Main.Codepipeline.start_pipeline_executionMethod
start_pipeline_execution(name)
start_pipeline_execution(name, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the pipeline to start.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientRequestToken": The system-generated unique ID used to identify a unique execution request.
Main.Codepipeline.stop_pipeline_executionMethod
stop_pipeline_execution(pipeline_execution_id, pipeline_name)
stop_pipeline_execution(pipeline_execution_id, pipeline_name, params::Dict{String,<:Any})

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.

Arguments

  • pipeline_execution_id: The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.
  • pipeline_name: The name of the pipeline to stop.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "abandon": Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions. This option can lead to failed or out-of-sequence tasks.
  • "reason": Use this option to enter comments, such as the reason the pipeline was stopped.
Main.Codepipeline.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource you want to add tags to.
  • tags: The tags you want to modify or add to the resource.
Main.Codepipeline.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from an Amazon Web Services resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource to remove tags from.
  • tag_keys: The list of keys for the tags to be removed from the resource.
Main.Codepipeline.update_action_typeMethod
update_action_type(action_type)
update_action_type(action_type, params::Dict{String,<:Any})

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.

Arguments

  • action_type: The action type definition for the action type to be updated.
Main.Codepipeline.update_pipelineMethod
update_pipeline(pipeline)
update_pipeline(pipeline, params::Dict{String,<:Any})

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.

Arguments

  • pipeline: The name of the pipeline to be updated.