Retrieve the list of existing custom images.
Request syntax
GET /images/custom
{
"imageStatus": "string",
"nextToken": "string",
"region": "string"
}Request body
- imageStatus
-
Filter images by the status provided.
Type: string
Valid values:
AVAILABLE | PENDING | FAILEDRequired: Yes
- nextToken
-
The token for the next set of results.
Type: string
Required: No
- region
-
The AWS Region that images are in.
Type: string
Required: No
Response syntax
{
"nextToken": "string",
"images": [
{
"imageId": "string",
"ec2AmiInfo": {
"amiId": "string"
},
"region": "string",
"version": "string",
"cloudformationStackArn": "string",
"imageBuildStatus": "BUILD_IN_PROGRESS",
"cloudformationStackStatus": "CREATE_IN_PROGRESS"
}
]
}Response body
- images
-
A list of images.
- cloudformationStackArn
-
The Amazon Resource Name (ARN) of the main CloudFormation stack.
Type: string
- cloudformationStackStatus
-
The CloudFormation stack status.
Type: string
Valid values:
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
-
The Amazon EC2 AMI ID.
Type: string
- imageBuildStatus
-
The image build status.
Valid values:
BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETEType: string
- imageId
-
The ID of the image.
Type: string
- region
-
The AWS Region in which the image is created.
Type: string
- version
-
The AWS ParallelCluster version that's used to build the image.
Type: string
- nextToken
-
A token that can be used to retrieve the next set of results, or
nullif there are no additional results.Type: string
Example
Request
$list_images("AVAILABLE")
200 Response
{
'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'
}
]
}