GetAccessPreview
Retrieves information about an access preview for the specified analyzer.
Request Syntax
GET /access-preview/accessPreviewId
?analyzerArn=analyzerArn
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- accessPreviewId
-
The unique ID for the access preview.
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
Required: Yes
- analyzerArn
-
The ARN of the analyzer used to generate the access preview.
Pattern:
[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:analyzer/.{1,255}
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"accessPreview": {
"analyzerArn": "string",
"configurations": {
"string" : {
"ebsSnapshot": {
"groups": [ "string" ],
"kmsKeyId": "string",
"userIds": [ "string" ]
},
"ecrRepository": {
"repositoryPolicy": "string"
},
"efsFileSystem": {
"fileSystemPolicy": "string"
},
"iamRole": {
"trustPolicy": "string"
},
"kmsKey": {
"grants": [
{
"constraints": {
"encryptionContextEquals": {
"string" : "string"
},
"encryptionContextSubset": {
"string" : "string"
}
},
"granteePrincipal": "string",
"issuingAccount": "string",
"operations": [ "string" ],
"retiringPrincipal": "string"
}
],
"keyPolicies": {
"string" : "string"
}
},
"rdsDbClusterSnapshot": {
"attributes": {
"string" : {
"accountIds": [ "string" ]
}
},
"kmsKeyId": "string"
},
"rdsDbSnapshot": {
"attributes": {
"string" : {
"accountIds": [ "string" ]
}
},
"kmsKeyId": "string"
},
"s3Bucket": {
"accessPoints": {
"string" : {
"accessPointPolicy": "string",
"networkOrigin": {
"internetConfiguration": {
},
"vpcConfiguration": {
"vpcId": "string"
}
},
"publicAccessBlock": {
"ignorePublicAcls": boolean,
"restrictPublicBuckets": boolean
}
}
},
"bucketAclGrants": [
{
"grantee": {
"id": "string",
"uri": "string"
},
"permission": "string"
}
],
"bucketPolicy": "string",
"bucketPublicAccessBlock": {
"ignorePublicAcls": boolean,
"restrictPublicBuckets": boolean
}
},
"secretsManagerSecret": {
"kmsKeyId": "string",
"secretPolicy": "string"
},
"snsTopic": {
"topicPolicy": "string"
},
"sqsQueue": {
"queuePolicy": "string"
}
}
},
"createdAt": number,
"id": "string",
"status": "string",
"statusReason": {
"code": "string"
}
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- accessPreview
-
An object that contains information about the access preview.
Type: AccessPreview object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
Throttling limit exceeded error.
HTTP Status Code: 429
- ValidationException
-
Validation exception error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: