Inspector class
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.
Constructors
- Inspector({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
-
addAttributesToFindings(
{required List< Attribute> attributes, required List<String> findingArns}) → Future<AddAttributesToFindingsResponse> - Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
-
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.
-
createAssessmentTarget(
{required String assessmentTargetName, String? resourceGroupArn}) → Future< CreateAssessmentTargetResponse> - Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.
-
createAssessmentTemplate(
{required String assessmentTargetArn, required String assessmentTemplateName, required int durationInSeconds, required List< String> rulesPackageArns, List<Attribute> ? userAttributesForFindings}) → Future<CreateAssessmentTemplateResponse> - Creates 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 registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.
-
createExclusionsPreview(
{required String assessmentTemplateArn}) → Future< CreateExclusionsPreviewResponse> - Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.
-
createResourceGroup(
{required List< ResourceGroupTag> resourceGroupTags}) → Future<CreateResourceGroupResponse> - 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. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.
-
deleteAssessmentRun(
{required String assessmentRunArn}) → Future< void> - Deletes the assessment run that is specified by the ARN of the assessment run.
-
deleteAssessmentTarget(
{required String assessmentTargetArn}) → Future< void> - Deletes the assessment target that is specified by the ARN of the assessment target.
-
deleteAssessmentTemplate(
{required String assessmentTemplateArn}) → Future< void> - Deletes the assessment template that is specified by the ARN of the assessment template.
-
describeAssessmentRuns(
{required List< String> assessmentRunArns}) → Future<DescribeAssessmentRunsResponse> - Describes the assessment runs that are specified by the ARNs of the assessment runs.
-
describeAssessmentTargets(
{required List< String> assessmentTargetArns}) → Future<DescribeAssessmentTargetsResponse> - Describes the assessment targets that are specified by the ARNs of the assessment targets.
-
describeAssessmentTemplates(
{required List< String> assessmentTemplateArns}) → Future<DescribeAssessmentTemplatesResponse> - Describes the assessment templates that are specified by the ARNs of the assessment templates.
-
describeCrossAccountAccessRole(
) → Future< DescribeCrossAccountAccessRoleResponse> - Describes the IAM role that enables Amazon Inspector to access your AWS account.
-
describeExclusions(
{required List< String> exclusionArns, Locale? locale}) → Future<DescribeExclusionsResponse> - Describes the exclusions that are specified by the exclusions' ARNs.
-
describeFindings(
{required List< String> findingArns, Locale? locale}) → Future<DescribeFindingsResponse> - Describes the findings that are specified by the ARNs of the findings.
-
describeResourceGroups(
{required List< String> resourceGroupArns}) → Future<DescribeResourceGroupsResponse> - Describes the resource groups that are specified by the ARNs of the resource groups.
-
describeRulesPackages(
{required List< String> rulesPackageArns, Locale? locale}) → Future<DescribeRulesPackagesResponse> - Describes the rules packages that are specified by the ARNs of the rules packages.
-
getAssessmentReport(
{required String assessmentRunArn, required ReportFileFormat reportFileFormat, required ReportType reportType}) → Future< GetAssessmentReportResponse> - Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
-
getExclusionsPreview(
{required String assessmentTemplateArn, required String previewToken, Locale? locale, int? maxResults, String? nextToken}) → Future< GetExclusionsPreviewResponse> - Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.
-
getTelemetryMetadata(
{required String assessmentRunArn}) → Future< GetTelemetryMetadataResponse> - Information about the data that is collected for the specified assessment run.
-
listAssessmentRunAgents(
{required String assessmentRunArn, AgentFilter? filter, int? maxResults, String? nextToken}) → Future< ListAssessmentRunAgentsResponse> - Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
-
listAssessmentRuns(
{List< String> ? assessmentTemplateArns, AssessmentRunFilter? filter, int? maxResults, String? nextToken}) → Future<ListAssessmentRunsResponse> - Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
-
listAssessmentTargets(
{AssessmentTargetFilter? filter, int? maxResults, String? nextToken}) → Future< ListAssessmentTargetsResponse> - Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.
-
listAssessmentTemplates(
{List< String> ? assessmentTargetArns, AssessmentTemplateFilter? filter, int? maxResults, String? nextToken}) → Future<ListAssessmentTemplatesResponse> - Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
-
listEventSubscriptions(
{int? maxResults, String? nextToken, String? resourceArn}) → Future< ListEventSubscriptionsResponse> - Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.
-
listExclusions(
{required String assessmentRunArn, int? maxResults, String? nextToken}) → Future< ListExclusionsResponse> - List exclusions that are generated by the assessment run.
-
listFindings(
{List< String> ? assessmentRunArns, FindingFilter? filter, int? maxResults, String? nextToken}) → Future<ListFindingsResponse> - Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
-
listRulesPackages(
{int? maxResults, String? nextToken}) → Future< ListRulesPackagesResponse> - Lists all available Amazon Inspector rules packages.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Lists all tags associated with an assessment template.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
previewAgents(
{required String previewAgentsArn, int? maxResults, String? nextToken}) → Future< PreviewAgentsResponse> - Previews the agents installed on the EC2 instances that are part of the specified assessment target.
-
registerCrossAccountAccessRole(
{required String roleArn}) → Future< void> - Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
-
removeAttributesFromFindings(
{required List< String> attributeKeys, required List<String> findingArns}) → Future<RemoveAttributesFromFindingsResponse> - 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(
{required String resourceArn, List< Tag> ? tags}) → Future<void> - Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
-
startAssessmentRun(
{required String assessmentTemplateArn, String? assessmentRunName}) → Future< StartAssessmentRunResponse> - Starts 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 500 concurrent agents per AWS account.
-
stopAssessmentRun(
{required String assessmentRunArn, StopAction? stopAction}) → Future< void> - Stops the assessment run that is specified by the ARN of the assessment run.
-
subscribeToEvent(
{required InspectorEvent event, required String resourceArn, required String topicArn}) → Future< void> - Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
-
toString(
) → String -
A string representation of this object.
inherited
-
unsubscribeFromEvent(
{required InspectorEvent event, required String resourceArn, required String topicArn}) → Future< void> - Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
-
updateAssessmentTarget(
{required String assessmentTargetArn, required String assessmentTargetName, String? resourceGroupArn}) → Future< void> - Updates the assessment target that is specified by the ARN of the assessment target.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited