inspector2: Inspector2

In paws: Amazon Web Services Software Development Kit

Inspector2

Description

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

Usage

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

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.

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.

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_member	Associates an Amazon Web Services account with an Amazon Inspector delegated administrator
batch_get_account_status	Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment
batch_get_code_snippet	Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in
batch_get_finding_details	Gets vulnerability details for findings
batch_get_free_trial_info	Gets free trial status for multiple Amazon Web Services accounts
batch_get_member_ec_2_deep_inspection_status	Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization
batch_update_member_ec_2_deep_inspection_status	Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization
cancel_findings_report	Cancels the given findings report
cancel_sbom_export	Cancels a software bill of materials (SBOM) report
create_filter	Creates a filter resource using specified filter criteria
create_findings_report	Creates a finding report
create_sbom_export	Creates a software bill of materials (SBOM) report
delete_filter	Deletes a filter resource
describe_organization_configuration	Describe Amazon Inspector configuration settings for an Amazon Web Services organization
disable	Disables Amazon Inspector scans for one or more Amazon Web Services accounts
disable_delegated_admin_account	Disables the Amazon Inspector delegated administrator for your organization
disassociate_member	Disassociates a member account from an Amazon Inspector delegated administrator
enable	Enables Amazon Inspector scans for one or more Amazon Web Services accounts
enable_delegated_admin_account	Enables the Amazon Inspector delegated administrator for your Organizations organization
get_configuration	Retrieves setting configurations for Inspector scans
get_delegated_admin_account	Retrieves information about the Amazon Inspector delegated administrator for your organization
get_ec_2_deep_inspection_configuration	Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account
get_encryption_key	Gets an encryption key
get_findings_report_status	Gets the status of a findings report
get_member	Gets member information for your organization
get_sbom_export	Gets details of a software bill of materials (SBOM) report
list_account_permissions	Lists the permissions an account has to configure Amazon Inspector
list_coverage	Lists coverage details for you environment
list_coverage_statistics	Lists Amazon Inspector coverage statistics for your environment
list_delegated_admin_accounts	Lists information about the Amazon Inspector delegated administrator of your organization
list_filters	Lists the filters associated with your account
list_finding_aggregations	Lists aggregated finding data for your environment based on specific criteria
list_findings	Lists findings for your environment
list_members	List members associated with the Amazon Inspector delegated administrator for your organization
list_tags_for_resource	Lists all tags attached to a given resource
list_usage_totals	Lists the Amazon Inspector usage totals over the last 30 days
reset_encryption_key	Resets an encryption key
search_vulnerabilities	Lists Amazon Inspector coverage details for a specific vulnerability
tag_resource	Adds tags to a resource
untag_resource	Removes tags from a resource
update_configuration	Updates setting configurations for your Amazon Inspector account
update_ec_2_deep_inspection_configuration	Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account
update_encryption_key	Updates an encryption key
update_filter	Specifies the action that is to be applied to the findings that match the filter
update_organization_configuration	Updates the configurations for your Amazon Inspector organization
update_org_ec_2_deep_inspection_configuration	Updates the Amazon Inspector deep inspection custom paths for your organization

Examples

## Not run: 
svc <- inspector2()
svc$associate_member(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 15, 2023, 5:06 p.m.