types

package
v1.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 18, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

type Address struct {

	// The unique ID for an address.
	AddressId *string

	// The city in an address that a Snow device is to be delivered to.
	City *string

	// The name of the company to receive a Snow device at an address.
	Company *string

	// The country in an address that a Snow device is to be delivered to.
	Country *string

	// If the address you are creating is a primary address, then set this option to
	// true. This field is not supported in most regions.
	IsRestricted bool

	// This field is no longer used and the value is ignored.
	Landmark *string

	// The name of a person to receive a Snow device at an address.
	Name *string

	// The phone number associated with an address that a Snow device is to be
	// delivered to.
	PhoneNumber *string

	// The postal code in an address that a Snow device is to be delivered to.
	PostalCode *string

	// This field is no longer used and the value is ignored.
	PrefectureOrDistrict *string

	// The state or province in an address that a Snow device is to be delivered to.
	StateOrProvince *string

	// The first line in a street address that a Snow device is to be delivered to.
	Street1 *string

	// The second line in a street address that a Snow device is to be delivered to.
	Street2 *string

	// The third line in a street address that a Snow device is to be delivered to.
	Street3 *string

	// Differentiates between delivery address and pickup address in the customer
	// account. Provided at job creation.
	Type AddressType
	// contains filtered or unexported fields
}

The address that you want the Snow device(s) associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown.

type AddressType added in v1.20.0 

type AddressType string
const (
	AddressTypeCustPickup AddressType = "CUST_PICKUP"
	AddressTypeAwsShip    AddressType = "AWS_SHIP"
)

Enum values for AddressType

func (AddressType) Values added in v1.20.0 

func (AddressType) Values() []AddressType

Values returns all known values for AddressType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ClusterLimitExceededException 

type ClusterLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.

func (*ClusterLimitExceededException) Error 

func (e *ClusterLimitExceededException) Error() string

func (*ClusterLimitExceededException) ErrorCode 

func (e *ClusterLimitExceededException) ErrorCode() string

func (*ClusterLimitExceededException) ErrorFault 

func (e *ClusterLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ClusterLimitExceededException) ErrorMessage 

func (e *ClusterLimitExceededException) ErrorMessage() string

type ClusterListEntry 

type ClusterListEntry struct {

	// The 39-character ID for the cluster that you want to list, for example
	// CID123e4567-e89b-12d3-a456-426655440000 .
	ClusterId *string

	// The current state of this cluster. For information about the state of a
	// specific node, see JobListEntry$JobState.
	ClusterState ClusterState

	// The creation date for this cluster.
	CreationDate *time.Time

	// Defines an optional description of the cluster, for example Environmental Data
	// Cluster-01 .
	Description *string
	// contains filtered or unexported fields
}

Contains a cluster's state, a cluster's ID, and other important information.

type ClusterMetadata 

type ClusterMetadata struct {

	// The automatically generated ID for a specific address.
	AddressId *string

	// The automatically generated ID for a cluster.
	ClusterId *string

	// The current status of the cluster.
	ClusterState ClusterState

	// The creation date for this cluster.
	CreationDate *time.Time

	// The optional description of the cluster.
	Description *string

	// 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.
	ForwardingAddressId *string

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

	// The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN
	// was created using the [CreateKey]API action in Key Management Service (KMS.
	//
	// [CreateKey]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
	KmsKeyARN *string

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

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

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

	// The role ARN associated with this cluster. This ARN was created using the [CreateRole] API
	// action in Identity and Access Management (IAM).
	//
	// [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
	RoleARN *string

	// 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.
	ShippingOption ShippingOption

	// 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.
	SnowballType SnowballType

	// The tax documents required in your Amazon Web Services Region.
	TaxDocuments *TaxDocuments
	// contains filtered or unexported fields
}

Contains metadata about a specific cluster.

type ClusterState 

type ClusterState string
const (
	ClusterStateAwaitingQuorum ClusterState = "AwaitingQuorum"
	ClusterStatePending        ClusterState = "Pending"
	ClusterStateInUse          ClusterState = "InUse"
	ClusterStateComplete       ClusterState = "Complete"
	ClusterStateCancelled      ClusterState = "Cancelled"
)

Enum values for ClusterState

func (ClusterState) Values added in v0.29.0 

func (ClusterState) Values() []ClusterState

