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

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

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

Instance Method Details

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

Deletes one or more builds.

507 508 509 510 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 507 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.

690 691 692 693 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 690 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.

855 856 857 858 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 855 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.

915 916 917 918 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 915 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.

985 986 987 988 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 985 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.

1159 1160 1161 1162 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1159 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.

1207 1208 1209 1210 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1207 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.

1264 1265 1266 1267 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1264 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.

1406 1407 1408 1409 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1406 def batch_get_sandboxes(params = {}, options = {}) req = build_request(:batch_get_sandboxes, params) req.send_request(options) end

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

1724 1725 1726 1727 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 1724 def create_fleet(params = {}, options = {}) req = build_request(:create_fleet, params) req.send_request(options) end

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

2197 2198 2199 2200 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2197 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.

2272 2273 2274 2275 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2272 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.

2402 2403 2404 2405 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2402 def create_webhook(params = {}, options = {}) req = build_request(:create_webhook, params) req.send_request(options) end

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

2437 2438 2439 2440 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2437 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.

2460 2461 2462 2463 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2460 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.

2483 2484 2485 2486 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2483 def delete_project(params = {}, options = {}) req = build_request(:delete_project, params) req.send_request(options) end

#delete_report(params = {}) ⇒ Struct

2505 2506 2507 2508 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2505 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.

2544 2545 2546 2547 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2544 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.

2566 2567 2568 2569 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2566 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.

2595 2596 2597 2598 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2595 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.

2620 2621 2622 2623 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2620 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.

2696 2697 2698 2699 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2696 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.

2760 2761 2762 2763 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2760 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.

2855 2856 2857 2858 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2855 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.

2883 2884 2885 2886 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2883 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.

2939 2940 2941 2942 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2939 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.

2961 2962 2963 2964 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 2961 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.

3016 3017 3018 3019 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3016 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.

3075 3076 3077 3078 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3075 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.

3123 3124 3125 3126 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3123 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.

3184 3185 3186 3187 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3184 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.

3254 3255 3256 3257 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3254 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.

3281 3282 3283 3284 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3281 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.

3353 3354 3355 3356 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3353 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.

3419 3420 3421 3422 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3419 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.

3482 3483 3484 3485 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3482 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.

3545 3546 3547 3548 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3545 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.

3605 3606 3607 3608 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3605 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.

3647 3648 3649 3650 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3647 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.

3693 3694 3695 3696 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3693 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.

3758 3759 3760 3761 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3758 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.

3822 3823 3824 3825 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3822 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.

3845 3846 3847 3848 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3845 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.

3886 3887 3888 3889 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 3886 def put_resource_policy(params = {}, options = {}) req = build_request(:put_resource_policy, params) req.send_request(options) end

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

4055 4056 4057 4058 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 4055 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.

4247 4248 4249 4250 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 4247 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.

4779 4780 4781 4782 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 4779 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.

5291 5292 5293 5294 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5291 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.

5351 5352 5353 5354 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5351 def start_command_execution(params = {}, options = {}) req = build_request(:start_command_execution, params) req.send_request(options) end

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

5493 5494 5495 5496 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5493 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.

5523 5524 5525 5526 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5523 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.

5684 5685 5686 5687 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5684 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.

5863 5864 5865 5866 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 5863 def stop_build_batch(params = {}, options = {}) req = build_request(:stop_build_batch, params) req.send_request(options) end

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

6001 6002 6003 6004 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6001 def stop_sandbox(params = {}, options = {}) req = build_request(:stop_sandbox, params) req.send_request(options) end

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

6319 6320 6321 6322 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6319 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.

6795 6796 6797 6798 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6795 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:

6879 6880 6881 6882 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6879 def update_project_visibility(params = {}, options = {}) req = build_request(:update_project_visibility, params) req.send_request(options) end

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

6953 6954 6955 6956 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 6953 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.

7049 7050 7051 7052 # File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb', line 7049 def update_webhook(params = {}, options = {}) req = build_request(:update_webhook, params) req.send_request(options) end