Décrire l'image

Obtenez des informations détaillées sur une image existante.

Syntaxe de demande

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

Corps de la demande

imageId

ID de l'image.

Type : chaîne

Obligatoire : oui

Région

LeRégion AWSdans lequel l'image a été créée.

Type : chaîne

Obligatoire : non

Syntaxe de réponse

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

Corps de la réponse

imageId

ID de l'image pour laquelle vous souhaitez récupérer des informations détaillées.

Type : chaîne

imageBuildStatus

État de création de l'image.

Type : chaîne

Valeurs valides : BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

Configuration de l'image

url

URL du fichier de configuration de l'image.

Type : chaîne

Région

LeRégion AWSdans lequel l'image a été créée.

Type : chaîne

version ;

LeAWS ParallelClusterversion utilisée pour créer l'image.

Type : chaîne

cloudformationStackArn

Le nom de ressource Amazon (ARN) de la ressource principale CloudFormation pile.

Type : chaîne

cloudformationStackCreationHeure

L'horodatage du moment où CloudFormation une pile a été créée.

Type : datetime

cloudformationStackStatus

Le CloudFormation état de la pile.

Type : chaîne

Valeurs valides : 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

cloudformationStackStatusMotif

La raison de la CloudFormation état de la pile.

Type : chaîne

cloudformationStackTags

La liste des tags pour CloudFormation pile.

key

Le nom du tag.

Type : chaîne

value

Valeur de balise.

Type : chaîne

creationTime

Horodatage indiquant le moment où l'image a été créée.

Type : datetime

ec2AmiInfo

AMiID

L'ID de l'AMI EC2.

Type : chaîne

Nom de mon nom

Nom de l'AMI EC2.

Type : chaîne

application

L'architecture de l'AMI EC2.

Type : chaîne

state

État de l'AMI EC2.

Type : chaîne

Valeurs valides : PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR

tags

Liste des balises AMI EC2.

key

Nom du tag.

Type : chaîne

value

Valeur du tag.

Type : chaîne

imagebuilderImageStatus

Le ImageBuilder statut.

Type : chaîne

Valeurs valides : PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED

imagebuilderImageStatusMotif

Raison de la ImageBuilder État de l'image.

Type : chaîne

imageBuildLogsArn

Le nom de ressource Amazon (ARN) des journaux pour le processus de création de l'image.

Type : chaîne

Exemple

Python

Demande

$ describe_image(custom-image-id)

Réponse 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'
}