inspector/aws.sdk.kotlin.services.inspector

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

addAttributesToFindings

inline suspend fun InspectorClient.addAttributesToFindings(crossinline block: AddAttributesToFindingsRequest.Builder.() -> Unit): AddAttributesToFindingsResponse

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.

createAssessmentTarget

inline suspend fun InspectorClient.createAssessmentTarget(crossinline block: CreateAssessmentTargetRequest.Builder.() -> Unit): 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

inline suspend fun InspectorClient.createAssessmentTemplate(crossinline block: CreateAssessmentTemplateRequest.Builder.() -> Unit): 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

inline suspend fun InspectorClient.createExclusionsPreview(crossinline block: CreateExclusionsPreviewRequest.Builder.() -> Unit): 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

inline suspend fun InspectorClient.createResourceGroup(crossinline block: CreateResourceGroupRequest.Builder.() -> Unit): 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

inline suspend fun InspectorClient.deleteAssessmentRun(crossinline block: DeleteAssessmentRunRequest.Builder.() -> Unit): DeleteAssessmentRunResponse

Deletes the assessment run that is specified by the ARN of the assessment run.

deleteAssessmentTarget

inline suspend fun InspectorClient.deleteAssessmentTarget(crossinline block: DeleteAssessmentTargetRequest.Builder.() -> Unit): DeleteAssessmentTargetResponse

Deletes the assessment target that is specified by the ARN of the assessment target.

deleteAssessmentTemplate

inline suspend fun InspectorClient.deleteAssessmentTemplate(crossinline block: DeleteAssessmentTemplateRequest.Builder.() -> Unit): DeleteAssessmentTemplateResponse

Deletes the assessment template that is specified by the ARN of the assessment template.

describeAssessmentRuns

inline suspend fun InspectorClient.describeAssessmentRuns(crossinline block: DescribeAssessmentRunsRequest.Builder.() -> Unit): DescribeAssessmentRunsResponse

Describes the assessment runs that are specified by the ARNs of the assessment runs.

describeAssessmentTargets

inline suspend fun InspectorClient.describeAssessmentTargets(crossinline block: DescribeAssessmentTargetsRequest.Builder.() -> Unit): DescribeAssessmentTargetsResponse

Describes the assessment targets that are specified by the ARNs of the assessment targets.

describeAssessmentTemplates

inline suspend fun InspectorClient.describeAssessmentTemplates(crossinline block: DescribeAssessmentTemplatesRequest.Builder.() -> Unit): DescribeAssessmentTemplatesResponse

Describes the assessment templates that are specified by the ARNs of the assessment templates.

describeCrossAccountAccessRole

inline suspend fun InspectorClient.describeCrossAccountAccessRole(crossinline block: DescribeCrossAccountAccessRoleRequest.Builder.() -> Unit): DescribeCrossAccountAccessRoleResponse

Describes the IAM role that enables Amazon Inspector to access your AWS account.

describeExclusions

inline suspend fun InspectorClient.describeExclusions(crossinline block: DescribeExclusionsRequest.Builder.() -> Unit): DescribeExclusionsResponse

Describes the exclusions that are specified by the exclusions' ARNs.

describeFindings

inline suspend fun InspectorClient.describeFindings(crossinline block: DescribeFindingsRequest.Builder.() -> Unit): DescribeFindingsResponse

Describes the findings that are specified by the ARNs of the findings.

describeResourceGroups

inline suspend fun InspectorClient.describeResourceGroups(crossinline block: DescribeResourceGroupsRequest.Builder.() -> Unit): DescribeResourceGroupsResponse

Describes the resource groups that are specified by the ARNs of the resource groups.

describeRulesPackages

inline suspend fun InspectorClient.describeRulesPackages(crossinline block: DescribeRulesPackagesRequest.Builder.() -> Unit): DescribeRulesPackagesResponse

Describes the rules packages that are specified by the ARNs of the rules packages.

getAssessmentReport

inline suspend fun InspectorClient.getAssessmentReport(crossinline block: GetAssessmentReportRequest.Builder.() -> Unit): GetAssessmentReportResponse

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

getExclusionsPreview

