@aws-sdk/client-inspector2
Description
AWS SDK for JavaScript Inspector2 Client for Node.js, Browser and React Native.
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.
Installing
To install this package, simply type add or install @aws-sdk/client-inspector2
using your favorite package manager:
npm install @aws-sdk/client-inspector2
yarn add @aws-sdk/client-inspector2
pnpm add @aws-sdk/client-inspector2
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the Inspector2Client
and
the commands you need, for example ListFiltersCommand
:
const { Inspector2Client, ListFiltersCommand } = require("@aws-sdk/client-inspector2");
import { Inspector2Client, ListFiltersCommand } from "@aws-sdk/client-inspector2";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new Inspector2Client({ region: "REGION" });
const params = {
};
const command = new ListFiltersCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-inspector2";
const client = new AWS.Inspector2({ region: "REGION" });
try {
const data = await client.listFilters(params);
} catch (error) {
}
client
.listFilters(params)
.then((data) => {
})
.catch((error) => {
});
client.listFilters(params, (err, data) => {
});
Troubleshooting
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-inspector2
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
AssociateMember
Command API Reference / Input / Output
BatchGetAccountStatus
Command API Reference / Input / Output
BatchGetCodeSnippet
Command API Reference / Input / Output
BatchGetFindingDetails
Command API Reference / Input / Output
BatchGetFreeTrialInfo
Command API Reference / Input / Output
BatchGetMemberEc2DeepInspectionStatus
Command API Reference / Input / Output
BatchUpdateMemberEc2DeepInspectionStatus
Command API Reference / Input / Output
CancelFindingsReport
Command API Reference / Input / Output
CancelSbomExport
Command API Reference / Input / Output
CreateCisScanConfiguration
Command API Reference / Input / Output
CreateFilter
Command API Reference / Input / Output
CreateFindingsReport
Command API Reference / Input / Output
CreateSbomExport
Command API Reference / Input / Output
DeleteCisScanConfiguration
Command API Reference / Input / Output
DeleteFilter
Command API Reference / Input / Output
DescribeOrganizationConfiguration
Command API Reference / Input / Output
Disable
Command API Reference / Input / Output
DisableDelegatedAdminAccount
Command API Reference / Input / Output
DisassociateMember
Command API Reference / Input / Output
Enable
Command API Reference / Input / Output
EnableDelegatedAdminAccount
Command API Reference / Input / Output
GetCisScanReport
Command API Reference / Input / Output
GetCisScanResultDetails
Command API Reference / Input / Output
GetConfiguration
Command API Reference / Input / Output
GetDelegatedAdminAccount
Command API Reference / Input / Output
GetEc2DeepInspectionConfiguration
Command API Reference / Input / Output
GetEncryptionKey
Command API Reference / Input / Output
GetFindingsReportStatus
Command API Reference / Input / Output
GetMember
Command API Reference / Input / Output
GetSbomExport
Command API Reference / Input / Output
ListAccountPermissions
Command API Reference / Input / Output
ListCisScanConfigurations
Command API Reference / Input / Output
ListCisScanResultsAggregatedByChecks
Command API Reference / Input / Output
ListCisScanResultsAggregatedByTargetResource
Command API Reference / Input / Output
ListCisScans
Command API Reference / Input / Output
ListCoverage
Command API Reference / Input / Output
ListCoverageStatistics
Command API Reference / Input / Output
ListDelegatedAdminAccounts
Command API Reference / Input / Output
ListFilters
Command API Reference / Input / Output
ListFindingAggregations
Command API Reference / Input / Output
ListFindings
Command API Reference / Input / Output
ListMembers
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListUsageTotals
Command API Reference / Input / Output
ResetEncryptionKey
Command API Reference / Input / Output
SearchVulnerabilities
Command API Reference / Input / Output
SendCisSessionHealth
Command API Reference / Input / Output
SendCisSessionTelemetry
Command API Reference / Input / Output
StartCisSession
Command API Reference / Input / Output
StopCisSession
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateCisScanConfiguration
Command API Reference / Input / Output
UpdateConfiguration
Command API Reference / Input / Output
UpdateEc2DeepInspectionConfiguration
Command API Reference / Input / Output
UpdateEncryptionKey
Command API Reference / Input / Output
UpdateFilter
Command API Reference / Input / Output
UpdateOrganizationConfiguration
Command API Reference / Input / Output
UpdateOrgEc2DeepInspectionConfiguration
Command API Reference / Input / Output