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_associate_code_security_scan_configuration(params = {}) ⇒ Types::BatchAssociateCodeSecurityScanConfigurationResponse
Associates multiple code repositories with an Amazon Inspector code security scan configuration.
-
#batch_disassociate_code_security_scan_configuration(params = {}) ⇒ Types::BatchDisassociateCodeSecurityScanConfigurationResponse
Disassociates multiple code repositories from an Amazon Inspector code security scan configuration.
-
#batch_get_account_status(params = {}) ⇒ Types::BatchGetAccountStatusResponse
Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
-
#batch_get_code_snippet(params = {}) ⇒ Types::BatchGetCodeSnippetResponse
Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.
-
#batch_get_finding_details(params = {}) ⇒ Types::BatchGetFindingDetailsResponse
Gets vulnerability details for findings.
-
#batch_get_free_trial_info(params = {}) ⇒ Types::BatchGetFreeTrialInfoResponse
Gets free trial status for multiple Amazon Web Services accounts.
-
#batch_get_member_ec2_deep_inspection_status(params = {}) ⇒ Types::BatchGetMemberEc2DeepInspectionStatusResponse
Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization.
-
#batch_update_member_ec2_deep_inspection_status(params = {}) ⇒ Types::BatchUpdateMemberEc2DeepInspectionStatusResponse
Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization.
-
#cancel_findings_report(params = {}) ⇒ Types::CancelFindingsReportResponse
Cancels the given findings report.
-
#cancel_sbom_export(params = {}) ⇒ Types::CancelSbomExportResponse
Cancels a software bill of materials (SBOM) report.
-
#create_cis_scan_configuration(params = {}) ⇒ Types::CreateCisScanConfigurationResponse
Creates a CIS scan configuration.
-
#create_code_security_integration(params = {}) ⇒ Types::CreateCodeSecurityIntegrationResponse
Creates a code security integration with a source code repository provider.
-
#create_code_security_scan_configuration(params = {}) ⇒ Types::CreateCodeSecurityScanConfigurationResponse
Creates a scan configuration for code security scanning.
-
#create_connector(params = {}) ⇒ Types::CreateConnectorResponse
Creates a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning.
-
#create_filter(params = {}) ⇒ Types::CreateFilterResponse
Creates a filter resource using specified filter criteria.
-
#create_findings_report(params = {}) ⇒ Types::CreateFindingsReportResponse
Creates a finding report.
-
#create_sbom_export(params = {}) ⇒ Types::CreateSbomExportResponse
Creates a software bill of materials (SBOM) report.
-
#delete_cis_scan_configuration(params = {}) ⇒ Types::DeleteCisScanConfigurationResponse
Deletes a CIS scan configuration.
-
#delete_code_security_integration(params = {}) ⇒ Types::DeleteCodeSecurityIntegrationResponse
Deletes a code security integration.
-
#delete_code_security_scan_configuration(params = {}) ⇒ Types::DeleteCodeSecurityScanConfigurationResponse
Deletes a code security scan configuration.
-
#delete_connector(params = {}) ⇒ Struct
Deletes a connector from your account.
-
#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_cis_scan_report(params = {}) ⇒ Types::GetCisScanReportResponse
Retrieves a CIS scan report.
-
#get_cis_scan_result_details(params = {}) ⇒ Types::GetCisScanResultDetailsResponse
Retrieves CIS scan result details.
-
#get_clusters_for_image(params = {}) ⇒ Types::GetClustersForImageResponse
Returns a list of clusters and metadata associated with an image.
-
#get_code_security_integration(params = {}) ⇒ Types::GetCodeSecurityIntegrationResponse
Retrieves information about a code security integration.
-
#get_code_security_scan(params = {}) ⇒ Types::GetCodeSecurityScanResponse
Retrieves information about a specific code security scan.
-
#get_code_security_scan_configuration(params = {}) ⇒ Types::GetCodeSecurityScanConfigurationResponse
Retrieves information about a code security scan configuration.
-
#get_configuration(params = {}) ⇒ Types::GetConfigurationResponse
Retrieves setting configurations for Amazon Inspector scans.
-
#get_delegated_admin_account(params = {}) ⇒ Types::GetDelegatedAdminAccountResponse
Retrieves information about the Amazon Inspector delegated administrator for your organization.
-
#get_ec2_deep_inspection_configuration(params = {}) ⇒ Types::GetEc2DeepInspectionConfigurationResponse
Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.
-
#get_encryption_key(params = {}) ⇒ Types::GetEncryptionKeyResponse
Gets an encryption key.
-
#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.
-
#get_on_demand_scan_status(params = {}) ⇒ Types::GetOnDemandScanStatusResponse
Retrieves the status of a specific on-demand scan for a resource.
-
#get_sbom_export(params = {}) ⇒ Types::GetSbomExportResponse
Gets details of a software bill of materials (SBOM) report.
-
#list_account_permissions(params = {}) ⇒ Types::ListAccountPermissionsResponse
Lists the permissions an account has to configure Amazon Inspector.
-
#list_cis_scan_configurations(params = {}) ⇒ Types::ListCisScanConfigurationsResponse
Lists CIS scan configurations.
-
#list_cis_scan_results_aggregated_by_checks(params = {}) ⇒ Types::ListCisScanResultsAggregatedByChecksResponse
Lists scan results aggregated by checks.
-
#list_cis_scan_results_aggregated_by_target_resource(params = {}) ⇒ Types::ListCisScanResultsAggregatedByTargetResourceResponse
Lists scan results aggregated by a target resource.
-
#list_cis_scans(params = {}) ⇒ Types::ListCisScansResponse
Returns a CIS scan list.
-
#list_code_security_integrations(params = {}) ⇒ Types::ListCodeSecurityIntegrationsResponse
Lists all code security integrations in your account.
-
#list_code_security_scan_configuration_associations(params = {}) ⇒ Types::ListCodeSecurityScanConfigurationAssociationsResponse
Lists the associations between code repositories and Amazon Inspector code security scan configurations.
-
#list_code_security_scan_configurations(params = {}) ⇒ Types::ListCodeSecurityScanConfigurationsResponse
Lists all code security scan configurations in your account.
-
#list_connector_scan_configurations(params = {}) ⇒ Types::ListConnectorScanConfigurationsResponse
Lists scan configurations for Amazon Web Services Config connectors.
-
#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse
Lists connectors in your account.
-
#list_coverage(params = {}) ⇒ Types::ListCoverageResponse
Lists coverage details for your 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_on_demand_scans(params = {}) ⇒ Types::ListOnDemandScansResponse
Lists the on-demand scans for a resource.
-
#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.
-
#reset_encryption_key(params = {}) ⇒ Struct
Resets an encryption key.
-
#search_vulnerabilities(params = {}) ⇒ Types::SearchVulnerabilitiesResponse
Lists Amazon Inspector coverage details for a specific vulnerability.
-
#send_cis_session_health(params = {}) ⇒ Struct
Sends a CIS session health.
-
#send_cis_session_telemetry(params = {}) ⇒ Struct
Sends a CIS session telemetry.
-
#start_cis_session(params = {}) ⇒ Struct
Starts a CIS session.
-
#start_code_security_scan(params = {}) ⇒ Types::StartCodeSecurityScanResponse
Initiates a code security scan on a specified repository.
-
#start_on_demand_scan(params = {}) ⇒ Types::StartOnDemandScanResponse
Starts an on-demand scan of the specified resource, such as an Amazon Machine Image (AMI).
-
#stop_cis_session(params = {}) ⇒ Struct
Stops a CIS session.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_cis_scan_configuration(params = {}) ⇒ Types::UpdateCisScanConfigurationResponse
Updates a CIS scan configuration.
-
#update_code_security_integration(params = {}) ⇒ Types::UpdateCodeSecurityIntegrationResponse
Updates an existing code security integration.
-
#update_code_security_scan_configuration(params = {}) ⇒ Types::UpdateCodeSecurityScanConfigurationResponse
Updates an existing code security scan configuration.
-
#update_configuration(params = {}) ⇒ Struct
Updates the scan configuration for your Amazon Inspector account.
-
#update_connector(params = {}) ⇒ Types::UpdateConnectorResponse
Updates the description or provider-specific configuration details of an existing connector.
-
#update_connector_scan_configuration(params = {}) ⇒ Struct
Updates scan configuration settings for resources associated with an Amazon Web Services Config connector.
-
#update_ec2_deep_inspection_configuration(params = {}) ⇒ Types::UpdateEc2DeepInspectionConfigurationResponse
Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.
-
#update_encryption_key(params = {}) ⇒ Struct
Updates an encryption key.
-
#update_filter(params = {}) ⇒ Types::UpdateFilterResponse
Specifies the action that is to be applied to the findings that match the filter.
-
#update_org_ec2_deep_inspection_configuration(params = {}) ⇒ Struct
Updates the Amazon Inspector deep inspection custom paths for your organization.
-
#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.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
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.
479 480 481 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 479 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. An HTTP 200 response indicates the association was successfully started, but doesn’t indicate whether it was completed. You can check if the association completed by using ListMembers for multiple accounts or GetMembers for a single account.
519 520 521 522 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 519 def associate_member(params = {}, = {}) req = build_request(:associate_member, params) req.send_request() end |
#batch_associate_code_security_scan_configuration(params = {}) ⇒ Types::BatchAssociateCodeSecurityScanConfigurationResponse
Associates multiple code repositories with an Amazon Inspector code security scan configuration.
564 565 566 567 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 564 def batch_associate_code_security_scan_configuration(params = {}, = {}) req = build_request(:batch_associate_code_security_scan_configuration, params) req.send_request() end |
#batch_disassociate_code_security_scan_configuration(params = {}) ⇒ Types::BatchDisassociateCodeSecurityScanConfigurationResponse
Disassociates multiple code repositories from an Amazon Inspector code security scan configuration.
609 610 611 612 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 609 def batch_disassociate_code_security_scan_configuration(params = {}, = {}) req = build_request(:batch_disassociate_code_security_scan_configuration, 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.
673 674 675 676 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 673 def batch_get_account_status(params = {}, = {}) req = build_request(:batch_get_account_status, params) req.send_request() end |
#batch_get_code_snippet(params = {}) ⇒ Types::BatchGetCodeSnippetResponse
Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.
717 718 719 720 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 717 def batch_get_code_snippet(params = {}, = {}) req = build_request(:batch_get_code_snippet, params) req.send_request() end |
#batch_get_finding_details(params = {}) ⇒ Types::BatchGetFindingDetailsResponse
Gets vulnerability details for findings.
827 828 829 830 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 827 def batch_get_finding_details(params = {}, = {}) req = build_request(:batch_get_finding_details, params) req.send_request() end |
#batch_get_free_trial_info(params = {}) ⇒ Types::BatchGetFreeTrialInfoResponse
Gets free trial status for multiple Amazon Web Services accounts.
867 868 869 870 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 867 def batch_get_free_trial_info(params = {}, = {}) req = build_request(:batch_get_free_trial_info, params) req.send_request() end |
#batch_get_member_ec2_deep_inspection_status(params = {}) ⇒ Types::BatchGetMemberEc2DeepInspectionStatusResponse
Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.
907 908 909 910 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 907 def batch_get_member_ec2_deep_inspection_status(params = {}, = {}) req = build_request(:batch_get_member_ec2_deep_inspection_status, params) req.send_request() end |
#batch_update_member_ec2_deep_inspection_status(params = {}) ⇒ Types::BatchUpdateMemberEc2DeepInspectionStatusResponse
Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.
952 953 954 955 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 952 def batch_update_member_ec2_deep_inspection_status(params = {}, = {}) req = build_request(:batch_update_member_ec2_deep_inspection_status, params) req.send_request() end |
#cancel_findings_report(params = {}) ⇒ Types::CancelFindingsReportResponse
Cancels the given findings report.
980 981 982 983 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 980 def cancel_findings_report(params = {}, = {}) req = build_request(:cancel_findings_report, params) req.send_request() end |
#cancel_sbom_export(params = {}) ⇒ Types::CancelSbomExportResponse
Cancels a software bill of materials (SBOM) report.
1008 1009 1010 1011 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1008 def cancel_sbom_export(params = {}, = {}) req = build_request(:cancel_sbom_export, params) req.send_request() end |
#create_cis_scan_configuration(params = {}) ⇒ Types::CreateCisScanConfigurationResponse
Creates a CIS scan configuration.
1114 1115 1116 1117 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1114 def create_cis_scan_configuration(params = {}, = {}) req = build_request(:create_cis_scan_configuration, params) req.send_request() end |
#create_code_security_integration(params = {}) ⇒ Types::CreateCodeSecurityIntegrationResponse
Creates a code security integration with a source code repository provider.
After calling the CreateCodeSecurityIntegration operation, you
complete authentication and authorization with your provider. Next you
call the UpdateCodeSecurityIntegration operation to provide the
details to complete the integration setup
1190 1191 1192 1193 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1190 def create_code_security_integration(params = {}, = {}) req = build_request(:create_code_security_integration, params) req.send_request() end |
#create_code_security_scan_configuration(params = {}) ⇒ Types::CreateCodeSecurityScanConfigurationResponse
Creates a scan configuration for code security scanning.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1254 def create_code_security_scan_configuration(params = {}, = {}) req = build_request(:create_code_security_scan_configuration, params) req.send_request() end |
#create_connector(params = {}) ⇒ Types::CreateConnectorResponse
Creates a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning.
1385 1386 1387 1388 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1385 def create_connector(params = {}, = {}) req = build_request(:create_connector, params) req.send_request() end |
#create_filter(params = {}) ⇒ Types::CreateFilterResponse
Creates a filter resource using specified filter criteria. When the
filter action is set to SUPPRESS this action creates a suppression
rule.
1899 1900 1901 1902 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 1899 def create_filter(params = {}, = {}) req = build_request(:create_filter, params) req.send_request() end |
#create_findings_report(params = {}) ⇒ Types::CreateFindingsReportResponse
Creates a finding report. By default only ACTIVE findings are
returned in the report. To see SUPRESSED or CLOSED findings you
must specify a value for the findingStatus filter criteria.
2401 2402 2403 2404 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2401 def create_findings_report(params = {}, = {}) req = build_request(:create_findings_report, params) req.send_request() end |
#create_sbom_export(params = {}) ⇒ Types::CreateSbomExportResponse
Creates a software bill of materials (SBOM) report.
2563 2564 2565 2566 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2563 def create_sbom_export(params = {}, = {}) req = build_request(:create_sbom_export, params) req.send_request() end |
#delete_cis_scan_configuration(params = {}) ⇒ Types::DeleteCisScanConfigurationResponse
Deletes a CIS scan configuration.
2603 2604 2605 2606 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2603 def delete_cis_scan_configuration(params = {}, = {}) req = build_request(:delete_cis_scan_configuration, params) req.send_request() end |
#delete_code_security_integration(params = {}) ⇒ Types::DeleteCodeSecurityIntegrationResponse
Deletes a code security integration.
2632 2633 2634 2635 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2632 def delete_code_security_integration(params = {}, = {}) req = build_request(:delete_code_security_integration, params) req.send_request() end |
#delete_code_security_scan_configuration(params = {}) ⇒ Types::DeleteCodeSecurityScanConfigurationResponse
Deletes a code security scan configuration.
2660 2661 2662 2663 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2660 def delete_code_security_scan_configuration(params = {}, = {}) req = build_request(:delete_code_security_scan_configuration, params) req.send_request() end |
#delete_connector(params = {}) ⇒ Struct
Deletes a connector from your account.
2693 2694 2695 2696 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2693 def delete_connector(params = {}, = {}) req = build_request(:delete_connector, params) req.send_request() end |
#delete_filter(params = {}) ⇒ Types::DeleteFilterResponse
Deletes a filter resource.
2721 2722 2723 2724 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2721 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.
2748 2749 2750 2751 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2748 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.
2803 2804 2805 2806 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2803 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.
2833 2834 2835 2836 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2833 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.
2863 2864 2865 2866 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2863 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.
2923 2924 2925 2926 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2923 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.
2960 2961 2962 2963 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 2960 def enable_delegated_admin_account(params = {}, = {}) req = build_request(:enable_delegated_admin_account, params) req.send_request() end |
#get_cis_scan_report(params = {}) ⇒ Types::GetCisScanReportResponse
Retrieves a CIS scan report.
3013 3014 3015 3016 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3013 def get_cis_scan_report(params = {}, = {}) req = build_request(:get_cis_scan_report, params) req.send_request() end |
#get_cis_scan_result_details(params = {}) ⇒ Types::GetCisScanResultDetailsResponse
Retrieves CIS scan result details.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3145 3146 3147 3148 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3145 def get_cis_scan_result_details(params = {}, = {}) req = build_request(:get_cis_scan_result_details, params) req.send_request() end |
#get_clusters_for_image(params = {}) ⇒ Types::GetClustersForImageResponse
Returns a list of clusters and metadata associated with an image.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3200 3201 3202 3203 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3200 def get_clusters_for_image(params = {}, = {}) req = build_request(:get_clusters_for_image, params) req.send_request() end |
#get_code_security_integration(params = {}) ⇒ Types::GetCodeSecurityIntegrationResponse
Retrieves information about a code security integration.
3263 3264 3265 3266 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3263 def get_code_security_integration(params = {}, = {}) req = build_request(:get_code_security_integration, params) req.send_request() end |
#get_code_security_scan(params = {}) ⇒ Types::GetCodeSecurityScanResponse
Retrieves information about a specific code security scan.
3311 3312 3313 3314 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3311 def get_code_security_scan(params = {}, = {}) req = build_request(:get_code_security_scan, params) req.send_request() end |
#get_code_security_scan_configuration(params = {}) ⇒ Types::GetCodeSecurityScanConfigurationResponse
Retrieves information about a code security scan configuration.
3359 3360 3361 3362 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3359 def get_code_security_scan_configuration(params = {}, = {}) req = build_request(:get_code_security_scan_configuration, params) req.send_request() end |
#get_configuration(params = {}) ⇒ Types::GetConfigurationResponse
Retrieves setting configurations for Amazon Inspector scans. If you
specify an accountId, this operation returns the scan configuration
for that member account. You must be the delegated administrator for
the specified member account. If you do not specify an accountId,
this operation returns your own scan configuration.
3415 3416 3417 3418 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3415 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.
3436 3437 3438 3439 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3436 def get_delegated_admin_account(params = {}, = {}) req = build_request(:get_delegated_admin_account, params) req.send_request() end |
#get_ec2_deep_inspection_configuration(params = {}) ⇒ Types::GetEc2DeepInspectionConfigurationResponse
Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.
3464 3465 3466 3467 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3464 def get_ec2_deep_inspection_configuration(params = {}, = {}) req = build_request(:get_ec2_deep_inspection_configuration, params) req.send_request() end |
#get_encryption_key(params = {}) ⇒ Types::GetEncryptionKeyResponse
Gets an encryption key.
3496 3497 3498 3499 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3496 def get_encryption_key(params = {}, = {}) req = build_request(:get_encryption_key, params) req.send_request() end |
#get_findings_report_status(params = {}) ⇒ Types::GetFindingsReportStatusResponse
Gets the status of a findings report.
3765 3766 3767 3768 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3765 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.
3797 3798 3799 3800 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3797 def get_member(params = {}, = {}) req = build_request(:get_member, params) req.send_request() end |
#get_on_demand_scan_status(params = {}) ⇒ Types::GetOnDemandScanStatusResponse
Retrieves the status of a specific on-demand scan for a resource.
3847 3848 3849 3850 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3847 def get_on_demand_scan_status(params = {}, = {}) req = build_request(:get_on_demand_scan_status, params) req.send_request() end |
#get_sbom_export(params = {}) ⇒ Types::GetSbomExportResponse
Gets details of a software bill of materials (SBOM) report.
3950 3951 3952 3953 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 3950 def get_sbom_export(params = {}, = {}) req = build_request(:get_sbom_export, params) req.send_request() end |
#list_account_permissions(params = {}) ⇒ Types::ListAccountPermissionsResponse
Lists the permissions an account has to configure Amazon Inspector. If the account is a member account or standalone account with resources managed by an Organizations policy, the operation returns fewer permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4003 4004 4005 4006 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4003 def (params = {}, = {}) req = build_request(:list_account_permissions, params) req.send_request() end |
#list_cis_scan_configurations(params = {}) ⇒ Types::ListCisScanConfigurationsResponse
Lists CIS scan configurations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4129 4130 4131 4132 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4129 def list_cis_scan_configurations(params = {}, = {}) req = build_request(:list_cis_scan_configurations, params) req.send_request() end |
#list_cis_scan_results_aggregated_by_checks(params = {}) ⇒ Types::ListCisScanResultsAggregatedByChecksResponse
Lists scan results aggregated by checks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4257 4258 4259 4260 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4257 def list_cis_scan_results_aggregated_by_checks(params = {}, = {}) req = build_request(:list_cis_scan_results_aggregated_by_checks, params) req.send_request() end |
#list_cis_scan_results_aggregated_by_target_resource(params = {}) ⇒ Types::ListCisScanResultsAggregatedByTargetResourceResponse
Lists scan results aggregated by a target resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4409 4410 4411 4412 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4409 def list_cis_scan_results_aggregated_by_target_resource(params = {}, = {}) req = build_request(:list_cis_scan_results_aggregated_by_target_resource, params) req.send_request() end |
#list_cis_scans(params = {}) ⇒ Types::ListCisScansResponse
Returns a CIS scan list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4571 4572 4573 4574 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4571 def list_cis_scans(params = {}, = {}) req = build_request(:list_cis_scans, params) req.send_request() end |
#list_code_security_integrations(params = {}) ⇒ Types::ListCodeSecurityIntegrationsResponse
Lists all code security integrations in your account.
4615 4616 4617 4618 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4615 def list_code_security_integrations(params = {}, = {}) req = build_request(:list_code_security_integrations, params) req.send_request() end |
#list_code_security_scan_configuration_associations(params = {}) ⇒ Types::ListCodeSecurityScanConfigurationAssociationsResponse
Lists the associations between code repositories and Amazon Inspector code security scan configurations.
4663 4664 4665 4666 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4663 def list_code_security_scan_configuration_associations(params = {}, = {}) req = build_request(:list_code_security_scan_configuration_associations, params) req.send_request() end |
#list_code_security_scan_configurations(params = {}) ⇒ Types::ListCodeSecurityScanConfigurationsResponse
Lists all code security scan configurations in your account.
4710 4711 4712 4713 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4710 def list_code_security_scan_configurations(params = {}, = {}) req = build_request(:list_code_security_scan_configurations, params) req.send_request() end |
#list_connector_scan_configurations(params = {}) ⇒ Types::ListConnectorScanConfigurationsResponse
Lists scan configurations for Amazon Web Services Config connectors.
Results are paginated. Use the nextToken parameter to retrieve the
next page of results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4790 4791 4792 4793 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4790 def list_connector_scan_configurations(params = {}, = {}) req = build_request(:list_connector_scan_configurations, params) req.send_request() end |
#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse
Lists connectors in your account. Results are paginated. Use the
nextToken parameter to retrieve the next page of results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- connector_connected
- connector_deleted
- connector_enabled
4975 4976 4977 4978 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 4975 def list_connectors(params = {}, = {}) req = build_request(:list_connectors, params) req.send_request() end |
#list_coverage(params = {}) ⇒ Types::ListCoverageResponse
Lists coverage details for your environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5295 5296 5297 5298 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 5295 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.
5551 5552 5553 5554 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 5551 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.
5598 5599 5600 5601 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 5598 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.
5889 5890 5891 5892 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 5889 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.
6642 6643 6644 6645 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 6642 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.
7338 7339 7340 7341 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7338 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.
7392 7393 7394 7395 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7392 def list_members(params = {}, = {}) req = build_request(:list_members, params) req.send_request() end |
#list_on_demand_scans(params = {}) ⇒ Types::ListOnDemandScansResponse
Lists the on-demand scans for a resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7445 7446 7447 7448 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7445 def list_on_demand_scans(params = {}, = {}) req = build_request(:list_on_demand_scans, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags attached to a given resource.
7474 7475 7476 7477 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7474 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.
7529 7530 7531 7532 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7529 def list_usage_totals(params = {}, = {}) req = build_request(:list_usage_totals, params) req.send_request() end |
#reset_encryption_key(params = {}) ⇒ Struct
Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key.
7556 7557 7558 7559 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7556 def reset_encryption_key(params = {}, = {}) req = build_request(:reset_encryption_key, params) req.send_request() end |
#search_vulnerabilities(params = {}) ⇒ Types::SearchVulnerabilitiesResponse
Lists Amazon Inspector coverage details for a specific vulnerability.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7631 7632 7633 7634 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7631 def search_vulnerabilities(params = {}, = {}) req = build_request(:search_vulnerabilities, params) req.send_request() end |
#send_cis_session_health(params = {}) ⇒ Struct
Sends a CIS session health. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
7672 7673 7674 7675 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7672 def send_cis_session_health(params = {}, = {}) req = build_request(:send_cis_session_health, params) req.send_request() end |
#send_cis_session_telemetry(params = {}) ⇒ Struct
Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
7735 7736 7737 7738 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7735 def send_cis_session_telemetry(params = {}, = {}) req = build_request(:send_cis_session_telemetry, params) req.send_request() end |
#start_cis_session(params = {}) ⇒ Struct
Starts a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
7780 7781 7782 7783 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7780 def start_cis_session(params = {}, = {}) req = build_request(:start_cis_session, params) req.send_request() end |
#start_code_security_scan(params = {}) ⇒ Types::StartCodeSecurityScanResponse
Initiates a code security scan on a specified repository.
7820 7821 7822 7823 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7820 def start_code_security_scan(params = {}, = {}) req = build_request(:start_code_security_scan, params) req.send_request() end |
#start_on_demand_scan(params = {}) ⇒ Types::StartOnDemandScanResponse
Starts an on-demand scan of the specified resource, such as an Amazon Machine Image (AMI).
7861 7862 7863 7864 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7861 def start_on_demand_scan(params = {}, = {}) req = build_request(:start_on_demand_scan, params) req.send_request() end |
#stop_cis_session(params = {}) ⇒ Struct
Stops a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to stop a CIS scan session for the scan ID supplied by the service.
7947 7948 7949 7950 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7947 def stop_cis_session(params = {}, = {}) req = build_request(:stop_cis_session, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
7975 7976 7977 7978 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 7975 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
8001 8002 8003 8004 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 8001 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_cis_scan_configuration(params = {}) ⇒ Types::UpdateCisScanConfigurationResponse
Updates a CIS scan configuration.
8106 8107 8108 8109 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 8106 def update_cis_scan_configuration(params = {}, = {}) req = build_request(:update_cis_scan_configuration, params) req.send_request() end |
#update_code_security_integration(params = {}) ⇒ Types::UpdateCodeSecurityIntegrationResponse
Updates an existing code security integration.
After calling the CreateCodeSecurityIntegration operation, you
complete authentication and authorization with your provider. Next you
call the UpdateCodeSecurityIntegration operation to provide the
details to complete the integration setup
8167 8168 8169 8170 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 8167 def update_code_security_integration(params = {}, = {}) req = build_request(:update_code_security_integration, params) req.send_request() end |
#update_code_security_scan_configuration(params = {}) ⇒ Types::UpdateCodeSecurityScanConfigurationResponse
Updates an existing code security scan configuration.
8208 8209 8210 8211 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 8208 def update_code_security_scan_configuration(params = {}, = {}) req = build_request(:update_code_security_scan_configuration, params) req.send_request() end |
#update_configuration(params = {}) ⇒ Struct
Updates the scan configuration for your Amazon Inspector account. If
you don't specify an accountId, this operation updates the
delegated administrator's configuration and propagates it to member
accounts that have not been individually configured. If you specify an
accountId, this operation updates that member account's
configuration. Only the delegated administrator can specify an
accountId; member accounts cannot call this operation.
8291 8292 8293 8294 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 8291 def update_configuration(params = {}, = {}) req = build_request(:update_configuration, params) req.send_request() end |
#update_connector(params = {}) ⇒ Types::UpdateConnectorResponse
Updates the description or provider-specific configuration details of an existing connector.
8385 8386 8387 8388 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 8385 def update_connector(params = {}, = {}) req = build_request(:update_connector, params) req.send_request() end |
#update_connector_scan_configuration(params = {}) ⇒ Struct
Updates scan configuration settings for resources associated with an Amazon Web Services Config connector.
8434 8435 8436 8437 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 8434 def update_connector_scan_configuration(params = {}, = {}) req = build_request(:update_connector_scan_configuration, params) req.send_request() end |
#update_ec2_deep_inspection_configuration(params = {}) ⇒ Types::UpdateEc2DeepInspectionConfigurationResponse
Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.
8484 8485 8486 8487 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 8484 def update_ec2_deep_inspection_configuration(params = {}, = {}) req = build_request(:update_ec2_deep_inspection_configuration, params) req.send_request() end |
#update_encryption_key(params = {}) ⇒ Struct
Updates an encryption key. A ResourceNotFoundException means that an
Amazon Web Services owned key is being used for encryption.
8515 8516 8517 8518 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 8515 def update_encryption_key(params = {}, = {}) req = build_request(:update_encryption_key, 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.
9024 9025 9026 9027 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 9024 def update_filter(params = {}, = {}) req = build_request(:update_filter, params) req.send_request() end |
#update_org_ec2_deep_inspection_configuration(params = {}) ⇒ Struct
Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.
9049 9050 9051 9052 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 9049 def update_org_ec2_deep_inspection_configuration(params = {}, = {}) req = build_request(:update_org_ec2_deep_inspection_configuration, params) req.send_request() end |
#update_organization_configuration(params = {}) ⇒ Types::UpdateOrganizationConfigurationResponse
Updates the configurations for your Amazon Inspector organization.
9090 9091 9092 9093 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 9090 def update_organization_configuration(params = {}, = {}) req = build_request(:update_organization_configuration, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay and :max_attempts values.
| waiter_name | params | :delay | :max_attempts |
|---|---|---|---|
| connector_connected | #list_connectors | 30 | 5 |
| connector_deleted | #list_connectors | 30 | 5 |
| connector_enabled | #list_connectors | 30 | 5 |
9207 9208 9209 9210 9211 |
# File 'gems/aws-sdk-inspector2/lib/aws-sdk-inspector2/client.rb', line 9207 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |