AWS.Inspector2 reference
AssociateMember
Section titled “AssociateMember”Source:
src/AWS/Inspector2/AssociateMember.ts
Runtime binding for inspector2:AssociateMember.
Associates an Amazon Web Services account with an Amazon Inspector delegated administrator. An HTTP 200 response indicates the association was successfully started, but doesn’t indicate whether it was completed. You can check if the association completed by using ListMembers for multiple accounts or GetMembers for a single account.
Provide the implementation with
Effect.provide(AWS.Inspector2.AssociateMemberHttp).
AssociateMember: Organization & Members
Section titled “AssociateMember: Organization & Members”// initconst associateMember = yield* AWS.Inspector2.AssociateMember();
// runtimeyield* associateMember({ accountId });BatchGetCodeSnippet
Section titled “BatchGetCodeSnippet”Source:
src/AWS/Inspector2/BatchGetCodeSnippet.ts
Runtime binding for inspector2:BatchGetCodeSnippet.
Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.
Provide the implementation with
Effect.provide(AWS.Inspector2.BatchGetCodeSnippetHttp).
BatchGetCodeSnippet: Querying Findings
Section titled “BatchGetCodeSnippet: Querying Findings”// initconst batchGetCodeSnippet = yield* AWS.Inspector2.BatchGetCodeSnippet();
// runtimeconst { codeSnippetResults } = yield* batchGetCodeSnippet({ findingArns: [findingArn] });BatchGetFindingDetails
Section titled “BatchGetFindingDetails”Source:
src/AWS/Inspector2/BatchGetFindingDetails.ts
Runtime binding for inspector2:BatchGetFindingDetails.
Gets vulnerability details for findings.
Provide the implementation with
Effect.provide(AWS.Inspector2.BatchGetFindingDetailsHttp).
BatchGetFindingDetails: Querying Findings
Section titled “BatchGetFindingDetails: Querying Findings”// initconst batchGetFindingDetails = yield* AWS.Inspector2.BatchGetFindingDetails();
// runtimeconst { findingDetails } = yield* batchGetFindingDetails({ findingArns: [findingArn] });BatchGetFreeTrialInfo
Section titled “BatchGetFreeTrialInfo”Source:
src/AWS/Inspector2/BatchGetFreeTrialInfo.ts
Runtime binding for inspector2:BatchGetFreeTrialInfo.
Gets free trial status for multiple Amazon Web Services accounts.
Provide the implementation with
Effect.provide(AWS.Inspector2.BatchGetFreeTrialInfoHttp).
BatchGetFreeTrialInfo: Account Settings & Usage
Section titled “BatchGetFreeTrialInfo: Account Settings & Usage”// initconst batchGetFreeTrialInfo = yield* AWS.Inspector2.BatchGetFreeTrialInfo();
// runtimeconst { accounts } = yield* batchGetFreeTrialInfo({ accountIds: [accountId] });BatchGetMemberEc2DeepInspectionStatus
Section titled “BatchGetMemberEc2DeepInspectionStatus”Source:
src/AWS/Inspector2/BatchGetMemberEc2DeepInspectionStatus.ts
Runtime binding for inspector2:BatchGetMemberEc2DeepInspectionStatus.
Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.
Provide the implementation with
Effect.provide(AWS.Inspector2.BatchGetMemberEc2DeepInspectionStatusHttp).
BatchGetMemberEc2DeepInspectionStatus: Organization & Members
Section titled “BatchGetMemberEc2DeepInspectionStatus: Organization & Members”// initconst batchGetMemberEc2DeepInspectionStatus = yield* AWS.Inspector2.BatchGetMemberEc2DeepInspectionStatus();
// runtimeconst { accountIds } = yield* batchGetMemberEc2DeepInspectionStatus();BatchUpdateMemberEc2DeepInspectionStatus
Section titled “BatchUpdateMemberEc2DeepInspectionStatus”Source:
src/AWS/Inspector2/BatchUpdateMemberEc2DeepInspectionStatus.ts
Runtime binding for inspector2:BatchUpdateMemberEc2DeepInspectionStatus.
Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.
Provide the implementation with
Effect.provide(AWS.Inspector2.BatchUpdateMemberEc2DeepInspectionStatusHttp).
BatchUpdateMemberEc2DeepInspectionStatus: Organization & Members
Section titled “BatchUpdateMemberEc2DeepInspectionStatus: Organization & Members”// initconst batchUpdateMemberEc2DeepInspectionStatus = yield* AWS.Inspector2.BatchUpdateMemberEc2DeepInspectionStatus();
// runtimeconst { accountIds } = yield* batchUpdateMemberEc2DeepInspectionStatus({ accountIds: [{ accountId, activateDeepInspection: true }],});CancelFindingsReport
Section titled “CancelFindingsReport”Source:
src/AWS/Inspector2/CancelFindingsReport.ts
Runtime binding for inspector2:CancelFindingsReport.
Cancels the given findings report.
Provide the implementation with
Effect.provide(AWS.Inspector2.CancelFindingsReportHttp).
CancelFindingsReport: Findings Reports & SBOM Exports
Section titled “CancelFindingsReport: Findings Reports & SBOM Exports”// initconst cancelFindingsReport = yield* AWS.Inspector2.CancelFindingsReport();
// runtimeyield* cancelFindingsReport({ reportId });CancelSbomExport
Section titled “CancelSbomExport”Source:
src/AWS/Inspector2/CancelSbomExport.ts
Runtime binding for inspector2:CancelSbomExport.
Cancels a software bill of materials (SBOM) report.
Provide the implementation with
Effect.provide(AWS.Inspector2.CancelSbomExportHttp).
CancelSbomExport: Findings Reports & SBOM Exports
Section titled “CancelSbomExport: Findings Reports & SBOM Exports”// initconst cancelSbomExport = yield* AWS.Inspector2.CancelSbomExport();
// runtimeyield* cancelSbomExport({ reportId });CisScanConfiguration
Section titled “CisScanConfiguration”Source:
src/AWS/Inspector2/CisScanConfiguration.ts
An Amazon Inspector CIS scan configuration — schedules CIS Benchmark scans of SSM-managed EC2 instances selected by resource tags. Name, level, schedule, and targets are all updatable in place; identity is the configuration’s ARN.
CisScanConfiguration: Scheduling CIS Scans
Section titled “CisScanConfiguration: Scheduling CIS Scans”Daily Level 1 scan of production instances
const scan = yield* AWS.Inspector2.CisScanConfiguration("NightlyCis", { securityLevel: "LEVEL_1", schedule: { daily: { startTime: { timeOfDay: "02:00", timezone: "UTC" } }, }, targets: { accountIds: ["SELF"], targetResourceTags: { Environment: ["production"] }, },});One-time Level 2 audit
const audit = yield* AWS.Inspector2.CisScanConfiguration("Level2Audit", { scanName: "level2-audit", securityLevel: "LEVEL_2", schedule: { oneTime: {} }, targets: { accountIds: ["SELF"], targetResourceTags: { Audit: ["true"] }, },});CreateFindingsReport
Section titled “CreateFindingsReport”Source:
src/AWS/Inspector2/CreateFindingsReport.ts
Runtime binding for inspector2:CreateFindingsReport.
Creates a finding report. By default only ACTIVE findings are returned in
the report. To see SUPRESSED or CLOSED findings you must specify
a value for the findingStatus filter criteria.
Provide the implementation with
Effect.provide(AWS.Inspector2.CreateFindingsReportHttp).
CreateFindingsReport: Findings Reports & SBOM Exports
Section titled “CreateFindingsReport: Findings Reports & SBOM Exports”// initconst createFindingsReport = yield* AWS.Inspector2.CreateFindingsReport();
// runtimeconst { reportId } = yield* createFindingsReport({ reportFormat: "JSON", s3Destination: { bucketName, keyPrefix: "findings/", kmsKeyArn },});CreateSbomExport
Section titled “CreateSbomExport”Source:
src/AWS/Inspector2/CreateSbomExport.ts
Runtime binding for inspector2:CreateSbomExport.
Creates a software bill of materials (SBOM) report.
Provide the implementation with
Effect.provide(AWS.Inspector2.CreateSbomExportHttp).
CreateSbomExport: Findings Reports & SBOM Exports
Section titled “CreateSbomExport: Findings Reports & SBOM Exports”// initconst createSbomExport = yield* AWS.Inspector2.CreateSbomExport();
// runtimeconst { reportId } = yield* createSbomExport({ reportFormat: "SPDX_2_3", s3Destination: { bucketName, keyPrefix: "sbom/", kmsKeyArn },});DescribeOrganizationConfiguration
Section titled “DescribeOrganizationConfiguration”Source:
src/AWS/Inspector2/DescribeOrganizationConfiguration.ts
Runtime binding for inspector2:DescribeOrganizationConfiguration.
Describe Amazon Inspector configuration settings for an Amazon Web Services organization.
Provide the implementation with
Effect.provide(AWS.Inspector2.DescribeOrganizationConfigurationHttp).
DescribeOrganizationConfiguration: Organization & Members
Section titled “DescribeOrganizationConfiguration: Organization & Members”// initconst describeOrganizationConfiguration = yield* AWS.Inspector2.DescribeOrganizationConfiguration();
// runtimeconst { autoEnable } = yield* describeOrganizationConfiguration();DisableDelegatedAdminAccount
Section titled “DisableDelegatedAdminAccount”Source:
src/AWS/Inspector2/DisableDelegatedAdminAccount.ts
Runtime binding for inspector2:DisableDelegatedAdminAccount.
Disables the Amazon Inspector delegated administrator for your organization.
Provide the implementation with
Effect.provide(AWS.Inspector2.DisableDelegatedAdminAccountHttp).
DisableDelegatedAdminAccount: Organization & Members
Section titled “DisableDelegatedAdminAccount: Organization & Members”// initconst disableDelegatedAdminAccount = yield* AWS.Inspector2.DisableDelegatedAdminAccount();
// runtimeyield* disableDelegatedAdminAccount({ delegatedAdminAccountId });DisassociateMember
Section titled “DisassociateMember”Source:
src/AWS/Inspector2/DisassociateMember.ts
Runtime binding for inspector2:DisassociateMember.
Disassociates a member account from an Amazon Inspector delegated administrator.
Provide the implementation with
Effect.provide(AWS.Inspector2.DisassociateMemberHttp).
DisassociateMember: Organization & Members
Section titled “DisassociateMember: Organization & Members”// initconst disassociateMember = yield* AWS.Inspector2.DisassociateMember();
// runtimeyield* disassociateMember({ accountId });EnableDelegatedAdminAccount
Section titled “EnableDelegatedAdminAccount”Source:
src/AWS/Inspector2/EnableDelegatedAdminAccount.ts
Runtime binding for inspector2:EnableDelegatedAdminAccount.
Enables the Amazon Inspector delegated administrator for your Organizations organization.
Provide the implementation with
Effect.provide(AWS.Inspector2.EnableDelegatedAdminAccountHttp).
EnableDelegatedAdminAccount: Organization & Members
Section titled “EnableDelegatedAdminAccount: Organization & Members”// initconst enableDelegatedAdminAccount = yield* AWS.Inspector2.EnableDelegatedAdminAccount();
// runtimeyield* enableDelegatedAdminAccount({ delegatedAdminAccountId });Enabler
Section titled “Enabler”Source:
src/AWS/Inspector2/Enabler.ts
Amazon Inspector account enablement — an account/region singleton that turns on continuous vulnerability scanning for the selected resource types (EC2, ECR, Lambda). Inspector exposes no tagging, so ownership is tracked by the set of scan types this resource enabled; destroy only disables those types and leaves any the account had enabled out-of-band untouched.
Enabler: Enabling Inspector
Section titled “Enabler: Enabling Inspector”const inspector = yield* Inspector2.Enabler("Inspector", { resourceTypes: ["EC2", "ECR", "LAMBDA"],});Filter
Section titled “Filter”Source:
src/AWS/Inspector2/Filter.ts
An Amazon Inspector findings filter — matches findings against criteria
and either keeps them visible (NONE, a saved view) or suppresses them
(SUPPRESS, a suppression rule). Everything is updatable in place; the
filter’s identity is its ARN.
Filter: Suppressing Findings
Section titled “Filter: Suppressing Findings”Suppress informational findings
const filter = yield* AWS.Inspector2.Filter("SuppressInfo", { action: "SUPPRESS", reason: "Informational findings are tracked elsewhere", filterCriteria: { severity: [{ comparison: "EQUALS", value: "INFORMATIONAL" }], },});Saved view of one repository’s findings
const filter = yield* AWS.Inspector2.Filter("RepoView", { name: "payments-repository", action: "NONE", filterCriteria: { ecrImageRepositoryName: [{ comparison: "EQUALS", value: "payments" }], },});GetCisScanReport
Section titled “GetCisScanReport”Source:
src/AWS/Inspector2/GetCisScanReport.ts
Runtime binding for inspector2:GetCisScanReport.
Retrieves a CIS scan report.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetCisScanReportHttp).
GetCisScanReport: CIS Scan Results
Section titled “GetCisScanReport: CIS Scan Results”// initconst getCisScanReport = yield* AWS.Inspector2.GetCisScanReport();
// runtimeconst { url, status } = yield* getCisScanReport({ scanArn });GetCisScanResultDetails
Section titled “GetCisScanResultDetails”Source:
src/AWS/Inspector2/GetCisScanResultDetails.ts
Runtime binding for inspector2:GetCisScanResultDetails.
Retrieves CIS scan result details.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetCisScanResultDetailsHttp).
GetCisScanResultDetails: CIS Scan Results
Section titled “GetCisScanResultDetails: CIS Scan Results”// initconst getCisScanResultDetails = yield* AWS.Inspector2.GetCisScanResultDetails();
// runtimeconst { scanResultDetails } = yield* getCisScanResultDetails({ scanArn, accountId, targetResourceId: instanceId,});GetClustersForImage
Section titled “GetClustersForImage”Source:
src/AWS/Inspector2/GetClustersForImage.ts
Runtime binding for inspector2:GetClustersForImage.
Returns a list of clusters and metadata associated with an image.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetClustersForImageHttp).
GetClustersForImage: Coverage & Vulnerability Intel
Section titled “GetClustersForImage: Coverage & Vulnerability Intel”// initconst getClustersForImage = yield* AWS.Inspector2.GetClustersForImage();
// runtimeconst { cluster } = yield* getClustersForImage({ filter: { resourceId: imageResourceId },});GetCodeSecurityScan
Section titled “GetCodeSecurityScan”Source:
src/AWS/Inspector2/GetCodeSecurityScan.ts
Runtime binding for inspector2:GetCodeSecurityScan.
Retrieves information about a specific code security scan.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetCodeSecurityScanHttp).
GetCodeSecurityScan: Code Security Scans
Section titled “GetCodeSecurityScan: Code Security Scans”// initconst getCodeSecurityScan = yield* AWS.Inspector2.GetCodeSecurityScan();
// runtimeconst { status } = yield* getCodeSecurityScan({ resource: { projectId }, scanId,});GetConfiguration
Section titled “GetConfiguration”Source:
src/AWS/Inspector2/GetConfiguration.ts
Runtime binding for inspector2:GetConfiguration.
Retrieves setting configurations for Inspector scans.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetConfigurationHttp).
GetConfiguration: Account Settings & Usage
Section titled “GetConfiguration: Account Settings & Usage”// initconst getConfiguration = yield* AWS.Inspector2.GetConfiguration();
// runtimeconst { ecrConfiguration, ec2Configuration } = yield* getConfiguration();GetDelegatedAdminAccount
Section titled “GetDelegatedAdminAccount”Source:
src/AWS/Inspector2/GetDelegatedAdminAccount.ts
Runtime binding for inspector2:GetDelegatedAdminAccount.
Retrieves information about the Amazon Inspector delegated administrator for your organization.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetDelegatedAdminAccountHttp).
GetDelegatedAdminAccount: Organization & Members
Section titled “GetDelegatedAdminAccount: Organization & Members”// initconst getDelegatedAdminAccount = yield* AWS.Inspector2.GetDelegatedAdminAccount();
// runtimeconst { delegatedAdmin } = yield* getDelegatedAdminAccount();GetEc2DeepInspectionConfiguration
Section titled “GetEc2DeepInspectionConfiguration”Source:
src/AWS/Inspector2/GetEc2DeepInspectionConfiguration.ts
Runtime binding for inspector2:GetEc2DeepInspectionConfiguration.
Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetEc2DeepInspectionConfigurationHttp).
GetEc2DeepInspectionConfiguration: Account Settings & Usage
Section titled “GetEc2DeepInspectionConfiguration: Account Settings & Usage”// initconst getEc2DeepInspectionConfiguration = yield* AWS.Inspector2.GetEc2DeepInspectionConfiguration();
// runtimeconst { status, packagePaths } = yield* getEc2DeepInspectionConfiguration();GetEncryptionKey
Section titled “GetEncryptionKey”Source:
src/AWS/Inspector2/GetEncryptionKey.ts
Runtime binding for inspector2:GetEncryptionKey.
Gets an encryption key.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetEncryptionKeyHttp).
GetEncryptionKey: Account Settings & Usage
Section titled “GetEncryptionKey: Account Settings & Usage”// initconst getEncryptionKey = yield* AWS.Inspector2.GetEncryptionKey();
// runtimeconst { kmsKeyId } = yield* getEncryptionKey({ resourceType: "AWS_ECR_CONTAINER_IMAGE", scanType: "PACKAGE",});GetFindingsReportStatus
Section titled “GetFindingsReportStatus”Source:
src/AWS/Inspector2/GetFindingsReportStatus.ts
Runtime binding for inspector2:GetFindingsReportStatus.
Gets the status of a findings report.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetFindingsReportStatusHttp).
GetFindingsReportStatus: Findings Reports & SBOM Exports
Section titled “GetFindingsReportStatus: Findings Reports & SBOM Exports”// initconst getFindingsReportStatus = yield* AWS.Inspector2.GetFindingsReportStatus();
// runtimeconst { status } = yield* getFindingsReportStatus({ reportId });GetMember
Section titled “GetMember”Source:
src/AWS/Inspector2/GetMember.ts
Runtime binding for inspector2:GetMember.
Gets member information for your organization.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetMemberHttp).
GetMember: Organization & Members
Section titled “GetMember: Organization & Members”// initconst getMember = yield* AWS.Inspector2.GetMember();
// runtimeconst { member } = yield* getMember({ accountId });GetSbomExport
Section titled “GetSbomExport”Source:
src/AWS/Inspector2/GetSbomExport.ts
Runtime binding for inspector2:GetSbomExport.
Gets details of a software bill of materials (SBOM) report.
Provide the implementation with
Effect.provide(AWS.Inspector2.GetSbomExportHttp).
GetSbomExport: Findings Reports & SBOM Exports
Section titled “GetSbomExport: Findings Reports & SBOM Exports”// initconst getSbomExport = yield* AWS.Inspector2.GetSbomExport();
// runtimeconst { status } = yield* getSbomExport({ reportId });ListAccountPermissions
Section titled “ListAccountPermissions”Source:
src/AWS/Inspector2/ListAccountPermissions.ts
Runtime binding for inspector2:ListAccountPermissions.
Lists the permissions an account has to configure Amazon Inspector. If the account is a member account or standalone account with resources managed by an Organizations policy, the operation returns fewer permissions.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListAccountPermissionsHttp).
ListAccountPermissions: Account Settings & Usage
Section titled “ListAccountPermissions: Account Settings & Usage”// initconst listAccountPermissions = yield* AWS.Inspector2.ListAccountPermissions();
// runtimeconst { permissions } = yield* listAccountPermissions();ListCisScanResultsAggregatedByChecks
Section titled “ListCisScanResultsAggregatedByChecks”Source:
src/AWS/Inspector2/ListCisScanResultsAggregatedByChecks.ts
Runtime binding for inspector2:ListCisScanResultsAggregatedByChecks.
Lists scan results aggregated by checks.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListCisScanResultsAggregatedByChecksHttp).
ListCisScanResultsAggregatedByChecks: CIS Scan Results
Section titled “ListCisScanResultsAggregatedByChecks: CIS Scan Results”// initconst listCisScanResultsAggregatedByChecks = yield* AWS.Inspector2.ListCisScanResultsAggregatedByChecks();
// runtimeconst { checkAggregations } = yield* listCisScanResultsAggregatedByChecks({ scanArn });ListCisScanResultsAggregatedByTargetResource
Section titled “ListCisScanResultsAggregatedByTargetResource”Source:
src/AWS/Inspector2/ListCisScanResultsAggregatedByTargetResource.ts
Runtime binding for inspector2:ListCisScanResultsAggregatedByTargetResource.
Lists scan results aggregated by a target resource.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListCisScanResultsAggregatedByTargetResourceHttp).
ListCisScanResultsAggregatedByTargetResource: CIS Scan Results
Section titled “ListCisScanResultsAggregatedByTargetResource: CIS Scan Results”// initconst listCisScanResultsAggregatedByTargetResource = yield* AWS.Inspector2.ListCisScanResultsAggregatedByTargetResource();
// runtimeconst { targetResourceAggregations } = yield* listCisScanResultsAggregatedByTargetResource({ scanArn });ListCisScans
Section titled “ListCisScans”Source:
src/AWS/Inspector2/ListCisScans.ts
Runtime binding for inspector2:ListCisScans.
Returns a CIS scan list.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListCisScansHttp).
ListCisScans: CIS Scan Results
Section titled “ListCisScans: CIS Scan Results”// initconst listCisScans = yield* AWS.Inspector2.ListCisScans();
// runtimeconst { scans } = yield* listCisScans();ListCoverage
Section titled “ListCoverage”Source:
src/AWS/Inspector2/ListCoverage.ts
Runtime binding for inspector2:ListCoverage.
Lists coverage details for your environment.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListCoverageHttp).
ListCoverage: Coverage & Vulnerability Intel
Section titled “ListCoverage: Coverage & Vulnerability Intel”// initconst listCoverage = yield* AWS.Inspector2.ListCoverage();
// runtimeconst { coveredResources } = yield* listCoverage();ListCoverageStatistics
Section titled “ListCoverageStatistics”Source:
src/AWS/Inspector2/ListCoverageStatistics.ts
Runtime binding for inspector2:ListCoverageStatistics.
Lists Amazon Inspector coverage statistics for your environment.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListCoverageStatisticsHttp).
ListCoverageStatistics: Coverage & Vulnerability Intel
Section titled “ListCoverageStatistics: Coverage & Vulnerability Intel”// initconst listCoverageStatistics = yield* AWS.Inspector2.ListCoverageStatistics();
// runtimeconst { countsByGroup, totalCounts } = yield* listCoverageStatistics({ groupBy: "RESOURCE_TYPE" });ListDelegatedAdminAccounts
Section titled “ListDelegatedAdminAccounts”Source:
src/AWS/Inspector2/ListDelegatedAdminAccounts.ts
Runtime binding for inspector2:ListDelegatedAdminAccounts.
Lists information about the Amazon Inspector delegated administrator of your organization.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListDelegatedAdminAccountsHttp).
ListDelegatedAdminAccounts: Organization & Members
Section titled “ListDelegatedAdminAccounts: Organization & Members”// initconst listDelegatedAdminAccounts = yield* AWS.Inspector2.ListDelegatedAdminAccounts();
// runtimeconst { delegatedAdminAccounts } = yield* listDelegatedAdminAccounts();ListFindingAggregations
Section titled “ListFindingAggregations”Source:
src/AWS/Inspector2/ListFindingAggregations.ts
Runtime binding for inspector2:ListFindingAggregations.
Lists aggregated finding data for your environment based on specific criteria.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListFindingAggregationsHttp).
ListFindingAggregations: Querying Findings
Section titled “ListFindingAggregations: Querying Findings”// initconst listFindingAggregations = yield* AWS.Inspector2.ListFindingAggregations();
// runtimeconst { responses } = yield* listFindingAggregations({ aggregationType: "ACCOUNT" });ListFindings
Section titled “ListFindings”Source:
src/AWS/Inspector2/ListFindings.ts
Runtime binding for inspector2:ListFindings.
Lists findings for your environment.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListFindingsHttp).
ListFindings: Querying Findings
Section titled “ListFindings: Querying Findings”// initconst listFindings = yield* AWS.Inspector2.ListFindings();
// runtimeconst { findings } = yield* listFindings({ filterCriteria: { severity: [{ comparison: "EQUALS", value: "CRITICAL" }] },});ListMembers
Section titled “ListMembers”Source:
src/AWS/Inspector2/ListMembers.ts
Runtime binding for inspector2:ListMembers.
List members associated with the Amazon Inspector delegated administrator for your organization.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListMembersHttp).
ListMembers: Organization & Members
Section titled “ListMembers: Organization & Members”// initconst listMembers = yield* AWS.Inspector2.ListMembers();
// runtimeconst { members } = yield* listMembers();ListUsageTotals
Section titled “ListUsageTotals”Source:
src/AWS/Inspector2/ListUsageTotals.ts
Runtime binding for inspector2:ListUsageTotals.
Lists the Amazon Inspector usage totals over the last 30 days.
Provide the implementation with
Effect.provide(AWS.Inspector2.ListUsageTotalsHttp).
ListUsageTotals: Account Settings & Usage
Section titled “ListUsageTotals: Account Settings & Usage”// initconst listUsageTotals = yield* AWS.Inspector2.ListUsageTotals();
// runtimeconst { totals } = yield* listUsageTotals();ResetEncryptionKey
Section titled “ResetEncryptionKey”Source:
src/AWS/Inspector2/ResetEncryptionKey.ts
Runtime binding for inspector2:ResetEncryptionKey.
Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key.
Provide the implementation with
Effect.provide(AWS.Inspector2.ResetEncryptionKeyHttp).
ResetEncryptionKey: Account Settings & Usage
Section titled “ResetEncryptionKey: Account Settings & Usage”// initconst resetEncryptionKey = yield* AWS.Inspector2.ResetEncryptionKey();
// runtimeyield* resetEncryptionKey({ resourceType: "AWS_ECR_CONTAINER_IMAGE", scanType: "PACKAGE",});SearchVulnerabilities
Section titled “SearchVulnerabilities”Source:
src/AWS/Inspector2/SearchVulnerabilities.ts
Runtime binding for inspector2:SearchVulnerabilities.
Lists Amazon Inspector coverage details for a specific vulnerability.
Provide the implementation with
Effect.provide(AWS.Inspector2.SearchVulnerabilitiesHttp).
SearchVulnerabilities: Coverage & Vulnerability Intel
Section titled “SearchVulnerabilities: Coverage & Vulnerability Intel”// initconst searchVulnerabilities = yield* AWS.Inspector2.SearchVulnerabilities();
// runtimeconst { vulnerabilities } = yield* searchVulnerabilities({ filterCriteria: { vulnerabilityIds: ["CVE-2021-44228"] },});StartCodeSecurityScan
Section titled “StartCodeSecurityScan”Source:
src/AWS/Inspector2/StartCodeSecurityScan.ts
Runtime binding for inspector2:StartCodeSecurityScan.
Initiates a code security scan on a specified repository.
Provide the implementation with
Effect.provide(AWS.Inspector2.StartCodeSecurityScanHttp).
StartCodeSecurityScan: Code Security Scans
Section titled “StartCodeSecurityScan: Code Security Scans”// initconst startCodeSecurityScan = yield* AWS.Inspector2.StartCodeSecurityScan();
// runtimeconst { scanId, status } = yield* startCodeSecurityScan({ resource: { projectId },});UpdateConfiguration
Section titled “UpdateConfiguration”Source:
src/AWS/Inspector2/UpdateConfiguration.ts
Runtime binding for inspector2:UpdateConfiguration.
Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.
Provide the implementation with
Effect.provide(AWS.Inspector2.UpdateConfigurationHttp).
UpdateConfiguration: Account Settings & Usage
Section titled “UpdateConfiguration: Account Settings & Usage”// initconst updateConfiguration = yield* AWS.Inspector2.UpdateConfiguration();
// runtimeyield* updateConfiguration({ ecrConfiguration: { rescanDuration: "DAYS_30" },});UpdateEc2DeepInspectionConfiguration
Section titled “UpdateEc2DeepInspectionConfiguration”Source:
src/AWS/Inspector2/UpdateEc2DeepInspectionConfiguration.ts
Runtime binding for inspector2:UpdateEc2DeepInspectionConfiguration.
Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.
Provide the implementation with
Effect.provide(AWS.Inspector2.UpdateEc2DeepInspectionConfigurationHttp).
UpdateEc2DeepInspectionConfiguration: Account Settings & Usage
Section titled “UpdateEc2DeepInspectionConfiguration: Account Settings & Usage”// initconst updateEc2DeepInspectionConfiguration = yield* AWS.Inspector2.UpdateEc2DeepInspectionConfiguration();
// runtimeconst { status } = yield* updateEc2DeepInspectionConfiguration({ activateDeepInspection: true });UpdateEncryptionKey
Section titled “UpdateEncryptionKey”Source:
src/AWS/Inspector2/UpdateEncryptionKey.ts
Runtime binding for inspector2:UpdateEncryptionKey.
Updates an encryption key. A ResourceNotFoundException means that an
Amazon Web Services owned key is being used for encryption.
Provide the implementation with
Effect.provide(AWS.Inspector2.UpdateEncryptionKeyHttp).
UpdateEncryptionKey: Account Settings & Usage
Section titled “UpdateEncryptionKey: Account Settings & Usage”// initconst updateEncryptionKey = yield* AWS.Inspector2.UpdateEncryptionKey();
// runtimeyield* updateEncryptionKey({ kmsKeyId, resourceType: "AWS_ECR_CONTAINER_IMAGE", scanType: "PACKAGE",});UpdateOrganizationConfiguration
Section titled “UpdateOrganizationConfiguration”Source:
src/AWS/Inspector2/UpdateOrganizationConfiguration.ts
Runtime binding for inspector2:UpdateOrganizationConfiguration.
Updates the configurations for your Amazon Inspector organization.
Provide the implementation with
Effect.provide(AWS.Inspector2.UpdateOrganizationConfigurationHttp).
UpdateOrganizationConfiguration: Organization & Members
Section titled “UpdateOrganizationConfiguration: Organization & Members”// initconst updateOrganizationConfiguration = yield* AWS.Inspector2.UpdateOrganizationConfiguration();
// runtimeyield* updateOrganizationConfiguration({ autoEnable: { ec2: true, ecr: true, lambda: true },});UpdateOrgEc2DeepInspectionConfiguration
Section titled “UpdateOrgEc2DeepInspectionConfiguration”Source:
src/AWS/Inspector2/UpdateOrgEc2DeepInspectionConfiguration.ts
Runtime binding for inspector2:UpdateOrgEc2DeepInspectionConfiguration.
Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.
Provide the implementation with
Effect.provide(AWS.Inspector2.UpdateOrgEc2DeepInspectionConfigurationHttp).
UpdateOrgEc2DeepInspectionConfiguration: Organization & Members
Section titled “UpdateOrgEc2DeepInspectionConfiguration: Organization & Members”// initconst updateOrgEc2DeepInspectionConfiguration = yield* AWS.Inspector2.UpdateOrgEc2DeepInspectionConfiguration();
// runtimeyield* updateOrgEc2DeepInspectionConfiguration({ orgPackagePaths: ["/opt/app"] });