Access Analyzer
API Reference (API Version 2019-11-01)

StartResourceScan

Immediately starts a scan of the policies applied to the specified resource.

Request Syntax

POST /resource/scan HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "resourceArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

analyzerArn

The ARN of the analyzer to use to scan the policies applied to the specified resource.

Type: String

Pattern: ^[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:analyzer/.{1,255}$

Required: Yes

resourceArn

The ARN of the resource to scan.

Type: String

Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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 AWS SDKs, see the following: