Class: Aws::CodeGuruSecurity::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodeGuruSecurity::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb
Overview
An API client for CodeGuruSecurity. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CodeGuruSecurity::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_get_findings(params = {}) ⇒ Types::BatchGetFindingsResponse
Returns a list of all requested findings.
-
#create_scan(params = {}) ⇒ Types::CreateScanResponse
Use to create a scan using code uploaded to an S3 bucket.
-
#create_upload_url(params = {}) ⇒ Types::CreateUploadUrlResponse
Generates a pre-signed URL and request headers used to upload a code resource.
-
#get_account_configuration(params = {}) ⇒ Types::GetAccountConfigurationResponse
Use to get account level configuration.
-
#get_findings(params = {}) ⇒ Types::GetFindingsResponse
Returns a list of all findings generated by a particular scan.
-
#get_metrics_summary(params = {}) ⇒ Types::GetMetricsSummaryResponse
Returns top level metrics about an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.
-
#get_scan(params = {}) ⇒ Types::GetScanResponse
Returns details about a scan, including whether or not a scan has completed.
-
#list_findings_metrics(params = {}) ⇒ Types::ListFindingsMetricsResponse
Returns metrics about all findings in an account within a specified time range.
-
#list_scans(params = {}) ⇒ Types::ListScansResponse
Returns a list of all the standard scans in an account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of all tags associated with a scan.
-
#tag_resource(params = {}) ⇒ Struct
Use to add one or more tags to an existing scan.
-
#untag_resource(params = {}) ⇒ Struct
Use to remove one or more tags from an existing scan.
-
#update_account_configuration(params = {}) ⇒ Types::UpdateAccountConfigurationResponse
Use to update account-level configuration with an encryption key.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
409 410 411 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#batch_get_findings(params = {}) ⇒ Types::BatchGetFindingsResponse
Returns a list of all requested findings.
485 486 487 488 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 485 def batch_get_findings(params = {}, = {}) req = build_request(:batch_get_findings, params) req.send_request() end |
#create_scan(params = {}) ⇒ Types::CreateScanResponse
Use to create a scan using code uploaded to an S3 bucket.
569 570 571 572 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 569 def create_scan(params = {}, = {}) req = build_request(:create_scan, params) req.send_request() end |
#create_upload_url(params = {}) ⇒ Types::CreateUploadUrlResponse
Generates a pre-signed URL and request headers used to upload a code resource.
You can upload your code resource to the URL and add the request headers using any HTTP client.
609 610 611 612 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 609 def create_upload_url(params = {}, = {}) req = build_request(:create_upload_url, params) req.send_request() end |
#get_account_configuration(params = {}) ⇒ Types::GetAccountConfigurationResponse
Use to get account level configuration.
628 629 630 631 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 628 def get_account_configuration(params = {}, = {}) req = build_request(:get_account_configuration, params) req.send_request() end |
#get_findings(params = {}) ⇒ Types::GetFindingsResponse
Returns a list of all findings generated by a particular scan.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
714 715 716 717 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 714 def get_findings(params = {}, = {}) req = build_request(:get_findings, params) req.send_request() end |
#get_metrics_summary(params = {}) ⇒ Types::GetMetricsSummaryResponse
Returns top level metrics about an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.
762 763 764 765 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 762 def get_metrics_summary(params = {}, = {}) req = build_request(:get_metrics_summary, params) req.send_request() end |
#get_scan(params = {}) ⇒ Types::GetScanResponse
Returns details about a scan, including whether or not a scan has completed.
811 812 813 814 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 811 def get_scan(params = {}, = {}) req = build_request(:get_scan, params) req.send_request() end |
#list_findings_metrics(params = {}) ⇒ Types::ListFindingsMetricsResponse
Returns metrics about all findings in an account within a specified time range.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
885 886 887 888 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 885 def list_findings_metrics(params = {}, = {}) req = build_request(:list_findings_metrics, params) req.send_request() end |
#list_scans(params = {}) ⇒ Types::ListScansResponse
Returns a list of all the standard scans in an account. Does not return express scans.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
935 936 937 938 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 935 def list_scans(params = {}, = {}) req = build_request(:list_scans, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of all tags associated with a scan.
965 966 967 968 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 965 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Use to add one or more tags to an existing scan.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1002 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Use to remove one or more tags from an existing scan.
1029 1030 1031 1032 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1029 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_account_configuration(params = {}) ⇒ Types::UpdateAccountConfigurationResponse
Use to update account-level configuration with an encryption key.
1060 1061 1062 1063 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1060 def update_account_configuration(params = {}, = {}) req = build_request(:update_account_configuration, params) req.send_request() end |