Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListClusters

Important

End of support notice: On November 12, 2024, AWS will discontinue previous generation AWS Snowball devices, and both Snowcone devices (HDD and SDD). We will continue to support existing customers using these end-of-life devices until November 12, 2025. The latest generation AWS Snowball devices are available for all customers. For more information, visit this blog post.

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "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.

MaxResults

The number of ClusterListEntry objects to return.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

NextToken

HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Required: No

Response Syntax


{
   "ClusterListEntries": [ 
      { 
         "ClusterId": "string",
         "ClusterState": "string",
         "CreationDate": number,
         "Description": "string"
      }
   ],
   "NextToken": "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.

ClusterListEntries

Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

Type: Array of ClusterListEntry objects

NextToken

HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Errors

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

InvalidNextTokenException

Important

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

HTTP Status Code: 400