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

# listImages
<a name="list-images"></a>

既存のカスタムイメージのリストを取得します。

**Topics**
+ [リクエスト構文](#list-images-request)
+ [リクエスト本文](#list-images-request-body)
+ [レスポンスの構文](#list-images-response)
+ [レスポンス本文](#list-images-response-body)
+ [例](#list-images-example)

## リクエスト構文
<a name="list-images-request"></a>

```
GET /images/custom
{
  "imageStatus": "string",
  "nextToken": "string",
  "region": "string"
}
```

## リクエスト本文
<a name="list-images-request-body"></a>

**imageStatus**  
指定されたステータスでイメージを絞り込みます。  
タイプ: 文字列  
有効な値: `AVAILABLE | PENDING | FAILED`  
必須: はい

**nextToken**  
次の結果セットのトークン。  
型: 文字列  
必須: いいえ

**region**  
イメージ AWS リージョン がある 。  
型: 文字列  
必須: いいえ

## レスポンスの構文
<a name="list-images-response"></a>

```
{
  "nextToken": "string",
  "images": [
    {
      "imageId": "string",
      "ec2AmiInfo": {
        "amiId": "string"
      },
      "region": "string",
      "version": "string",
      "cloudformationStackArn": "string",
      "imageBuildStatus": "BUILD_IN_PROGRESS",
      "cloudformationStackStatus": "CREATE_IN_PROGRESS"
    }
  ]
}
```

## レスポンス本文
<a name="list-images-response-body"></a>

**images**  
イメージのリスト。    
**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\$1id**  
Amazon EC2 AMI ID。  
タイプ: 文字列  
**imageBuildStatus**  
イメージビルドのステータス。  
有効な値: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
タイプ: 文字列  
**imageId**  
イメージの ID。  
タイプ: 文字列  
**region**  
イメージが作成される AWS リージョン 。  
タイプ: 文字列  
**version**  
イメージの構築に使用される AWS ParallelCluster バージョン。  
タイプ: 文字列

**nextToken**  
次の結果セットの取得に使用できるトークン、または追加の結果がない場合は `null` です。  
タイプ: 文字列

## 例
<a name="list-images-example"></a>

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

**リクエスト**

```
$ list_images("AVAILABLE")
```

**200 レスポンス**

```
{
  'images': [
    {
      'ec2_ami_info': {
        'ami_id': 'ami-abcdef01234567890'
      },
      'image_build_status': 'BUILD_COMPLETE',
      'image_id': 'custom-image',
      'region': 'us-east-1',
      'version': '3.2.1'
    }
  ]
}
```

------