Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListClusters

Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.

Request Syntax


{
   "ClusterStates": [ "string" ],
   "CreatedAfter": number,
   "CreatedBefore": number,
   "Marker": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClusterStates

The cluster state filters to apply when listing clusters. Clusters that change state while this action runs may be not be returned as expected in the list of clusters.

Type: Array of strings

Required: No

CreatedAfter

The creation date and time beginning value filter for listing clusters.

Type: Timestamp

Required: No

CreatedBefore

The creation date and time end value filter for listing clusters.

Type: Timestamp

Required: No

Marker

The pagination token that indicates the next set of results to retrieve.

Type: String

Required: No

Response Syntax


{
   "Clusters": [ 
      { 
         "ClusterArn": "string",
         "Id": "string",
         "Name": "string",
         "NormalizedInstanceHours": number,
         "OutpostArn": "string",
         "Status": { 
            "ErrorDetails": [ 
               { 
                  "ErrorCode": "string",
                  "ErrorData": [ 
                     { 
                        "string" : "string" 
                     }
                  ],
                  "ErrorMessage": "string"
               }
            ],
            "State": "string",
            "StateChangeReason": { 
               "Code": "string",
               "Message": "string"
            },
            "Timeline": { 
               "CreationDateTime": number,
               "EndDateTime": number,
               "ReadyDateTime": number
            }
         }
      }
   ],
   "Marker": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Clusters

The list of clusters for the account based on the given filters.

Type: Array of ClusterSummary objects

Marker

The pagination token that indicates the next set of results to retrieve.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500

InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400