Client — AWS SDK for Ruby V3 (original) (raw)

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

474 475 476 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 474 def initialize(*args) super end

Instance Method Details

#batch_delete_builds(params = {}) ⇒ Types::BatchDeleteBuildsOutput

Deletes one or more builds.

508 509 510 511 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 508 def batch_delete_builds(params = {}, options = {}) req = build_request(:batch_delete_builds, params) req.send_request(options) end

#batch_get_build_batches(params = {}) ⇒ Types::BatchGetBuildBatchesOutput

Retrieves information about one or more batch builds.

686 687 688 689 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 686 def batch_get_build_batches(params = {}, options = {}) req = build_request(:batch_get_build_batches, params) req.send_request(options) end

#batch_get_builds(params = {}) ⇒ Types::BatchGetBuildsOutput

Gets information about one or more builds.

846 847 848 849 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 846 def batch_get_builds(params = {}, options = {}) req = build_request(:batch_get_builds, params) req.send_request(options) end

#batch_get_command_executions(params = {}) ⇒ Types::BatchGetCommandExecutionsOutput

Gets information about the command executions.

906 907 908 909 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 906 def batch_get_command_executions(params = {}, options = {}) req = build_request(:batch_get_command_executions, params) req.send_request(options) end

#batch_get_fleets(params = {}) ⇒ Types::BatchGetFleetsOutput

Gets information about one or more compute fleets.

976 977 978 979 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 976 def batch_get_fleets(params = {}, options = {}) req = build_request(:batch_get_fleets, params) req.send_request(options) end

#batch_get_projects(params = {}) ⇒ Types::BatchGetProjectsOutput

Gets information about one or more build projects.

1145 1146 1147 1148 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1145 def batch_get_projects(params = {}, options = {}) req = build_request(:batch_get_projects, params) req.send_request(options) end

#batch_get_report_groups(params = {}) ⇒ Types::BatchGetReportGroupsOutput

Returns an array of report groups.

1193 1194 1195 1196 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1193 def batch_get_report_groups(params = {}, options = {}) req = build_request(:batch_get_report_groups, params) req.send_request(options) end

#batch_get_reports(params = {}) ⇒ Types::BatchGetReportsOutput

Returns an array of reports.

1250 1251 1252 1253 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1250 def batch_get_reports(params = {}, options = {}) req = build_request(:batch_get_reports, params) req.send_request(options) end

#batch_get_sandboxes(params = {}) ⇒ Types::BatchGetSandboxesOutput

Gets information about the sandbox status.

1387 1388 1389 1390 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1387 def batch_get_sandboxes(params = {}, options = {}) req = build_request(:batch_get_sandboxes, params) req.send_request(options) end

#create_fleet(params = {}) ⇒ Types::CreateFleetOutput

1699 1700 1701 1702 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1699 def create_fleet(params = {}, options = {}) req = build_request(:create_fleet, params) req.send_request(options) end

#create_project(params = {}) ⇒ Types::CreateProjectOutput

2159 2160 2161 2162 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2159 def create_project(params = {}, options = {}) req = build_request(:create_project, params) req.send_request(options) end

#create_report_group(params = {}) ⇒ Types::CreateReportGroupOutput

Creates a report group. A report group contains a collection of reports.

2234 2235 2236 2237 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2234 def create_report_group(params = {}, options = {}) req = build_request(:create_report_group, params) req.send_request(options) end

#create_webhook(params = {}) ⇒ Types::CreateWebhookOutput

For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.

If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 inChange a Build Project's Settings.

2364 2365 2366 2367 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2364 def create_webhook(params = {}, options = {}) req = build_request(:create_webhook, params) req.send_request(options) end

#delete_build_batch(params = {}) ⇒ Types::DeleteBuildBatchOutput

2399 2400 2401 2402 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2399 def delete_build_batch(params = {}, options = {}) req = build_request(:delete_build_batch, params) req.send_request(options) end

#delete_fleet(params = {}) ⇒ Struct

Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.

