DescribeResourceScanResponse Class

This is the response object from the DescribeResourceScan operation.

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceResponse
Amazon.CloudFormation.Model.DescribeResourceScanResponse

Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

public class DescribeResourceScanResponse : AmazonWebServiceResponse

The DescribeResourceScanResponse type exposes the following members

Constructors

	Name	Description
	DescribeResourceScanResponse()

Properties

Name	Type	Description
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
EndTime	System.DateTime	Gets and sets the property EndTime. The time that the resource scan was finished.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
PercentageCompleted	System.Double	Gets and sets the property PercentageCompleted. The percentage of the resource scan that has been completed.
ResourceScanId	System.String	Gets and sets the property 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`.
ResourcesRead	System.Int32	Gets and sets the property ResourcesRead. The number of resources that were read. This is only available for scans with a `Status` set to `COMPLETE`, `EXPIRED`, or `FAILED`. This field may be 0 if the resource scan failed with a `ResourceScanLimitExceededException`.
ResourcesScanned	System.Int32	Gets and sets the property ResourcesScanned. The number of resources that were listed. This is only available for scans with a `Status` set to `COMPLETE`, `EXPIRED`, or `FAILED` .
ResourceTypes	System.Collections.Generic.List<System.String>	Gets and sets the property ResourceTypes. The list of resource types for the specified scan. Resource types are only available for scans with a `Status` set to `COMPLETE` or `FAILED` .
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
ScanFilters	System.Collections.Generic.List<Amazon.CloudFormation.Model.ScanFilter>	Gets and sets the property ScanFilters. The scan filters that were used.
StartTime	System.DateTime	Gets and sets the property StartTime. The time that the resource scan was started.
Status	Amazon.CloudFormation.ResourceScanStatus	Gets and sets the property Status. Status of the resource scan. IN_PROGRESS 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.
StatusReason	System.String	Gets and sets the property StatusReason. The reason for the resource scan status, providing more information if a failure happened.

Examples

This example describes a selected resource scan

To describe a selected resource scan


var client = new AmazonCloudFormationClient();
var response = client.DescribeGeneratedTemplate(new DescribeGeneratedTemplateRequest 
{
    GeneratedTemplateName = "JazzyTemplate"
});

DateTime creationTime = response.CreationTime;
string generatedTemplateId = response.GeneratedTemplateId;
string generatedTemplateName = response.GeneratedTemplateName;
DateTime lastUpdatedTime = response.LastUpdatedTime;
TemplateProgress progress = response.Progress;
string status = response.Status;
string statusReason = response.StatusReason;
TemplateConfiguration templateConfiguration = response.TemplateConfiguration;
int totalWarnings = response.TotalWarnings;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5