listImages

既存のカスタムイメージのリストを取得します。

リクエストの構文

GET /images/custom
{
  "imageStatus": "string",
  "nextToken": "string",
  "region": "string"
}

リクエスト本文

imageStatus

指定されたステータスでイメージを絞り込みます。

タイプ: 文字列

有効な値: AVAILABLE | PENDING | FAILED

必須: はい

nextToken

ページ分割されたリクエストに使用するトークン。

型: 文字列

必須: いいえ

region

イメージが存在する AWS リージョン。

型: 文字列

必須: いいえ

レスポンスの構文

{
  "nextToken": "string",
  "images": [
    {
      "imageId": "string",
      "ec2AmiInfo": {
        "amiId": "string"
      },
      "region": "string",
      "version": "string",
      "cloudformationStackArn": "string",
      "imageBuildStatus": "BUILD_IN_PROGRESS",
      "cloudformationStackStatus": "CREATE_IN_PROGRESS"
    }
  ]
}

レスポンス本文

images

イメージのリスト。

cloudformationStackArn

メイン CloudFormation スタックの Amazon リソースネーム (ARN)。

タイプ: 文字列

cloudformationStackStatus

CloudFormation スタックの状態。

タイプ: 文字列

有効な値: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE

ec2AmiInfo

ami_id

EC2 AMI の ID。

タイプ: 文字列

imageBuildStatus

イメージビルドのステータス。

有効な値: BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

タイプ: 文字列

imageId

イメージの ID。

タイプ: 文字列

region

イメージが作成された AWS リージョン。

タイプ: 文字列

version

イメージのビルドに使用された AWS ParallelCluster バージョン。

タイプ: 文字列

nextToken

ページ分割されたリクエストに使用するトークン。

タイプ: 文字列

例

Python

リクエスト

$ list_images("AVAILABLE")

200 レスポンス

{
  'images': [
    {
      'ec2_ami_info': {
        'ami_id': 'ami-abcdef01234567890'
      },
      'image_build_status': 'BUILD_COMPLETE',
      'image_id': 'custom-image',
      'region': 'us-east-1',
      'version': '3.2.1'
    }
  ]
}