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 requested findings from standard scans.
-
#create_scan(params = {}) ⇒ Types::CreateScanResponse
Use to create a scan using code uploaded to an Amazon S3 bucket.
-
#create_upload_url(params = {}) ⇒ Types::CreateUploadUrlResponse
Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.
-
#get_account_configuration(params = {}) ⇒ Types::GetAccountConfigurationResponse
Use to get the encryption configuration for an account.
-
#get_findings(params = {}) ⇒ Types::GetFindingsResponse
Returns a list of all findings generated by a particular scan.
-
#get_metrics_summary(params = {}) ⇒ Types::GetMetricsSummaryResponse
Returns a summary of metrics for 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 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 the encryption configuration for an account.
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.
440 441 442 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 440 def initialize(*args) super end |
Instance Method Details
#batch_get_findings(params = {}) ⇒ Types::BatchGetFindingsResponse
Returns a list of requested findings from standard scans.
516 517 518 519 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 516 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 Amazon S3 bucket.
600 601 602 603 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 600 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, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.
You can upload your code resource to the URL with the request headers using any HTTP client.
640 641 642 643 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 640 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 the encryption configuration for an account.
659 660 661 662 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 659 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.
745 746 747 748 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 745 def get_findings(params = {}, = {}) req = build_request(:get_findings, params) req.send_request() end |
#get_metrics_summary(params = {}) ⇒ Types::GetMetricsSummaryResponse
Returns a summary of metrics for 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.
791 792 793 794 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 791 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.
842 843 844 845 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 842 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.
917 918 919 920 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 917 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 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.
967 968 969 970 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 967 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.
997 998 999 1000 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 997 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.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1034 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.
1061 1062 1063 1064 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1061 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_account_configuration(params = {}) ⇒ Types::UpdateAccountConfigurationResponse
Use to update the encryption configuration for an account.
1095 1096 1097 1098 |
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1095 def update_account_configuration(params = {}, = {}) req = build_request(:update_account_configuration, params) req.send_request() end |