snowball

package
v1.5.9 Latest Latest
Warning

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

 Go to latest Published: Nov 22, 2016 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package snowball provides a client for Amazon Import/Export Snowball.

Index

Examples

Constants

View Source 
const (
	// CapacityT50 is a Capacity enum value
	CapacityT50 = "T50"

	// CapacityT80 is a Capacity enum value
	CapacityT80 = "T80"

	// CapacityNoPreference is a Capacity enum value
	CapacityNoPreference = "NoPreference"
)
View Source 
const (
	// JobStateNew is a JobState enum value
	JobStateNew = "New"

	// JobStatePreparingAppliance is a JobState enum value
	JobStatePreparingAppliance = "PreparingAppliance"

	// JobStatePreparingShipment is a JobState enum value
	JobStatePreparingShipment = "PreparingShipment"

	// JobStateInTransitToCustomer is a JobState enum value
	JobStateInTransitToCustomer = "InTransitToCustomer"

	// JobStateWithCustomer is a JobState enum value
	JobStateWithCustomer = "WithCustomer"

	// JobStateInTransitToAws is a JobState enum value
	JobStateInTransitToAws = "InTransitToAWS"

	// JobStateWithAws is a JobState enum value
	JobStateWithAws = "WithAWS"

	// JobStateInProgress is a JobState enum value
	JobStateInProgress = "InProgress"

	// JobStateComplete is a JobState enum value
	JobStateComplete = "Complete"

	// JobStateCancelled is a JobState enum value
	JobStateCancelled = "Cancelled"

	// JobStateListing is a JobState enum value
	JobStateListing = "Listing"

	// JobStatePending is a JobState enum value
	JobStatePending = "Pending"
)
View Source 
const (
	// JobTypeImport is a JobType enum value
	JobTypeImport = "IMPORT"

	// JobTypeExport is a JobType enum value
	JobTypeExport = "EXPORT"
)
View Source 
const (
	// ShippingOptionSecondDay is a ShippingOption enum value
	ShippingOptionSecondDay = "SECOND_DAY"

	// ShippingOptionNextDay is a ShippingOption enum value
	ShippingOptionNextDay = "NEXT_DAY"

	// ShippingOptionExpress is a ShippingOption enum value
	ShippingOptionExpress = "EXPRESS"

	// ShippingOptionStandard is a ShippingOption enum value
	ShippingOptionStandard = "STANDARD"
)
View Source 
const ServiceName = "snowball"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

