View a markdown version of this page

AmiAggregationResponse - Inspector
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AmiAggregationResponse

A response that contains the results of a finding aggregation by AMI.

Contents

ami

The ID of the AMI that findings were aggregated for.

Type: String

Pattern: ami-([a-z0-9]{8}|[a-z0-9]{17}|\*)

Required: Yes

accountId

The Amazon Web Services account ID for the AMI.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: No

affectedInstances

The IDs of Amazon EC2 instances using this AMI.

Type: Long

Required: No

cloudAccountId

The cloud account ID for the AMI 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 AMI 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 AMI aggregation. Valid values:

  • aws – Amazon commercial Regions.

  • aws-cn – Amazon China Regions.

  • aws-us-gov – Amazon 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 Amazon Machine Image (AMI) aggregation. Valid values:

  • AWS – Findings from Amazon resources.

  • AZURE – Findings from Microsoft Azure resources.

Type: String

Valid Values: AWS | AZURE

Required: No

cloudRegion

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

  • An Amazon 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

severityCounts

An object that contains the count of matched findings per severity.

Type: SeverityCounts object

Required: No

See Also

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