Class: Aws::Inspector2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Inspector2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb
Overview
An API client for Inspector2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Inspector2::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
-
#associate_member(params = {}) ⇒ Types::AssociateMemberResponse
Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.
-
#batch_get_account_status(params = {}) ⇒ Types::BatchGetAccountStatusResponse
Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
-
#batch_get_free_trial_info(params = {}) ⇒ Types::BatchGetFreeTrialInfoResponse
Gets free trial status for multiple Amazon Web Services accounts.
-
#cancel_findings_report(params = {}) ⇒ Types::CancelFindingsReportResponse
Cancels the given findings report.
-
#create_filter(params = {}) ⇒ Types::CreateFilterResponse
Creates a filter resource using specified filter criteria.
-
#create_findings_report(params = {}) ⇒ Types::CreateFindingsReportResponse
Creates a finding report.
-
#delete_filter(params = {}) ⇒ Types::DeleteFilterResponse
Deletes a filter resource.
-
#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse
Describe Amazon Inspector configuration settings for an Amazon Web Services organization.
-
#disable(params = {}) ⇒ Types::DisableResponse
Disables Amazon Inspector scans for one or more Amazon Web Services accounts.
-
#disable_delegated_admin_account(params = {}) ⇒ Types::DisableDelegatedAdminAccountResponse
Disables the Amazon Inspector delegated administrator for your organization.
-
#disassociate_member(params = {}) ⇒ Types::DisassociateMemberResponse
Disassociates a member account from an Amazon Inspector delegated administrator.
-
#enable(params = {}) ⇒ Types::EnableResponse
Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
-
#enable_delegated_admin_account(params = {}) ⇒ Types::EnableDelegatedAdminAccountResponse
Enables the Amazon Inspector delegated administrator for your Organizations organization.
-
#get_delegated_admin_account(params = {}) ⇒ Types::GetDelegatedAdminAccountResponse
Retrieves information about the Amazon Inspector delegated administrator for your organization.
-
#get_findings_report_status(params = {}) ⇒ Types::GetFindingsReportStatusResponse
Gets the status of a findings report.
-
#get_member(params = {}) ⇒ Types::GetMemberResponse
Gets member information for your organization.
-
#list_account_permissions(params = {}) ⇒ Types::ListAccountPermissionsResponse
Lists the permissions an account has to configure Amazon Inspector.
-
#list_coverage(params = {}) ⇒ Types::ListCoverageResponse
Lists coverage details for you environment.
-
#list_coverage_statistics(params = {}) ⇒ Types::ListCoverageStatisticsResponse
Lists Amazon Inspector coverage statistics for your environment.
-
#list_delegated_admin_accounts(params = {}) ⇒ Types::ListDelegatedAdminAccountsResponse
Lists information about the Amazon Inspector delegated administrator of your organization.
-
#list_filters(params = {}) ⇒ Types::ListFiltersResponse
Lists the filters associated with your account.
-
#list_finding_aggregations(params = {}) ⇒ Types::ListFindingAggregationsResponse
Lists aggregated finding data for your environment based on specific criteria.
-
#list_findings(params = {}) ⇒ Types::ListFindingsResponse
Lists findings for your environment.
-
#list_members(params = {}) ⇒ Types::ListMembersResponse
List members associated with the Amazon Inspector delegated administrator for your organization.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags attached to a given resource.
-
#list_usage_totals(params = {}) ⇒ Types::ListUsageTotalsResponse
Lists the Amazon Inspector usage totals over the last 30 days.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_filter(params = {}) ⇒ Types::UpdateFilterResponse
Specifies the action that is to be applied to the findings that match the filter.
-
#update_organization_configuration(params = {}) ⇒ Types::UpdateOrganizationConfigurationResponse
Updates the configurations for your Amazon Inspector organization.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from 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.
348 349 350 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#associate_member(params = {}) ⇒ Types::AssociateMemberResponse
Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.
379 380 381 382 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 379 def associate_member(params = {}, = {}) req = build_request(:associate_member, params) req.send_request() end |
#batch_get_account_status(params = {}) ⇒ Types::BatchGetAccountStatusResponse
Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
427 428 429 430 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 427 def batch_get_account_status(params = {}, = {}) req = build_request(:batch_get_account_status, params) req.send_request() end |
#batch_get_free_trial_info(params = {}) ⇒ Types::BatchGetFreeTrialInfoResponse
Gets free trial status for multiple Amazon Web Services accounts.
466 467 468 469 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 466 def batch_get_free_trial_info(params = {}, = {}) req = build_request(:batch_get_free_trial_info, params) req.send_request() end |
#cancel_findings_report(params = {}) ⇒ Types::CancelFindingsReportResponse
Cancels the given findings report.
494 495 496 497 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 494 def cancel_findings_report(params = {}, = {}) req = build_request(:cancel_findings_report, params) req.send_request() end |
#create_filter(params = {}) ⇒ Types::CreateFilterResponse
Creates a filter resource using specified filter criteria.
753 754 755 756 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 753 def create_filter(params = {}, = {}) req = build_request(:create_filter, params) req.send_request() end |
#create_findings_report(params = {}) ⇒ Types::CreateFindingsReportResponse
Creates a finding report.
1003 1004 1005 1006 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1003 def create_findings_report(params = {}, = {}) req = build_request(:create_findings_report, params) req.send_request() end |
#delete_filter(params = {}) ⇒ Types::DeleteFilterResponse
Deletes a filter resource.
1031 1032 1033 1034 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1031 def delete_filter(params = {}, = {}) req = build_request(:delete_filter, params) req.send_request() end |
#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse
Describe Amazon Inspector configuration settings for an Amazon Web Services organization
1054 1055 1056 1057 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1054 def describe_organization_configuration(params = {}, = {}) req = build_request(:describe_organization_configuration, params) req.send_request() end |
#disable(params = {}) ⇒ Types::DisableResponse
Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.
1101 1102 1103 1104 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1101 def disable(params = {}, = {}) req = build_request(:disable, params) req.send_request() end |
#disable_delegated_admin_account(params = {}) ⇒ Types::DisableDelegatedAdminAccountResponse
Disables the Amazon Inspector delegated administrator for your organization.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1131 def disable_delegated_admin_account(params = {}, = {}) req = build_request(:disable_delegated_admin_account, params) req.send_request() end |
#disassociate_member(params = {}) ⇒ Types::DisassociateMemberResponse
Disassociates a member account from an Amazon Inspector delegated administrator.
1161 1162 1163 1164 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1161 def disassociate_member(params = {}, = {}) req = build_request(:disassociate_member, params) req.send_request() end |
#enable(params = {}) ⇒ Types::EnableResponse
Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
1213 1214 1215 1216 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1213 def enable(params = {}, = {}) req = build_request(:enable, params) req.send_request() end |
#enable_delegated_admin_account(params = {}) ⇒ Types::EnableDelegatedAdminAccountResponse
Enables the Amazon Inspector delegated administrator for your Organizations organization.
1250 1251 1252 1253 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1250 def enable_delegated_admin_account(params = {}, = {}) req = build_request(:enable_delegated_admin_account, params) req.send_request() end |
#get_delegated_admin_account(params = {}) ⇒ Types::GetDelegatedAdminAccountResponse
Retrieves information about the Amazon Inspector delegated administrator for your organization.
1271 1272 1273 1274 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1271 def get_delegated_admin_account(params = {}, = {}) req = build_request(:get_delegated_admin_account, params) req.send_request() end |
#get_findings_report_status(params = {}) ⇒ Types::GetFindingsReportStatusResponse
Gets the status of a findings report.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1414 def get_findings_report_status(params = {}, = {}) req = build_request(:get_findings_report_status, params) req.send_request() end |
#get_member(params = {}) ⇒ Types::GetMemberResponse
Gets member information for your organization.
1446 1447 1448 1449 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1446 def get_member(params = {}, = {}) req = build_request(:get_member, params) req.send_request() end |
#list_account_permissions(params = {}) ⇒ Types::ListAccountPermissionsResponse
Lists the permissions an account has to configure Amazon Inspector.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1492 1493 1494 1495 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1492 def (params = {}, = {}) req = build_request(:list_account_permissions, params) req.send_request() end |
#list_coverage(params = {}) ⇒ Types::ListCoverageResponse
Lists coverage details for you environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1607 1608 1609 1610 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1607 def list_coverage(params = {}, = {}) req = build_request(:list_coverage, params) req.send_request() end |
#list_coverage_statistics(params = {}) ⇒ Types::ListCoverageStatisticsResponse
Lists Amazon Inspector coverage statistics for your environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1712 1713 1714 1715 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1712 def list_coverage_statistics(params = {}, = {}) req = build_request(:list_coverage_statistics, params) req.send_request() end |
#list_delegated_admin_accounts(params = {}) ⇒ Types::ListDelegatedAdminAccountsResponse
Lists information about the Amazon Inspector delegated administrator of your organization.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1755 def list_delegated_admin_accounts(params = {}, = {}) req = build_request(:list_delegated_admin_accounts, params) req.send_request() end |
#list_filters(params = {}) ⇒ Types::ListFiltersResponse
Lists the filters associated with your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1917 def list_filters(params = {}, = {}) req = build_request(:list_filters, params) req.send_request() end |
#list_finding_aggregations(params = {}) ⇒ Types::ListFindingAggregationsResponse
Lists aggregated finding data for your environment based on specific criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2191 2192 2193 2194 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2191 def list_finding_aggregations(params = {}, = {}) req = build_request(:list_finding_aggregations, params) req.send_request() end |
#list_findings(params = {}) ⇒ Types::ListFindingsResponse
Lists findings for your environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2532 2533 2534 2535 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2532 def list_findings(params = {}, = {}) req = build_request(:list_findings, params) req.send_request() end |
#list_members(params = {}) ⇒ Types::ListMembersResponse
List members associated with the Amazon Inspector delegated administrator for your organization.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2582 2583 2584 2585 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2582 def list_members(params = {}, = {}) req = build_request(:list_members, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags attached to a given resource.
2611 2612 2613 2614 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2611 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_usage_totals(params = {}) ⇒ Types::ListUsageTotalsResponse
Lists the Amazon Inspector usage totals over the last 30 days.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2661 2662 2663 2664 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2661 def list_usage_totals(params = {}, = {}) req = build_request(:list_usage_totals, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
2689 2690 2691 2692 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2689 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
2715 2716 2717 2718 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2715 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_filter(params = {}) ⇒ Types::UpdateFilterResponse
Specifies the action that is to be applied to the findings that match the filter.
2971 2972 2973 2974 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2971 def update_filter(params = {}, = {}) req = build_request(:update_filter, params) req.send_request() end |
#update_organization_configuration(params = {}) ⇒ Types::UpdateOrganizationConfigurationResponse
Updates the configurations for your Amazon Inspector organization.
3004 3005 3006 3007 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3004 def update_organization_configuration(params = {}, = {}) req = build_request(:update_organization_configuration, params) req.send_request() end |