describeImage

Obtenga información detallada sobre una imagen existente.

Sintaxis de la solicitud

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

Cuerpo de la solicitud

imageId

El identificador de la imagen.

Tipo: String

Obligatorio: sí

region

La Región de AWS en la que se creó la imagen.

Tipo: String

Obligatorio: no

Sintaxis de la respuesta

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

Cuerpo de respuesta

imageId

El identificador de la imagen de la que se va a recuperar la información detallada.

Tipo: String

imageBuildStatus

El estado de creación de la imagen.

Tipo: String

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

imageConfiguration

url

La URL del archivo de configuración de la imagen.

Tipo: String

region

La Región de AWS en la que se crea la imagen.

Tipo: String

version

La versión de AWS ParallelCluster que se utiliza para crear la imagen.

Tipo: String

cloudformationStackArn

El nombre de recurso de Amazon (ARN) de la pila principal de CloudFormation.

Tipo: String

cloudformationStackCreationTime

La marca de tiempo en la que se creó la pila de CloudFormation.

Tipo: datetime

cloudformationStackStatus

El estado de la pila de CloudFormation.

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

cloudformationStackStatusReason

El motivo del estado de la pila de CloudFormation.

Tipo: String

cloudformationStackTags

La lista de etiquetas de la pila de CloudFormation.

key

El nombre de la etiqueta.

Tipo: String

value

El valor de la etiqueta.

Tipo: String

creationTime

Marca de tiempo de la creación de la imagen.

Tipo: datetime

ec2AmiInfo

amiId

El identificador de la AMI de EC2.

Tipo: String

amiName

El nombre de la AMI de EC2.

Tipo: String

architecture

La arquitectura de la AMI de EC2.

Tipo: String

estado

El estado de la AMI de EC2.

Tipo: String

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

etiquetas

La lista de etiquetas de AMI de EC2.

key

Nombre de la etiqueta.

Tipo: String

value

Valor de la etiqueta.

Tipo: String

imagebuilderImageStatus

El estado de ImageBuilder.

Tipo: String

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

imagebuilderImageStatusReason

El motivo del estado de la imagen de ImageBuilder.

Tipo: String

imageBuildLogsArn

El nombre de recurso de Amazon (ARN) de los registros del proceso de creación de la imagen.

Tipo: String

Ejemplo

Python

Solicitud

$ describe_image(custom-image-id)

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