

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Crie uma AWS ParallelCluster imagem personalizada em um Região da AWS.

**Topics**
+ [Sintaxe da solicitação](#build-image-request)
+ [Corpo da solicitação](#build-image-request-body)
+ [Sintaxe da resposta](#build-image-response)
+ [Corpo da resposta](#build-image-response-body)
+ [Exemplo](#build-image-example)

## Sintaxe da solicitação
<a name="build-image-request"></a>

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

## Corpo da solicitação
<a name="build-image-request-body"></a>

**imageConfiguration**  
A configuração da imagem como um documento YAML.  
Tipo: string  
Obrigatório: Sim

**imageId**  
A ID da imagem a ser parada.  
Tipo: string  
Obrigatório: Sim

**dryrun**  
Se definido como `true`, executa somente a validação da solicitação, sem criar nenhum recurso. Use este parâmetro para validar a configuração da imagem. O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

**região**  
O Região da AWS em que você executa o comando para criar a imagem.  
Tipo: string  
Obrigatório: Não

**rollbackOnFailure**  
Se definido como `true`, ocorre reversão da pilha de imagens em caso de falha na criação da imagem. O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

**suppressValidators**  
Identifica um ou mais validadores de configuração a serem suprimidos.  
Tipo: lista de strings  
Formato: `(ALL|type:[A-Za-z0-9]+)`  
Obrigatório: Não

**validationFailureLevel**  
O nível mínimo de validação que faz com que a criação da imagem falhe. O padrão é `ERROR`.  
Tipo: string  
Valores válidos: `INFO | WARNING | ERROR`  
Obrigatório: Não

## Sintaxe da resposta
<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"
    }
  ]
}
```

## Corpo da resposta
<a name="build-image-response-body"></a>

**image**    
**imageId**  
O ID da imagem.  
Tipo: string  
**cloudformationStackArn**  
O Amazon Resource Name (ARN) da pilha principal CloudFormation .  
Tipo: string  
**cloudformationStackStatus**  
O status da CloudFormation pilha.  
Tipo: string  
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**  
O ID da Amazon EC2 AMI.  
Tipo: string  
**imageBuildStatus**  
O status de construção da imagem.  
Tipo: string  
Valores válidos: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**região**  
O Região da AWS em que a imagem é construída.  
Tipo: string  
**version**  
A AWS ParallelCluster versão usada para criar a imagem.  
Tipo: string

**validationMessages**  
Uma lista de mensagens com um nível de validação inferior a `validationFailureLevel`. A lista de mensagens é coletada durante a validação da configuração.    
**id**  
O ID do validador.  
Tipo: string  
**nível**  
O nível de validação.  
Tipo: string  
Valores válidos: `INFO | WARNING | ERROR`  
**message**  
Mensagem de validação.  
Tipo: string  
**type**  
O tipo de validador.  
Tipo: string

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

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

**Solicitação**

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

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

------