accessanalyzer/aws.sdk.kotlin.services.accessanalyzer

Package-level declarations

Types

Link copied to clipboard
interface AccessAnalyzerClient : SdkClient

Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.applyArchiveRule(crossinline block: ApplyArchiveRuleRequest.Builder.() -> Unit): ApplyArchiveRuleResponse

Retroactively applies the archive rule to existing findings that meet the archive rule criteria.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.cancelPolicyGeneration(crossinline block: CancelPolicyGenerationRequest.Builder.() -> Unit): CancelPolicyGenerationResponse

Cancels the requested policy generation.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.checkAccessNotGranted(crossinline block: CheckAccessNotGrantedRequest.Builder.() -> Unit): CheckAccessNotGrantedResponse

Checks whether the specified access isn't allowed by a policy.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.checkNoNewAccess(crossinline block: CheckNoNewAccessRequest.Builder.() -> Unit): CheckNoNewAccessResponse

Checks whether new access is allowed for an updated policy when compared to the existing policy.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.checkNoPublicAccess(crossinline block: CheckNoPublicAccessRequest.Builder.() -> Unit): CheckNoPublicAccessResponse

Checks whether a resource policy can grant public access to the specified resource type.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.createAccessPreview(crossinline block: CreateAccessPreviewRequest.Builder.() -> Unit): CreateAccessPreviewResponse

Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.createAnalyzer(crossinline block: CreateAnalyzerRequest.Builder.() -> Unit): CreateAnalyzerResponse

Creates an analyzer for your account.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.createArchiveRule(crossinline block: CreateArchiveRuleRequest.Builder.() -> Unit): CreateArchiveRuleResponse

Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.deleteAnalyzer(crossinline block: DeleteAnalyzerRequest.Builder.() -> Unit): DeleteAnalyzerResponse

Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.deleteArchiveRule(crossinline block: DeleteArchiveRuleRequest.Builder.() -> Unit): DeleteArchiveRuleResponse

Deletes the specified archive rule.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.generateFindingRecommendation(crossinline block: GenerateFindingRecommendationRequest.Builder.() -> Unit): GenerateFindingRecommendationResponse

Creates a recommendation for an unused permissions finding.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.getAccessPreview(crossinline block: GetAccessPreviewRequest.Builder.() -> Unit): GetAccessPreviewResponse

Retrieves information about an access preview for the specified analyzer.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.getAnalyzedResource(crossinline block: GetAnalyzedResourceRequest.Builder.() -> Unit): GetAnalyzedResourceResponse

Retrieves information about a resource that was analyzed.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.getAnalyzer(crossinline block: GetAnalyzerRequest.Builder.() -> Unit): GetAnalyzerResponse

Retrieves information about the specified analyzer.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.getArchiveRule(crossinline block: GetArchiveRuleRequest.Builder.() -> Unit): GetArchiveRuleResponse

Retrieves information about an archive rule.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.getFinding(crossinline block: GetFindingRequest.Builder.() -> Unit): GetFindingResponse

Retrieves information about the specified finding. GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.getFindingRecommendation(crossinline block: GetFindingRecommendationRequest.Builder.() -> Unit): GetFindingRecommendationResponse

Retrieves information about a finding recommendation for the specified analyzer.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.getFindingsStatistics(crossinline block: GetFindingsStatisticsRequest.Builder.() -> Unit): GetFindingsStatisticsResponse

Retrieves a list of aggregated finding statistics for an external access or unused access analyzer.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.getFindingV2(crossinline block: GetFindingV2Request.Builder.() -> Unit): GetFindingV2Response

Retrieves information about the specified finding. GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.getGeneratedPolicy(crossinline block: GetGeneratedPolicyRequest.Builder.() -> Unit): GetGeneratedPolicyResponse

Retrieves the policy that was generated using StartPolicyGeneration.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.listAccessPreviewFindings(crossinline block: ListAccessPreviewFindingsRequest.Builder.() -> Unit): ListAccessPreviewFindingsResponse

Retrieves a list of access preview findings generated by the specified access preview.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.listAccessPreviews(crossinline block: ListAccessPreviewsRequest.Builder.() -> Unit): ListAccessPreviewsResponse

Retrieves a list of access previews for the specified analyzer.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.listAnalyzedResources(crossinline block: ListAnalyzedResourcesRequest.Builder.() -> Unit): ListAnalyzedResourcesResponse

Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.listAnalyzers(crossinline block: ListAnalyzersRequest.Builder.() -> Unit): ListAnalyzersResponse

Retrieves a list of analyzers.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.listArchiveRules(crossinline block: ListArchiveRulesRequest.Builder.() -> Unit): ListArchiveRulesResponse

Retrieves a list of archive rules created for the specified analyzer.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.listFindings(crossinline block: ListFindingsRequest.Builder.() -> Unit): ListFindingsResponse

Retrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.listFindingsV2(crossinline block: ListFindingsV2Request.Builder.() -> Unit): ListFindingsV2Response

Retrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.listPolicyGenerations(crossinline block: ListPolicyGenerationsRequest.Builder.() -> Unit): ListPolicyGenerationsResponse

Lists all of the policy generations requested in the last seven days.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Retrieves a list of tags applied to the specified resource.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.startPolicyGeneration(crossinline block: StartPolicyGenerationRequest.Builder.() -> Unit): StartPolicyGenerationResponse

Starts the policy generation request.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.startResourceScan(crossinline block: StartResourceScanRequest.Builder.() -> Unit): StartResourceScanResponse

Immediately starts a scan of the policies applied to the specified resource.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds a tag to the specified resource.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a tag from the specified resource.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.updateAnalyzer(crossinline block: UpdateAnalyzerRequest.Builder.() -> Unit): UpdateAnalyzerResponse

Modifies the configuration of an existing analyzer.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.updateArchiveRule(crossinline block: UpdateArchiveRuleRequest.Builder.() -> Unit): UpdateArchiveRuleResponse

Updates the criteria and values for the specified archive rule.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.updateFindings(crossinline block: UpdateFindingsRequest.Builder.() -> Unit): UpdateFindingsResponse

Updates the status for the specified findings.

Link copied to clipboard
inline suspend fun AccessAnalyzerClient.validatePolicy(crossinline block: ValidatePolicyRequest.Builder.() -> Unit): ValidatePolicyResponse

Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.

Link copied to clipboard
fun AccessAnalyzerClient.withConfig(block: AccessAnalyzerClient.Config.Builder.() -> Unit): AccessAnalyzerClient

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.