DescribeResourceScan - AWS CloudFormation

DescribeResourceScan

Describes details of a resource scan.

Request Parameters

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

ResourceScanId

The Amazon Resource Name (ARN) of the resource scan.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

EndTime

The time that the resource scan was finished.

Type: Timestamp

PercentageCompleted

The percentage of the resource scan that has been completed.

Type: Double

ResourceScanId

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

ResourcesRead

The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

Note

This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

Type: Integer

ResourcesScanned

The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

Type: Integer

ResourceTypes.member.N

The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

Type: Array of strings

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

StartTime

The time that the resource scan was started.

Type: Timestamp

Status

Status of the resource scan.

INPROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

Type: String

Valid Values: IN_PROGRESS | FAILED | COMPLETE | EXPIRED

StatusReason

The reason for the resource scan status, providing more information if a failure happened.

Type: String

Errors

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

ResourceScanNotFound

The resource scan was not found.

HTTP Status Code: 400

See Also

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