Learn R Programming

paws.security.identity (version 0.7.0)

inspector2: Inspector2

Description

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2, Amazon ECR, and Amazon Web Services Lambda environments.

Usage

inspector2(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Service syntax

svc <- inspector2(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

associate_memberAssociates an Amazon Web Services account with an Amazon Inspector delegated administrator
batch_get_account_statusRetrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment
batch_get_code_snippetRetrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in
batch_get_finding_detailsGets vulnerability details for findings
batch_get_free_trial_infoGets free trial status for multiple Amazon Web Services accounts
batch_get_member_ec_2_deep_inspection_statusRetrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization
batch_update_member_ec_2_deep_inspection_statusActivates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization
cancel_findings_reportCancels the given findings report
cancel_sbom_exportCancels a software bill of materials (SBOM) report
create_cis_scan_configurationCreates a CIS scan configuration
create_filterCreates a filter resource using specified filter criteria
create_findings_reportCreates a finding report
create_sbom_exportCreates a software bill of materials (SBOM) report
delete_cis_scan_configurationDeletes a CIS scan configuration
delete_filterDeletes a filter resource
describe_organization_configurationDescribe Amazon Inspector configuration settings for an Amazon Web Services organization
disableDisables Amazon Inspector scans for one or more Amazon Web Services accounts
disable_delegated_admin_accountDisables the Amazon Inspector delegated administrator for your organization
disassociate_memberDisassociates a member account from an Amazon Inspector delegated administrator
enableEnables Amazon Inspector scans for one or more Amazon Web Services accounts
enable_delegated_admin_accountEnables the Amazon Inspector delegated administrator for your Organizations organization
get_cis_scan_reportRetrieves a CIS scan report
get_cis_scan_result_detailsRetrieves CIS scan result details
get_configurationRetrieves setting configurations for Inspector scans
get_delegated_admin_accountRetrieves information about the Amazon Inspector delegated administrator for your organization
get_ec_2_deep_inspection_configurationRetrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account
get_encryption_keyGets an encryption key
get_findings_report_statusGets the status of a findings report
get_memberGets member information for your organization
get_sbom_exportGets details of a software bill of materials (SBOM) report
list_account_permissionsLists the permissions an account has to configure Amazon Inspector
list_cis_scan_configurationsLists CIS scan configurations
list_cis_scan_results_aggregated_by_checksLists scan results aggregated by checks
list_cis_scan_results_aggregated_by_target_resourceLists scan results aggregated by a target resource
list_cis_scansReturns a CIS scan list
list_coverageLists coverage details for you environment
list_coverage_statisticsLists Amazon Inspector coverage statistics for your environment
list_delegated_admin_accountsLists information about the Amazon Inspector delegated administrator of your organization
list_filtersLists the filters associated with your account
list_finding_aggregationsLists aggregated finding data for your environment based on specific criteria
list_findingsLists findings for your environment
list_membersList members associated with the Amazon Inspector delegated administrator for your organization
list_tags_for_resourceLists all tags attached to a given resource
list_usage_totalsLists the Amazon Inspector usage totals over the last 30 days
reset_encryption_keyResets an encryption key
search_vulnerabilitiesLists Amazon Inspector coverage details for a specific vulnerability
send_cis_session_healthSends a CIS session health
send_cis_session_telemetrySends a CIS session telemetry
start_cis_sessionStarts a CIS session
stop_cis_sessionStops a CIS session
tag_resourceAdds tags to a resource
untag_resourceRemoves tags from a resource
update_cis_scan_configurationUpdates a CIS scan configuration
update_configurationUpdates setting configurations for your Amazon Inspector account
update_ec_2_deep_inspection_configurationActivates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account
update_encryption_keyUpdates an encryption key
update_filterSpecifies the action that is to be applied to the findings that match the filter
update_organization_configurationUpdates the configurations for your Amazon Inspector organization
update_org_ec_2_deep_inspection_configurationUpdates the Amazon Inspector deep inspection custom paths for your organization

Examples

Run this code
if (FALSE) {
svc <- inspector2()
svc$associate_member(
  Foo = 123
)
}

Run the code above in your browser using DataLab