2422 2423 2424 2425 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2422 def delete_fleet(params = {}, options = {}) req = build_request(:delete_fleet, params) req.send_request(options) end

#delete_project(params = {}) ⇒ Struct

Deletes a build project. When you delete a project, its builds are not deleted.

2445 2446 2447 2448 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2445 def delete_project(params = {}, options = {}) req = build_request(:delete_project, params) req.send_request(options) end

#delete_report(params = {}) ⇒ Struct

2467 2468 2469 2470 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2467 def delete_report(params = {}, options = {}) req = build_request(:delete_report, params) req.send_request(options) end

#delete_report_group(params = {}) ⇒ Struct

Deletes a report group. Before you delete a report group, you must delete its reports.

2506 2507 2508 2509 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2506 def delete_report_group(params = {}, options = {}) req = build_request(:delete_report_group, params) req.send_request(options) end

#delete_resource_policy(params = {}) ⇒ Struct

Deletes a resource policy that is identified by its resource ARN.

2528 2529 2530 2531 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2528 def delete_resource_policy(params = {}, options = {}) req = build_request(:delete_resource_policy, params) req.send_request(options) end

#delete_source_credentials(params = {}) ⇒ Types::DeleteSourceCredentialsOutput

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

2557 2558 2559 2560 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2557 def delete_source_credentials(params = {}, options = {}) req = build_request(:delete_source_credentials, params) req.send_request(options) end

#delete_webhook(params = {}) ⇒ Struct

For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.

2582 2583 2584 2585 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2582 def delete_webhook(params = {}, options = {}) req = build_request(:delete_webhook, params) req.send_request(options) end

#describe_code_coverages(params = {}) ⇒ Types::DescribeCodeCoveragesOutput

Retrieves one or more code coverage reports.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

2658 2659 2660 2661 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2658 def describe_code_coverages(params = {}, options = {}) req = build_request(:describe_code_coverages, params) req.send_request(options) end

#describe_test_cases(params = {}) ⇒ Types::DescribeTestCasesOutput

Returns a list of details about test cases for a report.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

2722 2723 2724 2725 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2722 def describe_test_cases(params = {}, options = {}) req = build_request(:describe_test_cases, params) req.send_request(options) end

#get_report_group_trend(params = {}) ⇒ Types::GetReportGroupTrendOutput

Analyzes and accumulates test report values for the specified test reports.

2817 2818 2819 2820 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2817 def get_report_group_trend(params = {}, options = {}) req = build_request(:get_report_group_trend, params) req.send_request(options) end

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyOutput

Gets a resource policy that is identified by its resource ARN.

2845 2846 2847 2848 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2845 def get_resource_policy(params = {}, options = {}) req = build_request(:get_resource_policy, params) req.send_request(options) end

#import_source_credentials(params = {}) ⇒ Types::ImportSourceCredentialsOutput

Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository.

2901 2902 2903 2904 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2901 def import_source_credentials(params = {}, options = {}) req = build_request(:import_source_credentials, params) req.send_request(options) end

#invalidate_project_cache(params = {}) ⇒ Struct

Resets the cache for a project.

2923 2924 2925 2926 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2923 def invalidate_project_cache(params = {}, options = {}) req = build_request(:invalidate_project_cache, params) req.send_request(options) end

#list_build_batches(params = {}) ⇒ Types::ListBuildBatchesOutput

Retrieves the identifiers of your build batches in the current region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

2978 2979 2980 2981 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2978 def list_build_batches(params = {}, options = {}) req = build_request(:list_build_batches, params) req.send_request(options) end

#list_build_batches_for_project(params = {}) ⇒ Types::ListBuildBatchesForProjectOutput

Retrieves the identifiers of the build batches for a specific project.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3037 3038 3039 3040 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3037 def list_build_batches_for_project(params = {}, options = {}) req = build_request(:list_build_batches_for_project, params) req.send_request(options) end

#list_builds(params = {}) ⇒ Types::ListBuildsOutput

Gets a list of build IDs, with each build ID representing a single build.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3085 3086 3087 3088 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3085 def list_builds(params = {}, options = {}) req = build_request(:list_builds, params) req.send_request(options) end

#list_builds_for_project(params = {}) ⇒ Types::ListBuildsForProjectOutput

Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3146 3147 3148 3149 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3146 def list_builds_for_project(params = {}, options = {}) req = build_request(:list_builds_for_project, params) req.send_request(options) end

#list_command_executions_for_sandbox(params = {}) ⇒ Types::ListCommandExecutionsForSandboxOutput

Gets a list of command executions for a sandbox.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3216 3217 3218 3219 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3216 def list_command_executions_for_sandbox(params = {}, options = {}) req = build_request(:list_command_executions_for_sandbox, params) req.send_request(options) end

#list_curated_environment_images(params = {}) ⇒ Types::ListCuratedEnvironmentImagesOutput

Gets information about Docker images that are managed by CodeBuild.

3243 3244 3245 3246 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3243 def list_curated_environment_images(params = {}, options = {}) req = build_request(:list_curated_environment_images, params) req.send_request(options) end

#list_fleets(params = {}) ⇒ Types::ListFleetsOutput

Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3315 3316 3317 3318 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3315 def list_fleets(params = {}, options = {}) req = build_request(:list_fleets, params) req.send_request(options) end

#list_projects(params = {}) ⇒ Types::ListProjectsOutput

Gets a list of build project names, with each build project name representing a single build project.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3381 3382 3383 3384 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3381 def list_projects(params = {}, options = {}) req = build_request(:list_projects, params) req.send_request(options) end

#list_report_groups(params = {}) ⇒ Types::ListReportGroupsOutput

Gets a list ARNs for the report groups in the current Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3444 3445 3446 3447 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3444 def list_report_groups(params = {}, options = {}) req = build_request(:list_report_groups, params) req.send_request(options) end

#list_reports(params = {}) ⇒ Types::ListReportsOutput

Returns a list of ARNs for the reports in the current Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3507 3508 3509 3510 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3507 def list_reports(params = {}, options = {}) req = build_request(:list_reports, params) req.send_request(options) end

#list_reports_for_report_group(params = {}) ⇒ Types::ListReportsForReportGroupOutput

Returns a list of ARNs for the reports that belong to a ReportGroup.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3567 3568 3569 3570 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3567 def list_reports_for_report_group(params = {}, options = {}) req = build_request(:list_reports_for_report_group, params) req.send_request(options) end

#list_sandboxes(params = {}) ⇒ Types::ListSandboxesOutput

Gets a list of sandboxes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3609 3610 3611 3612 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3609 def list_sandboxes(params = {}, options = {}) req = build_request(:list_sandboxes, params) req.send_request(options) end

#list_sandboxes_for_project(params = {}) ⇒ Types::ListSandboxesForProjectOutput

Gets a list of sandboxes for a given project.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3655 3656 3657 3658 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3655 def list_sandboxes_for_project(params = {}, options = {}) req = build_request(:list_sandboxes_for_project, params) req.send_request(options) end

#list_shared_projects(params = {}) ⇒ Types::ListSharedProjectsOutput

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3720 3721 3722 3723 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3720 def list_shared_projects(params = {}, options = {}) req = build_request(:list_shared_projects, params) req.send_request(options) end

#list_shared_report_groups(params = {}) ⇒ Types::ListSharedReportGroupsOutput

Gets a list of report groups that are shared with other Amazon Web Services accounts or users.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

3784 3785 3786 3787 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3784 def list_shared_report_groups(params = {}, options = {}) req = build_request(:list_shared_report_groups, params) req.send_request(options) end

#list_source_credentials(params = {}) ⇒ Types::ListSourceCredentialsOutput

Returns a list of SourceCredentialsInfo objects.

3807 3808 3809 3810 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3807 def list_source_credentials(params = {}, options = {}) req = build_request(:list_source_credentials, params) req.send_request(options) end

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyOutput

Stores a resource policy for the ARN of a Project or ReportGroupobject.