inline suspend fun InspectorClient.getExclusionsPreview(crossinline block: GetExclusionsPreviewRequest.Builder.() -> Unit): 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

inline suspend fun InspectorClient.getTelemetryMetadata(crossinline block: GetTelemetryMetadataRequest.Builder.() -> Unit): GetTelemetryMetadataResponse

Information about the data that is collected for the specified assessment run.

listAssessmentRunAgents

inline suspend fun InspectorClient.listAssessmentRunAgents(crossinline block: ListAssessmentRunAgentsRequest.Builder.() -> Unit): ListAssessmentRunAgentsResponse

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

listAssessmentRuns

inline suspend fun InspectorClient.listAssessmentRuns(crossinline block: ListAssessmentRunsRequest.Builder.() -> Unit): ListAssessmentRunsResponse

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.

listAssessmentTargets

inline suspend fun InspectorClient.listAssessmentTargets(crossinline block: ListAssessmentTargetsRequest.Builder.() -> Unit): ListAssessmentTargetsResponse

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

listAssessmentTemplates

inline suspend fun InspectorClient.listAssessmentTemplates(crossinline block: ListAssessmentTemplatesRequest.Builder.() -> Unit): ListAssessmentTemplatesResponse

Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.

listEventSubscriptions

inline suspend fun InspectorClient.listEventSubscriptions(crossinline block: ListEventSubscriptionsRequest.Builder.() -> Unit): 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

inline suspend fun InspectorClient.listExclusions(crossinline block: ListExclusionsRequest.Builder.() -> Unit): ListExclusionsResponse

List exclusions that are generated by the assessment run.

listFindings

inline suspend fun InspectorClient.listFindings(crossinline block: ListFindingsRequest.Builder.() -> Unit): ListFindingsResponse

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

listRulesPackages

inline suspend fun InspectorClient.listRulesPackages(crossinline block: ListRulesPackagesRequest.Builder.() -> Unit): ListRulesPackagesResponse

Lists all available Amazon Inspector rules packages.

listTagsForResource

inline suspend fun InspectorClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags associated with an assessment template.

previewAgents

inline suspend fun InspectorClient.previewAgents(crossinline block: PreviewAgentsRequest.Builder.() -> Unit): PreviewAgentsResponse

Previews the agents installed on the EC2 instances that are part of the specified assessment target.

registerCrossAccountAccessRole

inline suspend fun InspectorClient.registerCrossAccountAccessRole(crossinline block: RegisterCrossAccountAccessRoleRequest.Builder.() -> Unit): RegisterCrossAccountAccessRoleResponse

Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.

removeAttributesFromFindings

inline suspend fun InspectorClient.removeAttributesFromFindings(crossinline block: RemoveAttributesFromFindingsRequest.Builder.() -> Unit): 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

inline suspend fun InspectorClient.setTagsForResource(crossinline block: SetTagsForResourceRequest.Builder.() -> Unit): SetTagsForResourceResponse

Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.

startAssessmentRun

inline suspend fun InspectorClient.startAssessmentRun(crossinline block: StartAssessmentRunRequest.Builder.() -> Unit): 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

inline suspend fun InspectorClient.stopAssessmentRun(crossinline block: StopAssessmentRunRequest.Builder.() -> Unit): StopAssessmentRunResponse

Stops the assessment run that is specified by the ARN of the assessment run.

subscribeToEvent

inline suspend fun InspectorClient.subscribeToEvent(crossinline block: SubscribeToEventRequest.Builder.() -> Unit): SubscribeToEventResponse

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

unsubscribeFromEvent

inline suspend fun InspectorClient.unsubscribeFromEvent(crossinline block: UnsubscribeFromEventRequest.Builder.() -> Unit): UnsubscribeFromEventResponse

Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

updateAssessmentTarget

inline suspend fun InspectorClient.updateAssessmentTarget(crossinline block: UpdateAssessmentTargetRequest.Builder.() -> Unit): UpdateAssessmentTargetResponse

Updates the assessment target that is specified by the ARN of the assessment target.

withConfig

fun InspectorClient.withConfig(block: InspectorClient.Config.Builder.() -> Unit): InspectorClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.