listOfficialImages - AWS ParallelCluster
Request syntaxRequest bodyResponse syntaxResponse bodyExample

listOfficialImages

Retrieve the list of AWS ParallelCluster official images.

Request syntax

GET /v3/images/official
{  
  "architecture": "string",
  "os": "string",
  "region": "string"
}

Request body

architecture

Filter by architecture. The default is no filtering.

Type: string

Valid values: x86_64 | arm64

Required: No

os

Filter by OS distribution. The default is no filtering.

Type: string

Valid values: alinux2 | ubuntu2204 | ubuntu2004 | rhel8

Required: No

region

The AWS Region that official images are listed in.

Type: string

Required: No

Response syntax

{
  "images": [
    {
      "architecture": "string",
      "amiId": "string",
      "name": "string",
      "os": "string",
      "version": "string"
    }
  ]
}

Response body

images
amiId

The ID of the AMI.

Type: string

architecture

The AMI architecture.

Type: string

name

The name of the AMI.

Type: string

os

The AMI operating system.

Type: string

version

The AWS ParallelCluster version.

Type: string

Example

Python

Request

$ list_official_images()

200 Response

{
  'images': [ 
    {
      'ami_id': 'ami-015cfeb4e0d6306b2',
      'architecture': 'x86_64',
      'name': 'aws-parallelcluster-3.2.1-ubuntu-2004-lts-hvm-x86_64-202202261505 '
      '2022-02-26T15-08-34.759Z',
      'os': 'ubuntu2004',
      'version': '3.2.1'
    },
    ...
  ]
}