type Address struct {

	// The unique ID for an address.
	AddressId *string `min:"40" type:"string"`

	// The city in an address that a Snowball is to be delivered to.
	City *string `min:"1" type:"string"`

	// The name of the company to receive a Snowball at an address.
	Company *string `min:"1" type:"string"`

	// The country in an address that a Snowball is to be delivered to.
	Country *string `min:"1" type:"string"`

	// A landmark listed in an address that a Snowball is to be delivered to.
	Landmark *string `min:"1" type:"string"`

	// The name of a person to receive a Snowball at an address.
	Name *string `min:"1" type:"string"`

	// The phone number associated with an address that a Snowball is to be delivered
	// to.
	PhoneNumber *string `min:"1" type:"string"`

	// The postal code in an address that a Snowball is to be delivered to.
	PostalCode *string `min:"1" type:"string"`

	// The prefecture or district in an address that a Snowball is to be delivered
	// to.
	PrefectureOrDistrict *string `min:"1" type:"string"`

	// The state or province in an address that a Snowball is to be delivered to.
	StateOrProvince *string `min:"1" type:"string"`

	// The first line in a street address that a Snowball is to be delivered to.
	Street1 *string `min:"1" type:"string"`

	// The second line in a street address that a Snowball is to be delivered to.
	Street2 *string `min:"1" type:"string"`

	// The third line in a street address that a Snowball is to be delivered to.
	Street3 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The address that you want the Snowball or Snowballs 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 (Address) GoString 

func (s Address) GoString() string

GoString returns the string representation

func (*Address) SetAddressId added in v1.5.0 

func (s *Address) SetAddressId(v string) *Address

SetAddressId sets the AddressId field's value.

func (*Address) SetCity added in v1.5.0 

func (s *Address) SetCity(v string) *Address

SetCity sets the City field's value.

func (*Address) SetCompany added in v1.5.0 

func (s *Address) SetCompany(v string) *Address

SetCompany sets the Company field's value.

func (*Address) SetCountry added in v1.5.0 

func (s *Address) SetCountry(v string) *Address

SetCountry sets the Country field's value.

func (*Address) SetLandmark added in v1.5.0 

func (s *Address) SetLandmark(v string) *Address

SetLandmark sets the Landmark field's value.

func (*Address) SetName added in v1.5.0 

func (s *Address) SetName(v string) *Address

SetName sets the Name field's value.

func (*Address) SetPhoneNumber added in v1.5.0 

func (s *Address) SetPhoneNumber(v string) *Address

SetPhoneNumber sets the PhoneNumber field's value.

func (*Address) SetPostalCode added in v1.5.0 

func (s *Address) SetPostalCode(v string) *Address

SetPostalCode sets the PostalCode field's value.

func (*Address) SetPrefectureOrDistrict added in v1.5.0 

func (s *Address) SetPrefectureOrDistrict(v string) *Address

SetPrefectureOrDistrict sets the PrefectureOrDistrict field's value.

func (*Address) SetStateOrProvince added in v1.5.0 

func (s *Address) SetStateOrProvince(v string) *Address

SetStateOrProvince sets the StateOrProvince field's value.

func (*Address) SetStreet1 added in v1.5.0 

func (s *Address) SetStreet1(v string) *Address

SetStreet1 sets the Street1 field's value.

func (*Address) SetStreet2 added in v1.5.0 

func (s *Address) SetStreet2(v string) *Address

SetStreet2 sets the Street2 field's value.

func (*Address) SetStreet3 added in v1.5.0 

func (s *Address) SetStreet3(v string) *Address

SetStreet3 sets the Street3 field's value.

func (Address) String 

func (s Address) String() string

String returns the string representation

func (*Address) Validate 

func (s *Address) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelJobInput 

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 (CancelJobInput) GoString 

func (s CancelJobInput) GoString() string

GoString returns the string representation

func (*CancelJobInput) SetJobId added in v1.5.0 

func (s *CancelJobInput) SetJobId(v string) *CancelJobInput

SetJobId sets the JobId field's value.

func (CancelJobInput) String 

func (s CancelJobInput) String() string

String returns the string representation

func (*CancelJobInput) Validate 

func (s *CancelJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelJobOutput 

type CancelJobOutput struct {
	// contains filtered or unexported fields
}

func (CancelJobOutput) GoString 

func (s CancelJobOutput) GoString() string

GoString returns the string representation

func (CancelJobOutput) String 

func (s CancelJobOutput) String() string

String returns the string representation

type CreateAddressInput 

type CreateAddressInput struct {

	// The address that you want the Snowball shipped to.
	//
	// Address is a required field
	Address *Address `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAddressInput) GoString 

func (s CreateAddressInput) GoString() string

GoString returns the string representation

func (*CreateAddressInput) SetAddress added in v1.5.0 

func (s *CreateAddressInput) SetAddress(v *Address) *CreateAddressInput

SetAddress sets the Address field's value.

func (CreateAddressInput) String 

func (s CreateAddressInput) String() string

String returns the string representation

func (*CreateAddressInput) Validate 

func (s *CreateAddressInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAddressOutput 

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 Snowball for
	// that job shipped to.
	AddressId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAddressOutput) GoString 

func (s CreateAddressOutput) GoString() string

GoString returns the string representation

func (*CreateAddressOutput) SetAddressId added in v1.5.0 

func (s *CreateAddressOutput) SetAddressId(v string) *CreateAddressOutput

SetAddressId sets the AddressId field's value.

func (CreateAddressOutput) String 

func (s CreateAddressOutput) String() string

String returns the string representation

type CreateJobInput 

type CreateJobInput struct {

	// The ID for the address that you want the Snowball shipped to.
	//
	// AddressId is a required field
	AddressId *string `min:"40" type:"string" required:"true"`

	// Defines an optional description of this specific job, for example Important
	// Photos 2016-08-11.
	Description *string `min:"1" type:"string"`

	// Defines the type of job that you're creating.
	//
	// JobType is a required field
	JobType *string `type:"string" required:"true" enum:"JobType"`

	// The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created
	// using the CreateKey (http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html)
	// AWS Key Management Service (KMS) API action.
	KmsKeyARN *string `type:"string"`

	// Defines the Amazon Simple Notification Service (Amazon SNS) notification
	// settings for this job.
	Notification *Notification `type:"structure"`

	// 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 is a required field
	Resources *JobResource `type:"structure" required:"true"`

	// The RoleARN that you want to associate with this job. RoleArns are created
	// using the CreateRole (http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html)
	// AWS Identity and Access Management (IAM) API action.
	//
	// RoleARN is a required field
	RoleARN *string `type:"string" required:"true"`

	// The shipping speed for this job. Note that this speed does not dictate how
	// soon you'll get the Snowball, rather it represents how quickly the Snowball
	// moves to its destination while in transit. Regional shipping speeds are as
	// follows:
	//
	//    * In Australia, you have access to express shipping. Typically, Snowballs
	//    shipped express are delivered in about a day.
	//
	//    * In the European Union (EU), you have access to express shipping. Typically,
	//    Snowballs 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, Snowballs 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 Snowball you'd like for this job. In all other regions,
	// Snowballs come with 80 TB in storage capacity.
	SnowballCapacityPreference *string `type:"string" enum:"Capacity"`
	// contains filtered or unexported fields
}

func (CreateJobInput) GoString 

func (s CreateJobInput) GoString() string

GoString returns the string representation

func (*CreateJobInput) SetAddressId added in v1.5.0 

func (s *CreateJobInput) SetAddressId(v string) *CreateJobInput

SetAddressId sets the AddressId field's value.

func (*CreateJobInput) SetDescription added in v1.5.0 

func (s *CreateJobInput) SetDescription(v string) *CreateJobInput

SetDescription sets the Description field's value.

func (*CreateJobInput) SetJobType added in v1.5.0 

func (s *CreateJobInput) SetJobType(v string) *CreateJobInput

SetJobType sets the JobType field's value.

func (*CreateJobInput) SetKmsKeyARN added in v1.5.0 

func (s *CreateJobInput) SetKmsKeyARN(v string) *CreateJobInput

SetKmsKeyARN sets the KmsKeyARN field's value.

func (*CreateJobInput) SetNotification added in v1.5.0 

func (s *CreateJobInput) SetNotification(v *Notification) *CreateJobInput

SetNotification sets the Notification field's value.

func (*CreateJobInput) SetResources added in v1.5.0 

func (s *CreateJobInput) SetResources(v *JobResource) *CreateJobInput

SetResources sets the Resources field's value.

func (*CreateJobInput) SetRoleARN added in v1.5.0 

func (s *CreateJobInput) SetRoleARN(v string) *CreateJobInput

SetRoleARN sets the RoleARN field's value.

func (*CreateJobInput) SetShippingOption added in v1.5.0 

func (s *CreateJobInput) SetShippingOption(v string) *CreateJobInput

SetShippingOption sets the ShippingOption field's value.

func (*CreateJobInput) SetSnowballCapacityPreference added in v1.5.0 

func (s *CreateJobInput) SetSnowballCapacityPreference(v string) *CreateJobInput

SetSnowballCapacityPreference sets the SnowballCapacityPreference field's value.

func (CreateJobInput) String 

func (s CreateJobInput) String() string

String returns the string representation

func (*CreateJobInput) Validate 

func (s *CreateJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateJobOutput 

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 (CreateJobOutput) GoString 

func (s CreateJobOutput) GoString() string

GoString returns the string representation

func (*CreateJobOutput) SetJobId added in v1.5.0 

func (s *CreateJobOutput) SetJobId(v string) *CreateJobOutput

SetJobId sets the JobId field's value.

func (CreateJobOutput) String 

func (s CreateJobOutput) String() string

String returns the string representation

type DataTransfer 

type DataTransfer struct {

	// The number of bytes transferred between a Snowball and Amazon S3.
	BytesTransferred *int64 `type:"long"`

	// The number of objects transferred between a Snowball and Amazon S3.
	ObjectsTransferred *int64 `type:"long"`

	// The total bytes of data for a transfer between a Snowball 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 Snowball 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 Snowball's data transfer while the appliance is at AWS. Note that this data is only available while a job has a JobState value of InProgress, for both import and export jobs.

func (DataTransfer) GoString 

func (s DataTransfer) GoString() string

GoString returns the string representation

func (*DataTransfer) SetBytesTransferred added in v1.5.0 

func (s *DataTransfer) SetBytesTransferred(v int64) *DataTransfer

SetBytesTransferred sets the BytesTransferred field's value.

func (*DataTransfer) SetObjectsTransferred added in v1.5.0 

func (s *DataTransfer) SetObjectsTransferred(v int64) *DataTransfer

SetObjectsTransferred sets the ObjectsTransferred field's value.

func (*DataTransfer) SetTotalBytes added in v1.5.0 

func (s *DataTransfer) SetTotalBytes(v int64) *DataTransfer

SetTotalBytes sets the TotalBytes field's value.

func (*DataTransfer) SetTotalObjects added in v1.5.0 

func (s *DataTransfer) SetTotalObjects(v int64) *DataTransfer

SetTotalObjects sets the TotalObjects field's value.

func (DataTransfer) String 

func (s DataTransfer) String() string

String returns the string representation

type DescribeAddressInput 

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 (DescribeAddressInput) GoString 

func (s DescribeAddressInput) GoString() string

GoString returns the string representation

func (*DescribeAddressInput) SetAddressId added in v1.5.0 

func (s *DescribeAddressInput) SetAddressId(v string) *DescribeAddressInput

SetAddressId sets the AddressId field's value.

func (DescribeAddressInput) String 

func (s DescribeAddressInput) String() string

String returns the string representation

func (*DescribeAddressInput) Validate 

func (s *DescribeAddressInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAddressOutput 

type DescribeAddressOutput struct {

	// The address that you want the Snowball or Snowballs associated with a specific
	// job to be shipped to.
	Address *Address `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAddressOutput) GoString 

func (s DescribeAddressOutput) GoString() string

GoString returns the string representation

func (*DescribeAddressOutput) SetAddress added in v1.5.0 

func (s *DescribeAddressOutput) SetAddress(v *Address) *DescribeAddressOutput

SetAddress sets the Address field's value.

func (DescribeAddressOutput) String 

func (s DescribeAddressOutput) String() string

String returns the string representation

type DescribeAddressesInput 

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 (DescribeAddressesInput) GoString 

func (s DescribeAddressesInput) GoString() string

GoString returns the string representation

func (*DescribeAddressesInput) SetMaxResults added in v1.5.0 

func (s *DescribeAddressesInput) SetMaxResults(v int64) *DescribeAddressesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeAddressesInput) SetNextToken added in v1.5.0 

func (s *DescribeAddressesInput) SetNextToken(v string) *DescribeAddressesInput

SetNextToken sets the NextToken field's value.

func (DescribeAddressesInput) String 

func (s DescribeAddressesInput) String() string

String returns the string representation

func (*DescribeAddressesInput) Validate 

func (s *DescribeAddressesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAddressesOutput 

type DescribeAddressesOutput struct {

	// The Snowball 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 (DescribeAddressesOutput) GoString 

func (s DescribeAddressesOutput) GoString() string

GoString returns the string representation

func (*DescribeAddressesOutput) SetAddresses added in v1.5.0 

func (s *DescribeAddressesOutput) SetAddresses(v []*Address) *DescribeAddressesOutput

SetAddresses sets the Addresses field's value.

func (*DescribeAddressesOutput) SetNextToken added in v1.5.0 

func (s *DescribeAddressesOutput) SetNextToken(v string) *DescribeAddressesOutput

SetNextToken sets the NextToken field's value.

func (DescribeAddressesOutput) String 

func (s DescribeAddressesOutput) String() string

String returns the string representation

type DescribeJobInput 

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 (DescribeJobInput) GoString 

func (s DescribeJobInput) GoString() string

GoString returns the string representation

func (*DescribeJobInput) SetJobId added in v1.5.0 

func (s *DescribeJobInput) SetJobId(v string) *DescribeJobInput

SetJobId sets the JobId field's value.

func (DescribeJobInput) String 

func (s DescribeJobInput) String() string

String returns the string representation

func (*DescribeJobInput) Validate 

func (s *DescribeJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeJobOutput 

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 (DescribeJobOutput) GoString 

func (s DescribeJobOutput) GoString() string

GoString returns the string representation

func (*DescribeJobOutput) SetJobMetadata added in v1.5.0 

func (s *DescribeJobOutput) SetJobMetadata(v *JobMetadata) *DescribeJobOutput

SetJobMetadata sets the JobMetadata field's value.

func (*DescribeJobOutput) SetSubJobMetadata added in v1.5.0 

func (s *DescribeJobOutput) SetSubJobMetadata(v []*JobMetadata) *DescribeJobOutput

SetSubJobMetadata sets the SubJobMetadata field's value.

func (DescribeJobOutput) String 

func (s DescribeJobOutput) String() string

String returns the string representation

type GetJobManifestInput 

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 (GetJobManifestInput) GoString 

func (s GetJobManifestInput) GoString() string

GoString returns the string representation

func (*GetJobManifestInput) SetJobId added in v1.5.0 

func (s *GetJobManifestInput) SetJobId(v string) *GetJobManifestInput

SetJobId sets the JobId field's value.

func (GetJobManifestInput) String 

func (s GetJobManifestInput) String() string

String returns the string representation

func (*GetJobManifestInput) Validate 

func (s *GetJobManifestInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetJobManifestOutput 

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 (GetJobManifestOutput) GoString 

func (s GetJobManifestOutput) GoString() string

GoString returns the string representation

func (*GetJobManifestOutput) SetManifestURI added in v1.5.0 

func (s *GetJobManifestOutput) SetManifestURI(v string) *GetJobManifestOutput

SetManifestURI sets the ManifestURI field's value.

func (GetJobManifestOutput) String 

func (s GetJobManifestOutput) String() string

String returns the string representation

type GetJobUnlockCodeInput 

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 (GetJobUnlockCodeInput) GoString 

func (s GetJobUnlockCodeInput) GoString() string

GoString returns the string representation

func (*GetJobUnlockCodeInput) SetJobId added in v1.5.0 

func (s *GetJobUnlockCodeInput) SetJobId(v string) *GetJobUnlockCodeInput

SetJobId sets the JobId field's value.

func (GetJobUnlockCodeInput) String 

func (s GetJobUnlockCodeInput) String() string

String returns the string representation

func (*GetJobUnlockCodeInput) Validate 

func (s *GetJobUnlockCodeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetJobUnlockCodeOutput 

type GetJobUnlockCodeOutput struct {

	// The UnlockCode value for the specified job. The UnlockCode value can be accessed
	// for up to 90 days after the job has been created.
	UnlockCode *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetJobUnlockCodeOutput) GoString 

func (s GetJobUnlockCodeOutput) GoString() string

GoString returns the string representation

func (*GetJobUnlockCodeOutput) SetUnlockCode added in v1.5.0 

func (s *GetJobUnlockCodeOutput) SetUnlockCode(v string) *GetJobUnlockCodeOutput

SetUnlockCode sets the UnlockCode field's value.

func (GetJobUnlockCodeOutput) String 

func (s GetJobUnlockCodeOutput) String() string

String returns the string representation

type GetSnowballUsageInput 

type GetSnowballUsageInput struct {
	// contains filtered or unexported fields
}

func (GetSnowballUsageInput) GoString 

func (s GetSnowballUsageInput) GoString() string

GoString returns the string representation

func (GetSnowballUsageInput) String 

func (s GetSnowballUsageInput) String() string

String returns the string representation

type GetSnowballUsageOutput 

type GetSnowballUsageOutput struct {

	// The service limit for number of Snowballs this account can have at once.
	// The default service limit is 1 (one).
	SnowballLimit *int64 `type:"integer"`

	// The number of Snowballs that this account is currently using.
	SnowballsInUse *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (GetSnowballUsageOutput) GoString 

func (s GetSnowballUsageOutput) GoString() string

GoString returns the string representation

func (*GetSnowballUsageOutput) SetSnowballLimit added in v1.5.0 

func (s *GetSnowballUsageOutput) SetSnowballLimit(v int64) *GetSnowballUsageOutput

SetSnowballLimit sets the SnowballLimit field's value.

func (*GetSnowballUsageOutput) SetSnowballsInUse added in v1.5.0 

func (s *GetSnowballUsageOutput) SetSnowballsInUse(v int64) *GetSnowballUsageOutput

SetSnowballsInUse sets the SnowballsInUse field's value.

func (GetSnowballUsageOutput) String 

func (s GetSnowballUsageOutput) String() string

String returns the string representation

type JobListEntry 

type JobListEntry struct {

	// A value that indicates that this job is a master job. A master job represents
	// a successful request to create an export job. Master jobs aren't associated
	// with any Snowballs. Instead, each master 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 master job are listed,
	// because they are created after the master 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"`
	// 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 (JobListEntry) GoString 

func (s JobListEntry) GoString() string

GoString returns the string representation

func (*JobListEntry) SetIsMaster added in v1.5.0 

func (s *JobListEntry) SetIsMaster(v bool) *JobListEntry

SetIsMaster sets the IsMaster field's value.

func (*JobListEntry) SetJobId added in v1.5.0 

func (s *JobListEntry) SetJobId(v string) *JobListEntry

SetJobId sets the JobId field's value.

func (*JobListEntry) SetJobState added in v1.5.0 

func (s *JobListEntry) SetJobState(v string) *JobListEntry

SetJobState sets the JobState field's value.

func (JobListEntry) String 

func (s JobListEntry) String() string

String returns the string representation

type JobLogs 

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 Snowball 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 Snowball 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 (JobLogs) GoString 

func (s JobLogs) GoString() string

GoString returns the string representation

func (*JobLogs) SetJobCompletionReportURI added in v1.5.0 

func (s *JobLogs) SetJobCompletionReportURI(v string) *JobLogs

SetJobCompletionReportURI sets the JobCompletionReportURI field's value.

func (*JobLogs) SetJobFailureLogURI added in v1.5.0 

func (s *JobLogs) SetJobFailureLogURI(v string) *JobLogs

SetJobFailureLogURI sets the JobFailureLogURI field's value.

func (*JobLogs) SetJobSuccessLogURI added in v1.5.0 

func (s *JobLogs) SetJobSuccessLogURI(v string) *JobLogs

SetJobSuccessLogURI sets the JobSuccessLogURI field's value.

func (JobLogs) String 

func (s JobLogs) String() string

String returns the string representation

type JobMetadata 

type JobMetadata struct {

	// The ID for the address that you want the Snowball shipped to.
	AddressId *string `min:"40" type:"string"`

	// The creation date for this job.
	CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// A value that defines the real-time status of a Snowball's data transfer while
	// the appliance is at AWS. Note that 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 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 Snowball
	// for your job part is being delivered to you.
	JobLogInfo *JobLogs `type:"structure"`

	// The current state 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 AWS Key Management Service (AWS KMS)
	// key associated with this job. This ARN was created using the CreateKey API
	// action in AWS KMS.
	KmsKeyARN *string `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"`

	// 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
	// API action in AWS Identity and Access Management (IAM).
	RoleARN *string `type:"string"`

	// A job's shipping information, including inbound and outbound tracking numbers
	// and shipping speed options.
	ShippingDetails *ShippingDetails `type:"structure"`

	// The Snowball 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.
	SnowballCapacityPreference *string `type:"string" enum:"Capacity"`
	// 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 (JobMetadata) GoString 

func (s JobMetadata) GoString() string

GoString returns the string representation

func (*JobMetadata) SetAddressId added in v1.5.0 

func (s *JobMetadata) SetAddressId(v string) *JobMetadata

SetAddressId sets the AddressId field's value.

func (*JobMetadata) SetCreationDate added in v1.5.0 

func (s *JobMetadata) SetCreationDate(v time.Time) *JobMetadata

SetCreationDate sets the CreationDate field's value.

func (*JobMetadata) SetDataTransferProgress added in v1.5.0 

func (s *JobMetadata) SetDataTransferProgress(v *DataTransfer) *JobMetadata

SetDataTransferProgress sets the DataTransferProgress field's value.

func (*JobMetadata) SetDescription added in v1.5.0 

func (s *JobMetadata) SetDescription(v string) *JobMetadata

SetDescription sets the Description field's value.

func (*JobMetadata) SetJobId added in v1.5.0 

func (s *JobMetadata) SetJobId(v string) *JobMetadata

SetJobId sets the JobId field's value.

func (*JobMetadata) SetJobLogInfo added in v1.5.0 

func (s *JobMetadata) SetJobLogInfo(v *JobLogs) *JobMetadata

SetJobLogInfo sets the JobLogInfo field's value.

func (*JobMetadata) SetJobState added in v1.5.0 

func (s *JobMetadata) SetJobState(v string) *JobMetadata

SetJobState sets the JobState field's value.

func (*JobMetadata) SetJobType added in v1.5.0 

func (s *JobMetadata) SetJobType(v string) *JobMetadata

SetJobType sets the JobType field's value.

func (*JobMetadata) SetKmsKeyARN added in v1.5.0 

func (s *JobMetadata) SetKmsKeyARN(v string) *JobMetadata

SetKmsKeyARN sets the KmsKeyARN field's value.

func (*JobMetadata) SetNotification added in v1.5.0 

func (s *JobMetadata) SetNotification(v *Notification) *JobMetadata

SetNotification sets the Notification field's value.

func (*JobMetadata) SetResources added in v1.5.0 

func (s *JobMetadata) SetResources(v *JobResource) *JobMetadata

SetResources sets the Resources field's value.

func (*JobMetadata) SetRoleARN added in v1.5.0 

func (s *JobMetadata) SetRoleARN(v string) *JobMetadata

SetRoleARN sets the RoleARN field's value.

func (*JobMetadata) SetShippingDetails added in v1.5.0 

func (s *JobMetadata) SetShippingDetails(v *ShippingDetails) *JobMetadata

SetShippingDetails sets the ShippingDetails field's value.

func (*JobMetadata) SetSnowballCapacityPreference added in v1.5.0 

func (s *JobMetadata) SetSnowballCapacityPreference(v string) *JobMetadata

SetSnowballCapacityPreference sets the SnowballCapacityPreference field's value.

func (JobMetadata) String 

func (s JobMetadata) String() string

String returns the string representation

type JobResource 

type JobResource struct {

	// An array of S3Resource objects.
	S3Resources []*S3Resource `type:"list"`
	// contains filtered or unexported fields
}

Contains an array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

func (JobResource) GoString 

func (s JobResource) GoString() string

GoString returns the string representation

func (*JobResource) SetS3Resources added in v1.5.0 

func (s *JobResource) SetS3Resources(v []*S3Resource) *JobResource

SetS3Resources sets the S3Resources field's value.

func (JobResource) String 

func (s JobResource) String() string

String returns the string representation

func (*JobResource) Validate 

func (s *JobResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KeyRange 

type KeyRange struct {

	// The key that starts an optional key range for an export job. Ranges are inclusive
	// and UTF-8 binary sorted.
	BeginMarker *string `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 (KeyRange) GoString 

func (s KeyRange) GoString() string

GoString returns the string representation

func (*KeyRange) SetBeginMarker added in v1.5.0 

func (s *KeyRange) SetBeginMarker(v string) *KeyRange

SetBeginMarker sets the BeginMarker field's value.

func (*KeyRange) SetEndMarker added in v1.5.0 

func (s *KeyRange) SetEndMarker(v string) *KeyRange

SetEndMarker sets the EndMarker field's value.

func (KeyRange) String 

func (s KeyRange) String() string

String returns the string representation

func (*KeyRange) Validate 

func (s *KeyRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListJobsInput 

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 (ListJobsInput) GoString 

func (s ListJobsInput) GoString() string

GoString returns the string representation

func (*ListJobsInput) SetMaxResults added in v1.5.0 

func (s *ListJobsInput) SetMaxResults(v int64) *ListJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListJobsInput) SetNextToken added in v1.5.0 

func (s *ListJobsInput) SetNextToken(v string) *ListJobsInput

SetNextToken sets the NextToken field's value.

func (ListJobsInput) String 

func (s ListJobsInput) String() string

String returns the string representation

func (*ListJobsInput) Validate 

func (s *ListJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListJobsOutput 

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 (ListJobsOutput) GoString 

func (s ListJobsOutput) GoString() string

GoString returns the string representation

func (*ListJobsOutput) SetJobListEntries added in v1.5.0 

func (s *ListJobsOutput) SetJobListEntries(v []*JobListEntry) *ListJobsOutput

SetJobListEntries sets the JobListEntries field's value.

func (*ListJobsOutput) SetNextToken added in v1.5.0 

func (s *ListJobsOutput) SetNextToken(v string) *ListJobsOutput

SetNextToken sets the NextToken field's value.

func (ListJobsOutput) String 

func (s ListJobsOutput) String() string

String returns the string representation

type Notification 

type Notification struct {

	// The list of job states that will trigger a notification for this job.
	JobStatesToNotify []*string `type:"list"`

	// 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 (http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html)
	// Amazon SNS API action.
	//
	// Note that you can subscribe email addresses to an Amazon SNS topic through
	// the AWS Management Console, or by using the Subscribe (http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)
	// AWS Simple Notification Service (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 (Notification) GoString 

func (s Notification) GoString() string

GoString returns the string representation

func (*Notification) SetJobStatesToNotify added in v1.5.0 

func (s *Notification) SetJobStatesToNotify(v []*string) *Notification

SetJobStatesToNotify sets the JobStatesToNotify field's value.

func (*Notification) SetNotifyAll added in v1.5.0 

func (s *Notification) SetNotifyAll(v bool) *Notification

SetNotifyAll sets the NotifyAll field's value.

func (*Notification) SetSnsTopicARN added in v1.5.0 

func (s *Notification) SetSnsTopicARN(v string) *Notification

SetSnsTopicARN sets the SnsTopicARN field's value.

func (Notification) String 

func (s Notification) String() string

String returns the string representation

type S3Resource 

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"`
	// 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 (S3Resource) GoString 

func (s S3Resource) GoString() string

GoString returns the string representation

func (*S3Resource) SetBucketArn added in v1.5.0 

func (s *S3Resource) SetBucketArn(v string) *S3Resource

SetBucketArn sets the BucketArn field's value.

func (*S3Resource) SetKeyRange added in v1.5.0 

func (s *S3Resource) SetKeyRange(v *KeyRange) *S3Resource

SetKeyRange sets the KeyRange field's value.

func (S3Resource) String 

func (s S3Resource) String() string

String returns the string representation

func (*S3Resource) Validate 

func (s *S3Resource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Shipment 

type Shipment struct {

	// Status information for a shipment. Valid statuses include NEW, IN_TRANSIT,
	// and DELIVERED.
	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 Snowball 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 (Shipment) GoString 

func (s Shipment) GoString() string

GoString returns the string representation

func (*Shipment) SetStatus added in v1.5.0 

func (s *Shipment) SetStatus(v string) *Shipment

SetStatus sets the Status field's value.

func (*Shipment) SetTrackingNumber added in v1.5.0 

func (s *Shipment) SetTrackingNumber(v string) *Shipment

SetTrackingNumber sets the TrackingNumber field's value.

func (Shipment) String 

func (s Shipment) String() string

String returns the string representation

type ShippingDetails 

type ShippingDetails struct {

	// The Status and TrackingNumber values for a Snowball being delivered to the
	// address that you specified for a particular job.
	InboundShipment *Shipment `type:"structure"`

	// The Status and TrackingNumber values for a Snowball being returned to AWS
	// for a particular job.
	OutboundShipment *Shipment `type:"structure"`

	// The shipping speed for a particular job. Note that this speed does not dictate
	// how soon you'll get the Snowball 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, Snowballs
	//    shipped express are delivered in about a day.
	//
	//    * In the European Union (EU), you have access to express shipping. Typically,
	//    Snowballs 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, Snowballs 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 (ShippingDetails) GoString 

func (s ShippingDetails) GoString() string

GoString returns the string representation

func (*ShippingDetails) SetInboundShipment added in v1.5.0 

func (s *ShippingDetails) SetInboundShipment(v *Shipment) *ShippingDetails

SetInboundShipment sets the InboundShipment field's value.

func (*ShippingDetails) SetOutboundShipment added in v1.5.0 

func (s *ShippingDetails) SetOutboundShipment(v *Shipment) *ShippingDetails

SetOutboundShipment sets the OutboundShipment field's value.

func (*ShippingDetails) SetShippingOption added in v1.5.0 

func (s *ShippingDetails) SetShippingOption(v string) *ShippingDetails

SetShippingOption sets the ShippingOption field's value.

func (ShippingDetails) String 

func (s ShippingDetails) String() string

String returns the string representation

type Snowball 

type Snowball struct {
	*client.Client
}

AWS Import/Export Snowball is a petabyte-scale data transport solution that uses secure appliances to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball appliance, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide (http://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New 

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: 

// 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 (*Snowball) CancelJob 

func (c *Snowball) CancelJob(input *CancelJobInput) (*CancelJobOutput, error)

CancelJob API operation for Amazon Import/Export Snowball.

Cancels the specified job. Note that you can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action will return 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 Codes:

  • 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 AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.CancelJobInput{
		JobId: aws.String("JobId"), // Required
	}
	resp, err := svc.CancelJob(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) CancelJobRequest 

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 can be used to capture response data after the request's "Send" method is called.

See CancelJob for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CancelJob method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) CreateAddress 

func (c *Snowball) CreateAddress(input *CreateAddressInput) (*CreateAddressOutput, error)

CreateAddress API operation for Amazon Import/Export Snowball.

Creates an address for a Snowball 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. If the address is invalid or unsupported, then an exception is thrown.

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 Codes:

  • 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 AWS Support.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.CreateAddressInput{
		Address: &snowball.Address{ // Required
			AddressId:            aws.String("AddressId"),
			City:                 aws.String("String"),
			Company:              aws.String("String"),
			Country:              aws.String("String"),
			Landmark:             aws.String("String"),
			Name:                 aws.String("String"),
			PhoneNumber:          aws.String("String"),
			PostalCode:           aws.String("String"),
			PrefectureOrDistrict: aws.String("String"),
			StateOrProvince:      aws.String("String"),
			Street1:              aws.String("String"),
			Street2:              aws.String("String"),
			Street3:              aws.String("String"),
		},
	}
	resp, err := svc.CreateAddress(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) CreateAddressRequest 

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 can be used to capture response data after the request's "Send" method is called.

See CreateAddress for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateAddress method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) CreateJob 

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. Note that your AWS account must have the right trust policies and permissions in place to create a job for Snowball. For more information, see api-reference-policies.

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 Codes:

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

  • KMSRequestFailedException The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.CreateJobInput{
		AddressId: aws.String("AddressId"), // Required
		JobType:   aws.String("JobType"),   // Required
		Resources: &snowball.JobResource{ // Required
			S3Resources: []*snowball.S3Resource{
				{ // Required
					BucketArn: aws.String("ResourceARN"),
					KeyRange: &snowball.KeyRange{
						BeginMarker: aws.String("String"),
						EndMarker:   aws.String("String"),
					},
				},
				// More values...
			},
		},
		RoleARN:        aws.String("RoleARN"),        // Required
		ShippingOption: aws.String("ShippingOption"), // Required
		Description:    aws.String("String"),
		KmsKeyARN:      aws.String("KmsKeyARN"),
		Notification: &snowball.Notification{
			JobStatesToNotify: []*string{
				aws.String("JobState"), // Required
				// More values...
			},
			NotifyAll:   aws.Bool(true),
			SnsTopicARN: aws.String("SnsTopicARN"),
		},
		SnowballCapacityPreference: aws.String("Capacity"),
	}
	resp, err := svc.CreateJob(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) CreateJobRequest 

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 can be used to capture response data after the request's "Send" method is called.

See CreateJob for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateJob method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) DescribeAddress 

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 Codes:

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

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.DescribeAddressInput{
		AddressId: aws.String("AddressId"), // Required
	}
	resp, err := svc.DescribeAddress(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) DescribeAddressRequest 

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 can be used to capture response data after the request's "Send" method is called.

See DescribeAddress for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeAddress method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) DescribeAddresses 

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 Codes:

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

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.DescribeAddressesInput{
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("String"),
	}
	resp, err := svc.DescribeAddresses(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) DescribeAddressesPages 

func (c *Snowball) DescribeAddressesPages(input *DescribeAddressesInput, fn func(p *DescribeAddressesOutput, lastPage bool) (shouldContinue 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 *DescribeAddressesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Snowball) DescribeAddressesRequest 

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 can be used to capture response data after the request's "Send" method is called.

See DescribeAddresses for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeAddresses method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) DescribeJob 

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 Codes:

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

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.DescribeJobInput{
		JobId: aws.String("JobId"), // Required
	}
	resp, err := svc.DescribeJob(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) DescribeJobRequest 

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 can be used to capture response data after the request's "Send" method is called.

See DescribeJob for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeJob method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) GetJobManifest 

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. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball 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 Snowball associated with that job.

Note that the credentials of a given job, including its manifest file and unlock code, expire 90 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 Codes:

  • 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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.GetJobManifestInput{
		JobId: aws.String("JobId"), // Required
	}
	resp, err := svc.GetJobManifest(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) GetJobManifestRequest 

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 can be used to capture response data after the request's "Send" method is called.

See GetJobManifest for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetJobManifest method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) GetJobUnlockCode 

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 90 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 Snowball 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 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 Snowball 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 Codes:

  • 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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.GetJobUnlockCodeInput{
		JobId: aws.String("JobId"), // Required
	}
	resp, err := svc.GetJobUnlockCode(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) GetJobUnlockCodeRequest 

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 can be used to capture response data after the request's "Send" method is called.

See GetJobUnlockCode for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetJobUnlockCode method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) GetSnowballUsage 

func (c *Snowball) GetSnowballUsage(input *GetSnowballUsageInput) (*GetSnowballUsageOutput, error)

GetSnowballUsage API operation for Amazon Import/Export Snowball.

Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

Note that the default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS 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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	var params *snowball.GetSnowballUsageInput
	resp, err := svc.GetSnowballUsage(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) GetSnowballUsageRequest 

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 can be used to capture response data after the request's "Send" method is called.

See GetSnowballUsage for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSnowballUsage method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) ListJobs 

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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.ListJobsInput{
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("String"),
	}
	resp, err := svc.ListJobs(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) ListJobsPages 

func (c *Snowball) ListJobsPages(input *ListJobsInput, fn func(p *ListJobsOutput, lastPage bool) (shouldContinue 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 *ListJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Snowball) ListJobsRequest 

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 can be used to capture response data after the request's "Send" method is called.

See ListJobs for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListJobs method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*Snowball) UpdateJob 

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 Codes:

  • 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 AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/snowball"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := snowball.New(sess)

	params := &snowball.UpdateJobInput{
		JobId:       aws.String("JobId"), // Required
		AddressId:   aws.String("AddressId"),
		Description: aws.String("String"),
		Notification: &snowball.Notification{
			JobStatesToNotify: []*string{
				aws.String("JobState"), // Required
				// More values...
			},
			NotifyAll:   aws.Bool(true),
			SnsTopicARN: aws.String("SnsTopicARN"),
		},
		Resources: &snowball.JobResource{
			S3Resources: []*snowball.S3Resource{
				{ // Required
					BucketArn: aws.String("ResourceARN"),
					KeyRange: &snowball.KeyRange{
						BeginMarker: aws.String("String"),
						EndMarker:   aws.String("String"),
					},
				},
				// More values...
			},
		},
		RoleARN:                    aws.String("RoleARN"),
		ShippingOption:             aws.String("ShippingOption"),
		SnowballCapacityPreference: aws.String("Capacity"),
	}
	resp, err := svc.UpdateJob(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*Snowball) UpdateJobRequest 

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 can be used to capture response data after the request's "Send" method is called.

See UpdateJob for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateJob method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

type UpdateJobInput 

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 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"`

	// The updated S3Resource object (for a single Amazon S3 bucket or key range),
	// or the updated JobResource object (for multiple buckets or key ranges).
	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 (http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html)
	// AWS 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.
	// Note that the 50 TB Snowballs are only available in the US regions.
	SnowballCapacityPreference *string `type:"string" enum:"Capacity"`
	// contains filtered or unexported fields
}

func (UpdateJobInput) GoString 

func (s UpdateJobInput) GoString() string

GoString returns the string representation

func (*UpdateJobInput) SetAddressId added in v1.5.0 

func (s *UpdateJobInput) SetAddressId(v string) *UpdateJobInput

SetAddressId sets the AddressId field's value.

func (*UpdateJobInput) SetDescription added in v1.5.0 

func (s *UpdateJobInput) SetDescription(v string) *UpdateJobInput

SetDescription sets the Description field's value.

func (*UpdateJobInput) SetJobId added in v1.5.0 

func (s *UpdateJobInput) SetJobId(v string) *UpdateJobInput

SetJobId sets the JobId field's value.

func (*UpdateJobInput) SetNotification added in v1.5.0 

func (s *UpdateJobInput) SetNotification(v *Notification) *UpdateJobInput

SetNotification sets the Notification field's value.

func (*UpdateJobInput) SetResources added in v1.5.0 

func (s *UpdateJobInput) SetResources(v *JobResource) *UpdateJobInput

SetResources sets the Resources field's value.

func (*UpdateJobInput) SetRoleARN added in v1.5.0 

func (s *UpdateJobInput) SetRoleARN(v string) *UpdateJobInput

SetRoleARN sets the RoleARN field's value.

func (*UpdateJobInput) SetShippingOption added in v1.5.0 

func (s *UpdateJobInput) SetShippingOption(v string) *UpdateJobInput

SetShippingOption sets the ShippingOption field's value.

func (*UpdateJobInput) SetSnowballCapacityPreference added in v1.5.0 

func (s *UpdateJobInput) SetSnowballCapacityPreference(v string) *UpdateJobInput

SetSnowballCapacityPreference sets the SnowballCapacityPreference field's value.

func (UpdateJobInput) String 

func (s UpdateJobInput) String() string

String returns the string representation

func (*UpdateJobInput) Validate 

func (s *UpdateJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateJobOutput 

type UpdateJobOutput struct {
	// contains filtered or unexported fields
}

func (UpdateJobOutput) GoString 

func (s UpdateJobOutput) GoString() string

GoString returns the string representation

func (UpdateJobOutput) String 

func (s UpdateJobOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package snowballiface provides an interface to enable mocking the Amazon Import/Export Snowball service client for testing your code.
 Package snowballiface provides an interface to enable mocking the Amazon Import/Export Snowball service client for testing your code.

Jump to

Keyboard shortcuts

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