Amazon Web Services, Inc.

Amazon Inspector

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

Identity & security#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Inspector
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 .

Endpoints 37

  • POSTAdd attributes to findings/#X-Amz-Target=InspectorService.AddAttributesToFindingsAssigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
  • POSTCreate assessment target/#X-Amz-Target=InspectorService.CreateAssessmentTargetCreates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup . If resourceGroupArn is not specified, all EC2…
  • POSTCreate assessment template/#X-Amz-Target=InspectorService.CreateAssessmentTemplateCreates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already…
  • POSTCreate exclusions preview/#X-Amz-Target=InspectorService.CreateExclusionsPreviewStarts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview)…
  • POSTCreate resource group/#X-Amz-Target=InspectorService.CreateResourceGroupCreates 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…
  • POSTDelete assessment run/#X-Amz-Target=InspectorService.DeleteAssessmentRunDeletes the assessment run that is specified by the ARN of the assessment run.
  • POSTDelete assessment target/#X-Amz-Target=InspectorService.DeleteAssessmentTargetDeletes the assessment target that is specified by the ARN of the assessment target.
  • POSTDelete assessment template/#X-Amz-Target=InspectorService.DeleteAssessmentTemplateDeletes the assessment template that is specified by the ARN of the assessment template.
  • POSTDescribe assessment runs/#X-Amz-Target=InspectorService.DescribeAssessmentRunsDescribes the assessment runs that are specified by the ARNs of the assessment runs.
  • POSTDescribe assessment targets/#X-Amz-Target=InspectorService.DescribeAssessmentTargetsDescribes the assessment targets that are specified by the ARNs of the assessment targets.
  • POSTDescribe assessment templates/#X-Amz-Target=InspectorService.DescribeAssessmentTemplatesDescribes the assessment templates that are specified by the ARNs of the assessment templates.
  • POSTDescribe cross account access role/#X-Amz-Target=InspectorService.DescribeCrossAccountAccessRoleDescribes the IAM role that enables Amazon Inspector to access your AWS account.
  • POSTDescribe exclusions/#X-Amz-Target=InspectorService.DescribeExclusionsDescribes the exclusions that are specified by the exclusions' ARNs.
  • POSTDescribe findings/#X-Amz-Target=InspectorService.DescribeFindingsDescribes the findings that are specified by the ARNs of the findings.
  • POSTDescribe resource groups/#X-Amz-Target=InspectorService.DescribeResourceGroupsDescribes the resource groups that are specified by the ARNs of the resource groups.
  • POSTDescribe rules packages/#X-Amz-Target=InspectorService.DescribeRulesPackagesDescribes the rules packages that are specified by the ARNs of the rules packages.
  • POSTGet assessment report/#X-Amz-Target=InspectorService.GetAssessmentReportProduces an assessment report that includes detailed and comprehensive results of a specified assessment run.
  • POSTGet exclusions preview/#X-Amz-Target=InspectorService.GetExclusionsPreviewRetrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the…
  • POSTGet telemetry metadata/#X-Amz-Target=InspectorService.GetTelemetryMetadataInformation about the data that is collected for the specified assessment run.
  • POSTList assessment run agents/#X-Amz-Target=InspectorService.ListAssessmentRunAgentsLists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
  • POSTList assessment runs/#X-Amz-Target=InspectorService.ListAssessmentRunsLists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
  • POSTList assessment targets/#X-Amz-Target=InspectorService.ListAssessmentTargetsLists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets .
  • POSTList assessment templates/#X-Amz-Target=InspectorService.ListAssessmentTemplatesLists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
  • POSTList event subscriptions/#X-Amz-Target=InspectorService.ListEventSubscriptionsLists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see…
  • POSTList exclusions/#X-Amz-Target=InspectorService.ListExclusionsList exclusions that are generated by the assessment run.
  • POSTList findings/#X-Amz-Target=InspectorService.ListFindingsLists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
  • POSTList rules packages/#X-Amz-Target=InspectorService.ListRulesPackagesLists all available Amazon Inspector rules packages.
  • POSTList tags for resource/#X-Amz-Target=InspectorService.ListTagsForResourceLists all tags associated with an assessment template.
  • POSTPreview agents/#X-Amz-Target=InspectorService.PreviewAgentsPreviews the agents installed on the EC2 instances that are part of the specified assessment target.
  • POSTRegister cross account access role/#X-Amz-Target=InspectorService.RegisterCrossAccountAccessRoleRegisters the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
  • POSTRemove attributes from findings/#X-Amz-Target=InspectorService.RemoveAttributesFromFindingsRemoves 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…
  • POSTSet tags for resource/#X-Amz-Target=InspectorService.SetTagsForResourceSets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
  • POSTStart assessment run/#X-Amz-Target=InspectorService.StartAssessmentRunStarts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to…
  • POSTStop assessment run/#X-Amz-Target=InspectorService.StopAssessmentRunStops the assessment run that is specified by the ARN of the assessment run.
  • POSTSubscribe to event/#X-Amz-Target=InspectorService.SubscribeToEventEnables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
  • POSTUnsubscribe from event/#X-Amz-Target=InspectorService.UnsubscribeFromEventDisables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
  • POSTUpdate assessment target/#X-Amz-Target=InspectorService.UpdateAssessmentTargetUpdates the assessment target that is specified by the ARN of the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current…

API details

Base URL
https://inspector.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
37 operations on 37 pathsPOST 37
Description format
AWS Smithy model, API version 2016-02-16

How to test the Amazon Inspector in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Inspector collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add attributes to findings” (POST /#X-Amz-Target=InspectorService.AddAttributesToFindings), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Inspector?

Amazon Inspector Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information,… It is listed under Identity & security and has 37 endpoints.

Who publishes the Amazon Inspector?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Inspector?

Requests go to https://inspector.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Inspector?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Inspector have?

37 operations on 37 paths (37 POST).

Is forking the Amazon Inspector free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.