Amazon IAM Access Analyzer Access Preview API is one of 10 APIs that Amazon IAM Access Analyzer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Access Preview. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.
This API exposes
3 operations
across 3 paths,
and defines 98 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://access-analyzer.{region}.amazonaws.com, https://access-analyzer.{region}.amazonaws.com, http://access-analyzer.{region}.amazonaws.com.cn, https://access-analyzer.{region}.amazonaws.com.cn.
The identity and technical contract details declared by the specification.
FindingSourceDetail
object
Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.
2 properties
EfsFileSystemConfiguration
object
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…
1 property
RdsDbClusterSnapshotKmsKeyId
string
AccessPreviewStatusReason
object
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. Th…
1 property
1 required
S3BucketAclGrantConfigurationsList
array
NetworkOriginConfiguration
object
The proposed InternetConfiguration or VpcConfiguration to apply to the Amazon S3 access point. VpcConfiguration does not apply to multi-region access points. Y…
2 properties
Criterion
object
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 .
4 properties
ResourceNotFoundException
GetAccessPreviewResponse
object
1 property
1 required
EfsFileSystemPolicy
string
SecretsManagerSecretPolicy
string
KmsKeyConfiguration
object
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 ke…
2 properties
KmsGrantConstraints
object
Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context . You ca…
2 properties
VpcConfiguration
object
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…
1 property
1 required
FindingSource
object
The source of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
2 properties
1 required
KmsConstraintsValue
string
IamRoleConfiguration
object
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 specifyin…
1 property
S3AccessPointConfiguration
object
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 poin…
3 properties
Configuration
object
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…
11 properties
AccessPreviewFindingId
string
InternetConfiguration
object
This configuration sets the network origin for the Amazon S3 access point or multi-region access point to Internet .
RdsDbSnapshotAccountIdsList
array
AccessPreviewStatus
string
ListAccessPreviewFindingsResponse
object
2 properties
1 required
SnsTopicConfiguration
object
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 t…
1 property
SecretsManagerSecretKmsId
string
KmsGrantConfiguration
object
A proposed grant configuration for a KMS key. For more information, see CreateGrant .
5 properties
3 required
RdsDbClusterSnapshotAttributesMap
object
S3BucketAclGrantConfiguration
object
A proposed access control list grant configuration for an Amazon S3 bucket. For more information, see How to Specify an ACL .
2 properties
2 required
RdsDbClusterSnapshotAccountId
string
RdsDbSnapshotAttributeValue
object
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 res…
1 property
RdsDbSnapshotConfiguration
object
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 s…
2 properties
EbsSnapshotConfiguration
object
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…
3 properties
RdsDbSnapshotAttributesMap
object
SecretsManagerSecretConfiguration
object
The configuration for a Secrets Manager secret. For more information, see CreateSecret . You can propose a configuration for a new secret or an existing secret…
2 properties
RdsDbSnapshotKmsKeyId
string
S3PublicAccessBlockConfiguration
object
The PublicAccessBlock configuration to apply to this Amazon S3 bucket. If the proposed configuration is for an existing Amazon S3 bucket and the configuration…
2 properties
2 required
SqsQueueConfiguration
object
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 t…
1 property
RdsDbClusterSnapshotAttributeValue
object
The values for a manual Amazon RDS DB cluster snapshot attribute.
1 property
RdsDbSnapshotAccountId
string
KmsGrantConfigurationsList
array
KmsGrantOperationsList
array
S3BucketConfiguration
object
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…
4 properties
EcrRepositoryPolicy
string
AclGrantee
object
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 .
2 properties
AccessPreviewFinding
object
An access preview finding generated by the access preview.
15 properties
6 required
RdsDbClusterSnapshotConfiguration
object
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…
2 properties
EcrRepositoryConfiguration
object
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 E…
1 property
CreateAccessPreviewResponse
object
1 property
1 required
AccessPreview
object
Contains information about an access preview.
6 properties
5 required
ServiceQuotaExceededException
AccessPreviewFindingsList
array
EbsSnapshotDataEncryptionKeyId
string
S3AccessPointConfigurationsMap
object
RdsDbClusterSnapshotAccountIdsList
array
AccessPreviewStatusReasonCode
string
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Amazon IAM Access Analyzer publishes across the network.