

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

Cree una AWS ParallelCluster imagen personalizada en un Región de AWS.

**Topics**
+ [Sintaxis de la solicitud](#build-image-request)
+ [Cuerpo de la solicitud](#build-image-request-body)
+ [Sintaxis de la respuesta](#build-image-response)
+ [Cuerpo de respuesta](#build-image-response-body)
+ [Ejemplo](#build-image-example)

## Sintaxis de la solicitud
<a name="build-image-request"></a>

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

## Cuerpo de la solicitud
<a name="build-image-request-body"></a>

**imageConfiguration**  
La configuración de la imagen como documento YAML.  
Tipo: cadena  
Obligatorio: sí

**imageId**  
El identificador de la imagen que desea crear.  
Tipo: cadena  
Obligatorio: sí

**dryrun**  
Si se establece en `true`, solo realiza la validación de la solicitud sin crear ningún recurso. Use este parámetro para validar la configuración de la imagen. El valor predeterminado es `false`.  
Tipo: booleano  
Obligatorio: no

**region**  
 Región de AWS En el que se ejecuta el comando para crear la imagen.  
Tipo: cadena  
Requerido: no

**rollbackOnFailure**  
Si se establece en `true`, se produce una reversión de la pila de imágenes si la imagen no se crea. El valor predeterminado es `false`.  
Tipo: booleano  
Obligatorio: no

**suppressValidators**  
Identifica uno o más validadores de configuración para suprimirlos.  
Tipo: lista de cadenas  
Formato: `(ALL|type:[A-Za-z0-9]+)`  
Obligatorio: no

**validationFailureLevel**  
El nivel mínimo de validación que provoca un error en la creación de la imagen. El valor predeterminado es `ERROR`.  
Tipo: cadena  
Valores válidos: `INFO | WARNING | ERROR`  
Obligatorio: no

## Sintaxis de la respuesta
<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"
    }
  ]
}
```

## Cuerpo de respuesta
<a name="build-image-response-body"></a>

**imagen**    
**imageId**  
El identificador de la imagen.  
Tipo: cadena  
**cloudformationStackArn**  
El nombre de recurso de Amazon (ARN) de la pila principal CloudFormation .  
Tipo: cadena  
**cloudformationStackStatus**  
El estado de la CloudFormation pila.  
Tipo: cadena  
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`  
**ec2 AmiInfo**    
**ami-id**  
El identificador de la EC2 AMI de Amazon.  
Tipo: cadena  
**imageBuildStatus**  
El estado de creación de la imagen.  
Tipo: cadena  
Valores válidos: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**region**  
El Región de AWS elemento en el que está construida la imagen.  
Tipo: cadena  
**versión**  
La AWS ParallelCluster versión que se utiliza para crear la imagen.  
Tipo: cadena

**validationMessages**  
Una lista de mensajes con un nivel de validación inferior a `validationFailureLevel`. La lista de mensajes se recopila durante la validación de la configuración.    
**id**  
El identificador del validador.  
Tipo: cadena  
**nivel**  
El nivel de validación.  
Tipo: cadena  
Valores válidos: `INFO | WARNING | ERROR`  
**message**  
Un mensaje de validación.  
Tipo: cadena  
**type**  
El tipo de validador.  
Tipo: cadena

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

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

**Solicitud**

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

**Respuesta 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"
  }
}
```

------