Documentation ¶
Overview ¶
Package snowball provides the client and types for making API requests to Amazon Import/Export Snowball.
AWS Snowball is a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The 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 and Snowball Edge devices. To transfer data locally with a device, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball.
See https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30 for more information on this service.
See snowball package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/snowball/
Using the Client ¶
To Amazon Import/Export Snowball with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon Import/Export Snowball client Snowball for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/snowball/#New
Index ¶
- Constants
- type Address
- type CancelClusterInput
- type CancelClusterOutput
- type CancelClusterRequest
- type CancelJobInput
- type CancelJobOutput
- type CancelJobRequest
- type Capacity
- type ClusterListEntry
- type ClusterMetadata
- type ClusterState
- type CompatibleImage
- type CreateAddressInput
- type CreateAddressOutput
- type CreateAddressRequest
- type CreateClusterInput
- type CreateClusterOutput
- type CreateClusterRequest
- type CreateJobInput
- type CreateJobOutput
- type CreateJobRequest
- type DataTransfer
- type DescribeAddressInput
- type DescribeAddressOutput
- type DescribeAddressRequest
- type DescribeAddressesInput
- type DescribeAddressesOutput
- type DescribeAddressesPager
- type DescribeAddressesRequest
- type DescribeClusterInput
- type DescribeClusterOutput
- type DescribeClusterRequest
- type DescribeJobInput
- type DescribeJobOutput
- type DescribeJobRequest
- type Ec2AmiResource
- type EventTriggerDefinition
- type GetJobManifestInput
- type GetJobManifestOutput
- type GetJobManifestRequest
- type GetJobUnlockCodeInput
- type GetJobUnlockCodeOutput
- type GetJobUnlockCodeRequest
- type GetSnowballUsageInput
- type GetSnowballUsageOutput
- type GetSnowballUsageRequest
- type JobListEntry
- type JobLogs
- type JobMetadata
- type JobResource
- type JobState
- type JobType
- type KeyRange
- type LambdaResource
- type ListClusterJobsInput
- type ListClusterJobsOutput
- type ListClusterJobsRequest
- type ListClustersInput
- type ListClustersOutput
- type ListClustersRequest
- type ListCompatibleImagesInput
- type ListCompatibleImagesOutput
- type ListCompatibleImagesRequest
- type ListJobsInput
- type ListJobsOutput
- type ListJobsPager
- type ListJobsRequest
- type Notification
- type S3Resource
- type Shipment
- type ShippingDetails
- type ShippingOption
- type Snowball
- func (c *Snowball) CancelClusterRequest(input *CancelClusterInput) CancelClusterRequest
- func (c *Snowball) CancelJobRequest(input *CancelJobInput) CancelJobRequest
- func (c *Snowball) CreateAddressRequest(input *CreateAddressInput) CreateAddressRequest
- func (c *Snowball) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest
- func (c *Snowball) CreateJobRequest(input *CreateJobInput) CreateJobRequest
- func (c *Snowball) DescribeAddressRequest(input *DescribeAddressInput) DescribeAddressRequest
- func (c *Snowball) DescribeAddressesRequest(input *DescribeAddressesInput) DescribeAddressesRequest
- func (c *Snowball) DescribeClusterRequest(input *DescribeClusterInput) DescribeClusterRequest
- func (c *Snowball) DescribeJobRequest(input *DescribeJobInput) DescribeJobRequest
- func (c *Snowball) GetJobManifestRequest(input *GetJobManifestInput) GetJobManifestRequest
- func (c *Snowball) GetJobUnlockCodeRequest(input *GetJobUnlockCodeInput) GetJobUnlockCodeRequest
- func (c *Snowball) GetSnowballUsageRequest(input *GetSnowballUsageInput) GetSnowballUsageRequest
- func (c *Snowball) ListClusterJobsRequest(input *ListClusterJobsInput) ListClusterJobsRequest
- func (c *Snowball) ListClustersRequest(input *ListClustersInput) ListClustersRequest
- func (c *Snowball) ListCompatibleImagesRequest(input *ListCompatibleImagesInput) ListCompatibleImagesRequest
- func (c *Snowball) ListJobsRequest(input *ListJobsInput) ListJobsRequest
- func (c *Snowball) UpdateClusterRequest(input *UpdateClusterInput) UpdateClusterRequest
- func (c *Snowball) UpdateJobRequest(input *UpdateJobInput) UpdateJobRequest
- type Type
- type UpdateClusterInput
- type UpdateClusterOutput
- type UpdateClusterRequest
- type UpdateJobInput
- type UpdateJobOutput
- type UpdateJobRequest
Examples ¶
- Snowball.CancelClusterRequest (Shared00)
- Snowball.CancelJobRequest (Shared00)
- Snowball.CreateAddressRequest (Shared00)
- Snowball.CreateClusterRequest (Shared00)
- Snowball.CreateJobRequest (Shared00)
- Snowball.DescribeAddressRequest (Shared00)
- Snowball.DescribeAddressesRequest (Shared00)
- Snowball.DescribeClusterRequest (Shared00)
- Snowball.DescribeJobRequest (Shared00)
- Snowball.GetJobManifestRequest (Shared00)
- Snowball.GetJobUnlockCodeRequest (Shared00)
- Snowball.GetSnowballUsageRequest (Shared00)
- Snowball.ListClusterJobsRequest (Shared00)
- Snowball.ListClustersRequest (Shared00)
- Snowball.ListJobsRequest (Shared00)
- Snowball.UpdateClusterRequest (Shared00)
- Snowball.UpdateJobRequest (Shared00)
Constants ¶
const ( // ErrCodeClusterLimitExceededException for service response error code // "ClusterLimitExceededException". // // Job creation failed. Currently, clusters support five nodes. If you have // less 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 // notes. ErrCodeClusterLimitExceededException = "ClusterLimitExceededException" // ErrCodeEc2RequestFailedException for service response error code // "Ec2RequestFailedException". // // Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted // action. ErrCodeEc2RequestFailedException = "Ec2RequestFailedException" // ErrCodeInvalidAddressException for service response error code // "InvalidAddressException". // // The address provided was invalid. Check the address with your region's carrier, // and try again. ErrCodeInvalidAddressException = "InvalidAddressException" // ErrCodeInvalidInputCombinationException for service response error code // "InvalidInputCombinationException". // // Job or cluster creation failed. One ore more inputs were invalid. Confirm // that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, // and try again. ErrCodeInvalidInputCombinationException = "InvalidInputCombinationException" // ErrCodeInvalidJobStateException for service response error code // "InvalidJobStateException". // // The action can't be performed because the job's current state doesn't allow // that action to be performed. ErrCodeInvalidJobStateException = "InvalidJobStateException" // ErrCodeInvalidNextTokenException for service response error code // "InvalidNextTokenException". // // The NextToken string was altered unexpectedly, and the operation has stopped. // Run the operation without changing the NextToken string, and try again. ErrCodeInvalidNextTokenException = "InvalidNextTokenException" // ErrCodeInvalidResourceException for service response error code // "InvalidResourceException". // // The specified resource can't be found. Check the information you provided // in your last request, and try again. ErrCodeInvalidResourceException = "InvalidResourceException" // ErrCodeKMSRequestFailedException for service response error code // "KMSRequestFailedException". // // The provided AWS Key Management Service key lacks the permissions to perform // the specified CreateJob or UpdateJob action. ErrCodeKMSRequestFailedException = "KMSRequestFailedException" // ErrCodeUnsupportedAddressException for service response error code // "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. ErrCodeUnsupportedAddressException = "UnsupportedAddressException" )
const ( ServiceName = "snowball" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
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"` // 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 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"` // 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 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/Address
type CancelClusterInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelClusterRequest
func (CancelClusterInput) GoString ¶
func (s CancelClusterInput) GoString() string
GoString returns the string representation
func (CancelClusterInput) String ¶
func (s CancelClusterInput) String() string
String returns the string representation
func (*CancelClusterInput) Validate ¶
func (s *CancelClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelClusterOutput ¶
type CancelClusterOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelClusterResult
func (CancelClusterOutput) GoString ¶
func (s CancelClusterOutput) GoString() string
GoString returns the string representation
func (CancelClusterOutput) SDKResponseMetadata ¶
func (s CancelClusterOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CancelClusterOutput) String ¶
func (s CancelClusterOutput) String() string
String returns the string representation
type CancelClusterRequest ¶
type CancelClusterRequest struct { *aws.Request Input *CancelClusterInput Copy func(*CancelClusterInput) CancelClusterRequest }
CancelClusterRequest is a API request type for the CancelCluster API operation.
func (CancelClusterRequest) Send ¶
func (r CancelClusterRequest) Send() (*CancelClusterOutput, error)
Send marshals and sends the CancelCluster API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJobRequest
func (CancelJobInput) GoString ¶
func (s CancelJobInput) GoString() string
GoString returns the string representation
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
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJobResult
func (CancelJobOutput) GoString ¶
func (s CancelJobOutput) GoString() string
GoString returns the string representation
func (CancelJobOutput) SDKResponseMetadata ¶
func (s CancelJobOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CancelJobOutput) String ¶
func (s CancelJobOutput) String() string
String returns the string representation
type CancelJobRequest ¶
type CancelJobRequest struct { *aws.Request Input *CancelJobInput Copy func(*CancelJobInput) CancelJobRequest }
CancelJobRequest is a API request type for the CancelJob API operation.
func (CancelJobRequest) Send ¶
func (r CancelJobRequest) Send() (*CancelJobOutput, error)
Send marshals and sends the CancelJob API request.
type Capacity ¶
type Capacity string
const ( CapacityT50 Capacity = "T50" CapacityT80 Capacity = "T80" CapacityT100 Capacity = "T100" CapacityT42 Capacity = "T42" CapacityNoPreference Capacity = "NoPreference" )
Enum values for Capacity
func (Capacity) MarshalValue ¶ added in v0.3.0
type ClusterListEntry ¶
type ClusterListEntry struct { // The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000. ClusterId *string `min:"1" type:"string"` // The current state of this cluster. For information about the state of a specific // node, see JobListEntry$JobState. ClusterState ClusterState `type:"string" enum:"true"` // The creation date for this cluster. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ClusterListEntry
func (ClusterListEntry) GoString ¶
func (s ClusterListEntry) GoString() string
GoString returns the string representation
func (ClusterListEntry) String ¶
func (s ClusterListEntry) String() string
String returns the string representation
type ClusterMetadata ¶
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 ClusterState `type:"string" enum:"true"` // The creation date for this cluster. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // 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 JobType `type:"string" enum:"true"` // The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This // ARN was created using the CreateKey (http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) // API action in AWS Key Management Service (AWS KMS). KmsKeyARN *string `type:"string"` // The Amazon Simple Notification Service (Amazon SNS) notification settings // for this cluster. Notification *Notification `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 (http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // API action in AWS 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, // 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, devices are delivered in one to seven days. // // * In the US, you have access to one-day shipping and two-day shipping. ShippingOption ShippingOption `type:"string" enum:"true"` // The type of AWS Snowball device to use for this cluster. The only supported // device types for cluster jobs are EDGE, EDGE_C, and EDGE_CG. SnowballType Type `type:"string" enum:"true"` // contains filtered or unexported fields }
Contains metadata about a specific cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ClusterMetadata
func (ClusterMetadata) GoString ¶
func (s ClusterMetadata) GoString() string
GoString returns the string representation
func (ClusterMetadata) String ¶
func (s ClusterMetadata) String() string
String returns the string representation
type ClusterState ¶
type ClusterState string
const ( ClusterStateAwaitingQuorum ClusterState = "AwaitingQuorum" ClusterStatePending ClusterState = "Pending" ClusterStateInUse ClusterState = "InUse" ClusterStateComplete ClusterState = "Complete" ClusterStateCancelled ClusterState = "Cancelled" )
Enum values for ClusterState
func (ClusterState) MarshalValue ¶ added in v0.3.0
func (enum ClusterState) MarshalValue() (string, error)
func (ClusterState) MarshalValueBuf ¶ added in v0.3.0
func (enum ClusterState) MarshalValueBuf(b []byte) ([]byte, error)
type CompatibleImage ¶ added in v0.5.0
type CompatibleImage struct { // The unique identifier for an individual Snowball Edge 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). For more information on compatible AMIs, see Using Amazon EC2 Compute Instances (http://docs.aws.amazon.com/snowball/latest/developer-guide/using-ec2.html) in the AWS Snowball Developer Guide. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CompatibleImage
func (CompatibleImage) GoString ¶ added in v0.5.0
func (s CompatibleImage) GoString() string
GoString returns the string representation
func (CompatibleImage) String ¶ added in v0.5.0
func (s CompatibleImage) 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddressRequest
func (CreateAddressInput) GoString ¶
func (s CreateAddressInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddressResult
func (CreateAddressOutput) GoString ¶
func (s CreateAddressOutput) GoString() string
GoString returns the string representation
func (CreateAddressOutput) SDKResponseMetadata ¶
func (s CreateAddressOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateAddressOutput) String ¶
func (s CreateAddressOutput) String() string
String returns the string representation
type CreateAddressRequest ¶
type CreateAddressRequest struct { *aws.Request Input *CreateAddressInput Copy func(*CreateAddressInput) CreateAddressRequest }
CreateAddressRequest is a API request type for the CreateAddress API operation.
func (CreateAddressRequest) Send ¶
func (r CreateAddressRequest) Send() (*CreateAddressOutput, error)
Send marshals and sends the CreateAddress API request.
type CreateClusterInput ¶
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"` // The forwarding address ID for a cluster. 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 is a required field JobType JobType `type:"string" required:"true" enum:"true"` // The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN // values are created by using the CreateKey (http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) // API action in AWS Key Management Service (AWS KMS). KmsKeyARN *string `type:"string"` // The Amazon Simple Notification Service (Amazon SNS) notification settings // for this cluster. Notification *Notification `type:"structure"` // The resources associated with the cluster job. These resources include Amazon // S3 buckets and optional AWS Lambda functions written in the Python language. // // Resources is a required field Resources *JobResource `type:"structure" required:"true"` // The RoleARN that you want to associate with this cluster. RoleArn values // are created by using the CreateRole (http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // API action in AWS Identity and Access Management (IAM). // // RoleARN is a required field RoleARN *string `type:"string" required:"true"` // 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, devices // shipped express are delivered in about a day. // // * In the European Union (EU), you have access to express shipping. Typically, // Snowball Edges 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, 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 ShippingOption `type:"string" required:"true" enum:"true"` // The type of AWS Snowball device to use for this cluster. The only supported // device types for cluster jobs are EDGE, EDGE_C, and EDGE_CG. SnowballType Type `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateClusterRequest
func (CreateClusterInput) GoString ¶
func (s CreateClusterInput) GoString() string
GoString returns the string representation
func (CreateClusterInput) String ¶
func (s CreateClusterInput) String() string
String returns the string representation
func (*CreateClusterInput) Validate ¶
func (s *CreateClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateClusterOutput ¶
type CreateClusterOutput struct { // The automatically generated ID for a cluster. ClusterId *string `min:"39" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateClusterResult
func (CreateClusterOutput) GoString ¶
func (s CreateClusterOutput) GoString() string
GoString returns the string representation
func (CreateClusterOutput) SDKResponseMetadata ¶
func (s CreateClusterOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateClusterOutput) String ¶
func (s CreateClusterOutput) String() string
String returns the string representation
type CreateClusterRequest ¶
type CreateClusterRequest struct { *aws.Request Input *CreateClusterInput Copy func(*CreateClusterInput) CreateClusterRequest }
CreateClusterRequest is a API request type for the CreateCluster API operation.
func (CreateClusterRequest) Send ¶
func (r CreateClusterRequest) Send() (*CreateClusterOutput, error)
Send marshals and sends the CreateCluster API request.
type CreateJobInput ¶
type CreateJobInput struct { // The ID for the address that you want the Snowball 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"` // The forwarding address ID for a job. This field is not supported in most // regions. ForwardingAddressId *string `min:"40" type:"string"` // Defines the type of job that you're creating. JobType JobType `type:"string" enum:"true"` // 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 *JobResource `type:"structure"` // 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 *string `type:"string"` // The shipping speed for this job. This speed doesn't 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 ShippingOption `type:"string" enum:"true"` // 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 Capacity `type:"string" enum:"true"` // The type of AWS Snowball device to use for this job. The only supported device // types for cluster jobs are EDGE, EDGE_C, and EDGE_CG. SnowballType Type `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJobRequest
func (CreateJobInput) GoString ¶
func (s CreateJobInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJobResult
func (CreateJobOutput) GoString ¶
func (s CreateJobOutput) GoString() string
GoString returns the string representation
func (CreateJobOutput) SDKResponseMetadata ¶
func (s CreateJobOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateJobOutput) String ¶
func (s CreateJobOutput) String() string
String returns the string representation
type CreateJobRequest ¶
type CreateJobRequest struct { *aws.Request Input *CreateJobInput Copy func(*CreateJobInput) CreateJobRequest }
CreateJobRequest is a API request type for the CreateJob API operation.
func (CreateJobRequest) Send ¶
func (r CreateJobRequest) Send() (*CreateJobOutput, error)
Send marshals and sends the CreateJob API request.
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 device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DataTransfer
func (DataTransfer) GoString ¶
func (s DataTransfer) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddressRequest
func (DescribeAddressInput) GoString ¶
func (s DescribeAddressInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddressResult
func (DescribeAddressOutput) GoString ¶
func (s DescribeAddressOutput) GoString() string
GoString returns the string representation
func (DescribeAddressOutput) SDKResponseMetadata ¶
func (s DescribeAddressOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeAddressOutput) String ¶
func (s DescribeAddressOutput) String() string
String returns the string representation
type DescribeAddressRequest ¶
type DescribeAddressRequest struct { *aws.Request Input *DescribeAddressInput Copy func(*DescribeAddressInput) DescribeAddressRequest }
DescribeAddressRequest is a API request type for the DescribeAddress API operation.
func (DescribeAddressRequest) Send ¶
func (r DescribeAddressRequest) Send() (*DescribeAddressOutput, error)
Send marshals and sends the DescribeAddress API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddressesRequest
func (DescribeAddressesInput) GoString ¶
func (s DescribeAddressesInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddressesResult
func (DescribeAddressesOutput) GoString ¶
func (s DescribeAddressesOutput) GoString() string
GoString returns the string representation
func (DescribeAddressesOutput) SDKResponseMetadata ¶
func (s DescribeAddressesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeAddressesOutput) String ¶
func (s DescribeAddressesOutput) String() string
String returns the string representation
type DescribeAddressesPager ¶ added in v0.3.0
DescribeAddressesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*DescribeAddressesPager) CurrentPage ¶ added in v0.3.0
func (p *DescribeAddressesPager) CurrentPage() *DescribeAddressesOutput
type DescribeAddressesRequest ¶
type DescribeAddressesRequest struct { *aws.Request Input *DescribeAddressesInput Copy func(*DescribeAddressesInput) DescribeAddressesRequest }
DescribeAddressesRequest is a API request type for the DescribeAddresses API operation.
func (*DescribeAddressesRequest) Paginate ¶ added in v0.3.0
func (p *DescribeAddressesRequest) Paginate(opts ...aws.Option) DescribeAddressesPager
Paginate pages iterates over the pages of a DescribeAddressesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeAddresses operation. req := client.DescribeAddressesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (DescribeAddressesRequest) Send ¶
func (r DescribeAddressesRequest) Send() (*DescribeAddressesOutput, error)
Send marshals and sends the DescribeAddresses API request.
type DescribeClusterInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeClusterRequest
func (DescribeClusterInput) GoString ¶
func (s DescribeClusterInput) GoString() string
GoString returns the string representation
func (DescribeClusterInput) String ¶
func (s DescribeClusterInput) String() string
String returns the string representation
func (*DescribeClusterInput) Validate ¶
func (s *DescribeClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeClusterOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeClusterResult
func (DescribeClusterOutput) GoString ¶
func (s DescribeClusterOutput) GoString() string
GoString returns the string representation
func (DescribeClusterOutput) SDKResponseMetadata ¶
func (s DescribeClusterOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeClusterOutput) String ¶
func (s DescribeClusterOutput) String() string
String returns the string representation
type DescribeClusterRequest ¶
type DescribeClusterRequest struct { *aws.Request Input *DescribeClusterInput Copy func(*DescribeClusterInput) DescribeClusterRequest }
DescribeClusterRequest is a API request type for the DescribeCluster API operation.
func (DescribeClusterRequest) Send ¶
func (r DescribeClusterRequest) Send() (*DescribeClusterOutput, error)
Send marshals and sends the DescribeCluster API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJobRequest
func (DescribeJobInput) GoString ¶
func (s DescribeJobInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJobResult
func (DescribeJobOutput) GoString ¶
func (s DescribeJobOutput) GoString() string
GoString returns the string representation
func (DescribeJobOutput) SDKResponseMetadata ¶
func (s DescribeJobOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeJobOutput) String ¶
func (s DescribeJobOutput) String() string
String returns the string representation
type DescribeJobRequest ¶
type DescribeJobRequest struct { *aws.Request Input *DescribeJobInput Copy func(*DescribeJobInput) DescribeJobRequest }
DescribeJobRequest is a API request type for the DescribeJob API operation.
func (DescribeJobRequest) Send ¶
func (r DescribeJobRequest) Send() (*DescribeJobOutput, error)
Send marshals and sends the DescribeJob API request.
type Ec2AmiResource ¶ added in v0.5.0
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 supported 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 AMI ID and the Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS Cloud and on the device. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/Ec2AmiResource
func (Ec2AmiResource) GoString ¶ added in v0.5.0
func (s Ec2AmiResource) GoString() string
GoString returns the string representation
func (Ec2AmiResource) String ¶ added in v0.5.0
func (s Ec2AmiResource) String() string
String returns the string representation
func (*Ec2AmiResource) Validate ¶ added in v0.5.0
func (s *Ec2AmiResource) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EventTriggerDefinition ¶
type EventTriggerDefinition struct { // The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an // AWS Lambda function's event trigger associated with this job. EventResourceARN *string `type:"string"` // contains filtered or unexported fields }
The container for the EventTriggerDefinition$EventResourceARN. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/EventTriggerDefinition
func (EventTriggerDefinition) GoString ¶
func (s EventTriggerDefinition) GoString() string
GoString returns the string representation
func (EventTriggerDefinition) String ¶
func (s EventTriggerDefinition) 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifestRequest
func (GetJobManifestInput) GoString ¶
func (s GetJobManifestInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifestResult
func (GetJobManifestOutput) GoString ¶
func (s GetJobManifestOutput) GoString() string
GoString returns the string representation
func (GetJobManifestOutput) SDKResponseMetadata ¶
func (s GetJobManifestOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetJobManifestOutput) String ¶
func (s GetJobManifestOutput) String() string
String returns the string representation
type GetJobManifestRequest ¶
type GetJobManifestRequest struct { *aws.Request Input *GetJobManifestInput Copy func(*GetJobManifestInput) GetJobManifestRequest }
GetJobManifestRequest is a API request type for the GetJobManifest API operation.
func (GetJobManifestRequest) Send ¶
func (r GetJobManifestRequest) Send() (*GetJobManifestOutput, error)
Send marshals and sends the GetJobManifest API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCodeRequest
func (GetJobUnlockCodeInput) GoString ¶
func (s GetJobUnlockCodeInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCodeResult
func (GetJobUnlockCodeOutput) GoString ¶
func (s GetJobUnlockCodeOutput) GoString() string
GoString returns the string representation
func (GetJobUnlockCodeOutput) SDKResponseMetadata ¶
func (s GetJobUnlockCodeOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetJobUnlockCodeOutput) String ¶
func (s GetJobUnlockCodeOutput) String() string
String returns the string representation
type GetJobUnlockCodeRequest ¶
type GetJobUnlockCodeRequest struct { *aws.Request Input *GetJobUnlockCodeInput Copy func(*GetJobUnlockCodeInput) GetJobUnlockCodeRequest }
GetJobUnlockCodeRequest is a API request type for the GetJobUnlockCode API operation.
func (GetJobUnlockCodeRequest) Send ¶
func (r GetJobUnlockCodeRequest) Send() (*GetJobUnlockCodeOutput, error)
Send marshals and sends the GetJobUnlockCode API request.
type GetSnowballUsageInput ¶
type GetSnowballUsageInput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsageRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsageResult
func (GetSnowballUsageOutput) GoString ¶
func (s GetSnowballUsageOutput) GoString() string
GoString returns the string representation
func (GetSnowballUsageOutput) SDKResponseMetadata ¶
func (s GetSnowballUsageOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetSnowballUsageOutput) String ¶
func (s GetSnowballUsageOutput) String() string
String returns the string representation
type GetSnowballUsageRequest ¶
type GetSnowballUsageRequest struct { *aws.Request Input *GetSnowballUsageInput Copy func(*GetSnowballUsageInput) GetSnowballUsageRequest }
GetSnowballUsageRequest is a API request type for the GetSnowballUsage API operation.
func (GetSnowballUsageRequest) Send ¶
func (r GetSnowballUsageRequest) Send() (*GetSnowballUsageOutput, error)
Send marshals and sends the GetSnowballUsage API request.
type JobListEntry ¶
type JobListEntry struct { // The creation date for this job. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // 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 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 JobState `type:"string" enum:"true"` // The type of job. JobType JobType `type:"string" enum:"true"` // The type of device used with this job. SnowballType Type `type:"string" enum:"true"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/JobListEntry
func (JobListEntry) GoString ¶
func (s JobListEntry) GoString() string
GoString returns the string representation
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/JobLogs
type JobMetadata ¶
type JobMetadata struct { // The ID for the address that you want the Snowball 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" timestampFormat:"unix"` // A value that defines the real-time status of a Snowball's data transfer while // the device is at AWS. 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 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 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 status of the jobs. JobState JobState `type:"string" enum:"true"` // The type of job. JobType JobType `type:"string" enum:"true"` // 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 (http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) // 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 // (http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // 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 Capacity `type:"string" enum:"true"` // The type of device used with this job. SnowballType Type `type:"string" enum:"true"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/JobMetadata
func (JobMetadata) GoString ¶
func (s JobMetadata) GoString() string
GoString returns the string representation
func (JobMetadata) String ¶
func (s JobMetadata) String() string
String returns the string representation
type JobResource ¶
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 AWS resource objects. Each object represents an Amazon S3 bucket, an AWS Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/JobResource
func (JobResource) GoString ¶
func (s JobResource) GoString() string
GoString returns the string representation
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 JobState ¶
type JobState string
const ( JobStateNew JobState = "New" JobStatePreparingAppliance JobState = "PreparingAppliance" JobStatePreparingShipment JobState = "PreparingShipment" JobStateInTransitToCustomer JobState = "InTransitToCustomer" JobStateWithCustomer JobState = "WithCustomer" JobStateInTransitToAws JobState = "InTransitToAWS" JobStateWithAwssortingFacility JobState = "WithAWSSortingFacility" JobStateWithAws JobState = "WithAWS" JobStateInProgress JobState = "InProgress" JobStateComplete JobState = "Complete" JobStateCancelled JobState = "Cancelled" JobStateListing JobState = "Listing" JobStatePending JobState = "Pending" )
Enum values for JobState
func (JobState) MarshalValue ¶ added in v0.3.0
type JobType ¶
type JobType string
const ( JobTypeImport JobType = "IMPORT" JobTypeExport JobType = "EXPORT" JobTypeLocalUse JobType = "LOCAL_USE" )
Enum values for JobType
func (JobType) MarshalValue ¶ added in v0.3.0
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/KeyRange
type LambdaResource ¶
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 AWS 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 Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/LambdaResource
func (LambdaResource) GoString ¶
func (s LambdaResource) GoString() string
GoString returns the string representation
func (LambdaResource) String ¶
func (s LambdaResource) String() string
String returns the string representation
type ListClusterJobsInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobsRequest
func (ListClusterJobsInput) GoString ¶
func (s ListClusterJobsInput) GoString() string
GoString returns the string representation
func (ListClusterJobsInput) String ¶
func (s ListClusterJobsInput) String() string
String returns the string representation
func (*ListClusterJobsInput) Validate ¶
func (s *ListClusterJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListClusterJobsOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobsResult
func (ListClusterJobsOutput) GoString ¶
func (s ListClusterJobsOutput) GoString() string
GoString returns the string representation
func (ListClusterJobsOutput) SDKResponseMetadata ¶
func (s ListClusterJobsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListClusterJobsOutput) String ¶
func (s ListClusterJobsOutput) String() string
String returns the string representation
type ListClusterJobsRequest ¶
type ListClusterJobsRequest struct { *aws.Request Input *ListClusterJobsInput Copy func(*ListClusterJobsInput) ListClusterJobsRequest }
ListClusterJobsRequest is a API request type for the ListClusterJobs API operation.
func (ListClusterJobsRequest) Send ¶
func (r ListClusterJobsRequest) Send() (*ListClusterJobsOutput, error)
Send marshals and sends the ListClusterJobs API request.
type ListClustersInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClustersRequest
func (ListClustersInput) GoString ¶
func (s ListClustersInput) GoString() string
GoString returns the string representation
func (ListClustersInput) String ¶
func (s ListClustersInput) String() string
String returns the string representation
func (*ListClustersInput) Validate ¶
func (s *ListClustersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListClustersOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClustersResult
func (ListClustersOutput) GoString ¶
func (s ListClustersOutput) GoString() string
GoString returns the string representation
func (ListClustersOutput) SDKResponseMetadata ¶
func (s ListClustersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListClustersOutput) String ¶
func (s ListClustersOutput) String() string
String returns the string representation
type ListClustersRequest ¶
type ListClustersRequest struct { *aws.Request Input *ListClustersInput Copy func(*ListClustersInput) ListClustersRequest }
ListClustersRequest is a API request type for the ListClusters API operation.
func (ListClustersRequest) Send ¶
func (r ListClustersRequest) Send() (*ListClustersOutput, error)
Send marshals and sends the ListClusters API request.
type ListCompatibleImagesInput ¶ added in v0.5.0
type ListCompatibleImagesInput struct { // The maximum number of results for the list of compatible images. Currently, // each supported 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListCompatibleImagesRequest
func (ListCompatibleImagesInput) GoString ¶ added in v0.5.0
func (s ListCompatibleImagesInput) GoString() string
GoString returns the string representation
func (ListCompatibleImagesInput) String ¶ added in v0.5.0
func (s ListCompatibleImagesInput) String() string
String returns the string representation
func (*ListCompatibleImagesInput) Validate ¶ added in v0.5.0
func (s *ListCompatibleImagesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListCompatibleImagesOutput ¶ added in v0.5.0
type ListCompatibleImagesOutput struct { // A JSON-formatted object that describes a compatible 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListCompatibleImagesResult
func (ListCompatibleImagesOutput) GoString ¶ added in v0.5.0
func (s ListCompatibleImagesOutput) GoString() string
GoString returns the string representation
func (ListCompatibleImagesOutput) SDKResponseMetadata ¶ added in v0.5.0
func (s ListCompatibleImagesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListCompatibleImagesOutput) String ¶ added in v0.5.0
func (s ListCompatibleImagesOutput) String() string
String returns the string representation
type ListCompatibleImagesRequest ¶ added in v0.5.0
type ListCompatibleImagesRequest struct { *aws.Request Input *ListCompatibleImagesInput Copy func(*ListCompatibleImagesInput) ListCompatibleImagesRequest }
ListCompatibleImagesRequest is a API request type for the ListCompatibleImages API operation.
func (ListCompatibleImagesRequest) Send ¶ added in v0.5.0
func (r ListCompatibleImagesRequest) Send() (*ListCompatibleImagesOutput, error)
Send marshals and sends the ListCompatibleImages API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobsRequest
func (ListJobsInput) GoString ¶
func (s ListJobsInput) GoString() string
GoString returns the string representation
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobsResult
func (ListJobsOutput) GoString ¶
func (s ListJobsOutput) GoString() string
GoString returns the string representation
func (ListJobsOutput) SDKResponseMetadata ¶
func (s ListJobsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListJobsOutput) String ¶
func (s ListJobsOutput) String() string
String returns the string representation
type ListJobsPager ¶ added in v0.3.0
ListJobsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListJobsPager) CurrentPage ¶ added in v0.3.0
func (p *ListJobsPager) CurrentPage() *ListJobsOutput
type ListJobsRequest ¶
type ListJobsRequest struct { *aws.Request Input *ListJobsInput Copy func(*ListJobsInput) ListJobsRequest }
ListJobsRequest is a API request type for the ListJobs API operation.
func (*ListJobsRequest) Paginate ¶ added in v0.3.0
func (p *ListJobsRequest) Paginate(opts ...aws.Option) ListJobsPager
Paginate pages iterates over the pages of a ListJobsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListJobs operation. req := client.ListJobsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListJobsRequest) Send ¶
func (r ListJobsRequest) Send() (*ListJobsOutput, error)
Send marshals and sends the ListJobs API request.
type Notification ¶
type Notification struct { // The list of job states that will trigger a notification for this job. JobStatesToNotify []JobState `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. // // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/Notification
func (Notification) GoString ¶
func (s Notification) GoString() string
GoString returns the string representation
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/S3Resource
func (S3Resource) GoString ¶
func (s S3Resource) GoString() string
GoString returns the string representation
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. 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/Shipment
type ShippingDetails ¶
type ShippingDetails struct { // The Status and TrackingNumber values for a Snowball being returned to AWS // for a particular job. InboundShipment *Shipment `type:"structure"` // The Status and TrackingNumber values for a Snowball 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 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 ShippingOption `type:"string" enum:"true"` // contains filtered or unexported fields }
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options. Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ShippingDetails
func (ShippingDetails) GoString ¶
func (s ShippingDetails) GoString() string
GoString returns the string representation
func (ShippingDetails) String ¶
func (s ShippingDetails) String() string
String returns the string representation
type ShippingOption ¶
type ShippingOption string
const ( ShippingOptionSecondDay ShippingOption = "SECOND_DAY" ShippingOptionNextDay ShippingOption = "NEXT_DAY" ShippingOptionExpress ShippingOption = "EXPRESS" ShippingOptionStandard ShippingOption = "STANDARD" )
Enum values for ShippingOption
func (ShippingOption) MarshalValue ¶ added in v0.3.0
func (enum ShippingOption) MarshalValue() (string, error)
func (ShippingOption) MarshalValueBuf ¶ added in v0.3.0
func (enum ShippingOption) MarshalValueBuf(b []byte) ([]byte, error)
type Snowball ¶
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 ¶
New creates a new instance of the Snowball client with a config.
Example:
// Create a Snowball client from just a config. svc := snowball.New(myConfig)
func (*Snowball) CancelClusterRequest ¶
func (c *Snowball) CancelClusterRequest(input *CancelClusterInput) CancelClusterRequest
CancelClusterRequest returns a request value for making 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.
// Example sending a request using the CancelClusterRequest method. req := client.CancelClusterRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelCluster
func (*Snowball) CancelJobRequest ¶
func (c *Snowball) CancelJobRequest(input *CancelJobInput) CancelJobRequest
CancelJobRequest returns a request value for making 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.
// Example sending a request using the CancelJobRequest method. req := client.CancelJobRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJob
func (*Snowball) CreateAddressRequest ¶
func (c *Snowball) CreateAddressRequest(input *CreateAddressInput) CreateAddressRequest
CreateAddressRequest returns a request value for making API operation for Amazon Import/Export Snowball.
Creates an address for a Snowball 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.
// Example sending a request using the CreateAddressRequest method. req := client.CreateAddressRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddress
func (*Snowball) CreateClusterRequest ¶
func (c *Snowball) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest
CreateClusterRequest returns a request value for making 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.
// Example sending a request using the CreateClusterRequest method. req := client.CreateClusterRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateCluster
func (*Snowball) CreateJobRequest ¶
func (c *Snowball) CreateJobRequest(input *CreateJobInput) CreateJobRequest
CreateJobRequest returns a request value for making 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 AWS account must have the right trust policies and permissions in place to create a job for Snowball. 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.
// Example sending a request using the CreateJobRequest method. req := client.CreateJobRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJob
func (*Snowball) DescribeAddressRequest ¶
func (c *Snowball) DescribeAddressRequest(input *DescribeAddressInput) DescribeAddressRequest
DescribeAddressRequest returns a request value for making API operation for Amazon Import/Export Snowball.
Takes an AddressId and returns specific details about that address in the form of an Address object.
// Example sending a request using the DescribeAddressRequest method. req := client.DescribeAddressRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddress
func (*Snowball) DescribeAddressesRequest ¶
func (c *Snowball) DescribeAddressesRequest(input *DescribeAddressesInput) DescribeAddressesRequest
DescribeAddressesRequest returns a request value for making 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.
// Example sending a request using the DescribeAddressesRequest method. req := client.DescribeAddressesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddresses
func (*Snowball) DescribeClusterRequest ¶
func (c *Snowball) DescribeClusterRequest(input *DescribeClusterInput) DescribeClusterRequest
DescribeClusterRequest returns a request value for making API operation for Amazon Import/Export Snowball.
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
// Example sending a request using the DescribeClusterRequest method. req := client.DescribeClusterRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeCluster
func (*Snowball) DescribeJobRequest ¶
func (c *Snowball) DescribeJobRequest(input *DescribeJobInput) DescribeJobRequest
DescribeJobRequest returns a request value for making API operation for Amazon Import/Export Snowball.
Returns information about a specific job including shipping information, job status, and other important metadata.
// Example sending a request using the DescribeJobRequest method. req := client.DescribeJobRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJob
func (*Snowball) GetJobManifestRequest ¶
func (c *Snowball) GetJobManifestRequest(input *GetJobManifestInput) GetJobManifestRequest
GetJobManifestRequest returns a request value for making 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.
The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
// Example sending a request using the GetJobManifestRequest method. req := client.GetJobManifestRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifest
func (*Snowball) GetJobUnlockCodeRequest ¶
func (c *Snowball) GetJobUnlockCodeRequest(input *GetJobUnlockCodeInput) GetJobUnlockCodeRequest
GetJobUnlockCodeRequest returns a request value for making 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.
// Example sending a request using the GetJobUnlockCodeRequest method. req := client.GetJobUnlockCodeRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCode
func (*Snowball) GetSnowballUsageRequest ¶
func (c *Snowball) GetSnowballUsageRequest(input *GetSnowballUsageInput) GetSnowballUsageRequest
GetSnowballUsageRequest returns a request value for making 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.
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.
// Example sending a request using the GetSnowballUsageRequest method. req := client.GetSnowballUsageRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsage
func (*Snowball) ListClusterJobsRequest ¶
func (c *Snowball) ListClusterJobsRequest(input *ListClusterJobsInput) ListClusterJobsRequest
ListClusterJobsRequest returns a request value for making 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.
// Example sending a request using the ListClusterJobsRequest method. req := client.ListClusterJobsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobs
func (*Snowball) ListClustersRequest ¶
func (c *Snowball) ListClustersRequest(input *ListClustersInput) ListClustersRequest
ListClustersRequest returns a request value for making 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.
// Example sending a request using the ListClustersRequest method. req := client.ListClustersRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusters
func (*Snowball) ListCompatibleImagesRequest ¶ added in v0.5.0
func (c *Snowball) ListCompatibleImagesRequest(input *ListCompatibleImagesInput) ListCompatibleImagesRequest
ListCompatibleImagesRequest returns a request value for making API operation for Amazon Import/Export Snowball.
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on EDGE, EDGE_C, and EDGE_CG devices. For more information on compatible AMIs, see Using Amazon EC2 Compute Instances (http://docs.aws.amazon.com/snowball/latest/developer-guide/using-ec2.html) in the AWS Snowball Developer Guide.
// Example sending a request using the ListCompatibleImagesRequest method. req := client.ListCompatibleImagesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListCompatibleImages
func (*Snowball) ListJobsRequest ¶
func (c *Snowball) ListJobsRequest(input *ListJobsInput) ListJobsRequest
ListJobsRequest returns a request value for making 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.
// Example sending a request using the ListJobsRequest method. req := client.ListJobsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobs
func (*Snowball) UpdateClusterRequest ¶
func (c *Snowball) UpdateClusterRequest(input *UpdateClusterInput) UpdateClusterRequest
UpdateClusterRequest returns a request value for making 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.
// Example sending a request using the UpdateClusterRequest method. req := client.UpdateClusterRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateCluster
func (*Snowball) UpdateJobRequest ¶
func (c *Snowball) UpdateJobRequest(input *UpdateJobInput) UpdateJobRequest
UpdateJobRequest returns a request value for making 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.
// Example sending a request using the UpdateJobRequest method. req := client.UpdateJobRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJob
type Type ¶
type Type string
const ( TypeStandard Type = "STANDARD" TypeEdge Type = "EDGE" TypeEdgeC Type = "EDGE_C" TypeEdgeCg Type = "EDGE_CG" )
Enum values for Type
func (Type) MarshalValue ¶ added in v0.3.0
type UpdateClusterInput ¶
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"` // 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 (http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // API action in AWS Identity and Access Management (IAM). RoleARN *string `type:"string"` // The updated shipping option value of this cluster's ShippingDetails object. ShippingOption ShippingOption `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateClusterRequest
func (UpdateClusterInput) GoString ¶
func (s UpdateClusterInput) GoString() string
GoString returns the string representation
func (UpdateClusterInput) String ¶
func (s UpdateClusterInput) String() string
String returns the string representation
func (*UpdateClusterInput) Validate ¶
func (s *UpdateClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateClusterOutput ¶
type UpdateClusterOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateClusterResult
func (UpdateClusterOutput) GoString ¶
func (s UpdateClusterOutput) GoString() string
GoString returns the string representation
func (UpdateClusterOutput) SDKResponseMetadata ¶
func (s UpdateClusterOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateClusterOutput) String ¶
func (s UpdateClusterOutput) String() string
String returns the string representation
type UpdateClusterRequest ¶
type UpdateClusterRequest struct { *aws.Request Input *UpdateClusterInput Copy func(*UpdateClusterInput) UpdateClusterRequest }
UpdateClusterRequest is a API request type for the UpdateCluster API operation.
func (UpdateClusterRequest) Send ¶
func (r UpdateClusterRequest) Send() (*UpdateClusterOutput, error)
Send marshals and sends the UpdateCluster API request.
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 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"` // 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 (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 ShippingOption `type:"string" enum:"true"` // The updated SnowballCapacityPreference of this job's JobMetadata object. // The 50 TB Snowballs are only available in the US regions. SnowballCapacityPreference Capacity `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJobRequest
func (UpdateJobInput) GoString ¶
func (s UpdateJobInput) GoString() string
GoString returns the string representation
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
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJobResult
func (UpdateJobOutput) GoString ¶
func (s UpdateJobOutput) GoString() string
GoString returns the string representation
func (UpdateJobOutput) SDKResponseMetadata ¶
func (s UpdateJobOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateJobOutput) String ¶
func (s UpdateJobOutput) String() string
String returns the string representation
type UpdateJobRequest ¶
type UpdateJobRequest struct { *aws.Request Input *UpdateJobInput Copy func(*UpdateJobInput) UpdateJobRequest }
UpdateJobRequest is a API request type for the UpdateJob API operation.
func (UpdateJobRequest) Send ¶
func (r UpdateJobRequest) Send() (*UpdateJobOutput, error)
Send marshals and sends the UpdateJob API request.
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. |