func AddressType_Values() []string
AddressType_Values returns all elements of the AddressType enum
func Capacity_Values() []string
Capacity_Values returns all elements of the Capacity enum
func ClusterState_Values() []string
ClusterState_Values returns all elements of the ClusterState enum
func DeviceServiceName_Values() []string
DeviceServiceName_Values returns all elements of the DeviceServiceName enum
func ImpactLevel_Values() []string
ImpactLevel_Values returns all elements of the ImpactLevel enum
func JobState_Values() []string
JobState_Values returns all elements of the JobState enum
func JobType_Values() []string
JobType_Values returns all elements of the JobType enum
func LongTermPricingType_Values() []string
LongTermPricingType_Values returns all elements of the LongTermPricingType enum
func RemoteManagement_Values() []string
RemoteManagement_Values returns all elements of the RemoteManagement enum
func ServiceName_Values() []string
ServiceName_Values returns all elements of the ServiceName enum
func ShipmentState_Values() []string
ShipmentState_Values returns all elements of the ShipmentState enum
func ShippingLabelStatus_Values() []string
ShippingLabelStatus_Values returns all elements of the ShippingLabelStatus enum
func ShippingOption_Values() []string
ShippingOption_Values returns all elements of the ShippingOption enum
func StorageUnit_Values() []string
StorageUnit_Values returns all elements of the StorageUnit enum
func TransferOption_Values() []string
TransferOption_Values returns all elements of the TransferOption enum
func Type_Values() []string
Type_Values returns all elements of the Type enum
type Address struct { // The unique ID for an address. AddressId *string `min:"40" type:"string"` // The city in an address that a Snow device is to be delivered to. City *string `min:"1" type:"string"` // The name of the company to receive a Snow device at an address. Company *string `min:"1" type:"string"` // The country in an address that a Snow device is to be delivered to. Country *string `min:"1" type:"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 `type:"boolean"` // This field is no longer used and the value is ignored. Landmark *string `min:"1" type:"string"` // The name of a person to receive a Snow device at an address. Name *string `min:"1" type:"string"` // The phone number associated with an address that a Snow device is to be delivered // to. PhoneNumber *string `min:"1" type:"string"` // The postal code in an address that a Snow device is to be delivered to. PostalCode *string `min:"1" type:"string"` // This field is no longer used and the value is ignored. PrefectureOrDistrict *string `min:"1" type:"string"` // The state or province in an address that a Snow device is to be delivered // to. StateOrProvince *string `min:"1" type:"string"` // The first line in a street address that a Snow device is to be delivered // to. Street1 *string `min:"1" type:"string"` // The second line in a street address that a Snow device is to be delivered // to. Street2 *string `min:"1" type:"string"` // The third line in a street address that a Snow device is to be delivered // to. Street3 *string `min:"1" type:"string"` // Differentiates between delivery address and pickup address in the customer // account. Provided at job creation. Type *string `type:"string" enum:"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.
func (s Address) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Address) SetAddressId(v string) *Address
SetAddressId sets the AddressId field's value.
func (s *Address) SetCity(v string) *Address
SetCity sets the City field's value.
func (s *Address) SetCompany(v string) *Address
SetCompany sets the Company field's value.
func (s *Address) SetCountry(v string) *Address
SetCountry sets the Country field's value.
func (s *Address) SetIsRestricted(v bool) *Address
SetIsRestricted sets the IsRestricted field's value.
func (s *Address) SetLandmark(v string) *Address
SetLandmark sets the Landmark field's value.
func (s *Address) SetName(v string) *Address
SetName sets the Name field's value.
func (s *Address) SetPhoneNumber(v string) *Address
SetPhoneNumber sets the PhoneNumber field's value.
func (s *Address) SetPostalCode(v string) *Address
SetPostalCode sets the PostalCode field's value.
func (s *Address) SetPrefectureOrDistrict(v string) *Address
SetPrefectureOrDistrict sets the PrefectureOrDistrict field's value.
func (s *Address) SetStateOrProvince(v string) *Address
SetStateOrProvince sets the StateOrProvince field's value.
func (s *Address) SetStreet1(v string) *Address
SetStreet1 sets the Street1 field's value.
func (s *Address) SetStreet2(v string) *Address
SetStreet2 sets the Street2 field's value.
func (s *Address) SetStreet3(v string) *Address
SetStreet3 sets the Street3 field's value.
func (s *Address) SetType(v string) *Address
SetType sets the Type field's value.
func (s Address) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Address) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelClusterInput struct { // The 39-character ID for the cluster that you want to cancel, for example // CID123e4567-e89b-12d3-a456-426655440000. // // ClusterId is a required field ClusterId *string `min:"39" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CancelClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelClusterInput) SetClusterId(v string) *CancelClusterInput
SetClusterId sets the ClusterId field's value.
func (s CancelClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelClusterOutput struct {
// contains filtered or unexported fields
}
func (s CancelClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s CancelClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CancelJobInput struct { // The 39-character job ID for the job that you want to cancel, for example // JID123e4567-e89b-12d3-a456-426655440000. // // JobId is a required field JobId *string `min:"39" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CancelJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelJobInput) SetJobId(v string) *CancelJobInput
SetJobId sets the JobId field's value.
func (s CancelJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelJobOutput struct {
// contains filtered or unexported fields
}
func (s CancelJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s CancelJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ClusterLimitExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"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 (s *ClusterLimitExceededException) Code() string
Code returns the exception type name.
func (s *ClusterLimitExceededException) Error() string
func (s ClusterLimitExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClusterLimitExceededException) Message() string
Message returns the exception's message.
func (s *ClusterLimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ClusterLimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ClusterLimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ClusterLimitExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ClusterListEntry struct { // The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000. ClusterId *string `min:"1" type:"string"` // The current state of this cluster. For information about the state of a specific // node, see JobListEntry$JobState. ClusterState *string `type:"string" enum:"ClusterState"` // The creation date for this cluster. CreationDate *time.Time `type:"timestamp"` // Defines an optional description of the cluster, for example Environmental // Data Cluster-01. Description *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains a cluster's state, a cluster's ID, and other important information.
func (s ClusterListEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClusterListEntry) SetClusterId(v string) *ClusterListEntry
SetClusterId sets the ClusterId field's value.
func (s *ClusterListEntry) SetClusterState(v string) *ClusterListEntry
SetClusterState sets the ClusterState field's value.
func (s *ClusterListEntry) SetCreationDate(v time.Time) *ClusterListEntry
SetCreationDate sets the CreationDate field's value.
func (s *ClusterListEntry) SetDescription(v string) *ClusterListEntry
SetDescription sets the Description field's value.
func (s ClusterListEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ClusterMetadata struct { // The automatically generated ID for a specific address. AddressId *string `min:"40" type:"string"` // The automatically generated ID for a cluster. ClusterId *string `min:"1" type:"string"` // The current status of the cluster. ClusterState *string `type:"string" enum:"ClusterState"` // The creation date for this cluster. CreationDate *time.Time `type:"timestamp"` // The optional description of the cluster. Description *string `min:"1" type:"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 `min:"40" type:"string"` // The type of job for this cluster. Currently, the only job type supported // for clusters is LOCAL_USE. JobType *string `type:"string" enum:"JobType"` // The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This // ARN was created using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) // API action in Key Management Service (KMS. KmsKeyARN *string `type:"string"` // The Amazon Simple Notification Service (Amazon SNS) notification settings // for this cluster. Notification *Notification `type:"structure"` // Represents metadata and configuration settings for services on an Amazon // Web Services Snow Family device. OnDeviceServiceConfiguration *OnDeviceServiceConfiguration `type:"structure"` // The arrays of JobResource objects that can include updated S3Resource objects // or LambdaResource objects. Resources *JobResource `type:"structure"` // The role ARN associated with this cluster. This ARN was created using the // CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // API action in Identity and Access Management (IAM). RoleARN *string `type:"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 *string `type:"string" enum:"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 *string `type:"string" enum:"Type"` // The tax documents required in your Amazon Web Services Region. TaxDocuments *TaxDocuments `type:"structure"` // contains filtered or unexported fields }
Contains metadata about a specific cluster.
func (s ClusterMetadata) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClusterMetadata) SetAddressId(v string) *ClusterMetadata
SetAddressId sets the AddressId field's value.
func (s *ClusterMetadata) SetClusterId(v string) *ClusterMetadata
SetClusterId sets the ClusterId field's value.
func (s *ClusterMetadata) SetClusterState(v string) *ClusterMetadata
SetClusterState sets the ClusterState field's value.
func (s *ClusterMetadata) SetCreationDate(v time.Time) *ClusterMetadata
SetCreationDate sets the CreationDate field's value.
func (s *ClusterMetadata) SetDescription(v string) *ClusterMetadata
SetDescription sets the Description field's value.
func (s *ClusterMetadata) SetForwardingAddressId(v string) *ClusterMetadata
SetForwardingAddressId sets the ForwardingAddressId field's value.
func (s *ClusterMetadata) SetJobType(v string) *ClusterMetadata
SetJobType sets the JobType field's value.
func (s *ClusterMetadata) SetKmsKeyARN(v string) *ClusterMetadata
SetKmsKeyARN sets the KmsKeyARN field's value.
func (s *ClusterMetadata) SetNotification(v *Notification) *ClusterMetadata
SetNotification sets the Notification field's value.
func (s *ClusterMetadata) SetOnDeviceServiceConfiguration(v *OnDeviceServiceConfiguration) *ClusterMetadata
SetOnDeviceServiceConfiguration sets the OnDeviceServiceConfiguration field's value.
func (s *ClusterMetadata) SetResources(v *JobResource) *ClusterMetadata
SetResources sets the Resources field's value.
func (s *ClusterMetadata) SetRoleARN(v string) *ClusterMetadata
SetRoleARN sets the RoleARN field's value.
func (s *ClusterMetadata) SetShippingOption(v string) *ClusterMetadata
SetShippingOption sets the ShippingOption field's value.
func (s *ClusterMetadata) SetSnowballType(v string) *ClusterMetadata
SetSnowballType sets the SnowballType field's value.
func (s *ClusterMetadata) SetTaxDocuments(v *TaxDocuments) *ClusterMetadata
SetTaxDocuments sets the TaxDocuments field's value.
func (s ClusterMetadata) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CompatibleImage struct { // The unique identifier for an individual Snow device AMI. AmiId *string `min:"1" type:"string"` // The optional name of a compatible image. Name *string `min:"1" type:"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.
func (s CompatibleImage) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CompatibleImage) SetAmiId(v string) *CompatibleImage
SetAmiId sets the AmiId field's value.
func (s *CompatibleImage) SetName(v string) *CompatibleImage
SetName sets the Name field's value.
func (s CompatibleImage) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // You get this resource when you call CreateReturnShippingLabel more than once // when other requests are not completed. . ConflictResource *string `min:"1" type:"string"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
func (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateAddressInput struct { // The address that you want the Snow device shipped to. // // Address is a required field Address *Address `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s CreateAddressInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAddressInput) SetAddress(v *Address) *CreateAddressInput
SetAddress sets the Address field's value.
func (s CreateAddressInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAddressInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAddressOutput struct { // The automatically generated ID for a specific address. You'll use this ID // when you create a job to specify which address you want the Snow device for // that job shipped to. AddressId *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s CreateAddressOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAddressOutput) SetAddressId(v string) *CreateAddressOutput
SetAddressId sets the AddressId field's value.
func (s CreateAddressOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateClusterInput struct { // The ID for the address that you want the cluster shipped to. // // AddressId is a required field AddressId *string `min:"40" type:"string" required:"true"` // An optional description of this specific cluster, for example Environmental // Data Cluster-01. Description *string `min:"1" type:"string"` // Force to create cluster when user attempts to overprovision or underprovision // a cluster. A cluster is overprovisioned or underprovisioned if the initial // size of the cluster is more (overprovisioned) or less (underprovisioned) // than what needed to meet capacity requirement specified with OnDeviceServiceConfiguration. ForceCreateJobs *bool `type:"boolean"` // The forwarding address ID for a cluster. This field is not supported in most // regions. ForwardingAddressId *string `min:"40" type:"string"` // If provided, each job will be automatically created and associated with the // new cluster. If not provided, will be treated as 0. InitialClusterSize *int64 `type:"integer"` // The type of job for this cluster. Currently, the only job type supported // for clusters is LOCAL_USE. // // 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. // // JobType is a required field JobType *string `type:"string" required:"true" enum:"JobType"` // The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN // values are created by using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) // API action in Key Management Service (KMS). KmsKeyARN *string `type:"string"` // Lists long-term pricing id that will be used to associate with jobs automatically // created for the new cluster. LongTermPricingIds []*string `type:"list"` // The Amazon Simple Notification Service (Amazon SNS) notification settings // for this cluster. Notification *Notification `type:"structure"` // 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 // device clusters support Amazon S3 and NFS (Network File System). OnDeviceServiceConfiguration *OnDeviceServiceConfiguration `type:"structure"` // Allows you to securely operate and manage Snow devices in a cluster 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 *string `type:"string" enum:"RemoteManagement"` // The resources associated with the cluster job. These resources include Amazon // S3 buckets and optional Lambda functions written in the Python language. Resources *JobResource `type:"structure"` // The RoleARN that you want to associate with this cluster. RoleArn values // are created by using the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // API action in Identity and Access Management (IAM). RoleARN *string `type:"string"` // The shipping speed for each node in this cluster. This speed doesn't dictate // how soon you'll get each Snowball Edge 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, 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. // // * 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 is a required field ShippingOption *string `type:"string" required:"true" enum:"ShippingOption"` // If your job is being created in one of the US regions, you have the option // of specifying what size Snow device you'd like for this job. In all other // regions, Snowballs come with 80 TB in storage capacity. // // 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 *string `type:"string" enum:"Capacity"` // The type of Snow Family devices to use for this cluster. // // For cluster jobs, Amazon Web Services Snow Family currently supports only // the EDGE device type. // // 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. // // SnowballType is a required field SnowballType *string `type:"string" required:"true" enum:"Type"` // The tax documents required in your Amazon Web Services Region. TaxDocuments *TaxDocuments `type:"structure"` // contains filtered or unexported fields }
func (s CreateClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateClusterInput) SetAddressId(v string) *CreateClusterInput
SetAddressId sets the AddressId field's value.
func (s *CreateClusterInput) SetDescription(v string) *CreateClusterInput
SetDescription sets the Description field's value.
func (s *CreateClusterInput) SetForceCreateJobs(v bool) *CreateClusterInput
SetForceCreateJobs sets the ForceCreateJobs field's value.
func (s *CreateClusterInput) SetForwardingAddressId(v string) *CreateClusterInput
SetForwardingAddressId sets the ForwardingAddressId field's value.
func (s *CreateClusterInput) SetInitialClusterSize(v int64) *CreateClusterInput
SetInitialClusterSize sets the InitialClusterSize field's value.
func (s *CreateClusterInput) SetJobType(v string) *CreateClusterInput
SetJobType sets the JobType field's value.
func (s *CreateClusterInput) SetKmsKeyARN(v string) *CreateClusterInput
SetKmsKeyARN sets the KmsKeyARN field's value.
func (s *CreateClusterInput) SetLongTermPricingIds(v []*string) *CreateClusterInput
SetLongTermPricingIds sets the LongTermPricingIds field's value.
func (s *CreateClusterInput) SetNotification(v *Notification) *CreateClusterInput
SetNotification sets the Notification field's value.
func (s *CreateClusterInput) SetOnDeviceServiceConfiguration(v *OnDeviceServiceConfiguration) *CreateClusterInput
SetOnDeviceServiceConfiguration sets the OnDeviceServiceConfiguration field's value.
func (s *CreateClusterInput) SetRemoteManagement(v string) *CreateClusterInput
SetRemoteManagement sets the RemoteManagement field's value.
func (s *CreateClusterInput) SetResources(v *JobResource) *CreateClusterInput
SetResources sets the Resources field's value.
func (s *CreateClusterInput) SetRoleARN(v string) *CreateClusterInput
SetRoleARN sets the RoleARN field's value.
func (s *CreateClusterInput) SetShippingOption(v string) *CreateClusterInput
SetShippingOption sets the ShippingOption field's value.
func (s *CreateClusterInput) SetSnowballCapacityPreference(v string) *CreateClusterInput
SetSnowballCapacityPreference sets the SnowballCapacityPreference field's value.
func (s *CreateClusterInput) SetSnowballType(v string) *CreateClusterInput
SetSnowballType sets the SnowballType field's value.
func (s *CreateClusterInput) SetTaxDocuments(v *TaxDocuments) *CreateClusterInput
SetTaxDocuments sets the TaxDocuments field's value.
func (s CreateClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateClusterOutput struct { // The automatically generated ID for a cluster. ClusterId *string `min:"39" type:"string"` // List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries // (http://amazonaws.com/snowball/latest/api-reference/API_ListJobs.html#API_ListJobs_ResponseSyntax) // in this guide. JobListEntries []*JobListEntry `type:"list"` // contains filtered or unexported fields }
func (s CreateClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateClusterOutput) SetClusterId(v string) *CreateClusterOutput
SetClusterId sets the ClusterId field's value.
func (s *CreateClusterOutput) SetJobListEntries(v []*JobListEntry) *CreateClusterOutput
SetJobListEntries sets the JobListEntries field's value.
func (s CreateClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateJobInput struct { // The ID for the address that you want the Snow device shipped to. AddressId *string `min:"40" type:"string"` // The ID of a cluster. If you're creating a job for a node in a cluster, you // need to provide only this clusterId value. The other job attributes are inherited // from the cluster. ClusterId *string `min:"39" type:"string"` // Defines an optional description of this specific job, for example Important // Photos 2016-08-11. Description *string `min:"1" type:"string"` // Defines the device configuration for an Snowcone job. // // 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. DeviceConfiguration *DeviceConfiguration `type:"structure"` // The forwarding address ID for a job. This field is not supported in most // Regions. ForwardingAddressId *string `min:"40" type:"string"` // The highest impact level of data that will be stored or processed on the // device, provided at job creation. ImpactLevel *string `type:"string" enum:"ImpactLevel"` // Defines the type of job that you're creating. JobType *string `type:"string" enum:"JobType"` // The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created // using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) // Key Management Service (KMS) API action. KmsKeyARN *string `type:"string"` // The ID of the long-term pricing type for the device. LongTermPricingId *string `min:"41" type:"string"` // Defines the Amazon Simple Notification Service (Amazon SNS) notification // settings for this job. Notification *Notification `type:"structure"` // 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) and the Amazon Web Services // Storage Gateway service Tape Gateway type. OnDeviceServiceConfiguration *OnDeviceServiceConfiguration `type:"structure"` // Information identifying the person picking up the device. PickupDetails *PickupDetails `type:"structure"` // 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 Edge client to manage the // device. When set to NOT_INSTALLED, remote management will not be available // on the device. RemoteManagement *string `type:"string" enum:"RemoteManagement"` // Defines the Amazon S3 buckets associated with this job. // // With IMPORT jobs, you specify the bucket or buckets that your transferred // data will be imported into. // // With EXPORT jobs, you specify the bucket or buckets that your transferred // data will be exported from. Optionally, you can also specify a KeyRange value. // If you choose to export a range, you define the length of the range by providing // either an inclusive BeginMarker value, an inclusive EndMarker value, or both. // Ranges are UTF-8 binary sorted. Resources *JobResource `type:"structure"` // The RoleARN that you want to associate with this job. RoleArns are created // using the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // Identity and Access Management (IAM) API action. RoleARN *string `type:"string"` // The shipping speed for this job. This speed doesn't dictate how soon you'll // get the Snow device, rather it represents how quickly the Snow device 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 US, you have access to one-day shipping and two-day shipping. ShippingOption *string `type:"string" enum:"ShippingOption"` // If your job is being created in one of the US regions, you have the option // of specifying what size Snow device you'd like for this job. In all other // regions, Snowballs come with 80 TB in storage capacity. // // 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 *string `type:"string" enum:"Capacity"` // The type of Snow Family devices to use for this job. // // For cluster jobs, Amazon Web Services Snow Family currently supports only // the EDGE device type. // // The type of Amazon Web Services Snow device to use for this job. Currently, // the only supported device type for cluster jobs is EDGE. // // For more information, see Snowball Edge Device Options (https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html) // in the Snowball Edge Developer Guide. // // 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. SnowballType *string `type:"string" enum:"Type"` // The tax documents required in your Amazon Web Services Region. TaxDocuments *TaxDocuments `type:"structure"` // contains filtered or unexported fields }
func (s CreateJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateJobInput) SetAddressId(v string) *CreateJobInput
SetAddressId sets the AddressId field's value.
func (s *CreateJobInput) SetClusterId(v string) *CreateJobInput
SetClusterId sets the ClusterId field's value.
func (s *CreateJobInput) SetDescription(v string) *CreateJobInput
SetDescription sets the Description field's value.
func (s *CreateJobInput) SetDeviceConfiguration(v *DeviceConfiguration) *CreateJobInput
SetDeviceConfiguration sets the DeviceConfiguration field's value.
func (s *CreateJobInput) SetForwardingAddressId(v string) *CreateJobInput
SetForwardingAddressId sets the ForwardingAddressId field's value.
func (s *CreateJobInput) SetImpactLevel(v string) *CreateJobInput
SetImpactLevel sets the ImpactLevel field's value.
func (s *CreateJobInput) SetJobType(v string) *CreateJobInput
SetJobType sets the JobType field's value.
func (s *CreateJobInput) SetKmsKeyARN(v string) *CreateJobInput
SetKmsKeyARN sets the KmsKeyARN field's value.
func (s *CreateJobInput) SetLongTermPricingId(v string) *CreateJobInput
SetLongTermPricingId sets the LongTermPricingId field's value.
func (s *CreateJobInput) SetNotification(v *Notification) *CreateJobInput
SetNotification sets the Notification field's value.
func (s *CreateJobInput) SetOnDeviceServiceConfiguration(v *OnDeviceServiceConfiguration) *CreateJobInput
SetOnDeviceServiceConfiguration sets the OnDeviceServiceConfiguration field's value.
func (s *CreateJobInput) SetPickupDetails(v *PickupDetails) *CreateJobInput
SetPickupDetails sets the PickupDetails field's value.
func (s *CreateJobInput) SetRemoteManagement(v string) *CreateJobInput
SetRemoteManagement sets the RemoteManagement field's value.
func (s *CreateJobInput) SetResources(v *JobResource) *CreateJobInput
SetResources sets the Resources field's value.
func (s *CreateJobInput) SetRoleARN(v string) *CreateJobInput
SetRoleARN sets the RoleARN field's value.
func (s *CreateJobInput) SetShippingOption(v string) *CreateJobInput
SetShippingOption sets the ShippingOption field's value.
func (s *CreateJobInput) SetSnowballCapacityPreference(v string) *CreateJobInput
SetSnowballCapacityPreference sets the SnowballCapacityPreference field's value.
func (s *CreateJobInput) SetSnowballType(v string) *CreateJobInput
SetSnowballType sets the SnowballType field's value.
func (s *CreateJobInput) SetTaxDocuments(v *TaxDocuments) *CreateJobInput
SetTaxDocuments sets the TaxDocuments field's value.
func (s CreateJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateJobOutput struct { // The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. JobId *string `min:"39" type:"string"` // contains filtered or unexported fields }
func (s CreateJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateJobOutput) SetJobId(v string) *CreateJobOutput
SetJobId sets the JobId field's value.
func (s CreateJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateLongTermPricingInput struct { // Specifies whether the current long-term pricing type for the device should // be renewed. IsLongTermPricingAutoRenew *bool `type:"boolean"` // The type of long-term pricing option you want for the device, either 1-year // or 3-year long-term pricing. // // LongTermPricingType is a required field LongTermPricingType *string `type:"string" required:"true" enum:"LongTermPricingType"` // The type of Snow Family devices to use for the long-term pricing job. // // SnowballType is a required field SnowballType *string `type:"string" required:"true" enum:"Type"` // contains filtered or unexported fields }
func (s CreateLongTermPricingInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateLongTermPricingInput) SetIsLongTermPricingAutoRenew(v bool) *CreateLongTermPricingInput
SetIsLongTermPricingAutoRenew sets the IsLongTermPricingAutoRenew field's value.
func (s *CreateLongTermPricingInput) SetLongTermPricingType(v string) *CreateLongTermPricingInput
SetLongTermPricingType sets the LongTermPricingType field's value.
func (s *CreateLongTermPricingInput) SetSnowballType(v string) *CreateLongTermPricingInput
SetSnowballType sets the SnowballType field's value.
func (s CreateLongTermPricingInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateLongTermPricingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateLongTermPricingOutput struct { // The ID of the long-term pricing type for the device. LongTermPricingId *string `min:"41" type:"string"` // contains filtered or unexported fields }
func (s CreateLongTermPricingOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateLongTermPricingOutput) SetLongTermPricingId(v string) *CreateLongTermPricingOutput
SetLongTermPricingId sets the LongTermPricingId field's value.
func (s CreateLongTermPricingOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateReturnShippingLabelInput struct { // The ID for a job that you want to create the return shipping label for; for // example, JID123e4567-e89b-12d3-a456-426655440000. // // JobId is a required field JobId *string `min:"39" type:"string" required:"true"` // The shipping speed for a particular job. This speed doesn't dictate how soon // the device is returned to Amazon Web Services. This speed represents how // quickly it moves to its destination while in transit. Regional shipping speeds // are as follows: ShippingOption *string `type:"string" enum:"ShippingOption"` // contains filtered or unexported fields }
func (s CreateReturnShippingLabelInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateReturnShippingLabelInput) SetJobId(v string) *CreateReturnShippingLabelInput
SetJobId sets the JobId field's value.
func (s *CreateReturnShippingLabelInput) SetShippingOption(v string) *CreateReturnShippingLabelInput
SetShippingOption sets the ShippingOption field's value.
func (s CreateReturnShippingLabelInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateReturnShippingLabelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateReturnShippingLabelOutput struct { // The status information of the task on a Snow device that is being returned // to Amazon Web Services. Status *string `type:"string" enum:"ShippingLabelStatus"` // contains filtered or unexported fields }
func (s CreateReturnShippingLabelOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateReturnShippingLabelOutput) SetStatus(v string) *CreateReturnShippingLabelOutput
SetStatus sets the Status field's value.
func (s CreateReturnShippingLabelOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DataTransfer struct { // The number of bytes transferred between a Snow device and Amazon S3. BytesTransferred *int64 `type:"long"` // The number of objects transferred between a Snow device and Amazon S3. ObjectsTransferred *int64 `type:"long"` // 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 `type:"long"` // 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 `type:"long"` // 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.
func (s DataTransfer) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DataTransfer) SetBytesTransferred(v int64) *DataTransfer
SetBytesTransferred sets the BytesTransferred field's value.
func (s *DataTransfer) SetObjectsTransferred(v int64) *DataTransfer
SetObjectsTransferred sets the ObjectsTransferred field's value.
func (s *DataTransfer) SetTotalBytes(v int64) *DataTransfer
SetTotalBytes sets the TotalBytes field's value.
func (s *DataTransfer) SetTotalObjects(v int64) *DataTransfer
SetTotalObjects sets the TotalObjects field's value.
func (s DataTransfer) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DependentService struct { // The name of the dependent service. ServiceName *string `type:"string" enum:"ServiceName"` // The version of the dependent service. ServiceVersion *ServiceVersion `type:"structure"` // contains filtered or unexported fields }
The name and version of the service dependant on the requested service.
func (s DependentService) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DependentService) SetServiceName(v string) *DependentService
SetServiceName sets the ServiceName field's value.
func (s *DependentService) SetServiceVersion(v *ServiceVersion) *DependentService
SetServiceVersion sets the ServiceVersion field's value.
func (s DependentService) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DependentService) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAddressInput struct { // The automatically generated ID for a specific address. // // AddressId is a required field AddressId *string `min:"40" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeAddressInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAddressInput) SetAddressId(v string) *DescribeAddressInput
SetAddressId sets the AddressId field's value.
func (s DescribeAddressInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAddressInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAddressOutput struct { // The address that you want the Snow device(s) associated with a specific job // to be shipped to. Address *Address `type:"structure"` // contains filtered or unexported fields }
func (s DescribeAddressOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAddressOutput) SetAddress(v *Address) *DescribeAddressOutput
SetAddress sets the Address field's value.
func (s DescribeAddressOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeAddressesInput struct { // The number of ADDRESS objects to return. MaxResults *int64 `type:"integer"` // HTTP requests are stateless. To identify what object comes "next" in the // list of ADDRESS objects, you have the option of specifying a value for NextToken // as the starting point for your list of returned addresses. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s DescribeAddressesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAddressesInput) SetMaxResults(v int64) *DescribeAddressesInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribeAddressesInput) SetNextToken(v string) *DescribeAddressesInput
SetNextToken sets the NextToken field's value.
func (s DescribeAddressesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAddressesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAddressesOutput struct { // The Snow device shipping addresses that were created for this account. Addresses []*Address `type:"list"` // HTTP requests are stateless. If you use the automatically generated NextToken // value in your next DescribeAddresses call, your list of returned addresses // will start from this point in the array. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s DescribeAddressesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAddressesOutput) SetAddresses(v []*Address) *DescribeAddressesOutput
SetAddresses sets the Addresses field's value.
func (s *DescribeAddressesOutput) SetNextToken(v string) *DescribeAddressesOutput
SetNextToken sets the NextToken field's value.
func (s DescribeAddressesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeClusterInput struct { // The automatically generated ID for a cluster. // // ClusterId is a required field ClusterId *string `min:"39" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeClusterInput) SetClusterId(v string) *DescribeClusterInput
SetClusterId sets the ClusterId field's value.
func (s DescribeClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeClusterOutput struct { // Information about a specific cluster, including shipping information, cluster // status, and other important metadata. ClusterMetadata *ClusterMetadata `type:"structure"` // contains filtered or unexported fields }
func (s DescribeClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeClusterOutput) SetClusterMetadata(v *ClusterMetadata) *DescribeClusterOutput
SetClusterMetadata sets the ClusterMetadata field's value.
func (s DescribeClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeJobInput struct { // The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. // // JobId is a required field JobId *string `min:"39" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJobInput) SetJobId(v string) *DescribeJobInput
SetJobId sets the JobId field's value.
func (s DescribeJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeJobOutput struct { // Information about a specific job, including shipping information, job status, // and other important metadata. JobMetadata *JobMetadata `type:"structure"` // Information about a specific job part (in the case of an export job), including // shipping information, job status, and other important metadata. SubJobMetadata []*JobMetadata `type:"list"` // contains filtered or unexported fields }
func (s DescribeJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeJobOutput) SetJobMetadata(v *JobMetadata) *DescribeJobOutput
SetJobMetadata sets the JobMetadata field's value.
func (s *DescribeJobOutput) SetSubJobMetadata(v []*JobMetadata) *DescribeJobOutput
SetSubJobMetadata sets the SubJobMetadata field's value.
func (s DescribeJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeReturnShippingLabelInput struct { // The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. // // JobId is a required field JobId *string `min:"39" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeReturnShippingLabelInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeReturnShippingLabelInput) SetJobId(v string) *DescribeReturnShippingLabelInput
SetJobId sets the JobId field's value.
func (s DescribeReturnShippingLabelInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeReturnShippingLabelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeReturnShippingLabelOutput struct { // The expiration date of the current return shipping label. ExpirationDate *time.Time `type:"timestamp"` // The pre-signed Amazon S3 URI used to download the return shipping label. ReturnShippingLabelURI *string `min:"1" type:"string"` // The status information of the task on a Snow device that is being returned // to Amazon Web Services. Status *string `type:"string" enum:"ShippingLabelStatus"` // contains filtered or unexported fields }
func (s DescribeReturnShippingLabelOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeReturnShippingLabelOutput) SetExpirationDate(v time.Time) *DescribeReturnShippingLabelOutput
SetExpirationDate sets the ExpirationDate field's value.
func (s *DescribeReturnShippingLabelOutput) SetReturnShippingLabelURI(v string) *DescribeReturnShippingLabelOutput
SetReturnShippingLabelURI sets the ReturnShippingLabelURI field's value.
func (s *DescribeReturnShippingLabelOutput) SetStatus(v string) *DescribeReturnShippingLabelOutput
SetStatus sets the Status field's value.
func (s DescribeReturnShippingLabelOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeviceConfiguration struct { // Returns information about the device configuration for an Snowcone job. SnowconeDeviceConfiguration *SnowconeDeviceConfiguration `type:"structure"` // contains filtered or unexported fields }
The container for SnowconeDeviceConfiguration.
func (s DeviceConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeviceConfiguration) SetSnowconeDeviceConfiguration(v *SnowconeDeviceConfiguration) *DeviceConfiguration
SetSnowconeDeviceConfiguration sets the SnowconeDeviceConfiguration field's value.
func (s DeviceConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EKSOnDeviceServiceConfiguration struct { // The optional version of EKS Anywhere on the Snow Family device. EKSAnywhereVersion *string `min:"1" type:"string"` // The Kubernetes version for EKS Anywhere on the Snow Family device. KubernetesVersion *string `min:"1" type:"string"` // contains filtered or unexported fields }
An object representing the metadata and configuration settings of EKS Anywhere on the Snow Family device.
func (s EKSOnDeviceServiceConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EKSOnDeviceServiceConfiguration) SetEKSAnywhereVersion(v string) *EKSOnDeviceServiceConfiguration
SetEKSAnywhereVersion sets the EKSAnywhereVersion field's value.
func (s *EKSOnDeviceServiceConfiguration) SetKubernetesVersion(v string) *EKSOnDeviceServiceConfiguration
SetKubernetesVersion sets the KubernetesVersion field's value.
func (s EKSOnDeviceServiceConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EKSOnDeviceServiceConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Ec2AmiResource struct { // The ID of the AMI in Amazon EC2. // // AmiId is a required field AmiId *string `min:"12" type:"string" required:"true"` // The ID of the AMI on the Snow device. SnowballAmiId *string `min:"1" type:"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.
func (s Ec2AmiResource) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Ec2AmiResource) SetAmiId(v string) *Ec2AmiResource
SetAmiId sets the AmiId field's value.
func (s *Ec2AmiResource) SetSnowballAmiId(v string) *Ec2AmiResource
SetSnowballAmiId sets the SnowballAmiId field's value.
func (s Ec2AmiResource) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Ec2AmiResource) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Ec2RequestFailedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
func (s *Ec2RequestFailedException) Code() string
Code returns the exception type name.
func (s *Ec2RequestFailedException) Error() string
func (s Ec2RequestFailedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Ec2RequestFailedException) Message() string
Message returns the exception's message.
func (s *Ec2RequestFailedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *Ec2RequestFailedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *Ec2RequestFailedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s Ec2RequestFailedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 `type:"string"` // contains filtered or unexported fields }
The container for the EventTriggerDefinition$EventResourceARN.
func (s EventTriggerDefinition) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EventTriggerDefinition) SetEventResourceARN(v string) *EventTriggerDefinition
SetEventResourceARN sets the EventResourceARN field's value.
func (s EventTriggerDefinition) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetJobManifestInput struct { // The ID for a job that you want to get the manifest file for, for example // JID123e4567-e89b-12d3-a456-426655440000. // // JobId is a required field JobId *string `min:"39" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetJobManifestInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetJobManifestInput) SetJobId(v string) *GetJobManifestInput
SetJobId sets the JobId field's value.
func (s GetJobManifestInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetJobManifestInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetJobManifestOutput struct { // The Amazon S3 presigned URL for the manifest file associated with the specified // JobId value. ManifestURI *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetJobManifestOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetJobManifestOutput) SetManifestURI(v string) *GetJobManifestOutput
SetManifestURI sets the ManifestURI field's value.
func (s GetJobManifestOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetJobUnlockCodeInput struct { // The ID for the job that you want to get the UnlockCode value for, for example // JID123e4567-e89b-12d3-a456-426655440000. // // JobId is a required field JobId *string `min:"39" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetJobUnlockCodeInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetJobUnlockCodeInput) SetJobId(v string) *GetJobUnlockCodeInput
SetJobId sets the JobId field's value.
func (s GetJobUnlockCodeInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetJobUnlockCodeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetJobUnlockCodeOutput struct { // The UnlockCode value for the specified job. The UnlockCode value can be accessed // for up to 360 days after the job has been created. UnlockCode *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetJobUnlockCodeOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetJobUnlockCodeOutput) SetUnlockCode(v string) *GetJobUnlockCodeOutput
SetUnlockCode sets the UnlockCode field's value.
func (s GetJobUnlockCodeOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetSnowballUsageInput struct {
// contains filtered or unexported fields
}
func (s GetSnowballUsageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s GetSnowballUsageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetSnowballUsageOutput struct { // The service limit for number of Snow devices this account can have at once. // The default service limit is 1 (one). SnowballLimit *int64 `type:"integer"` // The number of Snow devices that this account is currently using. SnowballsInUse *int64 `type:"integer"` // contains filtered or unexported fields }
func (s GetSnowballUsageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetSnowballUsageOutput) SetSnowballLimit(v int64) *GetSnowballUsageOutput
SetSnowballLimit sets the SnowballLimit field's value.
func (s *GetSnowballUsageOutput) SetSnowballsInUse(v int64) *GetSnowballUsageOutput
SetSnowballsInUse sets the SnowballsInUse field's value.
func (s GetSnowballUsageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetSoftwareUpdatesInput struct { // The ID for a job that you want to get the software update file for, for example // JID123e4567-e89b-12d3-a456-426655440000. // // JobId is a required field JobId *string `min:"39" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetSoftwareUpdatesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetSoftwareUpdatesInput) SetJobId(v string) *GetSoftwareUpdatesInput
SetJobId sets the JobId field's value.
func (s GetSoftwareUpdatesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetSoftwareUpdatesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSoftwareUpdatesOutput struct { // The Amazon S3 presigned URL for the update file associated with the specified // JobId value. The software update will be available for 2 days after this // request is made. To access an update after the 2 days have passed, you'll // have to make another call to GetSoftwareUpdates. UpdatesURI *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetSoftwareUpdatesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetSoftwareUpdatesOutput) SetUpdatesURI(v string) *GetSoftwareUpdatesOutput
SetUpdatesURI sets the UpdatesURI field's value.
func (s GetSoftwareUpdatesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type INDTaxDocuments struct { // The Goods and Services Tax (GST) documents required in Amazon Web Services // Region in India. GSTIN *string `min:"15" type:"string"` // contains filtered or unexported fields }
The tax documents required in Amazon Web Services Region in India.
func (s INDTaxDocuments) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *INDTaxDocuments) SetGSTIN(v string) *INDTaxDocuments
SetGSTIN sets the GSTIN field's value.
func (s INDTaxDocuments) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *INDTaxDocuments) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InvalidAddressException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
The address provided was invalid. Check the address with your region's carrier, and try again.
func (s *InvalidAddressException) Code() string
Code returns the exception type name.
func (s *InvalidAddressException) Error() string
func (s InvalidAddressException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidAddressException) Message() string
Message returns the exception's message.
func (s *InvalidAddressException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidAddressException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidAddressException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidAddressException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidInputCombinationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
func (s *InvalidInputCombinationException) Code() string
Code returns the exception type name.
func (s *InvalidInputCombinationException) Error() string
func (s InvalidInputCombinationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidInputCombinationException) Message() string
Message returns the exception's message.
func (s *InvalidInputCombinationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidInputCombinationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidInputCombinationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidInputCombinationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidJobStateException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"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 (s *InvalidJobStateException) Code() string
Code returns the exception type name.
func (s *InvalidJobStateException) Error() string
func (s InvalidJobStateException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidJobStateException) Message() string
Message returns the exception's message.
func (s *InvalidJobStateException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidJobStateException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidJobStateException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidJobStateException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidNextTokenException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"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 (s *InvalidNextTokenException) Code() string
Code returns the exception type name.
func (s *InvalidNextTokenException) Error() string
func (s InvalidNextTokenException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidNextTokenException) Message() string
Message returns the exception's message.
func (s *InvalidNextTokenException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidNextTokenException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidNextTokenException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidNextTokenException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidResourceException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // The provided resource value is invalid. ResourceType *string `min:"1" type:"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 (s *InvalidResourceException) Code() string
Code returns the exception type name.
func (s *InvalidResourceException) Error() string
func (s InvalidResourceException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidResourceException) Message() string
Message returns the exception's message.
func (s *InvalidResourceException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidResourceException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidResourceException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidResourceException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type JobListEntry struct { // The creation date for this job. CreationDate *time.Time `type:"timestamp"` // The optional description of this specific job, for example Important Photos // 2016-08-11. Description *string `min:"1" type:"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 `type:"boolean"` // The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. JobId *string `min:"1" type:"string"` // The current state of this job. JobState *string `type:"string" enum:"JobState"` // The type of job. JobType *string `type:"string" enum:"JobType"` // The type of device used with this job. SnowballType *string `type:"string" enum:"Type"` // 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.
func (s JobListEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JobListEntry) SetCreationDate(v time.Time) *JobListEntry
SetCreationDate sets the CreationDate field's value.
func (s *JobListEntry) SetDescription(v string) *JobListEntry
SetDescription sets the Description field's value.
func (s *JobListEntry) SetIsMaster(v bool) *JobListEntry
SetIsMaster sets the IsMaster field's value.
func (s *JobListEntry) SetJobId(v string) *JobListEntry
SetJobId sets the JobId field's value.
func (s *JobListEntry) SetJobState(v string) *JobListEntry
SetJobState sets the JobState field's value.
func (s *JobListEntry) SetJobType(v string) *JobListEntry
SetJobType sets the JobType field's value.
func (s *JobListEntry) SetSnowballType(v string) *JobListEntry
SetSnowballType sets the SnowballType field's value.
func (s JobListEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type JobLogs struct { // A link to an Amazon S3 presigned URL where the job completion report is located. JobCompletionReportURI *string `min:"1" type:"string"` // A link to an Amazon S3 presigned URL where the job failure log is located. JobFailureLogURI *string `min:"1" type:"string"` // A link to an Amazon S3 presigned URL where the job success log is located. JobSuccessLogURI *string `min:"1" type:"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.
func (s JobLogs) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JobLogs) SetJobCompletionReportURI(v string) *JobLogs
SetJobCompletionReportURI sets the JobCompletionReportURI field's value.
func (s *JobLogs) SetJobFailureLogURI(v string) *JobLogs
SetJobFailureLogURI sets the JobFailureLogURI field's value.
func (s *JobLogs) SetJobSuccessLogURI(v string) *JobLogs
SetJobSuccessLogURI sets the JobSuccessLogURI field's value.
func (s JobLogs) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type JobMetadata struct { // The ID for the address that you want the Snow device shipped to. AddressId *string `min:"40" type:"string"` // The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000. ClusterId *string `min:"1" type:"string"` // The creation date for this job. CreationDate *time.Time `type:"timestamp"` // 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 `type:"structure"` // The description of the job, provided at job creation. Description *string `min:"1" type:"string"` // The container for SnowconeDeviceConfiguration. DeviceConfiguration *DeviceConfiguration `type:"structure"` // 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 `min:"40" type:"string"` // The highest impact level of data that will be stored or processed on the // device, provided at job creation. ImpactLevel *string `type:"string" enum:"ImpactLevel"` // The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. JobId *string `min:"1" type:"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 `type:"structure"` // The current status of the jobs. JobState *string `type:"string" enum:"JobState"` // The type of job. JobType *string `type:"string" enum:"JobType"` // The Amazon Resource Name (ARN) for the Key Management Service (KMS) key associated // with this job. This ARN was created using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) // API action in KMS. KmsKeyARN *string `type:"string"` // The ID of the long-term pricing type for the device. LongTermPricingId *string `min:"41" type:"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 `type:"structure"` // Represents metadata and configuration settings for services on an Amazon // Web Services Snow Family device. OnDeviceServiceConfiguration *OnDeviceServiceConfiguration `type:"structure"` // Information identifying the person picking up the device. PickupDetails *PickupDetails `type:"structure"` // 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 *string `type:"string" enum:"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 `type:"structure"` // The role ARN associated with this job. This ARN was created using the CreateRole // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // API action in Identity and Access Management. RoleARN *string `type:"string"` // A job's shipping information, including inbound and outbound tracking numbers // and shipping speed options. ShippingDetails *ShippingDetails `type:"structure"` // 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 *string `type:"string" enum:"Capacity"` // Unique ID associated with a device. SnowballId *string `min:"1" type:"string"` // The type of device used with this job. SnowballType *string `type:"string" enum:"Type"` // The metadata associated with the tax documents required in your Amazon Web // Services Region. TaxDocuments *TaxDocuments `type:"structure"` // 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.
func (s JobMetadata) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JobMetadata) SetAddressId(v string) *JobMetadata
SetAddressId sets the AddressId field's value.
func (s *JobMetadata) SetClusterId(v string) *JobMetadata
SetClusterId sets the ClusterId field's value.
func (s *JobMetadata) SetCreationDate(v time.Time) *JobMetadata
SetCreationDate sets the CreationDate field's value.
func (s *JobMetadata) SetDataTransferProgress(v *DataTransfer) *JobMetadata
SetDataTransferProgress sets the DataTransferProgress field's value.
func (s *JobMetadata) SetDescription(v string) *JobMetadata
SetDescription sets the Description field's value.
func (s *JobMetadata) SetDeviceConfiguration(v *DeviceConfiguration) *JobMetadata
SetDeviceConfiguration sets the DeviceConfiguration field's value.
func (s *JobMetadata) SetForwardingAddressId(v string) *JobMetadata
SetForwardingAddressId sets the ForwardingAddressId field's value.
func (s *JobMetadata) SetImpactLevel(v string) *JobMetadata
SetImpactLevel sets the ImpactLevel field's value.
func (s *JobMetadata) SetJobId(v string) *JobMetadata
SetJobId sets the JobId field's value.
func (s *JobMetadata) SetJobLogInfo(v *JobLogs) *JobMetadata
SetJobLogInfo sets the JobLogInfo field's value.
func (s *JobMetadata) SetJobState(v string) *JobMetadata
SetJobState sets the JobState field's value.
func (s *JobMetadata) SetJobType(v string) *JobMetadata
SetJobType sets the JobType field's value.
func (s *JobMetadata) SetKmsKeyARN(v string) *JobMetadata
SetKmsKeyARN sets the KmsKeyARN field's value.
func (s *JobMetadata) SetLongTermPricingId(v string) *JobMetadata
SetLongTermPricingId sets the LongTermPricingId field's value.
func (s *JobMetadata) SetNotification(v *Notification) *JobMetadata
SetNotification sets the Notification field's value.
func (s *JobMetadata) SetOnDeviceServiceConfiguration(v *OnDeviceServiceConfiguration) *JobMetadata
SetOnDeviceServiceConfiguration sets the OnDeviceServiceConfiguration field's value.
func (s *JobMetadata) SetPickupDetails(v *PickupDetails) *JobMetadata
SetPickupDetails sets the PickupDetails field's value.
func (s *JobMetadata) SetRemoteManagement(v string) *JobMetadata
SetRemoteManagement sets the RemoteManagement field's value.
func (s *JobMetadata) SetResources(v *JobResource) *JobMetadata
SetResources sets the Resources field's value.
func (s *JobMetadata) SetRoleARN(v string) *JobMetadata
SetRoleARN sets the RoleARN field's value.
func (s *JobMetadata) SetShippingDetails(v *ShippingDetails) *JobMetadata
SetShippingDetails sets the ShippingDetails field's value.
func (s *JobMetadata) SetSnowballCapacityPreference(v string) *JobMetadata
SetSnowballCapacityPreference sets the SnowballCapacityPreference field's value.
func (s *JobMetadata) SetSnowballId(v string) *JobMetadata
SetSnowballId sets the SnowballId field's value.
func (s *JobMetadata) SetSnowballType(v string) *JobMetadata
SetSnowballType sets the SnowballType field's value.
func (s *JobMetadata) SetTaxDocuments(v *TaxDocuments) *JobMetadata
SetTaxDocuments sets the TaxDocuments field's value.
func (s JobMetadata) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type JobResource struct { // The Amazon Machine Images (AMIs) associated with this job. Ec2AmiResources []*Ec2AmiResource `type:"list"` // The Python-language Lambda functions for this job. LambdaResources []*LambdaResource `type:"list"` // An array of S3Resource objects. S3Resources []*S3Resource `type:"list"` // 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.
func (s JobResource) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JobResource) SetEc2AmiResources(v []*Ec2AmiResource) *JobResource
SetEc2AmiResources sets the Ec2AmiResources field's value.
func (s *JobResource) SetLambdaResources(v []*LambdaResource) *JobResource
SetLambdaResources sets the LambdaResources field's value.
func (s *JobResource) SetS3Resources(v []*S3Resource) *JobResource
SetS3Resources sets the S3Resources field's value.
func (s JobResource) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *JobResource) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KMSRequestFailedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
func (s *KMSRequestFailedException) Code() string
Code returns the exception type name.
func (s *KMSRequestFailedException) Error() string
func (s KMSRequestFailedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KMSRequestFailedException) Message() string
Message returns the exception's message.
func (s *KMSRequestFailedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *KMSRequestFailedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *KMSRequestFailedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s KMSRequestFailedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 `min:"1" type:"string"` // The key that ends an optional key range for an export job. Ranges are inclusive // and UTF-8 binary sorted. EndMarker *string `min:"1" type:"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.
func (s KeyRange) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KeyRange) SetBeginMarker(v string) *KeyRange
SetBeginMarker sets the BeginMarker field's value.
func (s *KeyRange) SetEndMarker(v string) *KeyRange
SetEndMarker sets the EndMarker field's value.
func (s KeyRange) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *KeyRange) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type LambdaResource struct { // The array of ARNs for S3Resource objects to trigger the LambdaResource objects // associated with this job. EventTriggers []*EventTriggerDefinition `type:"list"` // 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 `type:"string"` // contains filtered or unexported fields }
Identifies
func (s LambdaResource) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LambdaResource) SetEventTriggers(v []*EventTriggerDefinition) *LambdaResource
SetEventTriggers sets the EventTriggers field's value.
func (s *LambdaResource) SetLambdaArn(v string) *LambdaResource
SetLambdaArn sets the LambdaArn field's value.
func (s LambdaResource) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListClusterJobsInput struct { // The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000. // // ClusterId is a required field ClusterId *string `min:"39" type:"string" required:"true"` // The number of JobListEntry objects to return. MaxResults *int64 `type:"integer"` // HTTP requests are stateless. To identify what object comes "next" in the // list of JobListEntry objects, you have the option of specifying NextToken // as the starting point for your returned list. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListClusterJobsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListClusterJobsInput) SetClusterId(v string) *ListClusterJobsInput
SetClusterId sets the ClusterId field's value.
func (s *ListClusterJobsInput) SetMaxResults(v int64) *ListClusterJobsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListClusterJobsInput) SetNextToken(v string) *ListClusterJobsInput
SetNextToken sets the NextToken field's value.
func (s ListClusterJobsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListClusterJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListClusterJobsOutput struct { // 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 export jobs. JobListEntries []*JobListEntry `type:"list"` // HTTP requests are stateless. If you use the automatically generated NextToken // value in your next ListClusterJobsResult call, your list of returned jobs // will start from this point in the array. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListClusterJobsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListClusterJobsOutput) SetJobListEntries(v []*JobListEntry) *ListClusterJobsOutput
SetJobListEntries sets the JobListEntries field's value.
func (s *ListClusterJobsOutput) SetNextToken(v string) *ListClusterJobsOutput
SetNextToken sets the NextToken field's value.
func (s ListClusterJobsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListClustersInput struct { // The number of ClusterListEntry objects to return. MaxResults *int64 `type:"integer"` // 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. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListClustersInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListClustersInput) SetMaxResults(v int64) *ListClustersInput
SetMaxResults sets the MaxResults field's value.
func (s *ListClustersInput) SetNextToken(v string) *ListClustersInput
SetNextToken sets the NextToken field's value.
func (s ListClustersInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListClustersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListClustersOutput struct { // Each ClusterListEntry object contains a cluster's state, a cluster's ID, // and other important status information. ClusterListEntries []*ClusterListEntry `type:"list"` // 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. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListClustersOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListClustersOutput) SetClusterListEntries(v []*ClusterListEntry) *ListClustersOutput
SetClusterListEntries sets the ClusterListEntries field's value.
func (s *ListClustersOutput) SetNextToken(v string) *ListClustersOutput
SetNextToken sets the NextToken field's value.
func (s ListClustersOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListCompatibleImagesInput struct { // The maximum number of results for the list of compatible images. Currently, // a Snowball Edge device can store 10 AMIs. MaxResults *int64 `type:"integer"` // HTTP requests are stateless. To identify what object comes "next" in the // list of compatible images, you can specify a value for NextToken as the starting // point for your list of returned images. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListCompatibleImagesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListCompatibleImagesInput) SetMaxResults(v int64) *ListCompatibleImagesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListCompatibleImagesInput) SetNextToken(v string) *ListCompatibleImagesInput
SetNextToken sets the NextToken field's value.
func (s ListCompatibleImagesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListCompatibleImagesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListCompatibleImagesOutput struct { // A JSON-formatted object that describes a compatible AMI, including the ID // and name for a Snow device AMI. CompatibleImages []*CompatibleImage `type:"list"` // Because HTTP requests are stateless, this is the starting point for your // next list of returned images. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListCompatibleImagesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListCompatibleImagesOutput) SetCompatibleImages(v []*CompatibleImage) *ListCompatibleImagesOutput
SetCompatibleImages sets the CompatibleImages field's value.
func (s *ListCompatibleImagesOutput) SetNextToken(v string) *ListCompatibleImagesOutput
SetNextToken sets the NextToken field's value.
func (s ListCompatibleImagesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListJobsInput struct { // The number of JobListEntry objects to return. MaxResults *int64 `type:"integer"` // HTTP requests are stateless. To identify what object comes "next" in the // list of JobListEntry objects, you have the option of specifying NextToken // as the starting point for your returned list. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListJobsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJobsInput) SetMaxResults(v int64) *ListJobsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListJobsInput) SetNextToken(v string) *ListJobsInput
SetNextToken sets the NextToken field's value.
func (s ListJobsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListJobsOutput struct { // 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 export jobs. JobListEntries []*JobListEntry `type:"list"` // HTTP requests are stateless. If you use this automatically generated NextToken // value in your next ListJobs call, your returned JobListEntry objects will // start from this point in the array. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListJobsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListJobsOutput) SetJobListEntries(v []*JobListEntry) *ListJobsOutput
SetJobListEntries sets the JobListEntries field's value.
func (s *ListJobsOutput) SetNextToken(v string) *ListJobsOutput
SetNextToken sets the NextToken field's value.
func (s ListJobsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListLongTermPricingInput struct { // The maximum number of ListLongTermPricing objects to return. MaxResults *int64 `type:"integer"` // Because HTTP requests are stateless, this is the starting point for your // next list of ListLongTermPricing to return. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListLongTermPricingInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListLongTermPricingInput) SetMaxResults(v int64) *ListLongTermPricingInput
SetMaxResults sets the MaxResults field's value.
func (s *ListLongTermPricingInput) SetNextToken(v string) *ListLongTermPricingInput
SetNextToken sets the NextToken field's value.
func (s ListLongTermPricingInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListLongTermPricingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListLongTermPricingOutput struct { // Each LongTermPricingEntry object contains a status, ID, and other information // about the LongTermPricing type. LongTermPricingEntries []*LongTermPricingListEntry `type:"list"` // Because HTTP requests are stateless, this is the starting point for your // next list of returned ListLongTermPricing list. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListLongTermPricingOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListLongTermPricingOutput) SetLongTermPricingEntries(v []*LongTermPricingListEntry) *ListLongTermPricingOutput
SetLongTermPricingEntries sets the LongTermPricingEntries field's value.
func (s *ListLongTermPricingOutput) SetNextToken(v string) *ListLongTermPricingOutput
SetNextToken sets the NextToken field's value.
func (s ListLongTermPricingOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListPickupLocationsInput struct { // The maximum number of locations to list per page. MaxResults *int64 `type:"integer"` // HTTP requests are stateless. To identify what object comes "next" in the // list of ListPickupLocationsRequest objects, you have the option of specifying // NextToken as the starting point for your returned list. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListPickupLocationsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListPickupLocationsInput) SetMaxResults(v int64) *ListPickupLocationsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListPickupLocationsInput) SetNextToken(v string) *ListPickupLocationsInput
SetNextToken sets the NextToken field's value.
func (s ListPickupLocationsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListPickupLocationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPickupLocationsOutput struct { // Information about the address of pickup locations. Addresses []*Address `type:"list"` // HTTP requests are stateless. To identify what object comes "next" in the // list of ListPickupLocationsResult objects, you have the option of specifying // NextToken as the starting point for your returned list. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListPickupLocationsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListPickupLocationsOutput) SetAddresses(v []*Address) *ListPickupLocationsOutput
SetAddresses sets the Addresses field's value.
func (s *ListPickupLocationsOutput) SetNextToken(v string) *ListPickupLocationsOutput
SetNextToken sets the NextToken field's value.
func (s ListPickupLocationsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListServiceVersionsInput struct { // A list of names and versions of dependant services of the requested service. DependentServices []*DependentService `type:"list"` // The maximum number of ListServiceVersions objects to return. MaxResults *int64 `type:"integer"` // Because HTTP requests are stateless, this is the starting point for the next // list of returned ListServiceVersionsRequest versions. NextToken *string `min:"1" type:"string"` // The name of the service for which you're requesting supported versions. // // ServiceName is a required field ServiceName *string `type:"string" required:"true" enum:"ServiceName"` // contains filtered or unexported fields }
func (s ListServiceVersionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListServiceVersionsInput) SetDependentServices(v []*DependentService) *ListServiceVersionsInput
SetDependentServices sets the DependentServices field's value.
func (s *ListServiceVersionsInput) SetMaxResults(v int64) *ListServiceVersionsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListServiceVersionsInput) SetNextToken(v string) *ListServiceVersionsInput
SetNextToken sets the NextToken field's value.
func (s *ListServiceVersionsInput) SetServiceName(v string) *ListServiceVersionsInput
SetServiceName sets the ServiceName field's value.
func (s ListServiceVersionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListServiceVersionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListServiceVersionsOutput struct { // A list of names and versions of dependant services of the service for which // the system provided supported versions. DependentServices []*DependentService `type:"list"` // Because HTTP requests are stateless, this is the starting point of the next // list of returned ListServiceVersionsResult results. NextToken *string `min:"1" type:"string"` // The name of the service for which the system provided supported versions. // // ServiceName is a required field ServiceName *string `type:"string" required:"true" enum:"ServiceName"` // A list of supported versions. // // ServiceVersions is a required field ServiceVersions []*ServiceVersion `type:"list" required:"true"` // contains filtered or unexported fields }
func (s ListServiceVersionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListServiceVersionsOutput) SetDependentServices(v []*DependentService) *ListServiceVersionsOutput
SetDependentServices sets the DependentServices field's value.
func (s *ListServiceVersionsOutput) SetNextToken(v string) *ListServiceVersionsOutput
SetNextToken sets the NextToken field's value.
func (s *ListServiceVersionsOutput) SetServiceName(v string) *ListServiceVersionsOutput
SetServiceName sets the ServiceName field's value.
func (s *ListServiceVersionsOutput) SetServiceVersions(v []*ServiceVersion) *ListServiceVersionsOutput
SetServiceVersions sets the ServiceVersions field's value.
func (s ListServiceVersionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LongTermPricingListEntry struct { // The current active jobs on the device the long-term pricing type. CurrentActiveJob *string `min:"39" type:"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 `type:"boolean"` // The IDs of the jobs that are associated with a long-term pricing type. JobIds []*string `type:"list"` // The end date the long-term pricing contract. LongTermPricingEndDate *time.Time `type:"timestamp"` // The ID of the long-term pricing type for the device. LongTermPricingId *string `min:"41" type:"string"` // The start date of the long-term pricing contract. LongTermPricingStartDate *time.Time `type:"timestamp"` // The status of the long-term pricing type. LongTermPricingStatus *string `min:"1" type:"string"` // The type of long-term pricing that was selected for the device. LongTermPricingType *string `type:"string" enum:"LongTermPricingType"` // A new device that replaces a device that is ordered with long-term pricing. ReplacementJob *string `min:"39" type:"string"` // The type of Snow Family devices associated with this long-term pricing job. SnowballType *string `type:"string" enum:"Type"` // contains filtered or unexported fields }
Each LongTermPricingListEntry object contains information about a long-term pricing type.
func (s LongTermPricingListEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LongTermPricingListEntry) SetCurrentActiveJob(v string) *LongTermPricingListEntry
SetCurrentActiveJob sets the CurrentActiveJob field's value.
func (s *LongTermPricingListEntry) SetIsLongTermPricingAutoRenew(v bool) *LongTermPricingListEntry
SetIsLongTermPricingAutoRenew sets the IsLongTermPricingAutoRenew field's value.
func (s *LongTermPricingListEntry) SetJobIds(v []*string) *LongTermPricingListEntry
SetJobIds sets the JobIds field's value.
func (s *LongTermPricingListEntry) SetLongTermPricingEndDate(v time.Time) *LongTermPricingListEntry
SetLongTermPricingEndDate sets the LongTermPricingEndDate field's value.
func (s *LongTermPricingListEntry) SetLongTermPricingId(v string) *LongTermPricingListEntry
SetLongTermPricingId sets the LongTermPricingId field's value.
func (s *LongTermPricingListEntry) SetLongTermPricingStartDate(v time.Time) *LongTermPricingListEntry
SetLongTermPricingStartDate sets the LongTermPricingStartDate field's value.
func (s *LongTermPricingListEntry) SetLongTermPricingStatus(v string) *LongTermPricingListEntry
SetLongTermPricingStatus sets the LongTermPricingStatus field's value.
func (s *LongTermPricingListEntry) SetLongTermPricingType(v string) *LongTermPricingListEntry
SetLongTermPricingType sets the LongTermPricingType field's value.
func (s *LongTermPricingListEntry) SetReplacementJob(v string) *LongTermPricingListEntry
SetReplacementJob sets the ReplacementJob field's value.
func (s *LongTermPricingListEntry) SetSnowballType(v string) *LongTermPricingListEntry
SetSnowballType sets the SnowballType field's value.
func (s LongTermPricingListEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type NFSOnDeviceServiceConfiguration struct { // The maximum NFS storage for one Snow Family device. StorageLimit *int64 `type:"integer"` // The scale unit of the NFS storage on the device. // // Valid values: TB. StorageUnit *string `type:"string" enum:"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.
func (s NFSOnDeviceServiceConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *NFSOnDeviceServiceConfiguration) SetStorageLimit(v int64) *NFSOnDeviceServiceConfiguration
SetStorageLimit sets the StorageLimit field's value.
func (s *NFSOnDeviceServiceConfiguration) SetStorageUnit(v string) *NFSOnDeviceServiceConfiguration
SetStorageUnit sets the StorageUnit field's value.
func (s NFSOnDeviceServiceConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Notification struct { // Used to send SNS notifications for the person picking up the device (identified // during job creation). DevicePickupSnsTopicARN *string `type:"string"` // The list of job states that will trigger a notification for this job. JobStatesToNotify []*string `type:"list" enum:"JobState"` // Any change in job state will trigger a notification for this job. NotifyAll *bool `type:"boolean"` // 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 (https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html) // 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 (https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) // Amazon Simple Notification Service (Amazon SNS) API action. SnsTopicARN *string `type:"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.
func (s Notification) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Notification) SetDevicePickupSnsTopicARN(v string) *Notification
SetDevicePickupSnsTopicARN sets the DevicePickupSnsTopicARN field's value.
func (s *Notification) SetJobStatesToNotify(v []*string) *Notification
SetJobStatesToNotify sets the JobStatesToNotify field's value.
func (s *Notification) SetNotifyAll(v bool) *Notification
SetNotifyAll sets the NotifyAll field's value.
func (s *Notification) SetSnsTopicARN(v string) *Notification
SetSnsTopicARN sets the SnsTopicARN field's value.
func (s Notification) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type OnDeviceServiceConfiguration struct { // The configuration of EKS Anywhere on the Snow Family device. EKSOnDeviceService *EKSOnDeviceServiceConfiguration `type:"structure"` // Represents the NFS (Network File System) service on a Snow Family device. NFSOnDeviceService *NFSOnDeviceServiceConfiguration `type:"structure"` // Configuration for Amazon S3 compatible storage on Snow family devices. S3OnDeviceService *S3OnDeviceServiceConfiguration `type:"structure"` // Represents the Storage Gateway service Tape Gateway type on a Snow Family // device. TGWOnDeviceService *TGWOnDeviceServiceConfiguration `type:"structure"` // contains filtered or unexported fields }
An object that represents the metadata and configuration settings for services on an Amazon Web Services Snow Family device.
func (s OnDeviceServiceConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OnDeviceServiceConfiguration) SetEKSOnDeviceService(v *EKSOnDeviceServiceConfiguration) *OnDeviceServiceConfiguration
SetEKSOnDeviceService sets the EKSOnDeviceService field's value.
func (s *OnDeviceServiceConfiguration) SetNFSOnDeviceService(v *NFSOnDeviceServiceConfiguration) *OnDeviceServiceConfiguration
SetNFSOnDeviceService sets the NFSOnDeviceService field's value.
func (s *OnDeviceServiceConfiguration) SetS3OnDeviceService(v *S3OnDeviceServiceConfiguration) *OnDeviceServiceConfiguration
SetS3OnDeviceService sets the S3OnDeviceService field's value.
func (s *OnDeviceServiceConfiguration) SetTGWOnDeviceService(v *TGWOnDeviceServiceConfiguration) *OnDeviceServiceConfiguration
SetTGWOnDeviceService sets the TGWOnDeviceService field's value.
func (s OnDeviceServiceConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OnDeviceServiceConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PickupDetails struct { // The unique ID for a device that will be picked up. DevicePickupId *string `min:"40" type:"string"` // The email address of the person picking up the device. // // Email is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PickupDetails's // String and GoString methods. Email *string `min:"3" type:"string" sensitive:"true"` // Expiration date of the credential identifying the person picking up the device. IdentificationExpirationDate *time.Time `type:"timestamp"` // Organization that issued the credential identifying the person picking up // the device. IdentificationIssuingOrg *string `min:"1" type:"string"` // The number on the credential identifying the person picking up the device. IdentificationNumber *string `min:"1" type:"string"` // The name of the person picking up the device. Name *string `min:"1" type:"string"` // The phone number of the person picking up the device. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PickupDetails's // String and GoString methods. PhoneNumber *string `min:"7" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Information identifying the person picking up the device.
func (s PickupDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PickupDetails) SetDevicePickupId(v string) *PickupDetails
SetDevicePickupId sets the DevicePickupId field's value.
func (s *PickupDetails) SetEmail(v string) *PickupDetails
SetEmail sets the Email field's value.
func (s *PickupDetails) SetIdentificationExpirationDate(v time.Time) *PickupDetails
SetIdentificationExpirationDate sets the IdentificationExpirationDate field's value.
func (s *PickupDetails) SetIdentificationIssuingOrg(v string) *PickupDetails
SetIdentificationIssuingOrg sets the IdentificationIssuingOrg field's value.
func (s *PickupDetails) SetIdentificationNumber(v string) *PickupDetails
SetIdentificationNumber sets the IdentificationNumber field's value.
func (s *PickupDetails) SetName(v string) *PickupDetails
SetName sets the Name field's value.
func (s *PickupDetails) SetPhoneNumber(v string) *PickupDetails
SetPhoneNumber sets the PhoneNumber field's value.
func (s PickupDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PickupDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ReturnShippingLabelAlreadyExistsException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"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 (s *ReturnShippingLabelAlreadyExistsException) Code() string
Code returns the exception type name.
func (s *ReturnShippingLabelAlreadyExistsException) Error() string
func (s ReturnShippingLabelAlreadyExistsException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ReturnShippingLabelAlreadyExistsException) Message() string
Message returns the exception's message.
func (s *ReturnShippingLabelAlreadyExistsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ReturnShippingLabelAlreadyExistsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ReturnShippingLabelAlreadyExistsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ReturnShippingLabelAlreadyExistsException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 *int64 `min:"1" type:"integer"` // 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 *int64 `min:"3" type:"integer"` // 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 `type:"double"` // Storage unit. Currently the only supported unit is TB. StorageUnit *string `type:"string" enum:"StorageUnit"` // contains filtered or unexported fields }
Amazon S3 compatible storage on Snow family devices configuration items.
func (s S3OnDeviceServiceConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3OnDeviceServiceConfiguration) SetFaultTolerance(v int64) *S3OnDeviceServiceConfiguration
SetFaultTolerance sets the FaultTolerance field's value.
func (s *S3OnDeviceServiceConfiguration) SetServiceSize(v int64) *S3OnDeviceServiceConfiguration
SetServiceSize sets the ServiceSize field's value.
func (s *S3OnDeviceServiceConfiguration) SetStorageLimit(v float64) *S3OnDeviceServiceConfiguration
SetStorageLimit sets the StorageLimit field's value.
func (s *S3OnDeviceServiceConfiguration) SetStorageUnit(v string) *S3OnDeviceServiceConfiguration
SetStorageUnit sets the StorageUnit field's value.
func (s S3OnDeviceServiceConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3OnDeviceServiceConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3Resource struct { // The Amazon Resource Name (ARN) of an Amazon S3 bucket. BucketArn *string `type:"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 `type:"structure"` // 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 `type:"list"` // 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.
func (s S3Resource) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3Resource) SetBucketArn(v string) *S3Resource
SetBucketArn sets the BucketArn field's value.
func (s *S3Resource) SetKeyRange(v *KeyRange) *S3Resource
SetKeyRange sets the KeyRange field's value.
func (s *S3Resource) SetTargetOnDeviceServices(v []*TargetOnDeviceService) *S3Resource
SetTargetOnDeviceServices sets the TargetOnDeviceServices field's value.
func (s S3Resource) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *S3Resource) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ServiceVersion struct { // The version number of the requested service. Version *string `min:"1" type:"string"` // contains filtered or unexported fields }
The version of the requested service.
func (s ServiceVersion) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceVersion) SetVersion(v string) *ServiceVersion
SetVersion sets the Version field's value.
func (s ServiceVersion) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceVersion) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Shipment struct { // Status information for a shipment. Status *string `min:"1" type:"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 `min:"1" type:"string"` // contains filtered or unexported fields }
The Status and TrackingNumber information for an inbound or outbound shipment.
func (s Shipment) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Shipment) SetStatus(v string) *Shipment
SetStatus sets the Status field's value.
func (s *Shipment) SetTrackingNumber(v string) *Shipment
SetTrackingNumber sets the TrackingNumber field's value.
func (s Shipment) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ShippingDetails struct { // The Status and TrackingNumber values for a Snow device being returned to // Amazon Web Services for a particular job. InboundShipment *Shipment `type:"structure"` // The Status and TrackingNumber values for a Snow device being delivered to // the address that you specified for a particular job. OutboundShipment *Shipment `type:"structure"` // 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 *string `type:"string" enum:"ShippingOption"` // contains filtered or unexported fields }
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
func (s ShippingDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ShippingDetails) SetInboundShipment(v *Shipment) *ShippingDetails
SetInboundShipment sets the InboundShipment field's value.
func (s *ShippingDetails) SetOutboundShipment(v *Shipment) *ShippingDetails
SetOutboundShipment sets the OutboundShipment field's value.
func (s *ShippingDetails) SetShippingOption(v string) *ShippingDetails
SetShippingOption sets the ShippingOption field's value.
func (s ShippingDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Snowball struct { *client.Client }
Snowball provides the API operation methods for making requests to Amazon Import/Export Snowball. See this package's package overview docs for details on the service.
Snowball methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Snowball
New creates a new instance of the Snowball client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a Snowball client from just a session. svc := snowball.New(mySession) // Create a Snowball client with additional configuration svc := snowball.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *Snowball) CancelCluster(input *CancelClusterInput) (*CancelClusterOutput, error)
CancelCluster API operation for Amazon Import/Export Snowball.
Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation CancelCluster for usage and error information.
Returned Error Types:
KMSRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelCluster
func (c *Snowball) CancelClusterRequest(input *CancelClusterInput) (req *request.Request, output *CancelClusterOutput)
CancelClusterRequest generates a "aws/request.Request" representing the client's request for the CancelCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CancelCluster for more information on using the CancelCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CancelClusterRequest method. req, resp := client.CancelClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelCluster
func (c *Snowball) CancelClusterWithContext(ctx aws.Context, input *CancelClusterInput, opts ...request.Option) (*CancelClusterOutput, error)
CancelClusterWithContext is the same as CancelCluster with the addition of the ability to pass a context and additional request options.
See CancelCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) CancelJob(input *CancelJobInput) (*CancelJobOutput, error)
CancelJob API operation for Amazon Import/Export Snowball.
Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation CancelJob for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
KMSRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJob
func (c *Snowball) CancelJobRequest(input *CancelJobInput) (req *request.Request, output *CancelJobOutput)
CancelJobRequest generates a "aws/request.Request" representing the client's request for the CancelJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CancelJob for more information on using the CancelJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CancelJobRequest method. req, resp := client.CancelJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJob
func (c *Snowball) CancelJobWithContext(ctx aws.Context, input *CancelJobInput, opts ...request.Option) (*CancelJobOutput, error)
CancelJobWithContext is the same as CancelJob with the addition of the ability to pass a context and additional request options.
See CancelJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) CreateAddress(input *CreateAddressInput) (*CreateAddressOutput, error)
CreateAddress API operation for Amazon Import/Export Snowball.
Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. If providing an address as a JSON file through the cli-input-json option, include the full file path. For example, --cli-input-json file://create-address.json.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation CreateAddress for usage and error information.
Returned Error Types:
InvalidAddressException The address provided was invalid. Check the address with your region's carrier, and try again.
UnsupportedAddressException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddress
func (c *Snowball) CreateAddressRequest(input *CreateAddressInput) (req *request.Request, output *CreateAddressOutput)
CreateAddressRequest generates a "aws/request.Request" representing the client's request for the CreateAddress operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateAddress for more information on using the CreateAddress API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateAddressRequest method. req, resp := client.CreateAddressRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddress
func (c *Snowball) CreateAddressWithContext(ctx aws.Context, input *CreateAddressInput, opts ...request.Option) (*CreateAddressOutput, error)
CreateAddressWithContext is the same as CreateAddress with the addition of the ability to pass a context and additional request options.
See CreateAddress for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)
CreateCluster API operation for Amazon Import/Export Snowball.
Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation CreateCluster for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
KMSRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateCluster
func (c *Snowball) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)
CreateClusterRequest generates a "aws/request.Request" representing the client's request for the CreateCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateCluster for more information on using the CreateCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateClusterRequest method. req, resp := client.CreateClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateCluster
func (c *Snowball) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)
CreateClusterWithContext is the same as CreateCluster with the addition of the ability to pass a context and additional request options.
See CreateCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) CreateJob(input *CreateJobInput) (*CreateJobOutput, error)
CreateJob API operation for Amazon Import/Export Snowball.
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services (https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?p=ngi&loc=4).
Snow Family devices and their capacities.
Device type: SNC1_SSD Capacity: T14 Description: Snowcone
Device type: SNC1_HDD Capacity: T8 Description: Snowcone
Device type: EDGE_S Capacity: T98 Description: Snowball Edge Storage Optimized for data transfer only
Device type: EDGE_CG Capacity: T42 Description: Snowball Edge Compute Optimized with GPU
Device type: EDGE_C Capacity: T42 Description: Snowball Edge Compute Optimized without GPU
Device type: EDGE Capacity: T100 Description: Snowball Edge Storage Optimized with EC2 Compute This device is replaced with T98.
Device type: STANDARD Capacity: T50 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD Capacity: T80 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
Snow Family device type: RACK_5U_C Capacity: T13 Description: Snowblade.
Device type: V3_5S Capacity: T240 Description: Snowball Edge Storage Optimized 210TB
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation CreateJob for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
KMSRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
ClusterLimitExceededException 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.
Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJob
func (c *Snowball) CreateJobRequest(input *CreateJobInput) (req *request.Request, output *CreateJobOutput)
CreateJobRequest generates a "aws/request.Request" representing the client's request for the CreateJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateJob for more information on using the CreateJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateJobRequest method. req, resp := client.CreateJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJob
func (c *Snowball) CreateJobWithContext(ctx aws.Context, input *CreateJobInput, opts ...request.Option) (*CreateJobOutput, error)
CreateJobWithContext is the same as CreateJob with the addition of the ability to pass a context and additional request options.
See CreateJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) CreateLongTermPricing(input *CreateLongTermPricingInput) (*CreateLongTermPricingOutput, error)
CreateLongTermPricing API operation for Amazon Import/Export Snowball.
Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation CreateLongTermPricing for usage and error information.
Returned Error Types:
func (c *Snowball) CreateLongTermPricingRequest(input *CreateLongTermPricingInput) (req *request.Request, output *CreateLongTermPricingOutput)
CreateLongTermPricingRequest generates a "aws/request.Request" representing the client's request for the CreateLongTermPricing operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateLongTermPricing for more information on using the CreateLongTermPricing API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateLongTermPricingRequest method. req, resp := client.CreateLongTermPricingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Snowball) CreateLongTermPricingWithContext(ctx aws.Context, input *CreateLongTermPricingInput, opts ...request.Option) (*CreateLongTermPricingOutput, error)
CreateLongTermPricingWithContext is the same as CreateLongTermPricing with the addition of the ability to pass a context and additional request options.
See CreateLongTermPricing for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) CreateReturnShippingLabel(input *CreateReturnShippingLabelInput) (*CreateReturnShippingLabelOutput, error)
CreateReturnShippingLabel API operation for Amazon Import/Export Snowball.
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation CreateReturnShippingLabel for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
ConflictException You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
ReturnShippingLabelAlreadyExistsException 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 (c *Snowball) CreateReturnShippingLabelRequest(input *CreateReturnShippingLabelInput) (req *request.Request, output *CreateReturnShippingLabelOutput)
CreateReturnShippingLabelRequest generates a "aws/request.Request" representing the client's request for the CreateReturnShippingLabel operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateReturnShippingLabel for more information on using the CreateReturnShippingLabel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateReturnShippingLabelRequest method. req, resp := client.CreateReturnShippingLabelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Snowball) CreateReturnShippingLabelWithContext(ctx aws.Context, input *CreateReturnShippingLabelInput, opts ...request.Option) (*CreateReturnShippingLabelOutput, error)
CreateReturnShippingLabelWithContext is the same as CreateReturnShippingLabel with the addition of the ability to pass a context and additional request options.
See CreateReturnShippingLabel for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) DescribeAddress(input *DescribeAddressInput) (*DescribeAddressOutput, error)
DescribeAddress API operation for Amazon Import/Export Snowball.
Takes an AddressId and returns specific details about that address in the form of an Address object.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation DescribeAddress for usage and error information.
Returned Error Types:
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddress
func (c *Snowball) DescribeAddressRequest(input *DescribeAddressInput) (req *request.Request, output *DescribeAddressOutput)
DescribeAddressRequest generates a "aws/request.Request" representing the client's request for the DescribeAddress operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAddress for more information on using the DescribeAddress API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAddressRequest method. req, resp := client.DescribeAddressRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddress
func (c *Snowball) DescribeAddressWithContext(ctx aws.Context, input *DescribeAddressInput, opts ...request.Option) (*DescribeAddressOutput, error)
DescribeAddressWithContext is the same as DescribeAddress with the addition of the ability to pass a context and additional request options.
See DescribeAddress for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) DescribeAddresses(input *DescribeAddressesInput) (*DescribeAddressesOutput, error)
DescribeAddresses API operation for Amazon Import/Export Snowball.
Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation DescribeAddresses for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddresses
func (c *Snowball) DescribeAddressesPages(input *DescribeAddressesInput, fn func(*DescribeAddressesOutput, bool) bool) error
DescribeAddressesPages iterates over the pages of a DescribeAddresses operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeAddresses method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeAddresses operation. pageNum := 0 err := client.DescribeAddressesPages(params, func(page *snowball.DescribeAddressesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Snowball) DescribeAddressesPagesWithContext(ctx aws.Context, input *DescribeAddressesInput, fn func(*DescribeAddressesOutput, bool) bool, opts ...request.Option) error
DescribeAddressesPagesWithContext same as DescribeAddressesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) DescribeAddressesRequest(input *DescribeAddressesInput) (req *request.Request, output *DescribeAddressesOutput)
DescribeAddressesRequest generates a "aws/request.Request" representing the client's request for the DescribeAddresses operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAddresses for more information on using the DescribeAddresses API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAddressesRequest method. req, resp := client.DescribeAddressesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddresses
func (c *Snowball) DescribeAddressesWithContext(ctx aws.Context, input *DescribeAddressesInput, opts ...request.Option) (*DescribeAddressesOutput, error)
DescribeAddressesWithContext is the same as DescribeAddresses with the addition of the ability to pass a context and additional request options.
See DescribeAddresses for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) DescribeCluster(input *DescribeClusterInput) (*DescribeClusterOutput, error)
DescribeCluster API operation for Amazon Import/Export Snowball.
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation DescribeCluster for usage and error information.
Returned Error Types:
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeCluster
func (c *Snowball) DescribeClusterRequest(input *DescribeClusterInput) (req *request.Request, output *DescribeClusterOutput)
DescribeClusterRequest generates a "aws/request.Request" representing the client's request for the DescribeCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeCluster for more information on using the DescribeCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeClusterRequest method. req, resp := client.DescribeClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeCluster
func (c *Snowball) DescribeClusterWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...request.Option) (*DescribeClusterOutput, error)
DescribeClusterWithContext is the same as DescribeCluster with the addition of the ability to pass a context and additional request options.
See DescribeCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) DescribeJob(input *DescribeJobInput) (*DescribeJobOutput, error)
DescribeJob API operation for Amazon Import/Export Snowball.
Returns information about a specific job including shipping information, job status, and other important metadata.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation DescribeJob for usage and error information.
Returned Error Types:
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJob
func (c *Snowball) DescribeJobRequest(input *DescribeJobInput) (req *request.Request, output *DescribeJobOutput)
DescribeJobRequest generates a "aws/request.Request" representing the client's request for the DescribeJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeJob for more information on using the DescribeJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeJobRequest method. req, resp := client.DescribeJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJob
func (c *Snowball) DescribeJobWithContext(ctx aws.Context, input *DescribeJobInput, opts ...request.Option) (*DescribeJobOutput, error)
DescribeJobWithContext is the same as DescribeJob with the addition of the ability to pass a context and additional request options.
See DescribeJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) DescribeReturnShippingLabel(input *DescribeReturnShippingLabelInput) (*DescribeReturnShippingLabelOutput, error)
DescribeReturnShippingLabel API operation for Amazon Import/Export Snowball.
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation DescribeReturnShippingLabel for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
ConflictException You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
func (c *Snowball) DescribeReturnShippingLabelRequest(input *DescribeReturnShippingLabelInput) (req *request.Request, output *DescribeReturnShippingLabelOutput)
DescribeReturnShippingLabelRequest generates a "aws/request.Request" representing the client's request for the DescribeReturnShippingLabel operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeReturnShippingLabel for more information on using the DescribeReturnShippingLabel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeReturnShippingLabelRequest method. req, resp := client.DescribeReturnShippingLabelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Snowball) DescribeReturnShippingLabelWithContext(ctx aws.Context, input *DescribeReturnShippingLabelInput, opts ...request.Option) (*DescribeReturnShippingLabelOutput, error)
DescribeReturnShippingLabelWithContext is the same as DescribeReturnShippingLabel with the addition of the ability to pass a context and additional request options.
See DescribeReturnShippingLabel for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) GetJobManifest(input *GetJobManifestInput) (*GetJobManifestOutput, error)
GetJobManifest API operation for Amazon Import/Export Snowball.
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.
The manifest is an encrypted file that you can download after your job enters the WithCustomer status. This is the only valid status for calling this API as the manifest and UnlockCode code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time.
As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation GetJobManifest for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifest
func (c *Snowball) GetJobManifestRequest(input *GetJobManifestInput) (req *request.Request, output *GetJobManifestOutput)
GetJobManifestRequest generates a "aws/request.Request" representing the client's request for the GetJobManifest operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetJobManifest for more information on using the GetJobManifest API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetJobManifestRequest method. req, resp := client.GetJobManifestRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifest
func (c *Snowball) GetJobManifestWithContext(ctx aws.Context, input *GetJobManifestInput, opts ...request.Option) (*GetJobManifestOutput, error)
GetJobManifestWithContext is the same as GetJobManifest with the addition of the ability to pass a context and additional request options.
See GetJobManifest for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) GetJobUnlockCode(input *GetJobUnlockCodeInput) (*GetJobUnlockCodeOutput, error)
GetJobUnlockCode API operation for Amazon Import/Export Snowball.
Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 days after the associated job has been created.
The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device.
As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation GetJobUnlockCode for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCode
func (c *Snowball) GetJobUnlockCodeRequest(input *GetJobUnlockCodeInput) (req *request.Request, output *GetJobUnlockCodeOutput)
GetJobUnlockCodeRequest generates a "aws/request.Request" representing the client's request for the GetJobUnlockCode operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetJobUnlockCode for more information on using the GetJobUnlockCode API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetJobUnlockCodeRequest method. req, resp := client.GetJobUnlockCodeRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCode
func (c *Snowball) GetJobUnlockCodeWithContext(ctx aws.Context, input *GetJobUnlockCodeInput, opts ...request.Option) (*GetJobUnlockCodeOutput, error)
GetJobUnlockCodeWithContext is the same as GetJobUnlockCode with the addition of the ability to pass a context and additional request options.
See GetJobUnlockCode for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) GetSnowballUsage(input *GetSnowballUsageInput) (*GetSnowballUsageOutput, error)
GetSnowballUsage API operation for Amazon Import/Export Snowball.
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.
The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation GetSnowballUsage for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsage
func (c *Snowball) GetSnowballUsageRequest(input *GetSnowballUsageInput) (req *request.Request, output *GetSnowballUsageOutput)
GetSnowballUsageRequest generates a "aws/request.Request" representing the client's request for the GetSnowballUsage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetSnowballUsage for more information on using the GetSnowballUsage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetSnowballUsageRequest method. req, resp := client.GetSnowballUsageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsage
func (c *Snowball) GetSnowballUsageWithContext(ctx aws.Context, input *GetSnowballUsageInput, opts ...request.Option) (*GetSnowballUsageOutput, error)
GetSnowballUsageWithContext is the same as GetSnowballUsage with the addition of the ability to pass a context and additional request options.
See GetSnowballUsage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) GetSoftwareUpdates(input *GetSoftwareUpdatesInput) (*GetSoftwareUpdatesOutput, error)
GetSoftwareUpdates API operation for Amazon Import/Export Snowball.
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation GetSoftwareUpdates for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSoftwareUpdates
func (c *Snowball) GetSoftwareUpdatesRequest(input *GetSoftwareUpdatesInput) (req *request.Request, output *GetSoftwareUpdatesOutput)
GetSoftwareUpdatesRequest generates a "aws/request.Request" representing the client's request for the GetSoftwareUpdates operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetSoftwareUpdates for more information on using the GetSoftwareUpdates API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetSoftwareUpdatesRequest method. req, resp := client.GetSoftwareUpdatesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSoftwareUpdates
func (c *Snowball) GetSoftwareUpdatesWithContext(ctx aws.Context, input *GetSoftwareUpdatesInput, opts ...request.Option) (*GetSoftwareUpdatesOutput, error)
GetSoftwareUpdatesWithContext is the same as GetSoftwareUpdates with the addition of the ability to pass a context and additional request options.
See GetSoftwareUpdates for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListClusterJobs(input *ListClusterJobsInput) (*ListClusterJobsOutput, error)
ListClusterJobs API operation for Amazon Import/Export Snowball.
Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation ListClusterJobs for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobs
func (c *Snowball) ListClusterJobsPages(input *ListClusterJobsInput, fn func(*ListClusterJobsOutput, bool) bool) error
ListClusterJobsPages iterates over the pages of a ListClusterJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListClusterJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListClusterJobs operation. pageNum := 0 err := client.ListClusterJobsPages(params, func(page *snowball.ListClusterJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Snowball) ListClusterJobsPagesWithContext(ctx aws.Context, input *ListClusterJobsInput, fn func(*ListClusterJobsOutput, bool) bool, opts ...request.Option) error
ListClusterJobsPagesWithContext same as ListClusterJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListClusterJobsRequest(input *ListClusterJobsInput) (req *request.Request, output *ListClusterJobsOutput)
ListClusterJobsRequest generates a "aws/request.Request" representing the client's request for the ListClusterJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListClusterJobs for more information on using the ListClusterJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListClusterJobsRequest method. req, resp := client.ListClusterJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobs
func (c *Snowball) ListClusterJobsWithContext(ctx aws.Context, input *ListClusterJobsInput, opts ...request.Option) (*ListClusterJobsOutput, error)
ListClusterJobsWithContext is the same as ListClusterJobs with the addition of the ability to pass a context and additional request options.
See ListClusterJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListClusters(input *ListClustersInput) (*ListClustersOutput, error)
ListClusters API operation for Amazon Import/Export Snowball.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation ListClusters for usage and error information.
Returned Error Types:
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusters
func (c *Snowball) ListClustersPages(input *ListClustersInput, fn func(*ListClustersOutput, bool) bool) error
ListClustersPages iterates over the pages of a ListClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListClusters method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListClusters operation. pageNum := 0 err := client.ListClustersPages(params, func(page *snowball.ListClustersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Snowball) ListClustersPagesWithContext(ctx aws.Context, input *ListClustersInput, fn func(*ListClustersOutput, bool) bool, opts ...request.Option) error
ListClustersPagesWithContext same as ListClustersPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListClustersRequest(input *ListClustersInput) (req *request.Request, output *ListClustersOutput)
ListClustersRequest generates a "aws/request.Request" representing the client's request for the ListClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListClusters for more information on using the ListClusters API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListClustersRequest method. req, resp := client.ListClustersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusters
func (c *Snowball) ListClustersWithContext(ctx aws.Context, input *ListClustersInput, opts ...request.Option) (*ListClustersOutput, error)
ListClustersWithContext is the same as ListClusters with the addition of the ability to pass a context and additional request options.
See ListClusters for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListCompatibleImages(input *ListCompatibleImagesInput) (*ListCompatibleImagesOutput, error)
ListCompatibleImages API operation for Amazon Import/Export Snowball.
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation ListCompatibleImages for usage and error information.
Returned Error Types:
InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
func (c *Snowball) ListCompatibleImagesPages(input *ListCompatibleImagesInput, fn func(*ListCompatibleImagesOutput, bool) bool) error
ListCompatibleImagesPages iterates over the pages of a ListCompatibleImages operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListCompatibleImages method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListCompatibleImages operation. pageNum := 0 err := client.ListCompatibleImagesPages(params, func(page *snowball.ListCompatibleImagesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Snowball) ListCompatibleImagesPagesWithContext(ctx aws.Context, input *ListCompatibleImagesInput, fn func(*ListCompatibleImagesOutput, bool) bool, opts ...request.Option) error
ListCompatibleImagesPagesWithContext same as ListCompatibleImagesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListCompatibleImagesRequest(input *ListCompatibleImagesInput) (req *request.Request, output *ListCompatibleImagesOutput)
ListCompatibleImagesRequest generates a "aws/request.Request" representing the client's request for the ListCompatibleImages operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListCompatibleImages for more information on using the ListCompatibleImages API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListCompatibleImagesRequest method. req, resp := client.ListCompatibleImagesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Snowball) ListCompatibleImagesWithContext(ctx aws.Context, input *ListCompatibleImagesInput, opts ...request.Option) (*ListCompatibleImagesOutput, error)
ListCompatibleImagesWithContext is the same as ListCompatibleImages with the addition of the ability to pass a context and additional request options.
See ListCompatibleImages for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)
ListJobs API operation for Amazon Import/Export Snowball.
Returns an array of JobListEntry objects of the specified length. 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 export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation ListJobs for usage and error information.
Returned Error Types:
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobs
func (c *Snowball) ListJobsPages(input *ListJobsInput, fn func(*ListJobsOutput, bool) bool) error
ListJobsPages iterates over the pages of a ListJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListJobs operation. pageNum := 0 err := client.ListJobsPages(params, func(page *snowball.ListJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Snowball) ListJobsPagesWithContext(ctx aws.Context, input *ListJobsInput, fn func(*ListJobsOutput, bool) bool, opts ...request.Option) error
ListJobsPagesWithContext same as ListJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListJobsRequest(input *ListJobsInput) (req *request.Request, output *ListJobsOutput)
ListJobsRequest generates a "aws/request.Request" representing the client's request for the ListJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListJobs for more information on using the ListJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListJobsRequest method. req, resp := client.ListJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobs
func (c *Snowball) ListJobsWithContext(ctx aws.Context, input *ListJobsInput, opts ...request.Option) (*ListJobsOutput, error)
ListJobsWithContext is the same as ListJobs with the addition of the ability to pass a context and additional request options.
See ListJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListLongTermPricing(input *ListLongTermPricingInput) (*ListLongTermPricingOutput, error)
ListLongTermPricing API operation for Amazon Import/Export Snowball.
Lists all long-term pricing types.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation ListLongTermPricing for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListLongTermPricing
func (c *Snowball) ListLongTermPricingPages(input *ListLongTermPricingInput, fn func(*ListLongTermPricingOutput, bool) bool) error
ListLongTermPricingPages iterates over the pages of a ListLongTermPricing operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListLongTermPricing method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListLongTermPricing operation. pageNum := 0 err := client.ListLongTermPricingPages(params, func(page *snowball.ListLongTermPricingOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Snowball) ListLongTermPricingPagesWithContext(ctx aws.Context, input *ListLongTermPricingInput, fn func(*ListLongTermPricingOutput, bool) bool, opts ...request.Option) error
ListLongTermPricingPagesWithContext same as ListLongTermPricingPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListLongTermPricingRequest(input *ListLongTermPricingInput) (req *request.Request, output *ListLongTermPricingOutput)
ListLongTermPricingRequest generates a "aws/request.Request" representing the client's request for the ListLongTermPricing operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListLongTermPricing for more information on using the ListLongTermPricing API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListLongTermPricingRequest method. req, resp := client.ListLongTermPricingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListLongTermPricing
func (c *Snowball) ListLongTermPricingWithContext(ctx aws.Context, input *ListLongTermPricingInput, opts ...request.Option) (*ListLongTermPricingOutput, error)
ListLongTermPricingWithContext is the same as ListLongTermPricing with the addition of the ability to pass a context and additional request options.
See ListLongTermPricing for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListPickupLocations(input *ListPickupLocationsInput) (*ListPickupLocationsOutput, error)
ListPickupLocations API operation for Amazon Import/Export Snowball.
A list of locations from which the customer can choose to pickup a device.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation ListPickupLocations for usage and error information.
Returned Error Types:
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListPickupLocations
func (c *Snowball) ListPickupLocationsPages(input *ListPickupLocationsInput, fn func(*ListPickupLocationsOutput, bool) bool) error
ListPickupLocationsPages iterates over the pages of a ListPickupLocations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListPickupLocations method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListPickupLocations operation. pageNum := 0 err := client.ListPickupLocationsPages(params, func(page *snowball.ListPickupLocationsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Snowball) ListPickupLocationsPagesWithContext(ctx aws.Context, input *ListPickupLocationsInput, fn func(*ListPickupLocationsOutput, bool) bool, opts ...request.Option) error
ListPickupLocationsPagesWithContext same as ListPickupLocationsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListPickupLocationsRequest(input *ListPickupLocationsInput) (req *request.Request, output *ListPickupLocationsOutput)
ListPickupLocationsRequest generates a "aws/request.Request" representing the client's request for the ListPickupLocations operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListPickupLocations for more information on using the ListPickupLocations API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListPickupLocationsRequest method. req, resp := client.ListPickupLocationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListPickupLocations
func (c *Snowball) ListPickupLocationsWithContext(ctx aws.Context, input *ListPickupLocationsInput, opts ...request.Option) (*ListPickupLocationsOutput, error)
ListPickupLocationsWithContext is the same as ListPickupLocations with the addition of the ability to pass a context and additional request options.
See ListPickupLocations for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) ListServiceVersions(input *ListServiceVersionsInput) (*ListServiceVersionsOutput, error)
ListServiceVersions API operation for Amazon Import/Export Snowball.
Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation ListServiceVersions for usage and error information.
Returned Error Types:
InvalidNextTokenException The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListServiceVersions
func (c *Snowball) ListServiceVersionsRequest(input *ListServiceVersionsInput) (req *request.Request, output *ListServiceVersionsOutput)
ListServiceVersionsRequest generates a "aws/request.Request" representing the client's request for the ListServiceVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListServiceVersions for more information on using the ListServiceVersions API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListServiceVersionsRequest method. req, resp := client.ListServiceVersionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListServiceVersions
func (c *Snowball) ListServiceVersionsWithContext(ctx aws.Context, input *ListServiceVersionsInput, opts ...request.Option) (*ListServiceVersionsOutput, error)
ListServiceVersionsWithContext is the same as ListServiceVersions with the addition of the ability to pass a context and additional request options.
See ListServiceVersions for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) UpdateCluster(input *UpdateClusterInput) (*UpdateClusterOutput, error)
UpdateCluster API operation for Amazon Import/Export Snowball.
While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation UpdateCluster for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
KMSRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateCluster
func (c *Snowball) UpdateClusterRequest(input *UpdateClusterInput) (req *request.Request, output *UpdateClusterOutput)
UpdateClusterRequest generates a "aws/request.Request" representing the client's request for the UpdateCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateCluster for more information on using the UpdateCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateClusterRequest method. req, resp := client.UpdateClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateCluster
func (c *Snowball) UpdateClusterWithContext(ctx aws.Context, input *UpdateClusterInput, opts ...request.Option) (*UpdateClusterOutput, error)
UpdateClusterWithContext is the same as UpdateCluster with the addition of the ability to pass a context and additional request options.
See UpdateCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) UpdateJob(input *UpdateJobInput) (*UpdateJobOutput, error)
UpdateJob API operation for Amazon Import/Export Snowball.
While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation UpdateJob for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
KMSRequestFailedException The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
InvalidInputCombinationException Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
ClusterLimitExceededException 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.
Ec2RequestFailedException Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJob
func (c *Snowball) UpdateJobRequest(input *UpdateJobInput) (req *request.Request, output *UpdateJobOutput)
UpdateJobRequest generates a "aws/request.Request" representing the client's request for the UpdateJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateJob for more information on using the UpdateJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateJobRequest method. req, resp := client.UpdateJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJob
func (c *Snowball) UpdateJobShipmentState(input *UpdateJobShipmentStateInput) (*UpdateJobShipmentStateOutput, error)
UpdateJobShipmentState API operation for Amazon Import/Export Snowball.
Updates the state when a shipment state changes to a different state.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation UpdateJobShipmentState for usage and error information.
Returned Error Types:
InvalidResourceException The specified resource can't be found. Check the information you provided in your last request, and try again.
InvalidJobStateException The action can't be performed because the job's current state doesn't allow that action to be performed.
func (c *Snowball) UpdateJobShipmentStateRequest(input *UpdateJobShipmentStateInput) (req *request.Request, output *UpdateJobShipmentStateOutput)
UpdateJobShipmentStateRequest generates a "aws/request.Request" representing the client's request for the UpdateJobShipmentState operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateJobShipmentState for more information on using the UpdateJobShipmentState API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateJobShipmentStateRequest method. req, resp := client.UpdateJobShipmentStateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Snowball) UpdateJobShipmentStateWithContext(ctx aws.Context, input *UpdateJobShipmentStateInput, opts ...request.Option) (*UpdateJobShipmentStateOutput, error)
UpdateJobShipmentStateWithContext is the same as UpdateJobShipmentState with the addition of the ability to pass a context and additional request options.
See UpdateJobShipmentState for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) UpdateJobWithContext(ctx aws.Context, input *UpdateJobInput, opts ...request.Option) (*UpdateJobOutput, error)
UpdateJobWithContext is the same as UpdateJob with the addition of the ability to pass a context and additional request options.
See UpdateJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Snowball) UpdateLongTermPricing(input *UpdateLongTermPricingInput) (*UpdateLongTermPricingOutput, error)
UpdateLongTermPricing API operation for Amazon Import/Export Snowball.
Updates the long-term pricing type.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Import/Export Snowball's API operation UpdateLongTermPricing for usage and error information.
Returned Error Types:
func (c *Snowball) UpdateLongTermPricingRequest(input *UpdateLongTermPricingInput) (req *request.Request, output *UpdateLongTermPricingOutput)
UpdateLongTermPricingRequest generates a "aws/request.Request" representing the client's request for the UpdateLongTermPricing operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateLongTermPricing for more information on using the UpdateLongTermPricing API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateLongTermPricingRequest method. req, resp := client.UpdateLongTermPricingRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *Snowball) UpdateLongTermPricingWithContext(ctx aws.Context, input *UpdateLongTermPricingInput, opts ...request.Option) (*UpdateLongTermPricingOutput, error)
UpdateLongTermPricingWithContext is the same as UpdateLongTermPricing with the addition of the ability to pass a context and additional request options.
See UpdateLongTermPricing for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type SnowconeDeviceConfiguration struct { // Configures the wireless connection for the Snowcone device. WirelessConnection *WirelessConnection `type:"structure"` // contains filtered or unexported fields }
Specifies the device configuration for an Snowcone job.
func (s SnowconeDeviceConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SnowconeDeviceConfiguration) SetWirelessConnection(v *WirelessConnection) *SnowconeDeviceConfiguration
SetWirelessConnection sets the WirelessConnection field's value.
func (s SnowconeDeviceConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 *int64 `type:"integer"` // The scale unit of the virtual tapes on the device. StorageUnit *string `type:"string" enum:"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.
func (s TGWOnDeviceServiceConfiguration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TGWOnDeviceServiceConfiguration) SetStorageLimit(v int64) *TGWOnDeviceServiceConfiguration
SetStorageLimit sets the StorageLimit field's value.
func (s *TGWOnDeviceServiceConfiguration) SetStorageUnit(v string) *TGWOnDeviceServiceConfiguration
SetStorageUnit sets the StorageUnit field's value.
func (s TGWOnDeviceServiceConfiguration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 *string `type:"string" enum:"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 *string `type:"string" enum:"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).
func (s TargetOnDeviceService) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TargetOnDeviceService) SetServiceName(v string) *TargetOnDeviceService
SetServiceName sets the ServiceName field's value.
func (s *TargetOnDeviceService) SetTransferOption(v string) *TargetOnDeviceService
SetTransferOption sets the TransferOption field's value.
func (s TargetOnDeviceService) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TaxDocuments struct { // The tax documents required in Amazon Web Services Region in India. IND *INDTaxDocuments `type:"structure"` // contains filtered or unexported fields }
The tax documents required in your Amazon Web Services Region.
func (s TaxDocuments) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TaxDocuments) SetIND(v *INDTaxDocuments) *TaxDocuments
SetIND sets the IND field's value.
func (s TaxDocuments) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TaxDocuments) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UnsupportedAddressException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"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 (s *UnsupportedAddressException) Code() string
Code returns the exception type name.
func (s *UnsupportedAddressException) Error() string
func (s UnsupportedAddressException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UnsupportedAddressException) Message() string
Message returns the exception's message.
func (s *UnsupportedAddressException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *UnsupportedAddressException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *UnsupportedAddressException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s UnsupportedAddressException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateClusterInput struct { // The ID of the updated Address object. AddressId *string `min:"40" type:"string"` // The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000. // // ClusterId is a required field ClusterId *string `min:"39" type:"string" required:"true"` // The updated description of this cluster. Description *string `min:"1" type:"string"` // The updated ID for the forwarding address for a cluster. This field is not // supported in most regions. ForwardingAddressId *string `min:"40" type:"string"` // The new or updated Notification object. Notification *Notification `type:"structure"` // 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 // device clusters support Amazon S3 and NFS (Network File System). OnDeviceServiceConfiguration *OnDeviceServiceConfiguration `type:"structure"` // The updated arrays of JobResource objects that can include updated S3Resource // objects or LambdaResource objects. Resources *JobResource `type:"structure"` // The new role Amazon Resource Name (ARN) that you want to associate with this // cluster. To create a role ARN, use the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // API action in Identity and Access Management (IAM). RoleARN *string `type:"string"` // The updated shipping option value of this cluster's ShippingDetails object. ShippingOption *string `type:"string" enum:"ShippingOption"` // contains filtered or unexported fields }
func (s UpdateClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateClusterInput) SetAddressId(v string) *UpdateClusterInput
SetAddressId sets the AddressId field's value.
func (s *UpdateClusterInput) SetClusterId(v string) *UpdateClusterInput
SetClusterId sets the ClusterId field's value.
func (s *UpdateClusterInput) SetDescription(v string) *UpdateClusterInput
SetDescription sets the Description field's value.
func (s *UpdateClusterInput) SetForwardingAddressId(v string) *UpdateClusterInput
SetForwardingAddressId sets the ForwardingAddressId field's value.
func (s *UpdateClusterInput) SetNotification(v *Notification) *UpdateClusterInput
SetNotification sets the Notification field's value.
func (s *UpdateClusterInput) SetOnDeviceServiceConfiguration(v *OnDeviceServiceConfiguration) *UpdateClusterInput
SetOnDeviceServiceConfiguration sets the OnDeviceServiceConfiguration field's value.
func (s *UpdateClusterInput) SetResources(v *JobResource) *UpdateClusterInput
SetResources sets the Resources field's value.
func (s *UpdateClusterInput) SetRoleARN(v string) *UpdateClusterInput
SetRoleARN sets the RoleARN field's value.
func (s *UpdateClusterInput) SetShippingOption(v string) *UpdateClusterInput
SetShippingOption sets the ShippingOption field's value.
func (s UpdateClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateClusterOutput struct {
// contains filtered or unexported fields
}
func (s UpdateClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UpdateClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateJobInput struct { // The ID of the updated Address object. AddressId *string `min:"40" type:"string"` // The updated description of this job's JobMetadata object. Description *string `min:"1" type:"string"` // The updated ID for the forwarding address for a job. This field is not supported // in most regions. ForwardingAddressId *string `min:"40" type:"string"` // The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000. // // JobId is a required field JobId *string `min:"39" type:"string" required:"true"` // The new or updated Notification object. Notification *Notification `type:"structure"` // 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) and the Amazon Web Services // Storage Gateway service Tape Gateway type. OnDeviceServiceConfiguration *OnDeviceServiceConfiguration `type:"structure"` // Information identifying the person picking up the device. PickupDetails *PickupDetails `type:"structure"` // The updated JobResource object, or the updated JobResource object. Resources *JobResource `type:"structure"` // The new role Amazon Resource Name (ARN) that you want to associate with this // job. To create a role ARN, use the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html)Identity // and Access Management (IAM) API action. RoleARN *string `type:"string"` // The updated shipping option value of this job's ShippingDetails object. ShippingOption *string `type:"string" enum:"ShippingOption"` // The updated SnowballCapacityPreference of this job's JobMetadata object. // The 50 TB Snowballs are only available in the US regions. // // 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 *string `type:"string" enum:"Capacity"` // contains filtered or unexported fields }
func (s UpdateJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateJobInput) SetAddressId(v string) *UpdateJobInput
SetAddressId sets the AddressId field's value.
func (s *UpdateJobInput) SetDescription(v string) *UpdateJobInput
SetDescription sets the Description field's value.
func (s *UpdateJobInput) SetForwardingAddressId(v string) *UpdateJobInput
SetForwardingAddressId sets the ForwardingAddressId field's value.
func (s *UpdateJobInput) SetJobId(v string) *UpdateJobInput
SetJobId sets the JobId field's value.
func (s *UpdateJobInput) SetNotification(v *Notification) *UpdateJobInput
SetNotification sets the Notification field's value.
func (s *UpdateJobInput) SetOnDeviceServiceConfiguration(v *OnDeviceServiceConfiguration) *UpdateJobInput
SetOnDeviceServiceConfiguration sets the OnDeviceServiceConfiguration field's value.
func (s *UpdateJobInput) SetPickupDetails(v *PickupDetails) *UpdateJobInput
SetPickupDetails sets the PickupDetails field's value.
func (s *UpdateJobInput) SetResources(v *JobResource) *UpdateJobInput
SetResources sets the Resources field's value.
func (s *UpdateJobInput) SetRoleARN(v string) *UpdateJobInput
SetRoleARN sets the RoleARN field's value.
func (s *UpdateJobInput) SetShippingOption(v string) *UpdateJobInput
SetShippingOption sets the ShippingOption field's value.
func (s *UpdateJobInput) SetSnowballCapacityPreference(v string) *UpdateJobInput
SetSnowballCapacityPreference sets the SnowballCapacityPreference field's value.
func (s UpdateJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateJobOutput struct {
// contains filtered or unexported fields
}
func (s UpdateJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UpdateJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateJobShipmentStateInput struct { // The job ID of the job whose shipment date you want to update, for example // JID123e4567-e89b-12d3-a456-426655440000. // // JobId is a required field JobId *string `min:"39" type:"string" required:"true"` // The state of a device when it is being shipped. // // Set to RECEIVED when the device arrives at your location. // // Set to RETURNED when you have returned the device to Amazon Web Services. // // ShipmentState is a required field ShipmentState *string `type:"string" required:"true" enum:"ShipmentState"` // contains filtered or unexported fields }
func (s UpdateJobShipmentStateInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateJobShipmentStateInput) SetJobId(v string) *UpdateJobShipmentStateInput
SetJobId sets the JobId field's value.
func (s *UpdateJobShipmentStateInput) SetShipmentState(v string) *UpdateJobShipmentStateInput
SetShipmentState sets the ShipmentState field's value.
func (s UpdateJobShipmentStateInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateJobShipmentStateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateJobShipmentStateOutput struct {
// contains filtered or unexported fields
}
func (s UpdateJobShipmentStateOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UpdateJobShipmentStateOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateLongTermPricingInput struct { // 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 `type:"boolean"` // The ID of the long-term pricing type for the device. // // LongTermPricingId is a required field LongTermPricingId *string `min:"41" type:"string" required:"true"` // Specifies that a device that is ordered with long-term pricing should be // replaced with a new device. ReplacementJob *string `min:"39" type:"string"` // contains filtered or unexported fields }
func (s UpdateLongTermPricingInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateLongTermPricingInput) SetIsLongTermPricingAutoRenew(v bool) *UpdateLongTermPricingInput
SetIsLongTermPricingAutoRenew sets the IsLongTermPricingAutoRenew field's value.
func (s *UpdateLongTermPricingInput) SetLongTermPricingId(v string) *UpdateLongTermPricingInput
SetLongTermPricingId sets the LongTermPricingId field's value.
func (s *UpdateLongTermPricingInput) SetReplacementJob(v string) *UpdateLongTermPricingInput
SetReplacementJob sets the ReplacementJob field's value.
func (s UpdateLongTermPricingInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateLongTermPricingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateLongTermPricingOutput struct {
// contains filtered or unexported fields
}
func (s UpdateLongTermPricingOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UpdateLongTermPricingOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type WirelessConnection struct { // Enables the Wi-Fi adapter on an Snowcone device. IsWifiEnabled *bool `type:"boolean"` // contains filtered or unexported fields }
Configures the wireless connection on an Snowcone device.
func (s WirelessConnection) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *WirelessConnection) SetIsWifiEnabled(v bool) *WirelessConnection
SetIsWifiEnabled sets the IsWifiEnabled field's value.
func (s WirelessConnection) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".