

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

# イメージの API オペレーション
<a name="pc-py-lib-api-image"></a>

**Topics**
+ [`list_images`](pc-py-lib-api-image-list.md)
+ [`build_image`](pc-py-lib-api-image-build.md)
+ [`delete_image`](pc-py-lib-api-image-delete.md)
+ [`describe_image`](pc-py-lib-api-image-describe.md)

# `list_images`
<a name="pc-py-lib-api-image-list"></a>

```
list_images(image_status, region, next_token)
```

既存のイメージのリストを取得します。パラメータ :

**`image_status` (必須)**  
イメージのステータスでフィルタリングします。  
有効な値: `AVAILABLE` \$1 `PENDING` \$1 `FAILED`

**`region`**  
特定の AWS リージョンにビルドされているイメージを一覧表示します。

**`next_token`**  
次の結果セットのトークン。

# `build_image`
<a name="pc-py-lib-api-image-build"></a>

```
build_image(image_configuration, image_id, suppress_validators, validation_failure_level, dry_run, rollback_on_failure, region)
```

特定のリージョンにカスタム AWS ParallelCluster イメージを作成します。パラメータ :

**`image_configuration` (必須)**  
Python データとしてのイメージ設定。

**`image_id` (必須)**  
イメージ ID。

**`suppress_validators`**  
抑制する 1 つまたは複数のイメージ設定バリデータを指定します。  
形式: `(ALL | type:[A-Za-z0-9]+)`

**`validation_failure_level`**  
イメージ作成が失敗する最小の検証レベル。デフォルトは `ERROR` です。  
有効な値: `INFO` \$1 `WARNING` \$1 `ERROR`

**`dry_run`**  
に設定すると`True`、 はリソースを作成せずにリクエストの検証 AWS ParallelCluster を実行します。イメージの設定を検証するために使用することができます。デフォルトは `False` です。

**`rollback_on_failure`**  
に設定すると`True`、障害発生時にイメージスタックのロールバック AWS ParallelCluster が自動的に開始されます。デフォルトは `False` です。

**`region`**  
 AWS リージョンイメージ。

# `delete_image`
<a name="pc-py-lib-api-image-delete"></a>

```
delete_image(image_id, region, force)
```

特定のリージョンのイメージを削除します。パラメータ :

**`image_id` (必須)**  
イメージ ID。

**`region`**  
 AWS リージョンイメージ。

**`force`**  
に設定すると`True`、インスタンスが AMI を使用している場合、または AMI が共有されている場合、 は AWS ParallelCluster 強制的に削除します。デフォルトは `False` です。

# `describe_image`
<a name="pc-py-lib-api-image-describe"></a>

```
describe_image(image_id, region)
```

既存のイメージの詳細情報を取得します。パラメータ :

**`image_id` (必須)**  
イメージ ID。

**`region`**  
 AWS リージョンイメージ。