本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

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

在 中建立自訂 AWS ParallelCluster 映像 AWS 區域。

**Topics**
+ [請求語法](#build-image-request)
+ [請求內文](#build-image-request-body)
+ [回應語法](#build-image-response)
+ [回應內文](#build-image-response-body)
+ [範例](#build-image-example)

## 請求語法
<a name="build-image-request"></a>

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

## 請求內文
<a name="build-image-request-body"></a>

**imageConfiguration**  
影像組態做為 YAML 文件。  
類型：字串  
必要：是

**imageId**  
要建置之映像的 ID。  
類型：字串  
必要：是

**dryrun**  
如果設定為 `true`，則只執行請求驗證，而不建立任何資源。使用此參數來驗證映像組態。預設值為 `false`。  
類型：布林值  
必要：否

**region**  
您在 AWS 區域 其中執行 命令以建置映像的 。  
類型：字串  
必要：否

**rollbackOnFailure**  
如果設定為 `true`，則映像堆疊復原會在映像無法建立時發生。預設值為 `false`。  
類型：布林值  
必要：否

**suppressValidators**  
識別要隱藏的一或多個組態驗證程式。  
類型：字串清單  
格式：`(ALL|type:[A-Za-z0-9]+)`  
必要：否

**validationFailureLevel**  
導致映像建置失敗的最低驗證層級。預設值為 `ERROR`。  
類型：字串  
有效值：`INFO | WARNING | ERROR`  
必要：否

## 回應語法
<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"
    }
  ]
}
```

## 回應內文
<a name="build-image-response-body"></a>

**image**    
**imageId**  
影像的 ID。  
類型：字串  
**cloudformationStackArn**  
主要 CloudFormation 堆疊的 Amazon Resource Name (ARN)。  
類型：字串  
**cloudformationStackStatus**  
CloudFormation 堆疊狀態。  
類型：字串  
有效值：`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`  
**ec2AmiInfo**    
**ami\_id**  
Amazon EC2 AMI ID。  
類型：字串  
**imageBuildStatus**  
映像建置狀態。  
類型：字串  
有效值：`BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**region**  
建置映像 AWS 區域 的 。  
類型：字串  
**version**  
用來建置映像的 AWS ParallelCluster 版本。  
類型：字串

**validationMessages**  
驗證層級低於 的訊息清單`validationFailureLevel`。訊息清單會在組態驗證期間收集。    
**id**  
驗證器 ID。  
類型：字串  
**level**  
驗證層級。  
類型：字串  
有效值：`INFO | WARNING | ERROR`  
**message**  
驗證訊息。  
類型：字串  
**type**  
驗證器的類型。  
類型：字串

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

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

**請求**

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

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

------