Values returns all known values for ClusterState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CompatibleImage 

type CompatibleImage struct {

	// The unique identifier for an individual Snow device AMI.
	AmiId *string

	// The optional name of a compatible image.
	Name *string
	// contains filtered or unexported fields
}

A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), including the ID and name for a Snow device AMI. This AMI is compatible with the device's physical hardware requirements, and it should be able to be run in an SBE1 instance on the device.

type ConflictException added in v0.29.0 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ConflictResource *string
	// contains filtered or unexported fields
}

You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.

func (*ConflictException) Error added in v0.29.0 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v0.29.0 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v0.29.0 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage added in v0.29.0 

func (e *ConflictException) ErrorMessage() string

type DataTransfer 

type DataTransfer struct {

	// The number of bytes transferred between a Snow device and Amazon S3.
	BytesTransferred int64

	// The number of objects transferred between a Snow device and Amazon S3.
	ObjectsTransferred int64

	// The total bytes of data for a transfer between a Snow device and Amazon S3.
	// This value is set to 0 (zero) until all the keys that will be transferred have
	// been listed.
	TotalBytes int64

	// The total number of objects for a transfer between a Snow device and Amazon S3.
	// This value is set to 0 (zero) until all the keys that will be transferred have
	// been listed.
	TotalObjects int64
	// contains filtered or unexported fields
}

Defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. This data is only available while a job has a JobState value of InProgress , for both import and export jobs.

type DependentService added in v1.18.0 

type DependentService struct {

	// The name of the dependent service.
	ServiceName ServiceName

	// The version of the dependent service.
	ServiceVersion *ServiceVersion
	// contains filtered or unexported fields
}

The name and version of the service dependant on the requested service.

type DeviceConfiguration 

type DeviceConfiguration struct {

	// Returns information about the device configuration for an Snowcone job.
	SnowconeDeviceConfiguration *SnowconeDeviceConfiguration
	// contains filtered or unexported fields
}

The container for SnowconeDeviceConfiguration .

type DeviceServiceName added in v1.5.0 

type DeviceServiceName string
const (
	DeviceServiceNameNfsOnDeviceService DeviceServiceName = "NFS_ON_DEVICE_SERVICE"
	DeviceServiceNameS3OnDeviceService  DeviceServiceName = "S3_ON_DEVICE_SERVICE"
)

Enum values for DeviceServiceName

func (DeviceServiceName) Values added in v1.5.0 

func (DeviceServiceName) Values() []DeviceServiceName

Values returns all known values for DeviceServiceName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EKSOnDeviceServiceConfiguration added in v1.18.0 

type EKSOnDeviceServiceConfiguration struct {

	// The optional version of EKS Anywhere on the Snow Family device.
	EKSAnywhereVersion *string

	// The Kubernetes version for EKS Anywhere on the Snow Family device.
	KubernetesVersion *string
	// contains filtered or unexported fields
}

An object representing the metadata and configuration settings of EKS Anywhere on the Snow Family device.

type Ec2AmiResource 

type Ec2AmiResource struct {

	// The ID of the AMI in Amazon EC2.
	//
	// This member is required.
	AmiId *string

	// The ID of the AMI on the Snow device.
	SnowballAmiId *string
	// contains filtered or unexported fields
}

A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2-compatible AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.

type Ec2RequestFailedException 

type Ec2RequestFailedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

func (*Ec2RequestFailedException) Error 

func (e *Ec2RequestFailedException) Error() string

func (*Ec2RequestFailedException) ErrorCode 

func (e *Ec2RequestFailedException) ErrorCode() string

func (*Ec2RequestFailedException) ErrorFault 

func (e *Ec2RequestFailedException) ErrorFault() smithy.ErrorFault

func (*Ec2RequestFailedException) ErrorMessage 

func (e *Ec2RequestFailedException) ErrorMessage() string

type EventTriggerDefinition 

type EventTriggerDefinition struct {

	// The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an
	// Lambda function's event trigger associated with this job.
	EventResourceARN *string
	// contains filtered or unexported fields
}

The container for the EventTriggerDefinition$EventResourceARN.

type INDTaxDocuments 

type INDTaxDocuments struct {

	// The Goods and Services Tax (GST) documents required in Amazon Web Services
	// Region in India.
	GSTIN *string
	// contains filtered or unexported fields
}

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

