StartResourceScan - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.


A unique identifier for this StartResourceScan request. Specify this token if you plan to retry requests so that Amazon CloudFormation knows that you're not attempting to start a new resource scan.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Required: No

Response Elements

The following element is returned by the service.


The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

Type: String


For information about the errors that are common to all actions, see Common Errors.


A resource scan is currently in progress. Only one can be run at a time for an account in a Region.

HTTP Status Code: 400


The limit on resource scans has been exceeded. Reasons include:

  • Exceeded the daily quota for resource scans.

  • A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.

  • The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: