Class: Aws::CodePipeline::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodePipeline::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- lib/aws-sdk-codepipeline/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#acknowledge_job(params = {}) ⇒ Types::AcknowledgeJobOutput
Returns information about a specified job and whether that job has been received by the job worker.
-
#acknowledge_third_party_job(params = {}) ⇒ Types::AcknowledgeThirdPartyJobOutput
Confirms a job worker has received the specified job.
-
#create_custom_action_type(params = {}) ⇒ Types::CreateCustomActionTypeOutput
Creates a new custom action that can be used in all pipelines associated with the AWS account.
-
#create_pipeline(params = {}) ⇒ Types::CreatePipelineOutput
Creates a pipeline.
-
#delete_custom_action_type(params = {}) ⇒ Struct
Marks a custom action as deleted.
-
#delete_pipeline(params = {}) ⇒ Struct
Deletes the specified pipeline.
-
#delete_webhook(params = {}) ⇒ Struct
Deletes a previously created webhook by name.
-
#deregister_webhook_with_third_party(params = {}) ⇒ Struct
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected.
-
#disable_stage_transition(params = {}) ⇒ Struct
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
-
#enable_stage_transition(params = {}) ⇒ Struct
Enables artifacts in a pipeline to transition to a stage in a pipeline.
-
#get_job_details(params = {}) ⇒ Types::GetJobDetailsOutput
Returns information about a job.
-
#get_pipeline(params = {}) ⇒ Types::GetPipelineOutput
Returns the metadata, structure, stages, and actions of a pipeline.
-
#get_pipeline_execution(params = {}) ⇒ Types::GetPipelineExecutionOutput
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(params = {}) ⇒ Types::GetPipelineStateOutput
Returns information about the state of a pipeline, including the stages and actions.
-
#get_third_party_job_details(params = {}) ⇒ Types::GetThirdPartyJobDetailsOutput
Requests the details of a job for a third party action.
-
#list_action_types(params = {}) ⇒ Types::ListActionTypesOutput
Gets a summary of all AWS CodePipeline action types associated with your account.
-
#list_pipeline_executions(params = {}) ⇒ Types::ListPipelineExecutionsOutput
Gets a summary of the most recent executions for a pipeline.
-
#list_pipelines(params = {}) ⇒ Types::ListPipelinesOutput
Gets a summary of all of the pipelines associated with your account.
-
#list_webhooks(params = {}) ⇒ Types::ListWebhooksOutput
Gets a listing of all the webhooks in this region for this account.
-
#poll_for_jobs(params = {}) ⇒ Types::PollForJobsOutput
Returns information about any jobs for AWS CodePipeline to act upon.
-
#poll_for_third_party_jobs(params = {}) ⇒ Types::PollForThirdPartyJobsOutput
Determines whether there are any third party jobs for a job worker to act on.
-
#put_action_revision(params = {}) ⇒ Types::PutActionRevisionOutput
Provides information to AWS CodePipeline about new revisions to a source.
-
#put_approval_result(params = {}) ⇒ Types::PutApprovalResultOutput
Provides the response to a manual approval request to AWS CodePipeline.
-
#put_job_failure_result(params = {}) ⇒ Struct
Represents the failure of a job as returned to the pipeline by a job worker.
-
#put_job_success_result(params = {}) ⇒ Struct
Represents the success of a job as returned to the pipeline by a job worker.
-
#put_third_party_job_failure_result(params = {}) ⇒ Struct
Represents the failure of a third party job as returned to the pipeline by a job worker.
-
#put_third_party_job_success_result(params = {}) ⇒ Struct
Represents the success of a third party job as returned to the pipeline by a job worker.
-
#put_webhook(params = {}) ⇒ Types::PutWebhookOutput
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
-
#register_webhook_with_third_party(params = {}) ⇒ Struct
Configures a connection between the webhook that was created and the external tool with events to be detected.
-
#retry_stage_execution(params = {}) ⇒ Types::RetryStageExecutionOutput
Resumes the pipeline execution by retrying the last failed actions in a stage.
-
#start_pipeline_execution(params = {}) ⇒ Types::StartPipelineExecutionOutput
Starts the specified pipeline.
-
#update_pipeline(params = {}) ⇒ Types::UpdatePipelineOutput
Updates a specified pipeline with edits or changes to its structure.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
212 213 214 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 212 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1966 1967 1968 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1966 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1969 1970 1971 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1969 def errors_module Errors end |
Instance Method Details
#acknowledge_job(params = {}) ⇒ Types::AcknowledgeJobOutput
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
250 251 252 253 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 250 def acknowledge_job(params = {}, = {}) req = build_request(:acknowledge_job, params) req.send_request() end |
#acknowledge_third_party_job(params = {}) ⇒ Types::AcknowledgeThirdPartyJobOutput
Confirms a job worker has received the specified job. Only used for partner actions.
291 292 293 294 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 291 def acknowledge_third_party_job(params = {}, = {}) req = build_request(:acknowledge_third_party_job, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1944 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-codepipeline' context[:gem_version] = '1.11.0' Seahorse::Client::Request.new(handlers, context) end |
#create_custom_action_type(params = {}) ⇒ Types::CreateCustomActionTypeOutput
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
405 406 407 408 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 405 def create_custom_action_type(params = {}, = {}) req = build_request(:create_custom_action_type, params) req.send_request() end |
#create_pipeline(params = {}) ⇒ Types::CreatePipelineOutput
Creates a pipeline.
525 526 527 528 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 525 def create_pipeline(params = {}, = {}) req = build_request(:create_pipeline, params) req.send_request() end |
#delete_custom_action_type(params = {}) ⇒ Struct
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.
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.
565 566 567 568 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 565 def delete_custom_action_type(params = {}, = {}) req = build_request(:delete_custom_action_type, params) req.send_request() end |
#delete_pipeline(params = {}) ⇒ Struct
Deletes the specified pipeline.
587 588 589 590 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 587 def delete_pipeline(params = {}, = {}) req = build_request(:delete_pipeline, params) req.send_request() end |
#delete_webhook(params = {}) ⇒ Struct
Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API will return 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.
613 614 615 616 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 613 def delete_webhook(params = {}, = {}) req = build_request(:delete_webhook, params) req.send_request() end |
#deregister_webhook_with_third_party(params = {}) ⇒ Struct
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently only supported for webhooks that target an action type of GitHub.
638 639 640 641 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 638 def deregister_webhook_with_third_party(params = {}, = {}) req = build_request(:deregister_webhook_with_third_party, params) req.send_request() end |
#disable_stage_transition(params = {}) ⇒ Struct
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
680 681 682 683 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 680 def disable_stage_transition(params = {}, = {}) req = build_request(:disable_stage_transition, params) req.send_request() end |
#enable_stage_transition(params = {}) ⇒ Struct
Enables artifacts in a pipeline to transition to a stage in a pipeline.
717 718 719 720 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 717 def enable_stage_transition(params = {}, = {}) req = build_request(:enable_stage_transition, params) req.send_request() end |
#get_job_details(params = {}) ⇒ Types::GetJobDetailsOutput
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.
779 780 781 782 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 779 def get_job_details(params = {}, = {}) req = build_request(:get_job_details, params) req.send_request() end |
#get_pipeline(params = {}) ⇒ Types::GetPipelineOutput
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.
852 853 854 855 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 852 def get_pipeline(params = {}, = {}) req = build_request(:get_pipeline, params) req.send_request() end |
#get_pipeline_execution(params = {}) ⇒ Types::GetPipelineExecutionOutput
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.
898 899 900 901 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 898 def get_pipeline_execution(params = {}, = {}) req = build_request(:get_pipeline_execution, params) req.send_request() end |
#get_pipeline_state(params = {}) ⇒ Types::GetPipelineStateOutput
Returns information about the state of a pipeline, including the stages and actions.
959 960 961 962 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 959 def get_pipeline_state(params = {}, = {}) req = build_request(:get_pipeline_state, params) req.send_request() end |
#get_third_party_job_details(params = {}) ⇒ Types::GetThirdPartyJobDetailsOutput
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.
1028 1029 1030 1031 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1028 def get_third_party_job_details(params = {}, = {}) req = build_request(:get_third_party_job_details, params) req.send_request() end |
#list_action_types(params = {}) ⇒ Types::ListActionTypesOutput
Gets a summary of all AWS CodePipeline action types associated with your account.
1086 1087 1088 1089 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1086 def list_action_types(params = {}, = {}) req = build_request(:list_action_types, params) req.send_request() end |
#list_pipeline_executions(params = {}) ⇒ Types::ListPipelineExecutionsOutput
Gets a summary of the most recent executions for a pipeline.
1140 1141 1142 1143 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1140 def list_pipeline_executions(params = {}, = {}) req = build_request(:list_pipeline_executions, params) req.send_request() end |
#list_pipelines(params = {}) ⇒ Types::ListPipelinesOutput
Gets a summary of all of the pipelines associated with your account.
1175 1176 1177 1178 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1175 def list_pipelines(params = {}, = {}) req = build_request(:list_pipelines, params) req.send_request() end |
#list_webhooks(params = {}) ⇒ Types::ListWebhooksOutput
Gets a listing of all the webhooks in this region for this account. The output lists all webhooks and includes the webhook URL and ARN, as well the configuration for each webhook.
1228 1229 1230 1231 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1228 def list_webhooks(params = {}, = {}) req = build_request(:list_webhooks, params) req.send_request() end |
#poll_for_jobs(params = {}) ⇒ Types::PollForJobsOutput
Returns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid 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, 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.
1314 1315 1316 1317 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1314 def poll_for_jobs(params = {}, = {}) req = build_request(:poll_for_jobs, params) req.send_request() end |
#poll_for_third_party_jobs(params = {}) ⇒ Types::PollForThirdPartyJobsOutput
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.
1359 1360 1361 1362 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1359 def poll_for_third_party_jobs(params = {}, = {}) req = build_request(:poll_for_third_party_jobs, params) req.send_request() end |
#put_action_revision(params = {}) ⇒ Types::PutActionRevisionOutput
Provides information to AWS CodePipeline about new revisions to a source.
1408 1409 1410 1411 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1408 def put_action_revision(params = {}, = {}) req = build_request(:put_action_revision, params) req.send_request() end |
#put_approval_result(params = {}) ⇒ Types::PutApprovalResultOutput
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
1459 1460 1461 1462 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1459 def put_approval_result(params = {}, = {}) req = build_request(:put_approval_result, params) req.send_request() end |
#put_job_failure_result(params = {}) ⇒ Struct
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
1491 1492 1493 1494 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1491 def put_job_failure_result(params = {}, = {}) req = build_request(:put_job_failure_result, params) req.send_request() end |
#put_job_success_result(params = {}) ⇒ Struct
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
1543 1544 1545 1546 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1543 def put_job_success_result(params = {}, = {}) req = build_request(:put_job_success_result, params) req.send_request() end |
#put_third_party_job_failure_result(params = {}) ⇒ Struct
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
1581 1582 1583 1584 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1581 def put_third_party_job_failure_result(params = {}, = {}) req = build_request(:put_third_party_job_failure_result, params) req.send_request() end |
#put_third_party_job_success_result(params = {}) ⇒ Struct
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
1639 1640 1641 1642 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1639 def put_third_party_job_success_result(params = {}, = {}) req = build_request(:put_third_party_job_success_result, params) req.send_request() end |
#put_webhook(params = {}) ⇒ Types::PutWebhookOutput
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.
1707 1708 1709 1710 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1707 def put_webhook(params = {}, = {}) req = build_request(:put_webhook, params) req.send_request() end |
#register_webhook_with_third_party(params = {}) ⇒ Struct
Configures a connection between the webhook that was created and the external tool with events to be detected.
1731 1732 1733 1734 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1731 def register_webhook_with_third_party(params = {}, = {}) req = build_request(:register_webhook_with_third_party, params) req.send_request() end |
#retry_stage_execution(params = {}) ⇒ Types::RetryStageExecutionOutput
Resumes the pipeline execution by retrying the last failed actions in a stage.
1775 1776 1777 1778 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1775 def retry_stage_execution(params = {}, = {}) req = build_request(:retry_stage_execution, params) req.send_request() end |
#start_pipeline_execution(params = {}) ⇒ Types::StartPipelineExecutionOutput
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
1813 1814 1815 1816 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1813 def start_pipeline_execution(params = {}, = {}) req = build_request(:start_pipeline_execution, params) req.send_request() end |
#update_pipeline(params = {}) ⇒ Types::UpdatePipelineOutput
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.
1935 1936 1937 1938 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1935 def update_pipeline(params = {}, = {}) req = build_request(:update_pipeline, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1959 1960 1961 |
# File 'lib/aws-sdk-codepipeline/client.rb', line 1959 def waiter_names [] end |