AccessAnalyzer

public struct AccessAnalyzer

Client object for interacting with AWS AccessAnalyzer service.

AWS IAM 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 AWS environment. An external principal can be another AWS account, a root user, an IAM user or role, a federated user, an AWS service, or an anonymous user. This guide describes the AWS IAM Access Analyzer operations that you can call programmatically. For general information about Access Analyzer, see the AWS IAM Access Analyzer section of the IAM User Guide. To start using Access Analyzer, you first need to create an analyzer.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the AccessAnalyzer client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    createAnalyzer(_:)

Creates an analyzer for your account.

Declaration

Swift

public func createAnalyzer(_ input: CreateAnalyzerRequest) -> EventLoopFuture<CreateAnalyzerResponse>

createArchiveRule(_:)
Creates an archive rule for the specified analyzer. Archive rules automatically archive findings that meet the criteria you define when you create the rule.
Declaration
Swift

@discardableResult public func createArchiveRule(_ input: CreateArchiveRuleRequest) -> EventLoopFuture<Void>
deleteAnalyzer(_:)
Deletes the specified analyzer. When you delete an analyzer, Access Analyzer is disabled for the account in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.
Declaration
Swift

@discardableResult public func deleteAnalyzer(_ input: DeleteAnalyzerRequest) -> EventLoopFuture<Void>


                    
                    
                    deleteArchiveRule(_:)

Deletes the specified archive rule.

Declaration

Swift

@discardableResult
public func deleteArchiveRule(_ input: DeleteArchiveRuleRequest) -> EventLoopFuture<Void>


                    
                    
                    getAnalyzedResource(_:)

Retrieves information about a resource that was analyzed.

Declaration

Swift

public func getAnalyzedResource(_ input: GetAnalyzedResourceRequest) -> EventLoopFuture<GetAnalyzedResourceResponse>


                    
                    
                    getAnalyzer(_:)

Retrieves information about the specified analyzer.

Declaration

Swift

public func getAnalyzer(_ input: GetAnalyzerRequest) -> EventLoopFuture<GetAnalyzerResponse>


                    
                    
                    getArchiveRule(_:)

Retrieves information about an archive rule.

Declaration

Swift

public func getArchiveRule(_ input: GetArchiveRuleRequest) -> EventLoopFuture<GetArchiveRuleResponse>


                    
                    
                    getFinding(_:)

Retrieves information about the specified finding.

Declaration

Swift

public func getFinding(_ input: GetFindingRequest) -> EventLoopFuture<GetFindingResponse>

listAnalyzedResources(_:)
Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..
Declaration
Swift

public func listAnalyzedResources(_ input: ListAnalyzedResourcesRequest) -> EventLoopFuture<ListAnalyzedResourcesResponse>


                    
                    
                    listAnalyzers(_:)

Retrieves a list of analyzers.

Declaration

Swift

public func listAnalyzers(_ input: ListAnalyzersRequest) -> EventLoopFuture<ListAnalyzersResponse>


                    
                    
                    listArchiveRules(_:)

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

Declaration

Swift

public func listArchiveRules(_ input: ListArchiveRulesRequest) -> EventLoopFuture<ListArchiveRulesResponse>


                    
                    
                    listFindings(_:)

Retrieves a list of findings generated by the specified analyzer.

Declaration

Swift

public func listFindings(_ input: ListFindingsRequest) -> EventLoopFuture<ListFindingsResponse>


                    
                    
                    listTagsForResource(_:)

Retrieves a list of tags applied to the specified resource.

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>


                    
                    
                    startResourceScan(_:)

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

Declaration

Swift

@discardableResult
public func startResourceScan(_ input: StartResourceScanRequest) -> EventLoopFuture<Void>


                    
                    
                    tagResource(_:)

Adds a tag to the specified resource.

Declaration

Swift

public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>


                    
                    
                    untagResource(_:)

Removes a tag from the specified resource.

Declaration

Swift

public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>


                    
                    
                    updateArchiveRule(_:)

Updates the criteria and values for the specified archive rule.

Declaration

Swift

@discardableResult
public func updateArchiveRule(_ input: UpdateArchiveRuleRequest) -> EventLoopFuture<Void>


                    
                    
                    updateFindings(_:)

Updates the status for the specified findings.

Declaration

Swift

@discardableResult
public func updateFindings(_ input: UpdateFindingsRequest) -> EventLoopFuture<Void>

Paginators


                    
                    
                    listAnalyzedResourcesPaginator(_:onPage:)

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

Declaration

Swift