type ImpactLevel added in v1.20.0 

type ImpactLevel string
const (
	ImpactLevelIl2  ImpactLevel = "IL2"
	ImpactLevelIl4  ImpactLevel = "IL4"
	ImpactLevelIl5  ImpactLevel = "IL5"
	ImpactLevelIl6  ImpactLevel = "IL6"
	ImpactLevelIl99 ImpactLevel = "IL99"
)

Enum values for ImpactLevel

func (ImpactLevel) Values added in v1.20.0 

func (ImpactLevel) Values() []ImpactLevel

Values returns all known values for ImpactLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InvalidAddressException 

type InvalidAddressException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The address provided was invalid. Check the address with your region's carrier, and try again.

func (*InvalidAddressException) Error 

func (e *InvalidAddressException) Error() string

func (*InvalidAddressException) ErrorCode 

func (e *InvalidAddressException) ErrorCode() string

func (*InvalidAddressException) ErrorFault 

func (e *InvalidAddressException) ErrorFault() smithy.ErrorFault

func (*InvalidAddressException) ErrorMessage 

func (e *InvalidAddressException) ErrorMessage() string

type InvalidInputCombinationException 

type InvalidInputCombinationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballTypevalue supports your CreateJobRequest$JobType, and try again.

func (*InvalidInputCombinationException) Error 

func (e *InvalidInputCombinationException) Error() string

func (*InvalidInputCombinationException) ErrorCode 

func (e *InvalidInputCombinationException) ErrorCode() string

func (*InvalidInputCombinationException) ErrorFault 

func (e *InvalidInputCombinationException) ErrorFault() smithy.ErrorFault

func (*InvalidInputCombinationException) ErrorMessage 

func (e *InvalidInputCombinationException) ErrorMessage() string

type InvalidJobStateException 

type InvalidJobStateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The action can't be performed because the job's current state doesn't allow that action to be performed.

func (*InvalidJobStateException) Error 

func (e *InvalidJobStateException) Error() string

func (*InvalidJobStateException) ErrorCode 

func (e *InvalidJobStateException) ErrorCode() string

func (*InvalidJobStateException) ErrorFault 

func (e *InvalidJobStateException) ErrorFault() smithy.ErrorFault

func (*InvalidJobStateException) ErrorMessage 

func (e *InvalidJobStateException) ErrorMessage() string

type InvalidNextTokenException 

type InvalidNextTokenException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*InvalidNextTokenException) Error 

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode 

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault 

func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidNextTokenException) ErrorMessage 

func (e *InvalidNextTokenException) ErrorMessage() string

type InvalidResourceException 

type InvalidResourceException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType *string
	// contains filtered or unexported fields
}

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

func (*InvalidResourceException) Error 

func (e *InvalidResourceException) Error() string

func (*InvalidResourceException) ErrorCode 

func (e *InvalidResourceException) ErrorCode() string

func (*InvalidResourceException) ErrorFault 

func (e *InvalidResourceException) ErrorFault() smithy.ErrorFault

func (*InvalidResourceException) ErrorMessage 

func (e *InvalidResourceException) ErrorMessage() string

type JobListEntry 

type JobListEntry struct {

	// The creation date for this job.
	CreationDate *time.Time

	// The optional description of this specific job, for example Important Photos
	// 2016-08-11 .
	Description *string

	// A value that indicates that this job is a main job. A main job represents a
	// successful request to create an export job. Main jobs aren't associated with any
	// Snowballs. Instead, each main job will have at least one job part, and each job
	// part is associated with a Snowball. It might take some time before the job parts
	// associated with a particular main job are listed, because they are created after
	// the main job is created.
	IsMaster bool

	// The automatically generated ID for a job, for example
	// JID123e4567-e89b-12d3-a456-426655440000 .
	JobId *string

	// The current state of this job.
	JobState JobState

	// The type of job.
	JobType JobType

	// The type of device used with this job.
	SnowballType SnowballType
	// contains filtered or unexported fields
}

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of an export job.

type JobLogs 

type JobLogs struct {

	// A link to an Amazon S3 presigned URL where the job completion report is located.
	JobCompletionReportURI *string

	// A link to an Amazon S3 presigned URL where the job failure log is located.
	JobFailureLogURI *string

	// A link to an Amazon S3 presigned URL where the job success log is located.
	JobSuccessLogURI *string
	// contains filtered or unexported fields
}

