describeImage

既存のイメージの詳細情報を取得します。

リクエストの構文

GET /v3/images/custom/{imageId}
{
  "region": "string"
}

リクエスト本文

imageId

イメージの ID。

タイプ: 文字列

必須: はい

region

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

タイプ: 文字列

必須: いいえ

レスポンスの構文

{
  "imageId": "string",
  "region": "string",
  "version": "string",
  "imageBuildStatus": "BUILD_IN_PROGRESS",
  "imageBuildLogsArn": "string",
  "cloudformationStackStatus": "CREATE_IN_PROGRESS",
  "cloudformationStackStatusReason": "string",
  "cloudformationStackArn": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "cloudformationStackCreationTime": "2019-08-24T14:15:22Z",
  "cloudformationStackTags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "imageConfiguration": {
    "url": "string"
  },
  "imagebuilderImageStatus": "PENDING",
  "imagebuilderImageStatusReason": "string",
  "ec2AmiInfo": {
    "amiId": "string",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "amiName": "string",
    "architecture": "string",
    "state": "PENDING",
    "description": "string"
  }
}

レスポンス本文

imageId

詳細情報を取得するイメージの ID。

タイプ: 文字列

imageBuildStatus

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

タイプ: 文字列

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

imageConfiguration

url

イメージ設定ファイルの URL。

タイプ: 文字列

region

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

タイプ: 文字列

version

イメージの構築に使用される AWS ParallelCluster バージョン。

タイプ: 文字列

cloudformationStackArn

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

タイプ: 文字列

cloudformationStackCreation時間

CloudFormation スタックが作成された時刻のタイムスタンプ。

型: 日時

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

cloudformationStackStatus理由

CloudFormation スタックステータスの理由。

タイプ: 文字列

cloudformationStackTags

CloudFormation スタックのタグのリスト。

キー

タグ名。

タイプ: 文字列

value

タグ値。

タイプ: 文字列

creationTime

イメージが作成された時刻のタイムスタンプ。

型: 日時

EC2AmiInfo

amiId

Amazon EC2 AMI ID。

タイプ: 文字列

amiName

Amazon EC2 AMI 名。

タイプ: 文字列

architecture

Amazon EC2 AMI アーキテクチャ。

タイプ: 文字列

state

Amazon EC2 AMI の状態。

タイプ: 文字列

有効な値: PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR

タグ

Amazon EC2 AMI タグのリスト。

キー

タグ名。

タイプ: 文字列

value

タグ値。

タイプ: 文字列

imagebuilderImageStatus

ImageBuilder ステータス。

タイプ: 文字列

有効な値: PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED

imagebuilderImageStatus理由

ImageBuilder イメージステータスの理由。

タイプ: 文字列

imageBuildLogsArn

イメージビルドプロセスのログの Amazon リソースネーム (ARN)。

タイプ: 文字列

例

Python

リクエスト

$ describe_image(custom-image-id)

200 レスポンス

{
  'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/custom-image-id/6accc570-b080-11ec-845e-0e2dc6386985',
  'cloudformation_stack_creation_time': datetime.datetime(2022, 3, 30, 23, 23, 33, 731000, tzinfo=tzlocal()),
  'cloudformation_stack_status': 'CREATE_IN_PROGRESS',
  'cloudformation_stack_tags': [
    {
      'key': 'parallelcluster:version', 'value': '3.2.1'
    },
    {
      'key': 'parallelcluster:image_name',
      'value': 'custom-image-id'
    },
    {
      'key': 'parallelcluster:custom-image-id',
      'value': 'custom-image-id'
    },
    {
      'key': 'parallelcluster:s3_bucket',
      'value': 'parallelcluster-abcdef01234567890-v1-do-not-delete'
    },
    {
      'key': 'parallelcluster:s3_image_dir',
      'value': 'parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0'
    },
    {
      'key': 'parallelcluster:build_log',
      'value': 'arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-custom-image-id'
    },
    {
      'key': 'parallelcluster:build_config',
      'value': 's3://parallelcluster-abcdef01234567890-v1-do-not-delete/parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0/configs/image-config.yaml'
    }
  ],
  'image_build_logs_arn': 'arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-alinux2-image',
  'image_build_status': 'BUILD_IN_PROGRESS',
  'image_configuration': {
    'url': 'https://parallelcluster-abcdef01234567890-v1-do-not-delete.s3.amazonaws.com/parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0/configs/image-config.yaml?...'
  },
  'image_id': 'custom-image-id',
  'imagebuilder_image_status': 'PENDING',
  'region': 'us-east-1',
  'version': '3.2.1'
}