Client

inspector

R Documentation

Amazon Inspector¶

Description¶

Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide.

Usage¶

inspector(
  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 <- inspector(
  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¶

add_attributes_to_findings: Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings
create_assessment_target: Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup
create_assessment_template: Creates an assessment template for the assessment target that is specified by the ARN of the assessment target
create_exclusions_preview: Starts the generation of an exclusions preview for the specified assessment template
create_resource_group: Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target
delete_assessment_run: Deletes the assessment run that is specified by the ARN of the assessment run
delete_assessment_target: Deletes the assessment target that is specified by the ARN of the assessment target
delete_assessment_template: Deletes the assessment template that is specified by the ARN of the assessment template
describe_assessment_runs: Describes the assessment runs that are specified by the ARNs of the assessment runs
describe_assessment_targets: Describes the assessment targets that are specified by the ARNs of the assessment targets
describe_assessment_templates: Describes the assessment templates that are specified by the ARNs of the assessment templates
describe_cross_account_access_role: Describes the IAM role that enables Amazon Inspector to access your AWS account
describe_exclusions: Describes the exclusions that are specified by the exclusions' ARNs
describe_findings: Describes the findings that are specified by the ARNs of the findings
describe_resource_groups: Describes the resource groups that are specified by the ARNs of the resource groups
describe_rules_packages: Describes the rules packages that are specified by the ARNs of the rules packages
get_assessment_report: Produces an assessment report that includes detailed and comprehensive results of a specified assessment run
get_exclusions_preview: Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token
get_telemetry_metadata: Information about the data that is collected for the specified assessment run
list_assessment_run_agents: Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs
list_assessment_runs: Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates
list_assessment_targets: Lists the ARNs of the assessment targets within this AWS account
list_assessment_templates: Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets
list_event_subscriptions: Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template
list_exclusions: List exclusions that are generated by the assessment run
list_findings: Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs
list_rules_packages: Lists all available Amazon Inspector rules packages
list_tags_for_resource: Lists all tags associated with an assessment template
preview_agents: Previews the agents installed on the EC2 instances that are part of the specified assessment target
register_cross_account_access_role: Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments
remove_attributes_from_findings: Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists
set_tags_for_resource: Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template
start_assessment_run: Starts the assessment run specified by the ARN of the assessment template
stop_assessment_run: Stops the assessment run that is specified by the ARN of the assessment run
subscribe_to_event: Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic
unsubscribe_from_event: Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic
update_assessment_target: Updates the assessment target that is specified by the ARN of the assessment target

Examples¶

## Not run: 
svc <- inspector()
# Assigns attributes (key and value pairs) to the findings that are
# specified by the ARNs of the findings.
svc$add_attributes_to_findings(
  attributes = list(
    list(
      key = "Example",
      value = "example"
    )
  ),
  findingArns = list(
    "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-..."
  )
)

## End(Not run)