Contains job logs. Whenever a Snow device is used to import data into or export data out of Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type. The job logs can be accessed for up to 60 minutes after this request has been made. To access any of the job logs after 60 minutes have passed, you'll have to make another call to the DescribeJob action.

For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.

The job report provides you insight into the state of your Amazon S3 data transfer. The report includes details about your job or job part for your records.

For deeper visibility into the status of your transferred objects, you can look at the two associated logs: a success log and a failure log. The logs are saved in comma-separated value (CSV) format, and the name of each log includes the ID of the job or job part that the log describes.

type JobMetadata 

type JobMetadata struct {

	// The ID for the address that you want the Snow device shipped to.
	AddressId *string

	// The 39-character ID for the cluster, for example
	// CID123e4567-e89b-12d3-a456-426655440000 .
	ClusterId *string

	// The creation date for this job.
	CreationDate *time.Time

	// A value that defines the real-time status of a Snow device's data transfer
	// while the device is at Amazon Web Services. This data is only available while a
	// job has a JobState value of InProgress , for both import and export jobs.
	DataTransferProgress *DataTransfer

	// The description of the job, provided at job creation.
	Description *string

	// The container for SnowconeDeviceConfiguration .
	DeviceConfiguration *DeviceConfiguration

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

	// The highest impact level of data that will be stored or processed on the
	// device, provided at job creation.
	ImpactLevel ImpactLevel

	// The automatically generated ID for a job, for example
	// JID123e4567-e89b-12d3-a456-426655440000 .
	JobId *string

	// Links to Amazon S3 presigned URLs for the job report and logs. For import jobs,
	// the PDF job report becomes available at the end of the import process. For
	// export jobs, your job report typically becomes available while the Snow device
	// for your job part is being delivered to you.
	JobLogInfo *JobLogs

	// The current status of the jobs.
	JobState JobState

	// The type of job.
	JobType JobType

	// The Amazon Resource Name (ARN) for the Key Management Service (KMS) key
	// associated with this job. This ARN was created using the [CreateKey]API action in KMS.
	//
	// [CreateKey]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
	KmsKeyARN *string

	// The ID of the long-term pricing type for the device.
	LongTermPricingId *string

	// The Amazon Simple Notification Service (Amazon SNS) notification settings
	// associated with a specific job. The Notification object is returned as a part
	// of the response syntax of the DescribeJob action in the JobMetadata data type.
	Notification *Notification

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

	// Information identifying the person picking up the device.
	PickupDetails *PickupDetails

	// Allows you to securely operate and manage Snowcone devices remotely from
	// outside of your internal network. When set to INSTALLED_AUTOSTART , remote
	// management will automatically be available when the device arrives at your
	// location. Otherwise, you need to use the Snowball Client to manage the device.
	RemoteManagement RemoteManagement

	// An array of S3Resource objects. Each S3Resource object represents an Amazon S3
	// bucket that your transferred data will be exported from or imported into.
	Resources *JobResource

	// The role ARN associated with this job. This ARN was created using the [CreateRole] API
	// action in Identity and Access Management.
	//
	// [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
	RoleARN *string

	// A job's shipping information, including inbound and outbound tracking numbers
	// and shipping speed options.
	ShippingDetails *ShippingDetails

	// The Snow device capacity preference for this job, specified at job creation. In
	// US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions
	// use 80 TB capacity Snowballs.
	//
	// For more information, see
	// "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
	// (Snow Family Devices and Capacity) in the Snowcone User Guide or
	// "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html"
	// (Snow Family Devices and Capacity) in the Snowcone User Guide.
	SnowballCapacityPreference SnowballCapacity

	// Unique ID associated with a device.
	SnowballId *string

	// The type of device used with this job.
	SnowballType SnowballType

	// The metadata associated with the tax documents required in your Amazon Web
	// Services Region.
	TaxDocuments *TaxDocuments
	// contains filtered or unexported fields
}

Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the DescribeJob action.

type JobResource 

type JobResource struct {

	// The Amazon Machine Images (AMIs) associated with this job.
	Ec2AmiResources []Ec2AmiResource

	// The Python-language Lambda functions for this job.
	LambdaResources []LambdaResource

	// An array of S3Resource objects.
	S3Resources []S3Resource
	// contains filtered or unexported fields
}

