

# `pcluster list-images`
<a name="pcluster.list-images-v3"></a>

Retrieve the list of existing custom images.

```
pcluster list-images [-h] 
                 --image-status {AVAILABLE,PENDING,FAILED}
                [--debug]
                [--next-token NEXT_TOKEN]
                [--query QUERY]
                [--region REGION]
```

## Named arguments
<a name="pcluster-v3.list-images.namedargs"></a>

**-h, --help**  
Shows the help text for `pcluster list-images`.

**--image-status \$1`AVAILABLE`,`PENDING`,`FAILED`\$1**  
Filter returned images by the status provided.

**--debug**  
Enables debug logging.

**--next-token *NEXT\$1TOKEN***  
The token for the next set of results.

**--query *QUERY***  
Specifies the JMESPath query to perform on the output.

**--region, -r *REGION***  
Specifies the AWS Region to use. The AWS Region must be specified, using the `AWS_DEFAULT_REGION` environment variable, the `region` setting in the `[default]` section of the `~/.aws/config` file, or the `--region` parameter.

**Example using AWS ParallelCluster version 3.1.2:**

```
$ pcluster list-images --image-status AVAILABLE
{
  "images": [
    {
      "imageId": "custom-alinux2-image",
      "imageBuildStatus": "BUILD_COMPLETE",
      "ec2AmiInfo": {
        "amiId": "ami-1234abcd5678efgh"
      },
      "region": "us-east-1",
      "version": "3.1.2"
    }
  ]
}
```