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_configuration(params = {}) ⇒ Types::GetConfigurationResponse
Retrieves setting configurations for Inspector scans.
-
#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_configuration(params = {}) ⇒ Struct
Updates setting configurations for your Amazon Inspector account.
-
#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.
365 366 367 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 365 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.
396 397 398 399 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 396 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.
448 449 450 451 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 448 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.
487 488 489 490 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 487 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.
515 516 517 518 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 515 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.
824 825 826 827 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 824 def create_filter(params = {}, = {}) req = build_request(:create_filter, params) req.send_request() end |
#create_findings_report(params = {}) ⇒ Types::CreateFindingsReportResponse
Creates a finding report.
1120 1121 1122 1123 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1120 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.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1148 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.
1172 1173 1174 1175 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1172 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.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1221 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.
1251 1252 1253 1254 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1251 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.
1281 1282 1283 1284 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1281 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.
1335 1336 1337 1338 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1335 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.
1372 1373 1374 1375 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1372 def enable_delegated_admin_account(params = {}, = {}) req = build_request(:enable_delegated_admin_account, params) req.send_request() end |
#get_configuration(params = {}) ⇒ Types::GetConfigurationResponse
Retrieves setting configurations for Inspector scans.
1393 1394 1395 1396 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1393 def get_configuration(params = {}, = {}) req = build_request(:get_configuration, params) req.send_request() end |
#get_delegated_admin_account(params = {}) ⇒ Types::GetDelegatedAdminAccountResponse
Retrieves information about the Amazon Inspector delegated administrator for your organization.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1414 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.
1580 1581 1582 1583 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1580 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.
1612 1613 1614 1615 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1612 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.
1658 1659 1660 1661 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1658 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.
1798 1799 1800 1801 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1798 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.
1922 1923 1924 1925 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1922 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.
1965 1966 1967 1968 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1965 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.
2150 2151 2152 2153 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2150 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.
2494 2495 2496 2497 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2494 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.
2902 2903 2904 2905 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2902 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.
2952 2953 2954 2955 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2952 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.
2981 2982 2983 2984 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2981 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.
3031 3032 3033 3034 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3031 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.
3059 3060 3061 3062 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3059 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
3085 3086 3087 3088 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3085 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_configuration(params = {}) ⇒ Struct
Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.
3113 3114 3115 3116 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3113 def update_configuration(params = {}, = {}) req = build_request(:update_configuration, 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.
3419 3420 3421 3422 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3419 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.
3454 3455 3456 3457 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3454 def update_organization_configuration(params = {}, = {}) req = build_request(:update_organization_configuration, params) req.send_request() end |