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

# 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 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`  
類型：字串  
**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'
    }
  ]
}
```

------