Skip to content

aws.snowball.describe_cluster

Example SQL Queries

SELECT * FROM
aws.snowball.describe_cluster
WHERE
"cluster_id" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
cluster_id Required Input Column

The automatically generated ID for a cluster.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
cluster_metadata

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

STRUCT(
"cluster_id" VARCHAR,
"description" VARCHAR,
"kms_key_arn" VARCHAR,
"role_arn" VARCHAR,
"cluster_state" VARCHAR,
"job_type" VARCHAR,
"snowball_type" VARCHAR,
"creation_date" TIMESTAMP_S,
"resources" STRUCT(
"s3_resources" STRUCT(
"bucket_arn" VARCHAR,
"key_range" STRUCT(
"begin_marker" VARCHAR,
"end_marker" VARCHAR
),
"target_on_device_services" STRUCT(
"service_name" VARCHAR,
"transfer_option" VARCHAR
)[]
)[],
"lambda_resources" STRUCT(
"lambda_arn" VARCHAR,
"event_triggers" STRUCT(
"event_resource_arn" VARCHAR
)[]
)[],
"ec2_ami_resources" STRUCT(
"ami_id" VARCHAR,
"snowball_ami_id" VARCHAR
)[]
),
"address_id" VARCHAR,
"shipping_option" VARCHAR,
"notification" STRUCT(
"sns_topic_arn" VARCHAR,
"job_states_to_notify" VARCHAR[],
"notify_all" BOOLEAN,
"device_pickup_sns_topic_arn" VARCHAR
),
"forwarding_address_id" VARCHAR,
"tax_documents" STRUCT(
"ind" STRUCT(
"gstin" VARCHAR
)
),
"on_device_service_configuration" STRUCT(
"nfs_on_device_service" STRUCT(
"storage_limit" BIGINT,
"storage_unit" VARCHAR
),
"tgw_on_device_service" STRUCT(
"storage_limit" BIGINT,
"storage_unit" VARCHAR
),
"eks_on_device_service" STRUCT(
"kubernetes_version" VARCHAR,
"eks_anywhere_version" VARCHAR
),
"s3_on_device_service" STRUCT(
"storage_limit" DOUBLE,
"storage_unit" VARCHAR,
"service_size" BIGINT,
"fault_tolerance" BIGINT
)
)
)
Show child fields
cluster_metadata.address_id

The automatically generated ID for a specific address.

cluster_metadata.cluster_id

The automatically generated ID for a cluster.

cluster_metadata.cluster_state

The current status of the cluster.

cluster_metadata.creation_date

The creation date for this cluster.

cluster_metadata.description

The optional description of the cluster.

cluster_metadata.forwarding_address_id

The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

cluster_metadata.job_type

The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

cluster_metadata.kms_key_arn

The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.

cluster_metadata.notification

The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

Show child fields
cluster_metadata.notification.device_pickup_sns_topic_arn

Used to send SNS notifications for the person picking up the device (identified during job creation).

cluster_metadata.notification.job_states_to_notify[]
cluster_metadata.notification.notify_all

Any change in job state will trigger a notification for this job.

cluster_metadata.notification.sns_topic_arn

The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.

You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.

cluster_metadata.on_device_service_configuration

Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

Show child fields
cluster_metadata.on_device_service_configuration.eks_on_device_service

The configuration of EKS Anywhere on the Snow Family device.

Show child fields
cluster_metadata.on_device_service_configuration.eks_on_device_service.eks_anywhere_version

The optional version of EKS Anywhere on the Snow Family device.

cluster_metadata.on_device_service_configuration.eks_on_device_service.kubernetes_version

The Kubernetes version for EKS Anywhere on the Snow Family device.

cluster_metadata.on_device_service_configuration.nfs_on_device_service

Represents the NFS (Network File System) service on a Snow Family device.

Show child fields
cluster_metadata.on_device_service_configuration.nfs_on_device_service.storage_limit

The maximum NFS storage for one Snow Family device.

cluster_metadata.on_device_service_configuration.nfs_on_device_service.storage_unit

The scale unit of the NFS storage on the device.

Valid values: TB.

cluster_metadata.on_device_service_configuration.s3_on_device_service

Configuration for Amazon S3 compatible storage on Snow family devices.

Show child fields
cluster_metadata.on_device_service_configuration.s3_on_device_service.fault_tolerance

>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

cluster_metadata.on_device_service_configuration.s3_on_device_service.service_size

Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

cluster_metadata.on_device_service_configuration.s3_on_device_service.storage_limit

If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

cluster_metadata.on_device_service_configuration.s3_on_device_service.storage_unit

Storage unit. Currently the only supported unit is TB.

cluster_metadata.on_device_service_configuration.tgw_on_device_service

Represents the Storage Gateway service Tape Gateway type on a Snow Family device.

Show child fields
cluster_metadata.on_device_service_configuration.tgw_on_device_service.storage_limit

The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

cluster_metadata.on_device_service_configuration.tgw_on_device_service.storage_unit

The scale unit of the virtual tapes on the device.

cluster_metadata.resources

The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

Show child fields
cluster_metadata.resources.ec2_ami_resources[]
Show child fields
cluster_metadata.resources.ec2_ami_resources[].ami_id

The ID of the AMI in Amazon EC2.

cluster_metadata.resources.ec2_ami_resources[].snowball_ami_id

The ID of the AMI on the Snow device.

cluster_metadata.resources.lambda_resources[]
Show child fields
cluster_metadata.resources.lambda_resources[].event_triggers[]
Show child fields
cluster_metadata.resources.lambda_resources[].event_triggers[].event_resource_arn

The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.

cluster_metadata.resources.lambda_resources[].lambda_arn

An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.

cluster_metadata.resources.s3_resources[]
Show child fields
cluster_metadata.resources.s3_resources[].bucket_arn

The Amazon Resource Name (ARN) of an Amazon S3 bucket.

cluster_metadata.resources.s3_resources[].key_range

For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

Show child fields
cluster_metadata.resources.s3_resources[].key_range.begin_marker

The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

cluster_metadata.resources.s3_resources[].key_range.end_marker

The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

cluster_metadata.resources.s3_resources[].target_on_device_services[]
Show child fields
cluster_metadata.resources.s3_resources[].target_on_device_services[].service_name

Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.

cluster_metadata.resources.s3_resources[].target_on_device_services[].transfer_option

Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.

cluster_metadata.role_arn

The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).

cluster_metadata.shipping_option

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snow devices are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

cluster_metadata.snowball_type

The type of Snowcone device to use for this cluster.

For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

cluster_metadata.tax_documents

The tax documents required in your Amazon Web Services Region.

Show child fields
cluster_metadata.tax_documents.ind

The tax documents required in Amazon Web Services Region in India.

Show child fields
cluster_metadata.tax_documents.ind.gstin

The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.