How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon IAM Access Analyzer Access Preview API

The Access Preview API from Amazon IAM Access Analyzer — 3 operation(s) for access preview.

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.

3 operations 3 paths 98 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://access-analyzer.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon IAM Access Analyzer Access Preview API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Access Preview 3
PUT
/access-preview
Amazon IAM Access Analyzer Create Access Preview
CreateAccessPreview 7 params body → 200480481482483484485486
GET
/access-preview/{accessPreviewId}#analyzerArn
Amazon IAM Access Analyzer Get Access Preview
GetAccessPreview 9 params → 200480481482483484
POST
/access-preview/{accessPreviewId}
Amazon IAM Access Analyzer List Access Preview Findings
ListAccessPreviewFindings 10 params body → 200480481482483484485

Schemas 98

The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are AccessPreviewFinding (15 properties), Configuration (11 properties), AccessPreview (6 properties), KmsGrantConfiguration (5 properties). Each schema is shown below with its type and property counts.

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
AccessPreviewId
string
GetAccessPreviewResponse
object
1 property 1 required
String
string
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
EbsGroupList
array
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
FindingSourceList
array
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
ActionList
array
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
InternalServerException
InternetConfiguration
object
This configuration sets the network origin for the Amazon S3 access point or multi-region access point to Internet .
IamTrustPolicy
string
RdsDbSnapshotAccountIdsList
array
S3BucketPolicy
string
FindingId
string
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
RetiringPrincipal
string
SecretsManagerSecretKmsId
string
KmsGrantConfiguration
object
A proposed grant configuration for a KMS key. For more information, see CreateGrant .
5 properties 3 required
FindingSourceType
string
RdsDbClusterSnapshotAttributesMap
object
SnsTopicPolicy
string
Boolean
boolean
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
EbsUserIdList
array
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
AclPermission
string
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
IssuingAccount
string
KmsGrantOperation
string
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
VpcId
string
ValueList
array
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
ResourceType
string
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
AnalyzerArn
string
RdsDbClusterSnapshotAttributeValue
object
The values for a manual Amazon RDS DB cluster snapshot attribute.
1 property
GranteePrincipal
string
RdsDbSnapshotAccountId
string
AccessPointPolicy
string
PrincipalMap
object
KmsGrantConfigurationsList
array
KmsGrantOperationsList
array
KmsConstraintsMap
object
EbsGroup
string
ConditionKeyMap
object
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
FindingStatus
string
AccessPreviewFinding
object
An access preview finding generated by the access preview.
15 properties 6 required
AclCanonicalId
string
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
ConflictException
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
KmsKeyPolicy
string
AccessPreview
object
Contains information about an access preview.
6 properties 5 required
ThrottlingException
FindingChangeType
string
ServiceQuotaExceededException
AccessPreviewFindingsList
array
SqsQueuePolicy
string
EbsSnapshotDataEncryptionKeyId
string
S3AccessPointConfigurationsMap
object
RdsDbClusterSnapshotAccountIdsList
array
AclUri
string
AccessPreviewStatusReasonCode
string
Token
string
EbsUserId
string
Timestamp
string
KmsKeyPoliciesMap
object
ConfigurationsMap
object
AccessDeniedException
ValidationException

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iam-access-analyzer-access-preview-api-openapi.yml Raw ↑

Other APIs Amazon IAM Access Analyzer publishes across the network.

Amazon IAM Access Analyzer Access Preview#analyzerArn API
Amazon IAM Access Analyzer Analyzed Resource#analyzerArn&resourceArn API
Amazon IAM Access Analyzer Analyzed Resource API
Amazon IAM Access Analyzer Analyzer API
Amazon IAM Access Analyzer Archive Rule API
Amazon IAM Access Analyzer Finding API
Amazon IAM Access Analyzer Policy API
Amazon IAM Access Analyzer Resource API
Amazon IAM Access Analyzer Tags API
Where this information came from

This is an independent, third-party profile of Amazon IAM Access Analyzer Access Preview API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.