ClusterListEntry
Note
Effective November 7, 2025, AWS Snowball Edge will only be available to existing customers. If you would like to use AWS Snowball Edge, sign up prior to that date. New customers should explore AWS DataSync
Contains a cluster's state, a cluster's ID, and other important information.
Contents
- ClusterId
-
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- ClusterState
-
The current state of this cluster. For information about the state of a specific node, see JobListEntry:JobState.
Type: String
Valid Values:
AwaitingQuorum | Pending | InUse | Complete | CancelledRequired: No
- CreationDate
-
The creation date for this cluster.
Type: Timestamp
Required: No
- Description
-
Defines an optional description of the cluster, for example
Environmental Data Cluster-01.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: