Skip to content

VmInstanceAggregation

Source code in docs_src/capo_inspector2/types/vm_instance_aggregation.py
class VmInstanceAggregation(TypedDict, closed=True):
    resource_ids: NotRequired[
        "capo_inspector2.types.string_filter_list.StringFilterList"
    ]
    """<p>The resource IDs to aggregate findings for.</p>"""
    operating_systems: NotRequired[
        "capo_inspector2.types.string_filter_list.StringFilterList"
    ]
    """<p>The operating systems to aggregate findings for.</p>"""
    instance_tags: NotRequired["capo_inspector2.types.map_filter_list.MapFilterList"]
    """<p>The instance tags to aggregate findings for.</p>"""
    vm_image_references: NotRequired[
        "capo_inspector2.types.string_filter_list.StringFilterList"
    ]
    """<p>The VM image references to aggregate findings for.</p>"""
    cloud_providers: NotRequired[
        "capo_inspector2.types.string_filter_list.StringFilterList"
    ]
    """<p>The cloud providers to aggregate findings for. 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_partitions: NotRequired[
        "capo_inspector2.types.string_filter_list.StringFilterList"
    ]
    """<p>The cloud partitions to aggregate findings for. 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_regions: NotRequired[
        "capo_inspector2.types.string_filter_list.StringFilterList"
    ]
    """<p>The cloud regions to aggregate findings for. 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_ids: NotRequired[
        "capo_inspector2.types.string_filter_list.StringFilterList"
    ]
    """<p>The cloud organization IDs to aggregate findings for.</p>"""
    cloud_account_ids: NotRequired[
        "capo_inspector2.types.string_filter_list.StringFilterList"
    ]
    """<p>The cloud account IDs to aggregate findings for.</p>"""
    sort_order: NotRequired["capo_inspector2.types.sort_order.SortOrder"]
    """<p>The order to sort results by. Valid values are <code>ASC</code> and <code>DESC</code>.</p>"""
    sort_by: NotRequired["capo_inspector2.types.vm_instance_sort_by.VmInstanceSortBy"]
    """<p>The value to sort results by. Specify a field name from the aggregation response, such as <code>CRITICAL</code>, <code>HIGH</code>, <code>ALL</code>, or <code>NETWORK_FINDINGS</code>.</p>"""

cloud_account_ids instance-attribute

cloud_account_ids: NotRequired[StringFilterList]

The cloud account IDs to aggregate findings for.

cloud_org_ids instance-attribute

cloud_org_ids: NotRequired[StringFilterList]

The cloud organization IDs to aggregate findings for.

cloud_partitions instance-attribute

cloud_partitions: NotRequired[StringFilterList]

The cloud partitions to aggregate findings for. 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_providers instance-attribute

cloud_providers: NotRequired[StringFilterList]

The cloud providers to aggregate findings for. Valid values:

  • AWS – Findings from Amazon Web Services resources.

  • AZURE – Findings from Microsoft Azure resources.

cloud_regions instance-attribute

cloud_regions: NotRequired[StringFilterList]

The cloud regions to aggregate findings for. The value format depends on the cloud provider:

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

  • An Azure region, such as eastus.

instance_tags instance-attribute

instance_tags: NotRequired[MapFilterList]

The instance tags to aggregate findings for.

operating_systems instance-attribute

operating_systems: NotRequired[StringFilterList]

The operating systems to aggregate findings for.

resource_ids instance-attribute

resource_ids: NotRequired[StringFilterList]

The resource IDs to aggregate findings for.

sort_by instance-attribute

sort_by: NotRequired[VmInstanceSortBy]

The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, ALL, or NETWORK_FINDINGS.

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

The order to sort results by. Valid values are ASC and DESC.

vm_image_references instance-attribute

vm_image_references: NotRequired[StringFilterList]

The VM image references to aggregate findings for.