AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing AccessAnalyzer 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.AccessAnalyzer.AmazonAccessAnalyzerClient

Namespace: Amazon.AccessAnalyzer
Assembly: AWSSDK.AccessAnalyzer.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAccessAnalyzerClient : AmazonServiceClient
         IAmazonAccessAnalyzer, IAmazonService, IDisposable

The AmazonAccessAnalyzerClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAccessAnalyzerClient()

Constructs AmazonAccessAnalyzerClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAccessAnalyzerClient(RegionEndpoint)

Constructs AmazonAccessAnalyzerClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAccessAnalyzerClient(AmazonAccessAnalyzerConfig)

Constructs AmazonAccessAnalyzerClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAccessAnalyzerClient(AWSCredentials)

Constructs AmazonAccessAnalyzerClient with AWS Credentials

Public Method AmazonAccessAnalyzerClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAccessAnalyzerClient with AWS Credentials

Public Method AmazonAccessAnalyzerClient(AWSCredentials, AmazonAccessAnalyzerConfig)

Constructs AmazonAccessAnalyzerClient with AWS Credentials and an AmazonAccessAnalyzerClient Configuration object.

Public Method AmazonAccessAnalyzerClient(string, string)

Constructs AmazonAccessAnalyzerClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAccessAnalyzerClient(string, string, RegionEndpoint)

Constructs AmazonAccessAnalyzerClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAccessAnalyzerClient(string, string, AmazonAccessAnalyzerConfig)

Constructs AmazonAccessAnalyzerClient with AWS Access Key ID, AWS Secret Key and an AmazonAccessAnalyzerClient Configuration object.

Public Method AmazonAccessAnalyzerClient(string, string, string)

Constructs AmazonAccessAnalyzerClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAccessAnalyzerClient(string, string, string, RegionEndpoint)

Constructs AmazonAccessAnalyzerClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAccessAnalyzerClient(string, string, string, AmazonAccessAnalyzerConfig)

Constructs AmazonAccessAnalyzerClient with AWS Access Key ID, AWS Secret Key and an AmazonAccessAnalyzerClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateAnalyzer(CreateAnalyzerRequest)

Creates an analyzer for your account.

Public Method CreateAnalyzerAsync(CreateAnalyzerRequest, CancellationToken)

Creates an analyzer for your account.

Public Method CreateArchiveRule(CreateArchiveRuleRequest)

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

Public Method CreateArchiveRuleAsync(CreateArchiveRuleRequest, CancellationToken)

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

Public Method DeleteAnalyzer(DeleteAnalyzerRequest)

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.

Public Method DeleteAnalyzerAsync(DeleteAnalyzerRequest, CancellationToken)

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.

Public Method DeleteArchiveRule(DeleteArchiveRuleRequest)

Deletes the specified archive rule.

Public Method DeleteArchiveRuleAsync(DeleteArchiveRuleRequest, CancellationToken)

Deletes the specified archive rule.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetAnalyzedResource(GetAnalyzedResourceRequest)

Retrieves information about a resource that was analyzed.

Public Method GetAnalyzedResourceAsync(GetAnalyzedResourceRequest, CancellationToken)

Retrieves information about a resource that was analyzed.

Public Method GetAnalyzer(GetAnalyzerRequest)

Retrieves information about the specified analyzer.

Public Method GetAnalyzerAsync(GetAnalyzerRequest, CancellationToken)

Retrieves information about the specified analyzer.

Public Method GetArchiveRule(GetArchiveRuleRequest)

Retrieves information about an archive rule.

Public Method GetArchiveRuleAsync(GetArchiveRuleRequest, CancellationToken)

Retrieves information about an archive rule.

Public Method GetFinding(GetFindingRequest)

Retrieves information about the specified finding.

Public Method GetFindingAsync(GetFindingRequest, CancellationToken)

Retrieves information about the specified finding.

Public Method ListAnalyzedResources(ListAnalyzedResourcesRequest)

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

Public Method ListAnalyzedResourcesAsync(ListAnalyzedResourcesRequest, CancellationToken)

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

Public Method ListAnalyzers(ListAnalyzersRequest)

Retrieves a list of analyzers.

Public Method ListAnalyzersAsync(ListAnalyzersRequest, CancellationToken)

Retrieves a list of analyzers.

Public Method ListArchiveRules(ListArchiveRulesRequest)

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

Public Method ListArchiveRulesAsync(ListArchiveRulesRequest, CancellationToken)

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

Public Method ListFindings(ListFindingsRequest)

Retrieves a list of findings generated by the specified analyzer.

Public Method ListFindingsAsync(ListFindingsRequest, CancellationToken)

Retrieves a list of findings generated by the specified analyzer.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Retrieves a list of tags applied to the specified resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Retrieves a list of tags applied to the specified resource.

Public Method StartResourceScan(StartResourceScanRequest)

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

Public Method StartResourceScanAsync(StartResourceScanRequest, CancellationToken)

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

Public Method TagResource(TagResourceRequest)

Adds a tag to the specified resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds a tag to the specified resource.

Public Method UntagResource(UntagResourceRequest)

Removes a tag from the specified resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes a tag from the specified resource.

Public Method UpdateArchiveRule(UpdateArchiveRuleRequest)

Updates the criteria and values for the specified archive rule.

Public Method UpdateArchiveRuleAsync(UpdateArchiveRuleRequest, CancellationToken)

Updates the criteria and values for the specified archive rule.

Public Method UpdateFindings(UpdateFindingsRequest)

Updates the status for the specified findings.

Public Method UpdateFindingsAsync(UpdateFindingsRequest, CancellationToken)

Updates the status for the specified findings.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms