getClusterStackEvents
Retrieve the events that are associated with the stack for a cluster.
Note
Starting in version 3.6.0, Amazon ParallelCluster uses nested stacks to create the resources associated with queues and compute resources. The
GetClusterStackEvents API and the pcluster get-cluster-stack-events command only return the cluster main stack events.
You can view the cluster stack events, including those related to queues and compute resources, in the CloudFormation console.
Request syntax
GET /v3/clusters/{clusterName}/stackevents { "nextToken": "string", "region": "string" }
Request body
- clusterName
-
The name of the cluster.
Type: string
Required: Yes
- nextToken
-
A token that's used for paginated requests.
Type: string
Required: No
- region
-
The Amazon Web Services Region that the cluster is in.
Type: string
Required: No
Response syntax
{ "nextToken": "string", "events": [ { "stackId": "string", "eventId": "string", "stackName": "string", "logicalResourceId": "string", "physicalResourceId": "string", "resourceType": "string", "timestamp": "2019-08-24T14:15:22Z", "resourceStatus": "CREATE_IN_PROGRESS", "resourceStatusReason": "string", "resourceProperties": "string", "clientRequestToken": "string" } ] }
Response body
- events
-
List of filtered events.
- clientRequestToken
-
The token passed to the action that generated this event.
Type: string
- eventId
-
The unique ID of this event.
Type: string
- logicalResourceId
-
The logical name of the resource specified in the template.
Type: string
- physicalResourceId
-
The name or unique identifier that's associated with the physical instance of the resource.
Type: string
- resourceProperties
-
A BLOB of the properties that are used to create the resource.
Type: string
- resourceStatus
-
The resource status.
Type: string
Valid values:
CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE | IMPORT_FAILED | IMPORT_COMPLETE | IMPORT_IN_PROGRESS | IMPORT_ROLLBACK_IN_PROGRESS | IMPORT_ROLLBACK_FAILED | IMPORT_ROLLBACK_COMPLETE - resourceStatusReason
-
A success or failure message that's associated with the resource.
Type: string
- resourceType
-
The type of resource.
Type: string
- stackId
-
The unique ID name of the instance of the stack.
Type: string
- stackName
-
The name that's associated with a stack.
Type: string
- timestamp
-
The time when the status was updated.
Type: datetime
- nextToken
-
A token that's used for paginated requests.
Type: string