Contains an array of Amazon Web Services resource objects. Each object represents an Amazon S3 bucket, an Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job.

type JobState 

type JobState string
const (
	JobStateNew                    JobState = "New"
	JobStatePreparingAppliance     JobState = "PreparingAppliance"
	JobStatePreparingShipment      JobState = "PreparingShipment"
	JobStateInTransitToCustomer    JobState = "InTransitToCustomer"
	JobStateWithCustomer           JobState = "WithCustomer"
	JobStateInTransitToAws         JobState = "InTransitToAWS"
	JobStateWithAwsSortingFacility JobState = "WithAWSSortingFacility"
	JobStateWithAws                JobState = "WithAWS"
	JobStateInProgress             JobState = "InProgress"
	JobStateComplete               JobState = "Complete"
	JobStateCancelled              JobState = "Cancelled"
	JobStateListing                JobState = "Listing"
	JobStatePending                JobState = "Pending"
)

Enum values for JobState

func (JobState) Values added in v0.29.0 

func (JobState) Values() []JobState

Values returns all known values for JobState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobType 

type JobType string
const (
	JobTypeImport   JobType = "IMPORT"
	JobTypeExport   JobType = "EXPORT"
	JobTypeLocalUse JobType = "LOCAL_USE"
)

Enum values for JobType

func (JobType) Values added in v0.29.0 

func (JobType) Values() []JobType

Values returns all known values for JobType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KMSRequestFailedException 

type KMSRequestFailedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The provided Key Management Service key lacks the permissions to perform the specified CreateJobor UpdateJob action.

func (*KMSRequestFailedException) Error 

func (e *KMSRequestFailedException) Error() string

func (*KMSRequestFailedException) ErrorCode 

func (e *KMSRequestFailedException) ErrorCode() string

func (*KMSRequestFailedException) ErrorFault 

func (e *KMSRequestFailedException) ErrorFault() smithy.ErrorFault

func (*KMSRequestFailedException) ErrorMessage 

func (e *KMSRequestFailedException) ErrorMessage() string

type KeyRange 

type KeyRange struct {

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

	// The key that ends an optional key range for an export job. Ranges are inclusive
	// and UTF-8 binary sorted.
	EndMarker *string
	// contains filtered or unexported fields
}

Contains a key range. For export jobs, a S3Resource object can have an optional KeyRange value. 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.

type LambdaResource 

type LambdaResource struct {

	// The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
	EventTriggers []EventTriggerDefinition

	// An Amazon Resource Name (ARN) that represents an Lambda function to be
	// triggered by PUT object actions on the associated local Amazon S3 resource.
	LambdaArn *string
	// contains filtered or unexported fields
}

Identifies

type LongTermPricingListEntry added in v1.3.0 

type LongTermPricingListEntry struct {

	// The current active jobs on the device the long-term pricing type.
	CurrentActiveJob *string

	// If set to true , specifies that the current long-term pricing type for the
	// device should be automatically renewed before the long-term pricing contract
	// expires.
	IsLongTermPricingAutoRenew *bool

	// The IDs of the jobs that are associated with a long-term pricing type.
	JobIds []string

	// The end date the long-term pricing contract.
	LongTermPricingEndDate *time.Time

	// The ID of the long-term pricing type for the device.
	LongTermPricingId *string

	// The start date of the long-term pricing contract.
	LongTermPricingStartDate *time.Time

	// The status of the long-term pricing type.
	LongTermPricingStatus *string

	// The type of long-term pricing that was selected for the device.
	LongTermPricingType LongTermPricingType

	// A new device that replaces a device that is ordered with long-term pricing.
	ReplacementJob *string

	// The type of Snow Family devices associated with this long-term pricing job.
	SnowballType SnowballType
	// contains filtered or unexported fields
}

Each LongTermPricingListEntry object contains information about a long-term pricing type.

type LongTermPricingType added in v1.3.0 

type LongTermPricingType string
const (
	LongTermPricingTypeOneYear   LongTermPricingType = "OneYear"
	LongTermPricingTypeThreeYear LongTermPricingType = "ThreeYear"
	LongTermPricingTypeOneMonth  LongTermPricingType = "OneMonth"
)

Enum values for LongTermPricingType

