View a markdown version of this page

VmInstanceAggregationResponse - Inspector

VmInstanceAggregationResponse

A response that contains the results of a VM instance aggregation.

Contents

resourceId

The resource ID for the VM instance.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

accountId

The account ID associated with the VM instance.

Type: String

Required: No

cloudAccountId

The cloud account ID for the VM instance aggregation.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 36.

Pattern: (\d{12}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})

Required: No

cloudOrgId

The cloud organization ID for the VM instance aggregation.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 36.

Pattern: (o-[a-z0-9]{10,32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})

Required: No

cloudPartition

The cloud infrastructure partition associated with this VM instance aggregation. Valid values:

  • aws – AWS commercial Regions.

  • aws-cn – AWS China Regions.

  • aws-us-gov – AWS GovCloud (US) Regions.

  • AzureCloud – Azure commercial Regions.

Type: String

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

Pattern: (aws(-[a-z]+)*|Azure[A-Za-z]+)

Required: No

cloudProvider

The cloud service provider associated with this VM instance aggregation. Valid values:

  • AWS – Findings from AWS resources.

  • AZURE – Findings from Microsoft Azure resources.

Type: String

Valid Values: AWS | AZURE

Required: No

cloudRegion

The cloud Region associated with this VM instance aggregation. The value format depends on the cloud provider:

  • An AWS Region, such as us-east-1.

  • An Azure region, such as eastus.

Type: String

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

Pattern: ([a-z]{2}(-[a-z]+)+-\d+|[a-z][a-z0-9]+)

Required: No

exploitAvailableActiveFindingsCount

The number of active findings with an exploit available for the VM instance.

Type: Long

Required: No

fixAvailableActiveFindingsCount

The number of active findings with a fix available for the VM instance.

Type: Long

Required: No

networkFindings

The number of network findings for the VM instance. This field applies only to AWS resources.

Type: Long

Required: No

operatingSystem

The operating system of the VM instance.

Type: String

Required: No

severityCounts

An object that contains the counts of aggregated finding per severity.

Type: SeverityCounts object

Required: No

tags

The tags attached to the VM instance.

Type: String to string map

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

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

vmImageReference

The VM image reference for the VM instance.

Type: String

Required: No

See Also

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