3848 3849 3850 3851 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3848 def put_resource_policy(params = {}, options = {}) req = build_request(:put_resource_policy, params) req.send_request(options) end

#retry_build(params = {}) ⇒ Types::RetryBuildOutput

4012 4013 4014 4015 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 4012 def retry_build(params = {}, options = {}) req = build_request(:retry_build, params) req.send_request(options) end

#retry_build_batch(params = {}) ⇒ Types::RetryBuildBatchOutput

Restarts a failed batch build. Only batch builds that have failed can be retried.

4199 4200 4201 4202 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 4199 def retry_build_batch(params = {}, options = {}) req = build_request(:retry_build_batch, params) req.send_request(options) end

#start_build(params = {}) ⇒ Types::StartBuildOutput

Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output.

You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered.

4726 4727 4728 4729 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 4726 def start_build(params = {}, options = {}) req = build_request(:start_build, params) req.send_request(options) end

#start_build_batch(params = {}) ⇒ Types::StartBuildBatchOutput

Starts a batch build for a project.

5233 5234 5235 5236 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5233 def start_build_batch(params = {}, options = {}) req = build_request(:start_build_batch, params) req.send_request(options) end

#start_command_execution(params = {}) ⇒ Types::StartCommandExecutionOutput

Starts a command execution.

5293 5294 5295 5296 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5293 def start_command_execution(params = {}, options = {}) req = build_request(:start_command_execution, params) req.send_request(options) end

#start_sandbox(params = {}) ⇒ Types::StartSandboxOutput

5430 5431 5432 5433 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5430 def start_sandbox(params = {}, options = {}) req = build_request(:start_sandbox, params) req.send_request(options) end

#start_sandbox_connection(params = {}) ⇒ Types::StartSandboxConnectionOutput

Starts a sandbox connection.

5460 5461 5462 5463 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5460 def start_sandbox_connection(params = {}, options = {}) req = build_request(:start_sandbox_connection, params) req.send_request(options) end

#stop_build(params = {}) ⇒ Types::StopBuildOutput

Attempts to stop running a build.

5616 5617 5618 5619 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5616 def stop_build(params = {}, options = {}) req = build_request(:stop_build, params) req.send_request(options) end

#stop_build_batch(params = {}) ⇒ Types::StopBuildBatchOutput

Stops a running batch build.

5790 5791 5792 5793 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5790 def stop_build_batch(params = {}, options = {}) req = build_request(:stop_build_batch, params) req.send_request(options) end

#stop_sandbox(params = {}) ⇒ Types::StopSandboxOutput

5923 5924 5925 5926 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5923 def stop_sandbox(params = {}, options = {}) req = build_request(:stop_sandbox, params) req.send_request(options) end

#update_fleet(params = {}) ⇒ Types::UpdateFleetOutput

6235 6236 6237 6238 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6235 def update_fleet(params = {}, options = {}) req = build_request(:update_fleet, params) req.send_request(options) end

#update_project(params = {}) ⇒ Types::UpdateProjectOutput

Changes the settings of a build project.

6698 6699 6700 6701 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6698 def update_project(params = {}, options = {}) req = build_request(:update_project, params) req.send_request(options) end

#update_project_visibility(params = {}) ⇒ Types::UpdateProjectVisibilityOutput

Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide.

The following should be kept in mind when making your projects public:

6782 6783 6784 6785 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6782 def update_project_visibility(params = {}, options = {}) req = build_request(:update_project_visibility, params) req.send_request(options) end

#update_report_group(params = {}) ⇒ Types::UpdateReportGroupOutput

6856 6857 6858 6859 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6856 def update_report_group(params = {}, options = {}) req = build_request(:update_report_group, params) req.send_request(options) end

#update_webhook(params = {}) ⇒ Types::UpdateWebhookOutput

Updates the webhook associated with an CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.

6952 6953 6954 6955 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6952 def update_webhook(params = {}, options = {}) req = build_request(:update_webhook, params) req.send_request(options) end