func (LongTermPricingType) Values added in v1.3.0 

func (LongTermPricingType) Values() []LongTermPricingType

Values returns all known values for LongTermPricingType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NFSOnDeviceServiceConfiguration added in v1.5.0 

type NFSOnDeviceServiceConfiguration struct {

	// The maximum NFS storage for one Snow Family device.
	StorageLimit int32

	// The scale unit of the NFS storage on the device.
	//
	// Valid values: TB.
	StorageUnit StorageUnit
	// contains filtered or unexported fields
}

An object that represents the metadata and configuration settings for the NFS (Network File System) service on an Amazon Web Services Snow Family device.

type Notification 

type Notification struct {

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

	// The list of job states that will trigger a notification for this job.
	JobStatesToNotify []JobState

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

	// 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.
	//
	// [CreateTopic]: https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html
	// [Subscribe]: https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html
	SnsTopicARN *string
	// contains filtered or unexported fields
}

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.

type OnDeviceServiceConfiguration added in v1.5.0 

type OnDeviceServiceConfiguration struct {

	// The configuration of EKS Anywhere on the Snow Family device.
	EKSOnDeviceService *EKSOnDeviceServiceConfiguration

	// Represents the NFS (Network File System) service on a Snow Family device.
	NFSOnDeviceService *NFSOnDeviceServiceConfiguration

	// Configuration for Amazon S3 compatible storage on Snow family devices.
	S3OnDeviceService *S3OnDeviceServiceConfiguration

	// Represents the Storage Gateway service Tape Gateway type on a Snow Family
	// device.
	TGWOnDeviceService *TGWOnDeviceServiceConfiguration
	// contains filtered or unexported fields
}

An object that represents the metadata and configuration settings for services on an Amazon Web Services Snow Family device.

type PickupDetails added in v1.20.0 

type PickupDetails struct {

	// The unique ID for a device that will be picked up.
	DevicePickupId *string

	// The email address of the person picking up the device.
	Email *string

	// Expiration date of the credential identifying the person picking up the device.
	IdentificationExpirationDate *time.Time

	// Organization that issued the credential identifying the person picking up the
	// device.
	IdentificationIssuingOrg *string

	// The number on the credential identifying the person picking up the device.
	IdentificationNumber *string

	// The name of the person picking up the device.
	Name *string

	// The phone number of the person picking up the device.
	PhoneNumber *string
	// contains filtered or unexported fields
}

Information identifying the person picking up the device.

type RemoteManagement added in v1.5.0 

type RemoteManagement string
const (
	RemoteManagementInstalledOnly      RemoteManagement = "INSTALLED_ONLY"
	RemoteManagementInstalledAutostart RemoteManagement = "INSTALLED_AUTOSTART"
	RemoteManagementNotInstalled       RemoteManagement = "NOT_INSTALLED"
)

Enum values for RemoteManagement

func (RemoteManagement) Values added in v1.5.0 

func (RemoteManagement) Values() []RemoteManagement

Values returns all known values for RemoteManagement. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReturnShippingLabelAlreadyExistsException added in v0.29.0 

type ReturnShippingLabelAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You get this exception if you call CreateReturnShippingLabel and a valid return shipping label already exists. In this case, use DescribeReturnShippingLabel to get the URL.

func (*ReturnShippingLabelAlreadyExistsException) Error added in v0.29.0 

func (e *ReturnShippingLabelAlreadyExistsException) Error() string

func (*ReturnShippingLabelAlreadyExistsException) ErrorCode added in v0.29.0 

func (e *ReturnShippingLabelAlreadyExistsException) ErrorCode() string

func (*ReturnShippingLabelAlreadyExistsException) ErrorFault added in v0.29.0 

func (e *ReturnShippingLabelAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ReturnShippingLabelAlreadyExistsException) ErrorMessage added in v0.29.0 

func (e *ReturnShippingLabelAlreadyExistsException) ErrorMessage() string

type S3OnDeviceServiceConfiguration added in v1.19.0 

type S3OnDeviceServiceConfiguration struct {

	// >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.
	FaultTolerance *int32

	// 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.
	ServiceSize *int32

	// 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.
	StorageLimit *float64

	// Storage unit. Currently the only supported unit is TB.
	StorageUnit StorageUnit
	// contains filtered or unexported fields
}

