AccessAnalyzerClientProtocol
Identity and Access Management Access Analyzer helps identify potential resource-access risks by enabling you to identify any policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview and validate public and cross-account access to your resources before deploying permissions changes. This guide describes the Identity and Access Management Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see Identity and Access Management Access Analyzer in the IAM User Guide. To start using IAM Access Analyzer, you first need to create an analyzer.
public protocol AccessAnalyzerClientProtocol
Requirements
applyArchiveRule(input:completion:)
Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
func applyArchiveRule(input: ApplyArchiveRuleInput, completion: @escaping (ClientRuntime.SdkResult<ApplyArchiveRuleOutputResponse, ApplyArchiveRuleOutputError>) -> Void)
cancelPolicyGeneration(input:completion:)
Cancels the requested policy generation.
func cancelPolicyGeneration(input: CancelPolicyGenerationInput, completion: @escaping (ClientRuntime.SdkResult<CancelPolicyGenerationOutputResponse, CancelPolicyGenerationOutputError>) -> Void)
createAccessPreview(input:completion:)
Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
func createAccessPreview(input: CreateAccessPreviewInput, completion: @escaping (ClientRuntime.SdkResult<CreateAccessPreviewOutputResponse, CreateAccessPreviewOutputError>) -> Void)
createAnalyzer(input:completion:)
Creates an analyzer for your account.
func createAnalyzer(input: CreateAnalyzerInput, completion: @escaping (ClientRuntime.SdkResult<CreateAnalyzerOutputResponse, CreateAnalyzerOutputError>) -> Void)
createArchiveRule(input:completion:)
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. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
func createArchiveRule(input: CreateArchiveRuleInput, completion: @escaping (ClientRuntime.SdkResult<CreateArchiveRuleOutputResponse, CreateArchiveRuleOutputError>) -> Void)
deleteAnalyzer(input:completion:)
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.
func deleteAnalyzer(input: DeleteAnalyzerInput, completion: @escaping (ClientRuntime.SdkResult<DeleteAnalyzerOutputResponse, DeleteAnalyzerOutputError>) -> Void)
deleteArchiveRule(input:completion:)
Deletes the specified archive rule.
func deleteArchiveRule(input: DeleteArchiveRuleInput, completion: @escaping (ClientRuntime.SdkResult<DeleteArchiveRuleOutputResponse, DeleteArchiveRuleOutputError>) -> Void)
getAccessPreview(input:completion:)
Retrieves information about an access preview for the specified analyzer.
func getAccessPreview(input: GetAccessPreviewInput, completion: @escaping (ClientRuntime.SdkResult<GetAccessPreviewOutputResponse, GetAccessPreviewOutputError>) -> Void)
getAnalyzedResource(input:completion:)
Retrieves information about a resource that was analyzed.
func getAnalyzedResource(input: GetAnalyzedResourceInput, completion: @escaping (ClientRuntime.SdkResult<GetAnalyzedResourceOutputResponse, GetAnalyzedResourceOutputError>) -> Void)
getAnalyzer(input:completion:)
Retrieves information about the specified analyzer.
func getAnalyzer(input: GetAnalyzerInput, completion: @escaping (ClientRuntime.SdkResult<GetAnalyzerOutputResponse, GetAnalyzerOutputError>) -> Void)
getArchiveRule(input:completion:)
Retrieves information about an archive rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
func getArchiveRule(input: GetArchiveRuleInput, completion: @escaping (ClientRuntime.SdkResult<GetArchiveRuleOutputResponse, GetArchiveRuleOutputError>) -> Void)
getFinding(input:completion:)
Retrieves information about the specified finding.
func getFinding(input: GetFindingInput, completion: @escaping (ClientRuntime.SdkResult<GetFindingOutputResponse, GetFindingOutputError>) -> Void)
getGeneratedPolicy(input:completion:)
Retrieves the policy that was generated using StartPolicyGeneration.
func getGeneratedPolicy(input: GetGeneratedPolicyInput, completion: @escaping (ClientRuntime.SdkResult<GetGeneratedPolicyOutputResponse, GetGeneratedPolicyOutputError>) -> Void)
listAccessPreviewFindings(input:completion:)
Retrieves a list of access preview findings generated by the specified access preview.
func listAccessPreviewFindings(input: ListAccessPreviewFindingsInput, completion: @escaping (ClientRuntime.SdkResult<ListAccessPreviewFindingsOutputResponse, ListAccessPreviewFindingsOutputError>) -> Void)
listAccessPreviews(input:completion:)
Retrieves a list of access previews for the specified analyzer.
func listAccessPreviews(input: ListAccessPreviewsInput, completion: @escaping (ClientRuntime.SdkResult<ListAccessPreviewsOutputResponse, ListAccessPreviewsOutputError>) -> Void)
listAnalyzedResources(input:completion:)
Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
func listAnalyzedResources(input: ListAnalyzedResourcesInput, completion: @escaping (ClientRuntime.SdkResult<ListAnalyzedResourcesOutputResponse, ListAnalyzedResourcesOutputError>) -> Void)
listAnalyzers(input:completion:)
Retrieves a list of analyzers.
func listAnalyzers(input: ListAnalyzersInput, completion: @escaping (ClientRuntime.SdkResult<ListAnalyzersOutputResponse, ListAnalyzersOutputError>) -> Void)
listArchiveRules(input:completion:)
Retrieves a list of archive rules created for the specified analyzer.
func listArchiveRules(input: ListArchiveRulesInput, completion: @escaping (ClientRuntime.SdkResult<ListArchiveRulesOutputResponse, ListArchiveRulesOutputError>) -> Void)
listFindings(input:completion:)
Retrieves a list of findings generated by the specified analyzer. To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
func listFindings(input: ListFindingsInput, completion: @escaping (ClientRuntime.SdkResult<ListFindingsOutputResponse, ListFindingsOutputError>) -> Void)
listPolicyGenerations(input:completion:)
Lists all of the policy generations requested in the last seven days.
func listPolicyGenerations(input: ListPolicyGenerationsInput, completion: @escaping (ClientRuntime.SdkResult<ListPolicyGenerationsOutputResponse, ListPolicyGenerationsOutputError>) -> Void)
listTagsForResource(input:completion:)
Retrieves a list of tags applied to the specified resource.
func listTagsForResource(input: ListTagsForResourceInput, completion: @escaping (ClientRuntime.SdkResult<ListTagsForResourceOutputResponse, ListTagsForResourceOutputError>) -> Void)
startPolicyGeneration(input:completion:)
Starts the policy generation request.
func startPolicyGeneration(input: StartPolicyGenerationInput, completion: @escaping (ClientRuntime.SdkResult<StartPolicyGenerationOutputResponse, StartPolicyGenerationOutputError>) -> Void)
startResourceScan(input:completion:)
Immediately starts a scan of the policies applied to the specified resource.
func startResourceScan(input: StartResourceScanInput, completion: @escaping (ClientRuntime.SdkResult<StartResourceScanOutputResponse, StartResourceScanOutputError>) -> Void)
tagResource(input:completion:)
Adds a tag to the specified resource.
func tagResource(input: TagResourceInput, completion: @escaping (ClientRuntime.SdkResult<TagResourceOutputResponse, TagResourceOutputError>) -> Void)
untagResource(input:completion:)
Removes a tag from the specified resource.
func untagResource(input: UntagResourceInput, completion: @escaping (ClientRuntime.SdkResult<UntagResourceOutputResponse, UntagResourceOutputError>) -> Void)
updateArchiveRule(input:completion:)
Updates the criteria and values for the specified archive rule.
func updateArchiveRule(input: UpdateArchiveRuleInput, completion: @escaping (ClientRuntime.SdkResult<UpdateArchiveRuleOutputResponse, UpdateArchiveRuleOutputError>) -> Void)
updateFindings(input:completion:)
Updates the status for the specified findings.
func updateFindings(input: UpdateFindingsInput, completion: @escaping (ClientRuntime.SdkResult<UpdateFindingsOutputResponse, UpdateFindingsOutputError>) -> Void)
validatePolicy(input:completion:)
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.
func validatePolicy(input: ValidatePolicyInput, completion: @escaping (ClientRuntime.SdkResult<ValidatePolicyOutputResponse, ValidatePolicyOutputError>) -> Void)