Package-level declarations

Types

Link copied to clipboard
class Access

Contains information about actions and resources that define permissions to check against a policy.

Link copied to clipboard

Base class for all service related exceptions thrown by the AccessAnalyzer client

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

You do not have sufficient access to perform this action.

Link copied to clipboard

Contains information about an access preview.

Link copied to clipboard

An access preview finding generated by the access preview.

Link copied to clipboard
sealed class AccessPreviewStatus
Link copied to clipboard

Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid proposed resource configuration.

Link copied to clipboard
Link copied to clipboard

Contains a summary of information about an access preview.

Link copied to clipboard
sealed class AclGrantee

You specify each grantee as a type-value pair using one of these types. You can specify only one type of grantee. For more information, see PutBucketAcl.

Link copied to clipboard
sealed class AclPermission
Link copied to clipboard

Contains information about analysis rules for the analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule.

Link copied to clipboard

The criteria for an analysis rule for an analyzer. The criteria determine which entities will generate findings.

Link copied to clipboard

Contains details about the analyzed resource.

Link copied to clipboard

Contains the ARN of the analyzed resource.

Link copied to clipboard

Contains information about the configuration of an analyzer for an Amazon Web Services organization or account.

Link copied to clipboard
sealed class AnalyzerStatus
Link copied to clipboard

Contains information about the analyzer.

Link copied to clipboard

Retroactively applies an archive rule.

Link copied to clipboard
Link copied to clipboard

Contains information about an archive rule. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains information about CloudTrail access.

Link copied to clipboard

Contains information about CloudTrail access.

Link copied to clipboard
sealed class Configuration

Access control configuration structures for your resource. You specify the configuration as a type-value pair. You can specify only one type of access control configuration.

Link copied to clipboard

A conflict exception error.

Link copied to clipboard

Creates an analyzer.

Link copied to clipboard

The response to the request to create an analyzer.

Link copied to clipboard

Creates an archive rule.

Link copied to clipboard
Link copied to clipboard
class Criterion

The criteria to use in the filter that defines the archive rule. For more information on available filter keys, see IAM Access Analyzer filter keys.

Link copied to clipboard

Deletes an analyzer.

Link copied to clipboard
Link copied to clipboard

Deletes an archive rule.

Link copied to clipboard
Link copied to clipboard

The proposed access control configuration for a DynamoDB stream. You can propose a configuration for a new DynamoDB stream or an existing DynamoDB stream that you own by specifying the policy for the DynamoDB stream. For more information, see PutResourcePolicy.

Link copied to clipboard

The proposed access control configuration for a DynamoDB table or index. You can propose a configuration for a new DynamoDB table or index or an existing DynamoDB table or index that you own by specifying the policy for the DynamoDB table or index. For more information, see PutResourcePolicy.

Link copied to clipboard

The proposed access control configuration for an Amazon EBS volume snapshot. You can propose a configuration for a new Amazon EBS volume snapshot or an Amazon EBS volume snapshot that you own by specifying the user IDs, groups, and optional KMS encryption key. For more information, see ModifySnapshotAttribute.

Link copied to clipboard

The proposed access control configuration for an Amazon ECR repository. You can propose a configuration for a new Amazon ECR repository or an existing Amazon ECR repository that you own by specifying the Amazon ECR policy. For more information, see Repository.

Link copied to clipboard

The proposed access control configuration for an Amazon EFS file system. You can propose a configuration for a new Amazon EFS file system or an existing Amazon EFS file system that you own by specifying the Amazon EFS policy. For more information, see Using file systems in Amazon EFS.

Link copied to clipboard

Contains information about an external access finding.

Link copied to clipboard

Provides aggregate statistics about the findings for the specified external access analyzer.

Link copied to clipboard
class Finding

Contains information about a finding.

Link copied to clipboard

Contains information about the findings for an Amazon Web Services account in an organization unused access analyzer.

Link copied to clipboard
sealed class FindingChangeType
Link copied to clipboard
sealed class FindingDetails

Contains information about an external access or unused access finding. Only one parameter can be used in a FindingDetails object.

Link copied to clipboard

The source of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

Link copied to clipboard

Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.

Link copied to clipboard
sealed class FindingSourceType
Link copied to clipboard
sealed class FindingsStatistics

Contains information about the aggregate statistics for an external or unused access analyzer. Only one parameter can be used in a FindingsStatistics object.

Link copied to clipboard
sealed class FindingStatus
Link copied to clipboard
sealed class FindingStatusUpdate
Link copied to clipboard

Contains information about a finding.

Link copied to clipboard

Contains information about a finding.

Link copied to clipboard
sealed class FindingType
Link copied to clipboard

Contains the text for the generated policy.

Link copied to clipboard

Contains the generated policy details.

Link copied to clipboard

Contains the text for the generated policy and its details.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Retrieves an analyzed resource.

Link copied to clipboard

The response to the request.

Link copied to clipboard

Retrieves an analyzer.

Link copied to clipboard

The response to the request.

Link copied to clipboard

Retrieves an archive rule.

Link copied to clipboard

The response to the request.

Link copied to clipboard

Retrieves a finding.

Link copied to clipboard

The response to the request.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The proposed access control configuration for an IAM role. You can propose a configuration for a new IAM role or an existing IAM role that you own by specifying the trust policy. If the configuration is for a new IAM role, you must specify the trust policy. If the configuration is for an existing IAM role that you own and you do not propose the trust policy, the access preview uses the existing trust policy for the role. The proposed trust policy cannot be an empty string. For more information about role trust policy limits, see IAM and STS quotas.

Link copied to clipboard

An criterion statement in an archive rule. Each archive rule may have multiple criteria.

Link copied to clipboard

Internal server error.

Link copied to clipboard

This configuration sets the network origin for the Amazon S3 access point or multi-region access point to Internet.

Link copied to clipboard

The specified parameter is invalid.

Link copied to clipboard

Contains details about the policy generation request.

Link copied to clipboard
class JobError

Contains the details about the policy generation error.

Link copied to clipboard
sealed class JobErrorCode
Link copied to clipboard
sealed class JobStatus
Link copied to clipboard

A proposed grant configuration for a KMS key. For more information, see CreateGrant.

Link copied to clipboard

Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context. You can specify only one type of encryption context. An empty map is treated as not specified. For more information, see GrantConstraints.

Link copied to clipboard
sealed class KmsGrantOperation
Link copied to clipboard

Proposed access control configuration for a KMS key. You can propose a configuration for a new KMS key or an existing KMS key that you own by specifying the key policy and KMS grant configuration. If the configuration is for an existing key and you do not specify the key policy, the access preview uses the existing policy for the key. If the access preview is for a new resource and you do not specify the key policy, then the access preview uses the default key policy. The proposed key policy cannot be an empty string. For more information, see Default key policy. For more information about key policy limits, see Resource quotas.

Link copied to clipboard
Link copied to clipboard

Retrieves a list of resources that have been analyzed.

Link copied to clipboard

The response to the request.

Link copied to clipboard

Retrieves a list of analyzers.

Link copied to clipboard

The response to the request.

Link copied to clipboard

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

Link copied to clipboard

The response to the request.

Link copied to clipboard

Retrieves a list of findings generated by the specified analyzer.

Link copied to clipboard

The response to the request.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Retrieves a list of tags applied to the specified resource.

Link copied to clipboard

The response to the request.

Link copied to clipboard
sealed class Locale
Link copied to clipboard
class Location

A location in a policy that is represented as a path through the JSON representation and a corresponding span.

Link copied to clipboard

The proposed InternetConfiguration or VpcConfiguration to apply to the Amazon S3 access point. You can make the access point accessible from the internet, or you can specify that all requests made through that access point must originate from a specific virtual private cloud (VPC). You can specify only one type of network configuration. For more information, see Creating access points.

Link copied to clipboard
sealed class OrderBy
Link copied to clipboard
sealed class PathElement

A single element in a path through the JSON representation of a policy.

Link copied to clipboard

Contains details about the policy generation status and properties.

Link copied to clipboard

Contains the ARN details about the IAM entity for which the policy is generated.

Link copied to clipboard
sealed class PolicyType
Link copied to clipboard
class Position

A position in a policy.

Link copied to clipboard

The values for a manual Amazon RDS DB cluster snapshot attribute.

Link copied to clipboard

