Skip to content

VmInstanceAggregationResponse

Source code in docs_src/capo_inspector2/types/vm_instance_aggregation_response.py
class VmInstanceAggregationResponse(TypedDict, closed=True):
    resource_id: "capo_inspector2.types.non_empty_string.NonEmptyString"
    """<p>The resource ID for the VM instance.</p>"""
    cloud_provider: NotRequired["capo_inspector2.types.provider.Provider"]
    """<p>The cloud service provider associated with this VM instance aggregation. Valid values:</p> <ul> <li> <p> <code>AWS</code> – Findings from Amazon Web Services resources.</p> </li> <li> <p> <code>AZURE</code> – Findings from Microsoft Azure resources.</p> </li> </ul>"""
    cloud_account_id: NotRequired[
        "capo_inspector2.types.provider_account_id.ProviderAccountId"
    ]
    """<p>The cloud account ID for the VM instance aggregation.</p>"""
    cloud_partition: NotRequired[
        "capo_inspector2.types.provider_partition.ProviderPartition"
    ]
    """<p>The cloud infrastructure partition associated with this VM instance aggregation. Valid values:</p> <ul> <li> <p> <code>aws</code> – Amazon Web Services commercial Regions.</p> </li> <li> <p> <code>aws-cn</code> – Amazon Web Services China Regions.</p> </li> <li> <p> <code>aws-us-gov</code> – Amazon Web Services GovCloud (US) Regions.</p> </li> <li> <p> <code>AzureCloud</code> – Azure commercial Regions.</p> </li> </ul>"""
    cloud_region: NotRequired["capo_inspector2.types.provider_region.ProviderRegion"]
    """<p>The cloud Region associated with this VM instance aggregation. The value format depends on the cloud provider:</p> <ul> <li> <p>An Amazon Web Services Region, such as <code>us-east-1</code>.</p> </li> <li> <p>An Azure region, such as <code>eastus</code>.</p> </li> </ul>"""
    cloud_org_id: NotRequired["capo_inspector2.types.provider_org_id.ProviderOrgId"]
    """<p>The cloud organization ID for the VM instance aggregation.</p>"""
    vm_image_reference: NotRequired["str"]
    """<p>The VM image reference for the VM instance.</p>"""
    operating_system: NotRequired["str"]
    """<p>The operating system of the VM instance.</p>"""
    tags: NotRequired["capo_inspector2.types.tag_map.TagMap"]
    """<p>The tags attached to the VM instance.</p>"""
    account_id: NotRequired["str"]
    """<p>The account ID associated with the VM instance.</p>"""
    severity_counts: NotRequired["capo_inspector2.types.severity_counts.SeverityCounts"]
    network_findings: NotRequired["int"]
    """<p>The number of network findings for the VM instance. This field applies only to Amazon Web Services resources.</p>"""
    exploit_available_active_findings_count: NotRequired["int"]
    """<p>The number of active findings with an exploit available for the VM instance.</p>"""
    fix_available_active_findings_count: NotRequired["int"]
    """<p>The number of active findings with a fix available for the VM instance.</p>"""

account_id instance-attribute

account_id: NotRequired[str]

The account ID associated with the VM instance.

cloud_account_id instance-attribute

cloud_account_id: NotRequired[ProviderAccountId]

The cloud account ID for the VM instance aggregation.

cloud_org_id instance-attribute

cloud_org_id: NotRequired[ProviderOrgId]

The cloud organization ID for the VM instance aggregation.

cloud_partition instance-attribute

cloud_partition: NotRequired[ProviderPartition]

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

  • aws – Amazon Web Services commercial Regions.

  • aws-cn – Amazon Web Services China Regions.

  • aws-us-gov – Amazon Web Services GovCloud (US) Regions.

  • AzureCloud – Azure commercial Regions.

cloud_provider instance-attribute

cloud_provider: NotRequired[Provider]

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

  • AWS – Findings from Amazon Web Services resources.

  • AZURE – Findings from Microsoft Azure resources.

cloud_region instance-attribute

cloud_region: NotRequired[ProviderRegion]

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

  • An Amazon Web Services Region, such as us-east-1.

  • An Azure region, such as eastus.

exploit_available_active_findings_count instance-attribute

exploit_available_active_findings_count: NotRequired[int]

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

fix_available_active_findings_count instance-attribute

fix_available_active_findings_count: NotRequired[int]

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

network_findings instance-attribute

network_findings: NotRequired[int]

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

operating_system instance-attribute

operating_system: NotRequired[str]

The operating system of the VM instance.

resource_id instance-attribute

resource_id: NonEmptyString

The resource ID for the VM instance.

severity_counts instance-attribute

severity_counts: NotRequired[SeverityCounts]

tags instance-attribute

tags: NotRequired[TagMap]

The tags attached to the VM instance.

vm_image_reference instance-attribute

vm_image_reference: NotRequired[str]

The VM image reference for the VM instance.