/AWS1/CL_FRMDESCRRESRCSCANOUT¶
DescribeResourceScanOutput
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_RESOURCESCANID TYPE /AWS1/FRMRESOURCESCANID /AWS1/FRMRESOURCESCANID¶
The Amazon Resource Name (ARN) of the resource scan. The format is
arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example isarn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772.
IV_STATUS TYPE /AWS1/FRMRESOURCESCANSTATUS /AWS1/FRMRESOURCESCANSTATUS¶
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.
IV_STATUSREASON TYPE /AWS1/FRMRESOURCESCANSTATUSRSN /AWS1/FRMRESOURCESCANSTATUSRSN¶
The reason for the resource scan status, providing more information if a failure happened.
IV_STARTTIME TYPE /AWS1/FRMTIMESTAMP /AWS1/FRMTIMESTAMP¶
The time that the resource scan was started.
IV_ENDTIME TYPE /AWS1/FRMTIMESTAMP /AWS1/FRMTIMESTAMP¶
The time that the resource scan was finished.
IV_PERCENTAGECOMPLETED TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING¶
The percentage of the resource scan that has been completed.
IT_RESOURCETYPES TYPE /AWS1/CL_FRMRESOURCETYPES_W=>TT_RESOURCETYPES TT_RESOURCETYPES¶
The list of resource types for the specified scan. Resource types are only available for scans with a
Statusset toCOMPLETEorFAILED.
IV_RESOURCESSCANNED TYPE /AWS1/FRMRESOURCESSCANNED /AWS1/FRMRESOURCESSCANNED¶
The number of resources that were listed. This is only available for scans with a
Statusset toCOMPLETE,EXPIRED, orFAILED.
IV_RESOURCESREAD TYPE /AWS1/FRMRESOURCESREAD /AWS1/FRMRESOURCESREAD¶
The number of resources that were read. This is only available for scans with a
Statusset toCOMPLETE,EXPIRED, orFAILED.This field may be 0 if the resource scan failed with a
ResourceScanLimitExceededException.
Queryable Attributes¶
ResourceScanId¶
The Amazon Resource Name (ARN) of the resource scan. The format is
arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example isarn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCESCANID() |
Getter for RESOURCESCANID, with configurable default |
ASK_RESOURCESCANID() |
Getter for RESOURCESCANID w/ exceptions if field has no valu |
HAS_RESOURCESCANID() |
Determine if RESOURCESCANID has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
StatusReason¶
The reason for the resource scan status, providing more information if a failure happened.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
StartTime¶
The time that the resource scan was started.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTTIME() |
Getter for STARTTIME, with configurable default |
ASK_STARTTIME() |
Getter for STARTTIME w/ exceptions if field has no value |
HAS_STARTTIME() |
Determine if STARTTIME has a value |
EndTime¶
The time that the resource scan was finished.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDTIME() |
Getter for ENDTIME, with configurable default |
ASK_ENDTIME() |
Getter for ENDTIME w/ exceptions if field has no value |
HAS_ENDTIME() |
Determine if ENDTIME has a value |
PercentageCompleted¶
The percentage of the resource scan that has been completed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PERCENTAGECOMPLETED() |
Getter for PERCENTAGECOMPLETED, with configurable default |
ASK_PERCENTAGECOMPLETED() |
Getter for PERCENTAGECOMPLETED w/ exceptions if field has no |
STR_PERCENTAGECOMPLETED() |
String format for PERCENTAGECOMPLETED, with configurable def |
HAS_PERCENTAGECOMPLETED() |
Determine if PERCENTAGECOMPLETED has a value |
ResourceTypes¶
The list of resource types for the specified scan. Resource types are only available for scans with a
Statusset toCOMPLETEorFAILED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCETYPES() |
Getter for RESOURCETYPES, with configurable default |
ASK_RESOURCETYPES() |
Getter for RESOURCETYPES w/ exceptions if field has no value |
HAS_RESOURCETYPES() |
Determine if RESOURCETYPES has a value |
ResourcesScanned¶
The number of resources that were listed. This is only available for scans with a
Statusset toCOMPLETE,EXPIRED, orFAILED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCESSCANNED() |
Getter for RESOURCESSCANNED, with configurable default |
ASK_RESOURCESSCANNED() |
Getter for RESOURCESSCANNED w/ exceptions if field has no va |
HAS_RESOURCESSCANNED() |
Determine if RESOURCESSCANNED has a value |
ResourcesRead¶
The number of resources that were read. This is only available for scans with a
Statusset toCOMPLETE,EXPIRED, orFAILED.This field may be 0 if the resource scan failed with a
ResourceScanLimitExceededException.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCESREAD() |
Getter for RESOURCESREAD, with configurable default |
ASK_RESOURCESREAD() |
Getter for RESOURCESREAD w/ exceptions if field has no value |
HAS_RESOURCESREAD() |
Determine if RESOURCESREAD has a value |