The proposed access control configuration for an Amazon RDS DB cluster snapshot. You can propose a configuration for a new Amazon RDS DB cluster snapshot or an Amazon RDS DB cluster snapshot that you own by specifying the RdsDbClusterSnapshotAttributeValue and optional KMS encryption key. For more information, see ModifyDBClusterSnapshotAttribute.

Link copied to clipboard

The name and values of a manual Amazon RDS DB snapshot attribute. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot.

Link copied to clipboard

The proposed access control configuration for an Amazon RDS DB snapshot. You can propose a configuration for a new Amazon RDS DB snapshot or an Amazon RDS DB snapshot that you own by specifying the RdsDbSnapshotAttributeValue and optional KMS encryption key. For more information, see ModifyDBSnapshotAttribute.

Link copied to clipboard
sealed class ReasonCode
Link copied to clipboard

Contains information about the reasoning why a check for access passed or failed.

Link copied to clipboard

Contains information about the reason that the retrieval of a recommendation for a finding failed.

Link copied to clipboard
sealed class RecommendationType
Link copied to clipboard
Link copied to clipboard
sealed class RecommendedStep

Contains information about a recommended step for an unused access analyzer finding.

Link copied to clipboard

The specified resource could not be found.

Link copied to clipboard
sealed class ResourceType
Link copied to clipboard

Contains information about the total number of active cross-account and public findings for a resource type of an external access analyzer.

Link copied to clipboard

The configuration for an Amazon S3 access point or multi-region access point for the bucket. You can propose up to 10 access points or multi-region access points per bucket. If the proposed Amazon S3 access point configuration is for an existing bucket, the access preview uses the proposed access point configuration in place of the existing access points. To propose an access point without a policy, you can provide an empty string as the access point policy. For more information, see Creating access points. For more information about access point policy limits, see Access points restrictions and limitations.

Link copied to clipboard

A proposed access control list grant configuration for an Amazon S3 bucket. For more information, see How to Specify an ACL.

Link copied to clipboard

Proposed access control configuration for an Amazon S3 bucket. You can propose a configuration for a new Amazon S3 bucket or an existing Amazon S3 bucket that you own by specifying the Amazon S3 bucket policy, bucket ACLs, bucket BPA settings, Amazon S3 access points, and multi-region access points attached to the bucket. If the configuration is for an existing Amazon S3 bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the existing policy attached to the bucket. If the access preview is for a new resource and you do not specify the Amazon S3 bucket policy, the access preview assumes a bucket without a policy. To propose deletion of an existing bucket policy, you can specify an empty string. For more information about bucket policy limits, see Bucket Policy Examples.

Proposed configuration for an access point attached to an Amazon S3 directory bucket. You can propose up to 10 access points per bucket. If the proposed access point configuration is for an existing Amazon S3 directory bucket, the access preview uses the proposed access point configuration in place of the existing access points. To propose an access point without a policy, you can provide an empty string as the access point policy. For more information about access points for Amazon S3 directory buckets, see Managing access to directory buckets with access points in the Amazon Simple Storage Service User Guide.

Link copied to clipboard

Proposed access control configuration for an Amazon S3 directory bucket. You can propose a configuration for a new Amazon S3 directory bucket or an existing Amazon S3 directory bucket that you own by specifying the Amazon S3 bucket policy. If the configuration is for an existing Amazon S3 directory bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the existing policy attached to the directory bucket. If the access preview is for a new resource and you do not specify the Amazon S3 bucket policy, the access preview assumes an directory bucket without a policy. To propose deletion of an existing bucket policy, you can specify an empty string. For more information about Amazon S3 directory bucket policies, see Example bucket policies for directory buckets in the Amazon Simple Storage Service User Guide.

Link copied to clipboard

The PublicAccessBlock configuration to apply to this Amazon S3 bucket. If the proposed configuration is for an existing Amazon S3 bucket and the configuration is not specified, the access preview uses the existing setting. If the proposed configuration is for a new bucket and the configuration is not specified, the access preview uses false. If the proposed configuration is for a new access point or multi-region access point and the access point BPA configuration is not specified, the access preview uses true. For more information, see PublicAccessBlockConfiguration.

Link copied to clipboard

The configuration for a Secrets Manager secret. For more information, see CreateSecret.

Link copied to clipboard
Link copied to clipboard

