

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.

# Construire une image
<a name="build-image"></a>

Créez une AWS ParallelCluster image personnalisée dans un Région AWS.

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

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

```
POST /v3/images/custom
{
  "imageConfiguration": "string",
  "imageId": "string",
  "dryrun": boolean,
  "region": "string",
  "rollbackOnFailure": boolean,
  "supressValidators": [ "string" ],
  "validationFailureLevel": "string"
}
```

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

**Configuration de l'image**  
La configuration de l'image sous forme de document YAML.  
Type : chaîne  
Obligatoire : oui

**imageId**  
L'ID de l'image à créer.  
Type : chaîne  
Obligatoire : oui

**run à sec**  
Si ce paramètre est défini sur`true`, effectuez uniquement la validation des demandes sans créer de ressource. Utilisez ce paramètre pour valider la configuration de l'image. L’argument par défaut est `false`.  
Type : valeur booléenne  
Obligatoire : non

**region**  
Le Région AWS dans lequel vous exécutez la commande pour créer l'image.  
Type : chaîne  
Obligatoire : non

**rollbackOnFailure**  
Si cette valeur est définie sur`true`, la restauration de la pile d'images se produit si l'image ne parvient pas à être créée. L’argument par défaut est `false`.  
Type : valeur booléenne  
Obligatoire : non

**Supprimer les validateurs**  
Identifiez un ou plusieurs validateurs de configuration à supprimer.  
Type : liste de chaînes  
Format : `(ALL|type:[A-Za-z0-9]+)`  
Obligatoire : non

**validationFailureLevel**  
Le niveau de validation minimal qui entraîne l'échec de la création de l'image. L’argument par défaut est `ERROR`.  
Type : chaîne  
Valeurs valides : `INFO | WARNING | ERROR`  
Obligatoire : non

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

```
{
  "image": {
    "imageId": "string",
    "ec2AmiInfo": {
      "amiId": "string"
    },
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "imageBuildStatus": "BUILD_IN_PROGRESS",
    "cloudformationStackStatus": "CREATE_IN_PROGRESS"
  },
  "validationMessages": [
    {
      "id": "string",
      "type": "string",
      "level": "INFO",
      "message": "string"
    }
  ]
}
```

## Corps de la réponse
<a name="build-image-response-body"></a>

**image**    
**imageId**  
ID de l'image.  
Type : chaîne  
**cloudformationStackArn**  
Le nom de ressource Amazon (ARN) de la CloudFormation pile principale.  
Type : chaîne  
**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`  
**ec2 AmiInfo**    
**ami\_id**  
L'identifiant Amazon EC2 AMI.  
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`  
**region**  
Le Région AWS dans lequel l'image est construite.  
Type : chaîne  
**version**  
 AWS ParallelCluster Version utilisée pour créer l'image.  
Type : chaîne

**Messages de validation**  
Liste des messages dont le niveau de validation est inférieur à`validationFailureLevel`. La liste des messages est collectée lors de la validation de la configuration.    
**id**  
L'ID du validateur.  
Type : chaîne  
**level**  
Le niveau de validation.  
Type : chaîne  
Valeurs valides : `INFO | WARNING | ERROR`  
**message**  
Un message de validation.  
Type : chaîne  
**type**  
Type de validateur.  
Type : chaîne

## Exemple
<a name="build-image-example"></a>

------
#### [ Python ]

**Demande**

```
$ build_image({{custom-image-id}}, {{custom-image-config.yaml}})
```

**Réponse 200**

```
{
  "image": {
    "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/custom-image-id/711b76b0-af81-11ec-a29f-0ee549109f1f",
    "cloudformation_stack_status": "CREATE_IN_PROGRESS",
    "image_build_status": "BUILD_IN_PROGRESS",
    "image_id": "custom-image-id",
    "region": "us-east-1",
    "version": "3.2.1"
  }
}
```

------