Amazon S3 compatible storage on Snow family devices configuration items.

type S3Resource 

type S3Resource struct {

	// The Amazon Resource Name (ARN) of an Amazon S3 bucket.
	BucketArn *string

	// 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.
	KeyRange *KeyRange

	// Specifies the service or services on the Snow Family device that your
	// transferred data will be exported from or imported into. Amazon Web Services
	// Snow Family supports Amazon S3 and NFS (Network File System).
	TargetOnDeviceServices []TargetOnDeviceService
	// contains filtered or unexported fields
}

Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional KeyRange value. 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.

type ServiceName added in v1.18.0 

type ServiceName string
const (
	ServiceNameKubernetes  ServiceName = "KUBERNETES"
	ServiceNameEksAnywhere ServiceName = "EKS_ANYWHERE"
)

Enum values for ServiceName

func (ServiceName) Values added in v1.18.0 

func (ServiceName) Values() []ServiceName

Values returns all known values for ServiceName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceVersion added in v1.18.0 

type ServiceVersion struct {

	// The version number of the requested service.
	Version *string
	// contains filtered or unexported fields
}

The version of the requested service.

type Shipment 

type Shipment struct {

	// Status information for a shipment.
	Status *string

	// The tracking number for this job. Using this tracking number with your region's
	// carrier's website, you can track a Snow device as the carrier transports it.
	//
	// For India, the carrier is Amazon Logistics. For all other regions, UPS is the
	// carrier.
	TrackingNumber *string
	// contains filtered or unexported fields
}

The Status and TrackingNumber information for an inbound or outbound shipment.

type ShipmentState added in v0.29.0 

type ShipmentState string
const (
	ShipmentStateReceived ShipmentState = "RECEIVED"
	ShipmentStateReturned ShipmentState = "RETURNED"
)

Enum values for ShipmentState

func (ShipmentState) Values added in v0.29.0 

func (ShipmentState) Values() []ShipmentState

Values returns all known values for ShipmentState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ShippingDetails 

type ShippingDetails struct {

	// The Status and TrackingNumber values for a Snow device being returned to Amazon
	// Web Services for a particular job.
	InboundShipment *Shipment

	// The Status and TrackingNumber values for a Snow device being delivered to the
	// address that you specified for a particular job.
	OutboundShipment *Shipment

	// The shipping speed for a particular job. This speed doesn't dictate how soon
	// you'll get the Snow device from the job's creation date. This speed represents
	// how quickly it moves to its destination while in transit. Regional shipping
	// speeds are as follows:
	//
	//   - In Australia, you have access to express shipping. Typically, Snow 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 United States of America (US), you have access to one-day shipping
	//   and two-day shipping.
	ShippingOption ShippingOption
	// contains filtered or unexported fields
}

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

type ShippingLabelStatus added in v0.29.0 

type ShippingLabelStatus string
const (
	ShippingLabelStatusInProgress ShippingLabelStatus = "InProgress"
	ShippingLabelStatusTimedOut   ShippingLabelStatus = "TimedOut"
	ShippingLabelStatusSucceeded  ShippingLabelStatus = "Succeeded"
	ShippingLabelStatusFailed     ShippingLabelStatus = "Failed"
)

Enum values for ShippingLabelStatus

func (ShippingLabelStatus) Values added in v0.29.0 

func (ShippingLabelStatus) Values() []ShippingLabelStatus

Values returns all known values for ShippingLabelStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ShippingOption 

type ShippingOption string
const (
	ShippingOptionSecondDay ShippingOption = "SECOND_DAY"
	ShippingOptionNextDay   ShippingOption = "NEXT_DAY"
	ShippingOptionExpress   ShippingOption = "EXPRESS"
	ShippingOptionStandard  ShippingOption = "STANDARD"
)

Enum values for ShippingOption

func (ShippingOption) Values added in v0.29.0 

func (ShippingOption) Values() []ShippingOption

Values returns all known values for ShippingOption. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SnowballCapacity 

