Retrieves a list of access preview findings generated by the specified access preview.
Request Syntax
POST /access-preview/accessPreviewId HTTP/1.1
Content-type: application/json
{
"analyzerArn": "string",
"filter": {
"string" : {
"contains": [ "string" ],
"eq": [ "string" ],
"exists": boolean,
"neq": [ "string" ]
}
},
"maxResults": number,
"nextToken": "string"
}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
Request Body
The request accepts the following data in JSON format.
- analyzerArn
-
The ARN of the analyzer used to generate the access.
Type: String
Pattern:
[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:analyzer/.{1,255}Required: Yes
- filter
-
Criteria to filter the returned findings.
Type: String to Criterion object map
Required: No
- maxResults
-
The maximum number of results to return in the response.
Type: Integer
Required: No
- nextToken
-
A token used for pagination of results returned.
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"findings": [
{
"action": [ "string" ],
"changeType": "string",
"condition": {
"string" : "string"
},
"createdAt": "string",
"error": "string",
"existingFindingId": "string",
"existingFindingStatus": "string",
"id": "string",
"isPublic": boolean,
"principal": {
"string" : "string"
},
"resource": "string",
"resourceControlPolicyRestriction": "string",
"resourceOwnerAccount": "string",
"resourceType": "string",
"sources": [
{
"detail": {
"accessPointAccount": "string",
"accessPointArn": "string"
},
"type": "string"
}
],
"status": "string"
}
],
"nextToken": "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.
- findings
-
A list of access preview findings that match the specified filter criteria.
Type: Array of AccessPreviewFinding objects
- nextToken
-
A token used for pagination of results returned.
Type: String
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
- ConflictException
-
A conflict exception error.
HTTP Status Code: 409
- 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 AWS SDKs, see the following:
