翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 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**  
抑制する 1 つまたは複数の設定バリデータを指定します。  
タイプ: 文字列のリスト  
形式: `(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>

**画像**    
**imageId**  
イメージの ID。  
タイプ: 文字列  
**cloudformationStackArn**  
メイン CloudFormation スタックの Amazon リソースネーム (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"
  }
}
```

------