type SnowballCapacity string
const (
	SnowballCapacityT50          SnowballCapacity = "T50"
	SnowballCapacityT80          SnowballCapacity = "T80"
	SnowballCapacityT100         SnowballCapacity = "T100"
	SnowballCapacityT42          SnowballCapacity = "T42"
	SnowballCapacityT98          SnowballCapacity = "T98"
	SnowballCapacityT8           SnowballCapacity = "T8"
	SnowballCapacityT14          SnowballCapacity = "T14"
	SnowballCapacityT32          SnowballCapacity = "T32"
	SnowballCapacityNoPreference SnowballCapacity = "NoPreference"
	SnowballCapacityT240         SnowballCapacity = "T240"
	SnowballCapacityT13          SnowballCapacity = "T13"
)

Enum values for SnowballCapacity

func (SnowballCapacity) Values added in v0.29.0 

func (SnowballCapacity) Values() []SnowballCapacity

Values returns all known values for SnowballCapacity. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SnowballType 

type SnowballType string
const (
	SnowballTypeStandard SnowballType = "STANDARD"
	SnowballTypeEdge     SnowballType = "EDGE"
	SnowballTypeEdgeC    SnowballType = "EDGE_C"
	SnowballTypeEdgeCg   SnowballType = "EDGE_CG"
	SnowballTypeEdgeS    SnowballType = "EDGE_S"
	SnowballTypeSnc1Hdd  SnowballType = "SNC1_HDD"
	SnowballTypeSnc1Ssd  SnowballType = "SNC1_SSD"
	SnowballTypeV35c     SnowballType = "V3_5C"
	SnowballTypeV35s     SnowballType = "V3_5S"
	SnowballTypeRack5uC  SnowballType = "RACK_5U_C"
)

Enum values for SnowballType

func (SnowballType) Values added in v0.29.0 

func (SnowballType) Values() []SnowballType

Values returns all known values for SnowballType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SnowconeDeviceConfiguration 

type SnowconeDeviceConfiguration struct {

	// Configures the wireless connection for the Snowcone device.
	WirelessConnection *WirelessConnection
	// contains filtered or unexported fields
}

Specifies the device configuration for an Snowcone job.

type StorageUnit added in v1.5.0 

type StorageUnit string
const (
	StorageUnitTb StorageUnit = "TB"
)

Enum values for StorageUnit

func (StorageUnit) Values added in v1.5.0 

func (StorageUnit) Values() []StorageUnit

Values returns all known values for StorageUnit. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TGWOnDeviceServiceConfiguration added in v1.10.0 

type TGWOnDeviceServiceConfiguration struct {

	// 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.
	StorageLimit int32

	// The scale unit of the virtual tapes on the device.
	StorageUnit StorageUnit
	// contains filtered or unexported fields
}

An object that represents the metadata and configuration settings for the Storage Gateway service Tape Gateway type on an Amazon Web Services Snow Family device.

type TargetOnDeviceService added in v1.5.0 

type TargetOnDeviceService struct {

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

	// Specifies whether the data is being imported or exported. You can import or
	// export the data, or use it locally on the device.
	TransferOption TransferOption
	// contains filtered or unexported fields
}

An object that represents the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).

type TaxDocuments 

type TaxDocuments struct {

	// The tax documents required in Amazon Web Services Region in India.
	IND *INDTaxDocuments
	// contains filtered or unexported fields
}

The tax documents required in your Amazon Web Services Region.

type TransferOption added in v1.5.0 

type TransferOption string
const (
	TransferOptionImport   TransferOption = "IMPORT"
	TransferOptionExport   TransferOption = "EXPORT"
	TransferOptionLocalUse TransferOption = "LOCAL_USE"
)

Enum values for TransferOption

func (TransferOption) Values added in v1.5.0 

func (TransferOption) Values() []TransferOption

Values returns all known values for TransferOption. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UnsupportedAddressException 

type UnsupportedAddressException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact Amazon Web Services Support.

func (*UnsupportedAddressException) Error 

func (e *UnsupportedAddressException) Error() string

func (*UnsupportedAddressException) ErrorCode 

func (e *UnsupportedAddressException) ErrorCode() string

func (*UnsupportedAddressException) ErrorFault 

func (e *UnsupportedAddressException) ErrorFault() smithy.ErrorFault

func (*UnsupportedAddressException) ErrorMessage 

func (e *UnsupportedAddressException) ErrorMessage() string

type WirelessConnection 

type WirelessConnection struct {

	// Enables the Wi-Fi adapter on an Snowcone device.
	IsWifiEnabled bool
	// contains filtered or unexported fields
}

Configures the wireless connection on an Snowcone device.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.