public func listAnalyzedResourcesPaginator(_ input: ListAnalyzedResourcesRequest, onPage: @escaping (ListAnalyzedResourcesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listAnalyzersPaginator(_:onPage:)

Retrieves a list of analyzers.

Declaration

Swift

public func listAnalyzersPaginator(_ input: ListAnalyzersRequest, onPage: @escaping (ListAnalyzersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listArchiveRulesPaginator(_:onPage:)

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

Declaration

Swift

public func listArchiveRulesPaginator(_ input: ListArchiveRulesRequest, onPage: @escaping (ListArchiveRulesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listFindingsPaginator(_:onPage:)

Retrieves a list of findings generated by the specified analyzer.

Declaration

Swift

public func listFindingsPaginator(_ input: ListFindingsRequest, onPage: @escaping (ListFindingsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListAnalyzedResourcesRequest

Undocumented

Declaration

Swift

public struct ListAnalyzedResourcesRequest : AWSShape

extension AccessAnalyzer.ListAnalyzedResourcesRequest: AWSPaginateStringToken


                    
                    
                    ListAnalyzersRequest

Undocumented

Declaration

Swift

public struct ListAnalyzersRequest : AWSShape

extension AccessAnalyzer.ListAnalyzersRequest: AWSPaginateStringToken


                    
                    
                    ListArchiveRulesRequest

Undocumented

Declaration

Swift

public struct ListArchiveRulesRequest : AWSShape

extension AccessAnalyzer.ListArchiveRulesRequest: AWSPaginateStringToken


                    
                    
                    ListFindingsRequest

Undocumented

Declaration

Swift

public struct ListFindingsRequest : AWSShape

extension AccessAnalyzer.ListFindingsRequest: AWSPaginateStringToken

AnalyzedResource
Undocumented
See more
Declaration
Swift

public struct AnalyzedResource : AWSShape
AnalyzedResourceSummary
Undocumented
See more
Declaration
Swift

public struct AnalyzedResourceSummary : AWSShape
AnalyzerSummary
Undocumented
See more
Declaration
Swift

public struct AnalyzerSummary : AWSShape
ArchiveRuleSummary
Undocumented
See more
Declaration
Swift

public struct ArchiveRuleSummary : AWSShape
CreateAnalyzerRequest
Undocumented
See more
Declaration
Swift

public struct CreateAnalyzerRequest : AWSShape
CreateAnalyzerResponse
Undocumented
See more
Declaration
Swift

public struct CreateAnalyzerResponse : AWSShape
CreateArchiveRuleRequest
Undocumented
See more
Declaration
Swift

public struct CreateArchiveRuleRequest : AWSShape
Criterion
Undocumented
See more
Declaration
Swift

public struct Criterion : AWSShape
DeleteAnalyzerRequest
Undocumented
See more
Declaration
Swift

public struct DeleteAnalyzerRequest : AWSShape
DeleteArchiveRuleRequest
Undocumented
See more
Declaration
Swift

public struct DeleteArchiveRuleRequest : AWSShape
Finding
Undocumented
See more
Declaration
Swift

public struct Finding : AWSShape
FindingSource
Undocumented
See more
Declaration
Swift

public struct FindingSource : AWSShape
FindingSourceDetail
Undocumented
See more
Declaration
Swift

public struct FindingSourceDetail : AWSShape
FindingSummary
Undocumented
See more
Declaration
Swift

public struct FindingSummary : AWSShape
GetAnalyzedResourceRequest
Undocumented
See more
Declaration
Swift

public struct GetAnalyzedResourceRequest : AWSShape
GetAnalyzedResourceResponse
Undocumented
See more
Declaration
Swift

public struct GetAnalyzedResourceResponse : AWSShape
GetAnalyzerRequest
Undocumented
See more
Declaration
Swift

public struct GetAnalyzerRequest : AWSShape
GetAnalyzerResponse
Undocumented
See more
Declaration
Swift

public struct GetAnalyzerResponse : AWSShape
GetArchiveRuleRequest
Undocumented
See more
Declaration
Swift

public struct GetArchiveRuleRequest : AWSShape
GetArchiveRuleResponse
Undocumented
See more
Declaration
Swift

public struct GetArchiveRuleResponse : AWSShape
GetFindingRequest
Undocumented
See more
Declaration
Swift

public struct GetFindingRequest : AWSShape
GetFindingResponse
Undocumented
See more
Declaration
Swift

public struct GetFindingResponse : AWSShape
InlineArchiveRule
Undocumented
See more
Declaration
Swift

public struct InlineArchiveRule : AWSShape
ListAnalyzedResourcesResponse
Undocumented
See more
Declaration
Swift

public struct ListAnalyzedResourcesResponse : AWSShape
ListAnalyzersResponse
Undocumented
See more
Declaration
Swift

public struct ListAnalyzersResponse : AWSShape
ListArchiveRulesResponse
Undocumented
See more
Declaration
Swift

public struct ListArchiveRulesResponse : AWSShape
ListFindingsResponse
Undocumented
See more
Declaration
Swift

public struct ListFindingsResponse : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
SortCriteria
Undocumented
See more
Declaration
Swift

public struct SortCriteria : AWSShape
StartResourceScanRequest
Undocumented
See more
Declaration
Swift

public struct StartResourceScanRequest : AWSShape
StatusReason
Undocumented
See more
Declaration
Swift

public struct StatusReason : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
TagResourceResponse
Undocumented
See more
Declaration
Swift

public struct TagResourceResponse : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UntagResourceResponse
Undocumented
See more
Declaration
Swift

public struct UntagResourceResponse : AWSShape
UpdateArchiveRuleRequest
Undocumented
See more
Declaration
Swift

public struct UpdateArchiveRuleRequest : AWSShape
UpdateFindingsRequest
Undocumented
See more
Declaration
Swift

public struct UpdateFindingsRequest : AWSShape

Enums


                    
                    
                    AnalyzerStatus

Undocumented

Declaration

Swift

public enum AnalyzerStatus : String, CustomStringConvertible, Codable


                    
                    
                    FindingSourceType

Undocumented

Declaration

Swift

public enum FindingSourceType : String, CustomStringConvertible, Codable


                    
                    
                    FindingStatus

Undocumented

Declaration

Swift

public enum FindingStatus : String, CustomStringConvertible, Codable


                    
                    
                    FindingStatusUpdate

Undocumented

Declaration

Swift

public enum FindingStatusUpdate : String, CustomStringConvertible, Codable


                    
                    
                    OrderBy

Undocumented

Declaration

Swift

public enum OrderBy : String, CustomStringConvertible, Codable


                    
                    
                    ReasonCode

Undocumented

Declaration

Swift

public enum ReasonCode : String, CustomStringConvertible, Codable


                    
                    
                    ResourceType

Undocumented

Declaration

Swift

public enum ResourceType : String, CustomStringConvertible, Codable


                    
                    
                    Type

Undocumented

Declaration

Swift

public enum `Type` : String, CustomStringConvertible, Codable