The proposed access control configuration for an Amazon SNS topic. You can propose a configuration for a new Amazon SNS topic or an existing Amazon SNS topic that you own by specifying the policy. If the configuration is for an existing Amazon SNS topic and you do not specify the Amazon SNS policy, then the access preview uses the existing Amazon SNS policy for the topic. If the access preview is for a new resource and you do not specify the policy, then the access preview assumes an Amazon SNS topic without a policy. To propose deletion of an existing Amazon SNS topic policy, you can specify an empty string for the Amazon SNS policy. For more information, see Topic.

Link copied to clipboard

The criteria used to sort.

Link copied to clipboard
class Span

A span in a policy. The span consists of a start position (inclusive) and end position (exclusive).

Link copied to clipboard

The proposed access control configuration for an Amazon SQS queue. You can propose a configuration for a new Amazon SQS queue or an existing Amazon SQS queue that you own by specifying the Amazon SQS policy. If the configuration is for an existing Amazon SQS queue and you do not specify the Amazon SQS policy, the access preview uses the existing Amazon SQS policy for the queue. If the access preview is for a new resource and you do not specify the policy, the access preview assumes an Amazon SQS queue without a policy. To propose deletion of an existing Amazon SQS queue policy, you can specify an empty string for the Amazon SQS policy. For more information about Amazon SQS policy limits, see Quotas related to policies.

Link copied to clipboard

Starts a scan of the policies applied to the specified resource.

Link copied to clipboard
Link copied to clipboard
sealed class Status
Link copied to clipboard

Provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is returned. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the Amazon Web Services organization.

Link copied to clipboard
class Substring

A reference to a substring of a literal string in a JSON document.

Link copied to clipboard

Adds a tag to the specified resource.

Link copied to clipboard

The response to the request.

Link copied to clipboard

Throttling limit exceeded error.

Link copied to clipboard
class Trail

Contains details about the CloudTrail trail being analyzed to generate a policy.

Link copied to clipboard

Contains details about the CloudTrail trail being analyzed to generate a policy.

Link copied to clipboard
sealed class Type
Link copied to clipboard

The specified entity could not be processed.

Link copied to clipboard

Removes a tag from the specified resource.

Link copied to clipboard

The response to the request.

Link copied to clipboard

Contains information about an unused access analyzer.

Link copied to clipboard

Provides aggregate statistics about the findings for the specified unused access analyzer.

Link copied to clipboard

Contains information about the total number of findings for a type of unused access.

Link copied to clipboard

Contains information about an unused access finding for an action. IAM Access Analyzer charges for unused access analysis based on the number of IAM roles and users analyzed per month. For more details on pricing, see IAM Access Analyzer pricing.

Link copied to clipboard

Contains information about an unused access finding for an IAM role. IAM Access Analyzer charges for unused access analysis based on the number of IAM roles and users analyzed per month. For more details on pricing, see IAM Access Analyzer pricing.

Link copied to clipboard

Contains information about an unused access finding for an IAM user access key. IAM Access Analyzer charges for unused access analysis based on the number of IAM roles and users analyzed per month. For more details on pricing, see IAM Access Analyzer pricing.

Link copied to clipboard

Contains information about an unused access finding for an IAM user password. IAM Access Analyzer charges for unused access analysis based on the number of IAM roles and users analyzed per month. For more details on pricing, see IAM Access Analyzer pricing.

Link copied to clipboard

Contains information about an unused access finding for a permission. IAM Access Analyzer charges for unused access analysis based on the number of IAM roles and users analyzed per month. For more details on pricing, see IAM Access Analyzer pricing.

Link copied to clipboard

Contains information about the action to take for a policy in an unused permissions finding.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Updates the specified archive rule.

Link copied to clipboard
Link copied to clipboard

Updates findings with the new values provided in the request.

Link copied to clipboard
Link copied to clipboard

A finding in a policy. Each finding is an actionable recommendation that can be used to improve the policy.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Validation exception error.

Link copied to clipboard

Contains information about a validation exception.

Link copied to clipboard
Link copied to clipboard

The proposed virtual private cloud (VPC) configuration for the Amazon S3 access point. VPC configuration does not apply to multi-region access points. For more information, see VpcConfiguration.