DescribeClusterCommand

Suggest an Edit

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SnowballClient, DescribeClusterCommand } from "@aws-sdk/client-snowball"; // ES Modules import
// const { SnowballClient, DescribeClusterCommand } = require("@aws-sdk/client-snowball"); // CommonJS import
const client = new SnowballClient(config);
const input = { // DescribeClusterRequest
  ClusterId: "STRING_VALUE", // required
};
const command = new DescribeClusterCommand(input);
const response = await client.send(command);
// { // DescribeClusterResult
//   ClusterMetadata: { // ClusterMetadata
//     ClusterId: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     KmsKeyARN: "STRING_VALUE",
//     RoleARN: "STRING_VALUE",
//     ClusterState: "AwaitingQuorum" || "Pending" || "InUse" || "Complete" || "Cancelled",
//     JobType: "IMPORT" || "EXPORT" || "LOCAL_USE",
//     SnowballType: "STANDARD" || "EDGE" || "EDGE_C" || "EDGE_CG" || "EDGE_S" || "SNC1_HDD" || "SNC1_SSD" || "V3_5C" || "V3_5S" || "RACK_5U_C",
//     CreationDate: new Date("TIMESTAMP"),
//     Resources: { // JobResource
//       S3Resources: [ // S3ResourceList
//         { // S3Resource
//           BucketArn: "STRING_VALUE",
//           KeyRange: { // KeyRange
//             BeginMarker: "STRING_VALUE",
//             EndMarker: "STRING_VALUE",
//           },
//           TargetOnDeviceServices: [ // TargetOnDeviceServiceList
//             { // TargetOnDeviceService
//               ServiceName: "NFS_ON_DEVICE_SERVICE" || "S3_ON_DEVICE_SERVICE",
//               TransferOption: "IMPORT" || "EXPORT" || "LOCAL_USE",
//             },
//           ],
//         },
//       ],
//       LambdaResources: [ // LambdaResourceList
//         { // LambdaResource
//           LambdaArn: "STRING_VALUE",
//           EventTriggers: [ // EventTriggerDefinitionList
//             { // EventTriggerDefinition
//               EventResourceARN: "STRING_VALUE",
//             },
//           ],
//         },
//       ],
//       Ec2AmiResources: [ // Ec2AmiResourceList
//         { // Ec2AmiResource
//           AmiId: "STRING_VALUE", // required
//           SnowballAmiId: "STRING_VALUE",
//         },
//       ],
//     },
//     AddressId: "STRING_VALUE",
//     ShippingOption: "SECOND_DAY" || "NEXT_DAY" || "EXPRESS" || "STANDARD",
//     Notification: { // Notification
//       SnsTopicARN: "STRING_VALUE",
//       JobStatesToNotify: [ // JobStateList
//         "New" || "PreparingAppliance" || "PreparingShipment" || "InTransitToCustomer" || "WithCustomer" || "InTransitToAWS" || "WithAWSSortingFacility" || "WithAWS" || "InProgress" || "Complete" || "Cancelled" || "Listing" || "Pending",
//       ],
//       NotifyAll: true || false,
//       DevicePickupSnsTopicARN: "STRING_VALUE",
//     },
//     ForwardingAddressId: "STRING_VALUE",
//     TaxDocuments: { // TaxDocuments
//       IND: { // INDTaxDocuments
//         GSTIN: "STRING_VALUE",
//       },
//     },
//     OnDeviceServiceConfiguration: { // OnDeviceServiceConfiguration
//       NFSOnDeviceService: { // NFSOnDeviceServiceConfiguration
//         StorageLimit: Number("int"),
//         StorageUnit: "TB",
//       },
//       TGWOnDeviceService: { // TGWOnDeviceServiceConfiguration
//         StorageLimit: Number("int"),
//         StorageUnit: "TB",
//       },
//       EKSOnDeviceService: { // EKSOnDeviceServiceConfiguration
//         KubernetesVersion: "STRING_VALUE",
//         EKSAnywhereVersion: "STRING_VALUE",
//       },
//       S3OnDeviceService: { // S3OnDeviceServiceConfiguration
//         StorageLimit: Number("double"),
//         StorageUnit: "TB",
//         ServiceSize: Number("int"),
//         FaultTolerance: Number("int"),
//       },
//     },
//   },
// };

DescribeClusterCommand Input

See DescribeClusterCommandInput for more details

Parameter
Type
Description
ClusterId
Required
string | undefined

The automatically generated ID for a cluster.

DescribeClusterCommand Output

See DescribeClusterCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ClusterMetadata
ClusterMetadata | undefined

Information about a specific cluster, including shipping information, cluster status, and other important metadata.

Throws

Name
Fault
Details
InvalidResourceException
client

The specified resource can't be found. Check the information you provided in your last request, and try again.

SnowballServiceException
Base exception class for all service exceptions from Snowball service.