Inspector2 class

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.

Constructors

Inspector2({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

associateMember({required String accountId}) → Future<AssociateMemberResponse>
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.
batchAssociateCodeSecurityScanConfiguration({required List<AssociateConfigurationRequest> associateConfigurationRequests}) → Future<BatchAssociateCodeSecurityScanConfigurationResponse>
Associates multiple code repositories with an Amazon Inspector code security scan configuration.
batchDisassociateCodeSecurityScanConfiguration({required List<DisassociateConfigurationRequest> disassociateConfigurationRequests}) → Future<BatchDisassociateCodeSecurityScanConfigurationResponse>
Disassociates multiple code repositories from an Amazon Inspector code security scan configuration.
batchGetAccountStatus({List<String>? accountIds}) → Future<BatchGetAccountStatusResponse>
Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
batchGetCodeSnippet({required List<String> findingArns}) → Future<BatchGetCodeSnippetResponse>
Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.
batchGetFindingDetails({required List<String> findingArns}) → Future<BatchGetFindingDetailsResponse>
Gets vulnerability details for findings.
batchGetFreeTrialInfo({required List<String> accountIds}) → Future<BatchGetFreeTrialInfoResponse>
Gets free trial status for multiple Amazon Web Services accounts.
batchGetMemberEc2DeepInspectionStatus({List<String>? accountIds}) → Future<BatchGetMemberEc2DeepInspectionStatusResponse>
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.
batchUpdateMemberEc2DeepInspectionStatus({required List<MemberAccountEc2DeepInspectionStatus> accountIds}) → Future<BatchUpdateMemberEc2DeepInspectionStatusResponse>
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.
cancelFindingsReport({required String reportId}) → Future<CancelFindingsReportResponse>
Cancels the given findings report.
cancelSbomExport({required String reportId}) → Future<CancelSbomExportResponse>
Cancels a software bill of materials (SBOM) report.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createCisScanConfiguration({required String scanName, required Schedule schedule, required CisSecurityLevel securityLevel, required CreateCisTargets targets, Map<String, String>? tags}) → Future<CreateCisScanConfigurationResponse>
Creates a CIS scan configuration.
createCodeSecurityIntegration({required String name, required IntegrationType type, CreateIntegrationDetail? details, Map<String, String>? tags}) → Future<CreateCodeSecurityIntegrationResponse>
Creates a code security integration with a source code repository provider.
createCodeSecurityScanConfiguration({required CodeSecurityScanConfiguration configuration, required ConfigurationLevel level, required String name, ScopeSettings? scopeSettings, Map<String, String>? tags}) → Future<CreateCodeSecurityScanConfigurationResponse>
Creates a scan configuration for code security scanning.
createFilter({required FilterAction action, required FilterCriteria filterCriteria, required String name, String? description, String? reason, Map<String, String>? tags}) → Future<CreateFilterResponse>
Creates a filter resource using specified filter criteria. When the filter action is set to SUPPRESS this action creates a suppression rule.
createFindingsReport({required ReportFormat reportFormat, required Destination s3Destination, FilterCriteria? filterCriteria}) → Future<CreateFindingsReportResponse>
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.
createSbomExport({required SbomReportFormat reportFormat, required Destination s3Destination, ResourceFilterCriteria? resourceFilterCriteria}) → Future<CreateSbomExportResponse>
Creates a software bill of materials (SBOM) report.
deleteCisScanConfiguration({required String scanConfigurationArn}) → Future<DeleteCisScanConfigurationResponse>
Deletes a CIS scan configuration.
deleteCodeSecurityIntegration({required String integrationArn}) → Future<DeleteCodeSecurityIntegrationResponse>
Deletes a code security integration.
deleteCodeSecurityScanConfiguration({required String scanConfigurationArn}) → Future<DeleteCodeSecurityScanConfigurationResponse>
Deletes a code security scan configuration.
deleteFilter({required String arn}) → Future<DeleteFilterResponse>
Deletes a filter resource.
describeOrganizationConfiguration() → Future<DescribeOrganizationConfigurationResponse>
Describe Amazon Inspector configuration settings for an Amazon Web Services organization.
disable({List<String>? accountIds, List<ResourceScanType>? resourceTypes}) → Future<DisableResponse>
Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.
disableDelegatedAdminAccount({required String delegatedAdminAccountId}) → Future<DisableDelegatedAdminAccountResponse>
Disables the Amazon Inspector delegated administrator for your organization.
disassociateMember({required String accountId}) → Future<DisassociateMemberResponse>
Disassociates a member account from an Amazon Inspector delegated administrator.
enable({required List<ResourceScanType> resourceTypes, List<String>? accountIds, String? clientToken}) → Future<EnableResponse>
Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
enableDelegatedAdminAccount({required String delegatedAdminAccountId, String? clientToken}) → Future<EnableDelegatedAdminAccountResponse>
Enables the Amazon Inspector delegated administrator for your Organizations organization.
getCisScanReport({required String scanArn, CisReportFormat? reportFormat, List<String>? targetAccounts}) → Future<GetCisScanReportResponse>
Retrieves a CIS scan report.
getCisScanResultDetails({required String accountId, required String scanArn, required String targetResourceId, CisScanResultDetailsFilterCriteria? filterCriteria, int? maxResults, String? nextToken, CisScanResultDetailsSortBy? sortBy, CisSortOrder? sortOrder}) → Future<GetCisScanResultDetailsResponse>
Retrieves CIS scan result details.
getClustersForImage({required ClusterForImageFilterCriteria filter, int? maxResults, String? nextToken}) → Future<GetClustersForImageResponse>
Returns a list of clusters and metadata associated with an image.
getCodeSecurityIntegration({required String integrationArn, Map<String, String>? tags}) → Future<GetCodeSecurityIntegrationResponse>
Retrieves information about a code security integration.
getCodeSecurityScan({required CodeSecurityResource resource, required String scanId}) → Future<GetCodeSecurityScanResponse>
Retrieves information about a specific code security scan.
getCodeSecurityScanConfiguration({required String scanConfigurationArn}) → Future<GetCodeSecurityScanConfigurationResponse>
Retrieves information about a code security scan configuration.
getConfiguration() → Future<GetConfigurationResponse>
Retrieves setting configurations for Inspector scans.
getDelegatedAdminAccount() → Future<GetDelegatedAdminAccountResponse>
Retrieves information about the Amazon Inspector delegated administrator for your organization.
getEc2DeepInspectionConfiguration() → Future<GetEc2DeepInspectionConfigurationResponse>
Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.
getEncryptionKey({required ResourceType resourceType, required ScanType scanType}) → Future<GetEncryptionKeyResponse>
Gets an encryption key.
getFindingsReportStatus({String? reportId}) → Future<GetFindingsReportStatusResponse>
Gets the status of a findings report.
getMember({required String accountId}) → Future<GetMemberResponse>
Gets member information for your organization.
getSbomExport({required String reportId}) → Future<GetSbomExportResponse>
Gets details of a software bill of materials (SBOM) report.
listAccountPermissions({int? maxResults, String? nextToken, Service? service}) → Future<ListAccountPermissionsResponse>
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.
listCisScanConfigurations({ListCisScanConfigurationsFilterCriteria? filterCriteria, int? maxResults, String? nextToken, CisScanConfigurationsSortBy? sortBy, CisSortOrder? sortOrder}) → Future<ListCisScanConfigurationsResponse>
Lists CIS scan configurations.
listCisScanResultsAggregatedByChecks({required String scanArn, CisScanResultsAggregatedByChecksFilterCriteria? filterCriteria, int? maxResults, String? nextToken, CisScanResultsAggregatedByChecksSortBy? sortBy, CisSortOrder? sortOrder}) → Future<ListCisScanResultsAggregatedByChecksResponse>
Lists scan results aggregated by checks.
listCisScanResultsAggregatedByTargetResource({required String scanArn, CisScanResultsAggregatedByTargetResourceFilterCriteria? filterCriteria, int? maxResults, String? nextToken, CisScanResultsAggregatedByTargetResourceSortBy? sortBy, CisSortOrder? sortOrder}) → Future<ListCisScanResultsAggregatedByTargetResourceResponse>
Lists scan results aggregated by a target resource.
listCisScans({ListCisScansDetailLevel? detailLevel, ListCisScansFilterCriteria? filterCriteria, int? maxResults, String? nextToken, ListCisScansSortBy? sortBy, CisSortOrder? sortOrder}) → Future<ListCisScansResponse>
Returns a CIS scan list.
listCodeSecurityIntegrations({int? maxResults, String? nextToken}) → Future<ListCodeSecurityIntegrationsResponse>
Lists all code security integrations in your account.
listCodeSecurityScanConfigurationAssociations({required String scanConfigurationArn, int? maxResults, String? nextToken}) → Future<ListCodeSecurityScanConfigurationAssociationsResponse>
Lists the associations between code repositories and Amazon Inspector code security scan configurations.
listCodeSecurityScanConfigurations({int? maxResults, String? nextToken}) → Future<ListCodeSecurityScanConfigurationsResponse>
Lists all code security scan configurations in your account.
listCoverage({CoverageFilterCriteria? filterCriteria, int? maxResults, String? nextToken}) → Future<ListCoverageResponse>
Lists coverage details for your environment.
listCoverageStatistics({CoverageFilterCriteria? filterCriteria, GroupKey? groupBy, String? nextToken}) → Future<ListCoverageStatisticsResponse>
Lists Amazon Inspector coverage statistics for your environment.
listDelegatedAdminAccounts({int? maxResults, String? nextToken}) → Future<ListDelegatedAdminAccountsResponse>
Lists information about the Amazon Inspector delegated administrator of your organization.
listFilters({FilterAction? action, List<String>? arns, int? maxResults, String? nextToken}) → Future<ListFiltersResponse>
Lists the filters associated with your account.
listFindingAggregations({required AggregationType aggregationType, List<StringFilter>? accountIds, AggregationRequest? aggregationRequest, int? maxResults, String? nextToken}) → Future<ListFindingAggregationsResponse>
Lists aggregated finding data for your environment based on specific criteria.
listFindings({FilterCriteria? filterCriteria, int? maxResults, String? nextToken, SortCriteria? sortCriteria}) → Future<ListFindingsResponse>
Lists findings for your environment.
listMembers({int? maxResults, String? nextToken, bool? onlyAssociated}) → Future<ListMembersResponse>
List members associated with the Amazon Inspector delegated administrator for your organization.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists all tags attached to a given resource.
listUsageTotals({List<String>? accountIds, int? maxResults, String? nextToken}) → Future<ListUsageTotalsResponse>
Lists the Amazon Inspector usage totals over the last 30 days.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resetEncryptionKey({required ResourceType resourceType, required ScanType scanType}) → Future<void>
Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key.
searchVulnerabilities({required SearchVulnerabilitiesFilterCriteria filterCriteria, String? nextToken}) → Future<SearchVulnerabilitiesResponse>
Lists Amazon Inspector coverage details for a specific vulnerability.
sendCisSessionHealth({required String scanJobId, required String sessionToken}) → Future<void>
Sends a CIS session health. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
sendCisSessionTelemetry({required List<CisSessionMessage> messages, required String scanJobId, required String sessionToken}) → Future<void>
Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
startCisSession({required StartCisSessionMessage message, required String scanJobId}) → Future<void>
Starts a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.
startCodeSecurityScan({required CodeSecurityResource resource, String? clientToken}) → Future<StartCodeSecurityScanResponse>
Initiates a code security scan on a specified repository.
stopCisSession({required StopCisSessionMessage message, required String scanJobId, required String sessionToken}) → Future<void>
Stops a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to stop a CIS scan session for the scan ID supplied by the service.
tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>
Adds tags to a resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes tags from a resource.
updateCisScanConfiguration({required String scanConfigurationArn, String? scanName, Schedule? schedule, CisSecurityLevel? securityLevel, UpdateCisTargets? targets}) → Future<UpdateCisScanConfigurationResponse>
Updates a CIS scan configuration.
updateCodeSecurityIntegration({required UpdateIntegrationDetails details, required String integrationArn}) → Future<UpdateCodeSecurityIntegrationResponse>
Updates an existing code security integration.
updateCodeSecurityScanConfiguration({required CodeSecurityScanConfiguration configuration, required String scanConfigurationArn}) → Future<UpdateCodeSecurityScanConfigurationResponse>
Updates an existing code security scan configuration.
updateConfiguration({Ec2Configuration? ec2Configuration, EcrConfiguration? ecrConfiguration}) → Future<void>
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.
updateEc2DeepInspectionConfiguration({bool? activateDeepInspection, List<String>? packagePaths}) → Future<UpdateEc2DeepInspectionConfigurationResponse>
Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.
updateEncryptionKey({required String kmsKeyId, required ResourceType resourceType, required ScanType scanType}) → Future<void>
Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.
updateFilter({required String filterArn, FilterAction? action, String? description, FilterCriteria? filterCriteria, String? name, String? reason}) → Future<UpdateFilterResponse>
Specifies the action that is to be applied to the findings that match the filter.
updateOrganizationConfiguration({required AutoEnable autoEnable}) → Future<UpdateOrganizationConfigurationResponse>
Updates the configurations for your Amazon Inspector organization.
updateOrgEc2DeepInspectionConfiguration({required List<String> orgPackagePaths}) → Future<void>
Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.

Operators

operator ==(Object other) → bool
The equality operator.
inherited