Class: AWS.Inspector
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Inspector
- Identifier:
- inspector
- API Version:
- 2016-02-16
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service 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.
Sending a Request Using Inspector
var inspector = new AWS.Inspector();
inspector.createAssessmentTarget(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Inspector object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var inspector = new AWS.Inspector({apiVersion: '2016-02-16'});
You can also set the API version globally in AWS.config.apiVersions using
the inspector service identifier:
AWS.config.apiVersions = {
inspector: '2016-02-16',
// other service API versions
};
var inspector = new AWS.Inspector();
Constructor Summary collapse
-
new AWS.Inspector(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
addAttributesToFindings(params = {}, callback) ⇒ AWS.Request
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
.
-
createAssessmentTarget(params = {}, callback) ⇒ AWS.Request
Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup.
-
createAssessmentTemplate(params = {}, callback) ⇒ AWS.Request
Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
-
createExclusionsPreview(params = {}, callback) ⇒ AWS.Request
Starts the generation of an exclusions preview for the specified assessment template.
-
createResourceGroup(params = {}, callback) ⇒ AWS.Request
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.
-
deleteAssessmentRun(params = {}, callback) ⇒ AWS.Request
Deletes the assessment run that is specified by the ARN of the assessment run.
.
-
deleteAssessmentTarget(params = {}, callback) ⇒ AWS.Request
Deletes the assessment target that is specified by the ARN of the assessment target.
.
-
deleteAssessmentTemplate(params = {}, callback) ⇒ AWS.Request
Deletes the assessment template that is specified by the ARN of the assessment template.
.
-
describeAssessmentRuns(params = {}, callback) ⇒ AWS.Request
Describes the assessment runs that are specified by the ARNs of the assessment runs.
.
-
describeAssessmentTargets(params = {}, callback) ⇒ AWS.Request
Describes the assessment targets that are specified by the ARNs of the assessment targets.
.
-
describeAssessmentTemplates(params = {}, callback) ⇒ AWS.Request
Describes the assessment templates that are specified by the ARNs of the assessment templates.
.
-
describeCrossAccountAccessRole(params = {}, callback) ⇒ AWS.Request
Describes the IAM role that enables Amazon Inspector to access your AWS account.
.
-
describeExclusions(params = {}, callback) ⇒ AWS.Request
Describes the exclusions that are specified by the exclusions' ARNs.
.
-
describeFindings(params = {}, callback) ⇒ AWS.Request
Describes the findings that are specified by the ARNs of the findings.
.
-
describeResourceGroups(params = {}, callback) ⇒ AWS.Request
Describes the resource groups that are specified by the ARNs of the resource groups.
.
-
describeRulesPackages(params = {}, callback) ⇒ AWS.Request
Describes the rules packages that are specified by the ARNs of the rules packages.
.
-
getAssessmentReport(params = {}, callback) ⇒ AWS.Request
Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
-
getExclusionsPreview(params = {}, callback) ⇒ AWS.Request
Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token.
-
getTelemetryMetadata(params = {}, callback) ⇒ AWS.Request
Information about the data that is collected for the specified assessment run.
.
-
listAssessmentRunAgents(params = {}, callback) ⇒ AWS.Request
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
.
-
listAssessmentRuns(params = {}, callback) ⇒ AWS.Request
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
.
-
listAssessmentTargets(params = {}, callback) ⇒ AWS.Request
Lists the ARNs of the assessment targets within this AWS account.
-
listAssessmentTemplates(params = {}, callback) ⇒ AWS.Request
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
.
-
listEventSubscriptions(params = {}, callback) ⇒ AWS.Request
Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template.
-
listExclusions(params = {}, callback) ⇒ AWS.Request
List exclusions that are generated by the assessment run.
.
-
listFindings(params = {}, callback) ⇒ AWS.Request
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
.
-
listRulesPackages(params = {}, callback) ⇒ AWS.Request
Lists all available Amazon Inspector rules packages.
.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists all tags associated with an assessment template.
.
-
previewAgents(params = {}, callback) ⇒ AWS.Request
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
.
-
registerCrossAccountAccessRole(params = {}, callback) ⇒ AWS.Request
Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
.
-
removeAttributesFromFindings(params = {}, callback) ⇒ AWS.Request
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.
.
-
setTagsForResource(params = {}, callback) ⇒ AWS.Request
Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
.
-
startAssessmentRun(params = {}, callback) ⇒ AWS.Request
Starts the assessment run specified by the ARN of the assessment template.
-
stopAssessmentRun(params = {}, callback) ⇒ AWS.Request
Stops the assessment run that is specified by the ARN of the assessment run.
.
-
subscribeToEvent(params = {}, callback) ⇒ AWS.Request
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
.
-
unsubscribeFromEvent(params = {}, callback) ⇒ AWS.Request
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
.
-
updateAssessmentTarget(params = {}, callback) ⇒ AWS.Request
Updates the assessment target that is specified by the ARN of the assessment target.
If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.
.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.Inspector(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.