describeImage

Obtém informações detalhadas sobre uma imagem existente.

Sintaxe da solicitação

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

Corpo da solicitação

imageId

O ID da imagem.

Tipo: string

Obrigatório: Sim

região

O em Região da AWS que a imagem foi criada.

Tipo: string

Obrigatório: Não

Sintaxe da resposta

{
  "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"
  }
}

Corpo da resposta

imageId

O ID da imagem para a qual recuperar informações detalhadas.

Tipo: string

imageBuildStatus

O status de construção da imagem.

Tipo: string

Valores válidos: BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

imageConfiguration

url

URL do arquivo de configuração da imagem.

Tipo: string

região

O em Região da AWS que a imagem é criada.

Tipo: string

versão

A AWS ParallelCluster versão usada para criar a imagem.

Tipo: string

cloudformationStackArn

O Amazon Resource Name (ARN) da pilha principal CloudFormation .

Tipo: string

cloudformationStackCreationHora

A data e hora de quando a CloudFormation pilha foi criada.

Tipo: datetime

cloudformationStackStatus

O status da CloudFormation pilha.

Tipo: string

Valores válidos: 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

cloudformationStackStatusRazão

O motivo do status da CloudFormation pilha.

Tipo: string

cloudformationStackTags

A lista de tags para a CloudFormation pilha.

chave

O nome da tag.

Tipo: string

valor

O valor da tag.

Tipo: string

creationTime

A marca de data/hora da criação da imagem.

Tipo: datetime

ec2 AmiInfo

amiId

O ID da AMI do Amazon EC2.

Tipo: string

amiName

O nome da Amazon EC2 AMI.

Tipo: string

arquitetura

A arquitetura do Amazon EC2 AMI.

Tipo: string

estado

O estado da Amazon EC2 AMI.

Tipo: string

Valores válidos: PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR

tags

Lista de tags de AMI do Amazon EC2.

chave

Nome da tag.

Tipo: string

valor

Valor da tag.

Tipo: string

imagebuilderImageStatus

O ImageBuilder status.

Tipo: string

Valores válidos: PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED

imagebuilderImageStatusRazão

Motivo do status ImageBuilder da imagem.

Tipo: string

imageBuildLogsArn

O nome do recurso da Amazon (ARN) dos logs do processo de criação de imagens.

Tipo: string

Exemplo

Python

Solicitação

$ describe_image(custom-image-id)

Resposta 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'
}