Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Décrire l'image
<a name="describe-image"></a>

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

**Topics**
+ [Syntaxe de demande](#describe-image-request)
+ [Corps de la demande](#describe-image-request-body)
+ [Syntaxe de réponse](#describe-image-response)
+ [Corps de la réponse](#describe-image-response-body)
+ [Exemple](#describe-image-example)

## Syntaxe de demande
<a name="describe-image-request"></a>

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

## Corps de la demande
<a name="describe-image-request-body"></a>

**imageId**  
ID de l'image.  
Type : chaîne  
Obligatoire : oui

**region**  
L' Région AWS endroit dans lequel l'image a été créée.  
Type : chaîne  
Obligatoire : non

## Syntaxe de réponse
<a name="describe-image-response"></a>

```
{
  "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
<a name="describe-image-response-body"></a>

**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

**region**  
L' Région AWS endroit dans lequel l'image est créée.  
Type : chaîne

**version**  
 AWS ParallelCluster Version utilisée pour créer l'image.  
Type : chaîne

**cloudformationStackArn**  
Le nom de ressource Amazon (ARN) de la CloudFormation pile principale.  
Type : chaîne

**cloudformationStackCreationHeure**  
Heure à laquelle la CloudFormation pile a été créée.  
Type : datetime

**cloudformationStackStatus**  
L'état de la CloudFormation 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 l'état de la CloudFormation pile.  
Type : chaîne

**cloudformationStackTags**  
La liste des balises de la CloudFormation pile.    
**clé**  
Le nom du tag.  
Type : chaîne  
**value**  
Valeur de balise.  
Type : chaîne

**creationTime**  
Les heures auxquelles l'image a été créée.  
Type : datetime

**ec2 AmiInfo**    
**AMID**  
L'identifiant Amazon EC2 AMI.  
Type : chaîne  
**Nom de mon nom**  
Le nom de l' EC2 AMI Amazon.  
Type : chaîne  
**application**  
L'architecture Amazon EC2 AMI.  
Type : chaîne  
**state**  
État de l' EC2 AMI Amazon.  
Type : chaîne  
Valeurs valides : `PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR`  
**balises**  
Liste des balises Amazon EC2 AMI.    
**clé**  
Nom du tag.  
Type : chaîne  
**value**  
Valeur du tag.  
Type : chaîne

**imagebuilderImageStatus**  
État de ImageBuilder l'image.  
Type : chaîne  
Valeurs valides : `PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED`

**imagebuilderImageStatusMotif**  
La raison pour laquelle l' ImageBuilder image possède ce statut.  
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
<a name="describe-image-example"></a>

------
#### [ 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:amzn-s3-demo-bucket",
      "value": 'amzn-s3-demo-bucket"
    },
    {
      "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://amzn-s3-demo-bucket/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://amzn-s3-demo-bucket.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"
}
```

------