

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

# BuildImage
<a name="build-image"></a>

Erstellen Sie ein benutzerdefiniertes AWS ParallelCluster Bild in einem. AWS-Region

**Topics**
+ [Erforderliche Syntax](#build-image-request)
+ [Anforderungstext](#build-image-request-body)
+ [Antwortsyntax](#build-image-response)
+ [Antworttext](#build-image-response-body)
+ [Beispiel](#build-image-example)

## Erforderliche Syntax
<a name="build-image-request"></a>

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

## Anforderungstext
<a name="build-image-request-body"></a>

**Image-Konfiguration**  
Die Image-Konfiguration als YAML-Dokument.  
Type: Zeichenkette  
Erforderlich: Ja

**imageId**  
Die ID des zu erstellenden Images.  
Type: Zeichenkette  
Erforderlich: Ja

**Trockenlauf**  
Wenn auf gesetzt`true`, wird nur eine Anforderungsvalidierung durchgeführt, ohne eine Ressource zu erstellen. Verwenden Sie diesen Parameter, um die Image-Konfiguration zu validieren. Der Standardwert ist `false`.  
Typ: Boolesch  
Erforderlich: Nein

**Region**  
Der, AWS-Region in dem Sie den Befehl ausführen, um das Image zu erstellen.  
Type: Zeichenkette  
Erforderlich: Nein

**rollbackOnFailure**  
Wenn diese Option auf gesetzt ist`true`, erfolgt ein Rollback des Image-Stacks, wenn das Image nicht erstellt werden kann. Der Standardwert ist `false`.  
Typ: Boolesch  
Erforderlich: Nein

**SuppressValidators**  
Identifizieren Sie einen oder mehrere Konfigurationsvalidatoren, die unterdrückt werden sollen.  
Typ: Liste von Zeichenketten  
Format: `(ALL|type:[A-Za-z0-9]+)`  
Erforderlich: Nein

**validationFailureLevel**  
Die Mindestvalidierungsstufe, die dazu führt, dass die Image-Erstellung fehlschlägt. Der Standardwert ist `ERROR`.  
Type: Zeichenkette  
Zulässige Werte: `INFO | WARNING | ERROR`  
Erforderlich: Nein

## Antwortsyntax
<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"
    }
  ]
}
```

## Antworttext
<a name="build-image-response-body"></a>

**Abbild**    
**imageId**  
Die ID des Images.  
Type: Zeichenkette  
**cloudformationStackArn**  
Der Amazon-Ressourcenname (ARN) des CloudFormation Hauptstapels.  
Type: Zeichenkette  
**cloudformationStackStatus**  
Der CloudFormation Stack-Status.  
Type: Zeichenkette  
Zulässige Werte: `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**  
Die Amazon EC2 AMI-ID.  
Type: Zeichenkette  
**imageBuildStatus**  
Der Status der Image-Erstellung.  
Type: Zeichenkette  
Zulässige Werte: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**Region**  
Der, AWS-Region in dem das Image erstellt wurde.  
Type: Zeichenkette  
**version**  
Die AWS ParallelCluster Version, mit der das Image erstellt wurde.  
Type: Zeichenkette

**Bestätigungsnachrichten**  
Eine Liste von Nachrichten mit einer Gültigkeitsstufe unter. `validationFailureLevel` Die Liste der Nachrichten wird während der Konfigurationsvalidierung gesammelt.    
**id**  
Die Validator-ID.  
Type: Zeichenkette  
**level**  
Die Validierungsebene.  
Type: Zeichenkette  
Zulässige Werte: `INFO | WARNING | ERROR`  
**Nachricht**  
Eine Bestätigungsnachricht.  
Type: Zeichenkette  
**Typ**  
Der Typ des Validators.  
Type: Zeichenkette

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

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

**Anforderung**

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

**200 Antwort**

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

------