snowball

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 17

Documentation

Overview

Package snowball provides the client and types for making API requests to Amazon 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 Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball device, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide (https://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html).

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 use Amazon 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 Snowball client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/snowball/#New

Index

Examples

Constants

View Source 
const (
	ServiceName = "Amazon Snowball" // Service's name
	ServiceID   = "Snowball"        // Service's identifier
	EndpointsID = "snowball"        // Service's Endpoint identifier
)
View Source 
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 or 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"
)

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.

func (Address) String 

func (s Address) String() string

String returns the string representation

func (*Address) Validate 

func (s *Address) Validate() error

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

type 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
}

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
}

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 the request type for the CancelCluster API operation.

func (CancelClusterRequest) Send 

func (r CancelClusterRequest) Send(ctx context.Context) (*CancelClusterResponse, error)

Send marshals and sends the CancelCluster API request.

type CancelClusterResponse added in v0.9.0 

type CancelClusterResponse struct {
	*CancelClusterOutput
	// contains filtered or unexported fields
}

CancelClusterResponse is the response type for the CancelCluster API operation.

func (*CancelClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *CancelClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CancelCluster 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
}

func (CancelJobInput) String 

func (s CancelJobInput) String() string

String returns the string representation

func (*CancelJobInput) Validate 

func (s *CancelJobInput) Validate() error

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

type CancelJobOutput 

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

func (CancelJobOutput) 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 the request type for the CancelJob API operation.

func (CancelJobRequest) Send 

func (r CancelJobRequest) Send(ctx context.Context) (*CancelJobResponse, error)

Send marshals and sends the CancelJob API request.

type CancelJobResponse added in v0.9.0 

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

CancelJobResponse is the response type for the CancelJob API operation.

func (*CancelJobResponse) SDKResponseMetdata added in v0.9.0 

func (r *CancelJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CancelJob request.

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon Snowball. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := snowball.New(myConfig)

func (*Client) CancelClusterRequest added in v0.9.0 

func (c *Client) 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 CancelClusterRequest.
req := client.CancelClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelCluster

Example (Shared00)

To cancel a cluster job

This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.CancelClusterInput{
		ClusterId: aws.String("CID123e4567-e89b-12d3-a456-426655440000"),
	}

	req := svc.CancelClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeKMSRequestFailedException:
				fmt.Println(snowball.ErrCodeKMSRequestFailedException, aerr.Error())
			case snowball.ErrCodeInvalidJobStateException:
				fmt.Println(snowball.ErrCodeInvalidJobStateException, aerr.Error())
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) CancelJobRequest added in v0.9.0 

func (c *Client) 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 CancelJobRequest.
req := client.CancelJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJob

Example (Shared00)

To cancel a job for a Snowball device

This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.CancelJobInput{
		JobId: aws.String("JID123e4567-e89b-12d3-a456-426655440000"),
	}

	req := svc.CancelJobRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			case snowball.ErrCodeInvalidJobStateException:
				fmt.Println(snowball.ErrCodeInvalidJobStateException, aerr.Error())
			case snowball.ErrCodeKMSRequestFailedException:
				fmt.Println(snowball.ErrCodeKMSRequestFailedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) CreateAddressRequest added in v0.9.0 

func (c *Client) 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 CreateAddressRequest.
req := client.CreateAddressRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddress

Example (Shared00)

To create an address for a job

This operation creates an address for a job. 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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.CreateAddressInput{
		Address: &snowball.Address{
			City:            aws.String("Seattle"),
			Company:         aws.String("My Company's Name"),
			Country:         aws.String("USA"),
			Name:            aws.String("My Name"),
			PhoneNumber:     aws.String("425-555-5555"),
			PostalCode:      aws.String("98101"),
			StateOrProvince: aws.String("WA"),
			Street1:         aws.String("123 Main Street"),
		},
	}

	req := svc.CreateAddressRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidAddressException:
				fmt.Println(snowball.ErrCodeInvalidAddressException, aerr.Error())
			case snowball.ErrCodeUnsupportedAddressException:
				fmt.Println(snowball.ErrCodeUnsupportedAddressException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) CreateClusterRequest added in v0.9.0 

func (c *Client) 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 CreateClusterRequest.
req := client.CreateClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateCluster

Example (Shared00)

To create a cluster

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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.CreateClusterInput{
		AddressId:   aws.String("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"),
		Description: aws.String("MyCluster"),
		JobType:     snowball.JobTypeLocalUse,
		KmsKeyARN:   aws.String("arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456"),
		Notification: &snowball.Notification{
			NotifyAll: aws.Bool(false),
		},
		Resources: &snowball.JobResource{
			S3Resources: []snowball.S3Resource{
				{
					BucketArn: aws.String("arn:aws:s3:::MyBucket"),
					KeyRange:  &snowball.KeyRange{},
				},
			},
		},
		RoleARN:        aws.String("arn:aws:iam::123456789012:role/snowball-import-S3-role"),
		ShippingOption: snowball.ShippingOptionSecondDay,
		SnowballType:   snowball.SnowballTypeEdge,
	}

	req := svc.CreateClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			case snowball.ErrCodeKMSRequestFailedException:
				fmt.Println(snowball.ErrCodeKMSRequestFailedException, aerr.Error())
			case snowball.ErrCodeInvalidInputCombinationException:
				fmt.Println(snowball.ErrCodeInvalidInputCombinationException, aerr.Error())
			case snowball.ErrCodeEc2RequestFailedException:
				fmt.Println(snowball.ErrCodeEc2RequestFailedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) CreateJobRequest added in v0.9.0 

func (c *Client) 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 CreateJobRequest.
req := client.CreateJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJob

Example (Shared00)

To create a job

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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.CreateJobInput{
		AddressId:   aws.String("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"),
		Description: aws.String("My Job"),
		JobType:     snowball.JobTypeImport,
		KmsKeyARN:   aws.String("arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456"),
		Notification: &snowball.Notification{
			NotifyAll: aws.Bool(false),
		},
		Resources: &snowball.JobResource{
			S3Resources: []snowball.S3Resource{
				{
					BucketArn: aws.String("arn:aws:s3:::MyBucket"),
					KeyRange:  &snowball.KeyRange{},
				},
			},
		},
		RoleARN:                    aws.String("arn:aws:iam::123456789012:role/snowball-import-S3-role"),
		ShippingOption:             snowball.ShippingOptionSecondDay,
		SnowballCapacityPreference: snowball.SnowballCapacityT80,
		SnowballType:               snowball.SnowballTypeStandard,
	}

	req := svc.CreateJobRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			case snowball.ErrCodeKMSRequestFailedException:
				fmt.Println(snowball.ErrCodeKMSRequestFailedException, aerr.Error())
			case snowball.ErrCodeInvalidInputCombinationException:
				fmt.Println(snowball.ErrCodeInvalidInputCombinationException, aerr.Error())
			case snowball.ErrCodeClusterLimitExceededException:
				fmt.Println(snowball.ErrCodeClusterLimitExceededException, aerr.Error())
			case snowball.ErrCodeEc2RequestFailedException:
				fmt.Println(snowball.ErrCodeEc2RequestFailedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeAddressRequest added in v0.9.0 

func (c *Client) 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 DescribeAddressRequest.
req := client.DescribeAddressRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddress

Example (Shared00)

To describe an address for a job

This operation describes an address for a job. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.DescribeAddressInput{
		AddressId: aws.String("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"),
	}

	req := svc.DescribeAddressRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeAddressesRequest added in v0.9.0 

func (c *Client) 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 DescribeAddressesRequest.
req := client.DescribeAddressesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddresses

Example (Shared00)

To describe all the addresses you've created for AWS Snowball

This operation describes all the addresses that you've created for AWS Snowball. 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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.DescribeAddressesInput{}

	req := svc.DescribeAddressesRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			case snowball.ErrCodeInvalidNextTokenException:
				fmt.Println(snowball.ErrCodeInvalidNextTokenException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeClusterRequest added in v0.9.0 

func (c *Client) 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 DescribeClusterRequest.
req := client.DescribeClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeCluster

Example (Shared00)

To describe a cluster

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

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.DescribeClusterInput{
		ClusterId: aws.String("CID123e4567-e89b-12d3-a456-426655440000"),
	}

	req := svc.DescribeClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeJobRequest added in v0.9.0 

func (c *Client) 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 DescribeJobRequest.
req := client.DescribeJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJob

Example (Shared00)

To describe a job you've created for AWS Snowball

This operation describes a job you've created for AWS Snowball. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.DescribeJobInput{
		JobId: aws.String("JID123e4567-e89b-12d3-a456-426655440000"),
	}

	req := svc.DescribeJobRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) GetJobManifestRequest added in v0.9.0 

func (c *Client) 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 GetJobManifestRequest.
req := client.GetJobManifestRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifest

Example (Shared00)

To get the manifest for a job you've created for AWS 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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.GetJobManifestInput{
		JobId: aws.String("JID123e4567-e89b-12d3-a456-426655440000"),
	}

	req := svc.GetJobManifestRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			case snowball.ErrCodeInvalidJobStateException:
				fmt.Println(snowball.ErrCodeInvalidJobStateException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) GetJobUnlockCodeRequest added in v0.9.0 

func (c *Client) 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 GetJobUnlockCodeRequest.
req := client.GetJobUnlockCodeRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCode

Example (Shared00)

To get the unlock code for a job you've created for AWS 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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.GetJobUnlockCodeInput{
		JobId: aws.String("JID123e4567-e89b-12d3-a456-426655440000"),
	}

	req := svc.GetJobUnlockCodeRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			case snowball.ErrCodeInvalidJobStateException:
				fmt.Println(snowball.ErrCodeInvalidJobStateException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) GetSnowballUsageRequest added in v0.9.0 

func (c *Client) 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 GetSnowballUsageRequest.
req := client.GetSnowballUsageRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsage

Example (Shared00)

To see your Snowball service limit and the number of Snowballs you have in use

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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.GetSnowballUsageInput{}

	req := svc.GetSnowballUsageRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) GetSoftwareUpdatesRequest added in v0.14.0 

func (c *Client) GetSoftwareUpdatesRequest(input *GetSoftwareUpdatesInput) GetSoftwareUpdatesRequest

GetSoftwareUpdatesRequest returns a request value for making API operation for Amazon Import/Export Snowball.

Returns an Amazon S3 presigned URL for an update file associated with a specified JobId. 

// Example sending a request using GetSoftwareUpdatesRequest.
req := client.GetSoftwareUpdatesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSoftwareUpdates

func (*Client) ListClusterJobsRequest added in v0.9.0 

func (c *Client) 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 ListClusterJobsRequest.
req := client.ListClusterJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobs

Example (Shared00)

To get a list of jobs in a cluster that you've created for AWS 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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.ListClusterJobsInput{
		ClusterId: aws.String("CID123e4567-e89b-12d3-a456-426655440000"),
	}

	req := svc.ListClusterJobsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			case snowball.ErrCodeInvalidNextTokenException:
				fmt.Println(snowball.ErrCodeInvalidNextTokenException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) ListClustersRequest added in v0.9.0 

func (c *Client) 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 ListClustersRequest.
req := client.ListClustersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusters

Example (Shared00)

To get a list of clusters that you've created for AWS 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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.ListClustersInput{}

	req := svc.ListClustersRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidNextTokenException:
				fmt.Println(snowball.ErrCodeInvalidNextTokenException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) ListCompatibleImagesRequest added in v0.9.0 

func (c *Client) 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 a Snowball Edge device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace. 

// Example sending a request using ListCompatibleImagesRequest.
req := client.ListCompatibleImagesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListCompatibleImages

func (*Client) ListJobsRequest added in v0.9.0 

func (c *Client) 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 ListJobsRequest.
req := client.ListJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobs

Example (Shared00)

To get a list of jobs that you've created for AWS 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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.ListJobsInput{}

	req := svc.ListJobsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidNextTokenException:
				fmt.Println(snowball.ErrCodeInvalidNextTokenException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) UpdateClusterRequest added in v0.9.0 

func (c *Client) 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 UpdateClusterRequest.
req := client.UpdateClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateCluster

Example (Shared00)

To update a cluster

This action allows you to update certain parameters for a cluster. Once the cluster changes to a different state, usually within 60 minutes of it being created, this action is no longer available. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.UpdateClusterInput{
		AddressId:   aws.String("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"),
		ClusterId:   aws.String("CID123e4567-e89b-12d3-a456-426655440000"),
		Description: aws.String("Updated the address to send this to image processing - RJ"),
	}

	req := svc.UpdateClusterRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			case snowball.ErrCodeInvalidJobStateException:
				fmt.Println(snowball.ErrCodeInvalidJobStateException, aerr.Error())
			case snowball.ErrCodeKMSRequestFailedException:
				fmt.Println(snowball.ErrCodeKMSRequestFailedException, aerr.Error())
			case snowball.ErrCodeInvalidInputCombinationException:
				fmt.Println(snowball.ErrCodeInvalidInputCombinationException, aerr.Error())
			case snowball.ErrCodeEc2RequestFailedException:
				fmt.Println(snowball.ErrCodeEc2RequestFailedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) UpdateJobRequest added in v0.9.0 

func (c *Client) 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 UpdateJobRequest.
req := client.UpdateJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJob

Example (Shared00)

To update a job

This action allows you to update certain parameters for 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. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/snowball"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := snowball.New(cfg)
	input := &snowball.UpdateJobInput{
		AddressId:                  aws.String("ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"),
		Description:                aws.String("Upgraded to Edge, shipped to Finance Dept, and requested faster shipping speed - TS."),
		JobId:                      aws.String("JID123e4567-e89b-12d3-a456-426655440000"),
		ShippingOption:             snowball.ShippingOptionNextDay,
		SnowballCapacityPreference: snowball.SnowballCapacityT100,
	}

	req := svc.UpdateJobRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case snowball.ErrCodeInvalidResourceException:
				fmt.Println(snowball.ErrCodeInvalidResourceException, aerr.Error())
			case snowball.ErrCodeInvalidJobStateException:
				fmt.Println(snowball.ErrCodeInvalidJobStateException, aerr.Error())
			case snowball.ErrCodeKMSRequestFailedException:
				fmt.Println(snowball.ErrCodeKMSRequestFailedException, aerr.Error())
			case snowball.ErrCodeInvalidInputCombinationException:
				fmt.Println(snowball.ErrCodeInvalidInputCombinationException, aerr.Error())
			case snowball.ErrCodeClusterLimitExceededException:
				fmt.Println(snowball.ErrCodeClusterLimitExceededException, aerr.Error())
			case snowball.ErrCodeEc2RequestFailedException:
				fmt.Println(snowball.ErrCodeEc2RequestFailedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

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

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

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

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

	// 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 (https://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 (https://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 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, Snowball Edges 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.
	//
	// For cluster jobs, AWS Snowball currently supports only the EDGE device type.
	SnowballType SnowballType `type:"string" enum:"true"`

	// The tax documents required in your AWS Region.
	TaxDocuments *TaxDocuments `type:"structure"`
	// contains filtered or unexported fields
}

Contains metadata about a specific cluster.

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), including the ID and name for a Snowball Edge AMI. This AMI is compatible with the device's physical hardware requirements, and it should be able to be run in an SBE1 instance on the device.

func (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
}

func (CreateAddressInput) String 

func (s CreateAddressInput) String() string

String returns the string representation

func (*CreateAddressInput) Validate 

func (s *CreateAddressInput) Validate() error

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

type CreateAddressOutput 

type CreateAddressOutput struct {

	// The automatically generated ID for a specific address. You'll use this ID
	// when you create a job to specify which address you want the Snowball for
	// that job shipped to.
	AddressId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAddressOutput) 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 the request type for the CreateAddress API operation.

func (CreateAddressRequest) Send 

func (r CreateAddressRequest) Send(ctx context.Context) (*CreateAddressResponse, error)

Send marshals and sends the CreateAddress API request.

type CreateAddressResponse added in v0.9.0 

type CreateAddressResponse struct {
	*CreateAddressOutput
	// contains filtered or unexported fields
}

CreateAddressResponse is the response type for the CreateAddress API operation.

func (*CreateAddressResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateAddressResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateAddress 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 (https://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 (https://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, 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.
	//
	//    * 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, Snowball Edges 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.
	//
	// For cluster jobs, AWS Snowball currently supports only the EDGE device type.
	SnowballType SnowballType `type:"string" enum:"true"`

	// The tax documents required in your AWS Region.
	TaxDocuments *TaxDocuments `type:"structure"`
	// contains filtered or unexported fields
}

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
}

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 the request type for the CreateCluster API operation.

func (CreateClusterRequest) Send 

func (r CreateClusterRequest) Send(ctx context.Context) (*CreateClusterResponse, error)

Send marshals and sends the CreateCluster API request.

type CreateClusterResponse added in v0.9.0 

type CreateClusterResponse struct {
	*CreateClusterOutput
	// contains filtered or unexported fields
}

CreateClusterResponse is the response type for the CreateCluster API operation.

func (*CreateClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCluster 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"`

	// Defines the device configuration for an AWS Snowcone job.
	DeviceConfiguration *DeviceConfiguration `type:"structure"`

	// The forwarding address ID for a job. This field is not supported in most
	// regions.
	ForwardingAddressId *string `min:"40" type:"string"`

	// 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 (https://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 (https://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 SnowballCapacity `type:"string" enum:"true"`

	// The type of AWS Snowball device to use for this job.
	//
	// For cluster jobs, AWS Snowball currently supports only the EDGE device type.
	//
	// The type of AWS Snowball device to use for this job. Currently, the only
	// supported device type for cluster jobs is EDGE.
	//
	// For more information, see Snowball Edge Device Options (https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html)
	// in the Snowball Edge Developer Guide.
	SnowballType SnowballType `type:"string" enum:"true"`

	// The tax documents required in your AWS Region.
	TaxDocuments *TaxDocuments `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateJobInput) String 

func (s CreateJobInput) String() string

String returns the string representation

func (*CreateJobInput) Validate 

func (s *CreateJobInput) Validate() error

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

type CreateJobOutput 

type CreateJobOutput struct {

	// The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
	JobId *string `min:"39" type:"string"`
	// contains filtered or unexported fields
}

func (CreateJobOutput) 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 the request type for the CreateJob API operation.

func (CreateJobRequest) Send 

func (r CreateJobRequest) Send(ctx context.Context) (*CreateJobResponse, error)

Send marshals and sends the CreateJob API request.

type CreateJobResponse added in v0.9.0 

type CreateJobResponse struct {
	*CreateJobOutput
	// contains filtered or unexported fields
}

CreateJobResponse is the response type for the CreateJob API operation.

func (*CreateJobResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateJob 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.

func (DataTransfer) String 

func (s DataTransfer) String() string

String returns the string representation

type DescribeAddressInput 

type DescribeAddressInput struct {

	// The automatically generated ID for a specific address.
	//
	// AddressId is a required field
	AddressId *string `min:"40" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAddressInput) String 

func (s DescribeAddressInput) String() string

String returns the string representation

func (*DescribeAddressInput) Validate 

func (s *DescribeAddressInput) Validate() error

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

type DescribeAddressOutput 

type DescribeAddressOutput struct {

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

func (DescribeAddressOutput) 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 the request type for the DescribeAddress API operation.

func (DescribeAddressRequest) Send 

func (r DescribeAddressRequest) Send(ctx context.Context) (*DescribeAddressResponse, error)

Send marshals and sends the DescribeAddress API request.

type DescribeAddressResponse added in v0.9.0 

type DescribeAddressResponse struct {
	*DescribeAddressOutput
	// contains filtered or unexported fields
}

DescribeAddressResponse is the response type for the DescribeAddress API operation.

func (*DescribeAddressResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeAddressResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAddress 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
}

func (DescribeAddressesInput) String 

func (s DescribeAddressesInput) String() string

String returns the string representation

func (*DescribeAddressesInput) Validate 

func (s *DescribeAddressesInput) Validate() error

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

type DescribeAddressesOutput 

type DescribeAddressesOutput struct {

	// The Snowball shipping addresses that were created for this account.
	Addresses []Address `type:"list"`

	// HTTP requests are stateless. If you use the automatically generated NextToken
	// value in your next DescribeAddresses call, your list of returned addresses
	// will start from this point in the array.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAddressesOutput) String 

func (s DescribeAddressesOutput) String() string

String returns the string representation

type DescribeAddressesPaginator added in v0.9.0 

type DescribeAddressesPaginator struct {
	aws.Pager
}

DescribeAddressesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeAddressesPaginator added in v0.9.0 

func NewDescribeAddressesPaginator(req DescribeAddressesRequest) DescribeAddressesPaginator

NewDescribeAddressesRequestPaginator returns a paginator for DescribeAddresses. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeAddressesRequest(input)
p := snowball.NewDescribeAddressesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeAddressesPaginator) CurrentPage added in v0.9.0 

func (p *DescribeAddressesPaginator) CurrentPage() *DescribeAddressesOutput

type DescribeAddressesRequest 

type DescribeAddressesRequest struct {
	*aws.Request
	Input *DescribeAddressesInput
	Copy  func(*DescribeAddressesInput) DescribeAddressesRequest
}

DescribeAddressesRequest is the request type for the DescribeAddresses API operation.

func (DescribeAddressesRequest) Send 

func (r DescribeAddressesRequest) Send(ctx context.Context) (*DescribeAddressesResponse, error)

Send marshals and sends the DescribeAddresses API request.

type DescribeAddressesResponse added in v0.9.0 

type DescribeAddressesResponse struct {
	*DescribeAddressesOutput
	// contains filtered or unexported fields
}

DescribeAddressesResponse is the response type for the DescribeAddresses API operation.

func (*DescribeAddressesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeAddressesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAddresses 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
}

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
}

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 the request type for the DescribeCluster API operation.

func (DescribeClusterRequest) Send 

func (r DescribeClusterRequest) Send(ctx context.Context) (*DescribeClusterResponse, error)

Send marshals and sends the DescribeCluster API request.

type DescribeClusterResponse added in v0.9.0 

type DescribeClusterResponse struct {
	*DescribeClusterOutput
	// contains filtered or unexported fields
}

DescribeClusterResponse is the response type for the DescribeCluster API operation.

func (*DescribeClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCluster 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
}

func (DescribeJobInput) String 

func (s DescribeJobInput) String() string

String returns the string representation

func (*DescribeJobInput) Validate 

func (s *DescribeJobInput) Validate() error

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

type DescribeJobOutput 

type DescribeJobOutput struct {

	// Information about a specific job, including shipping information, job status,
	// and other important metadata.
	JobMetadata *JobMetadata `type:"structure"`

	// Information about a specific job part (in the case of an export job), including
	// shipping information, job status, and other important metadata.
	SubJobMetadata []JobMetadata `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeJobOutput) 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 the request type for the DescribeJob API operation.

func (DescribeJobRequest) Send 

func (r DescribeJobRequest) Send(ctx context.Context) (*DescribeJobResponse, error)

Send marshals and sends the DescribeJob API request.

type DescribeJobResponse added in v0.9.0 

type DescribeJobResponse struct {
	*DescribeJobOutput
	// contains filtered or unexported fields
}

DescribeJobResponse is the response type for the DescribeJob API operation.

func (*DescribeJobResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeJob request.

type DeviceConfiguration added in v0.24.0 

type DeviceConfiguration struct {

	// Returns information about the device configuration for an AWS Snowcone job.
	SnowconeDeviceConfiguration *SnowconeDeviceConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The container for SnowconeDeviceConfiguration.

func (DeviceConfiguration) String added in v0.24.0 

func (s DeviceConfiguration) String() string

String returns the string representation

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 Snowball Edge 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.

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.

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
}

func (GetJobManifestInput) String 

func (s GetJobManifestInput) String() string

String returns the string representation

func (*GetJobManifestInput) Validate 

func (s *GetJobManifestInput) Validate() error

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

type GetJobManifestOutput 

type GetJobManifestOutput struct {

	// The Amazon S3 presigned URL for the manifest file associated with the specified
	// JobId value.
	ManifestURI *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetJobManifestOutput) 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 the request type for the GetJobManifest API operation.

func (GetJobManifestRequest) Send 

func (r GetJobManifestRequest) Send(ctx context.Context) (*GetJobManifestResponse, error)

Send marshals and sends the GetJobManifest API request.

type GetJobManifestResponse added in v0.9.0 

type GetJobManifestResponse struct {
	*GetJobManifestOutput
	// contains filtered or unexported fields
}

GetJobManifestResponse is the response type for the GetJobManifest API operation.

func (*GetJobManifestResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetJobManifestResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetJobManifest 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
}

func (GetJobUnlockCodeInput) String 

func (s GetJobUnlockCodeInput) String() string

String returns the string representation

func (*GetJobUnlockCodeInput) Validate 

func (s *GetJobUnlockCodeInput) Validate() error

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

type GetJobUnlockCodeOutput 

type GetJobUnlockCodeOutput struct {

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

func (GetJobUnlockCodeOutput) 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 the request type for the GetJobUnlockCode API operation.

func (GetJobUnlockCodeRequest) Send 

func (r GetJobUnlockCodeRequest) Send(ctx context.Context) (*GetJobUnlockCodeResponse, error)

Send marshals and sends the GetJobUnlockCode API request.

type GetJobUnlockCodeResponse added in v0.9.0 

type GetJobUnlockCodeResponse struct {
	*GetJobUnlockCodeOutput
	// contains filtered or unexported fields
}

GetJobUnlockCodeResponse is the response type for the GetJobUnlockCode API operation.

func (*GetJobUnlockCodeResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetJobUnlockCodeResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetJobUnlockCode request.

type GetSnowballUsageInput 

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

func (GetSnowballUsageInput) String 

func (s GetSnowballUsageInput) String() string

String returns the string representation

type GetSnowballUsageOutput 

type GetSnowballUsageOutput struct {

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

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

func (GetSnowballUsageOutput) 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 the request type for the GetSnowballUsage API operation.

func (GetSnowballUsageRequest) Send 

func (r GetSnowballUsageRequest) Send(ctx context.Context) (*GetSnowballUsageResponse, error)

Send marshals and sends the GetSnowballUsage API request.

type GetSnowballUsageResponse added in v0.9.0 

type GetSnowballUsageResponse struct {
	*GetSnowballUsageOutput
	// contains filtered or unexported fields
}

GetSnowballUsageResponse is the response type for the GetSnowballUsage API operation.

func (*GetSnowballUsageResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetSnowballUsageResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSnowballUsage request.

type GetSoftwareUpdatesInput added in v0.14.0 

type GetSoftwareUpdatesInput struct {

	// The ID for a job that you want to get the software update file for, for example
	// JID123e4567-e89b-12d3-a456-426655440000.
	//
	// JobId is a required field
	JobId *string `min:"39" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSoftwareUpdatesInput) String added in v0.14.0 

func (s GetSoftwareUpdatesInput) String() string

String returns the string representation

func (*GetSoftwareUpdatesInput) Validate added in v0.14.0 

func (s *GetSoftwareUpdatesInput) Validate() error

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

type GetSoftwareUpdatesOutput added in v0.14.0 

type GetSoftwareUpdatesOutput struct {

	// The Amazon S3 presigned URL for the update file associated with the specified
	// JobId value. The software update will be available for 2 days after this
	// request is made. To access an update after the 2 days have passed, you'll
	// have to make another call to GetSoftwareUpdates.
	UpdatesURI *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetSoftwareUpdatesOutput) String added in v0.14.0 

func (s GetSoftwareUpdatesOutput) String() string

String returns the string representation

type GetSoftwareUpdatesRequest added in v0.14.0 

type GetSoftwareUpdatesRequest struct {
	*aws.Request
	Input *GetSoftwareUpdatesInput
	Copy  func(*GetSoftwareUpdatesInput) GetSoftwareUpdatesRequest
}

GetSoftwareUpdatesRequest is the request type for the GetSoftwareUpdates API operation.

func (GetSoftwareUpdatesRequest) Send added in v0.14.0 

func (r GetSoftwareUpdatesRequest) Send(ctx context.Context) (*GetSoftwareUpdatesResponse, error)

Send marshals and sends the GetSoftwareUpdates API request.

type GetSoftwareUpdatesResponse added in v0.14.0 

type GetSoftwareUpdatesResponse struct {
	*GetSoftwareUpdatesOutput
	// contains filtered or unexported fields
}

GetSoftwareUpdatesResponse is the response type for the GetSoftwareUpdates API operation.

func (*GetSoftwareUpdatesResponse) SDKResponseMetdata added in v0.14.0 

func (r *GetSoftwareUpdatesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSoftwareUpdates request.

type INDTaxDocuments added in v0.20.0 

type INDTaxDocuments struct {

	// The Goods and Services Tax (GST) documents required in AWS Regions in India.
	GSTIN *string `type:"string"`
	// contains filtered or unexported fields
}

The tax documents required in AWS Regions in India.

func (INDTaxDocuments) String added in v0.20.0 

func (s INDTaxDocuments) String() string

String returns the string representation

type JobListEntry 

type JobListEntry struct {

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

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

	// A value that indicates that this job is a 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 SnowballType `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.

func (JobListEntry) String 

func (s JobListEntry) String() string

String returns the string representation

type JobLogs 

type JobLogs struct {

	// A link to an Amazon S3 presigned URL where the job completion report is located.
	JobCompletionReportURI *string `min:"1" type:"string"`

	// A link to an Amazon S3 presigned URL where the job failure log is located.
	JobFailureLogURI *string `min:"1" type:"string"`

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

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

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

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

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

func (JobLogs) String 

func (s JobLogs) String() string

String returns the string representation

type JobMetadata 

type JobMetadata struct {

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

	// The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.
	ClusterId *string `min:"1" type:"string"`

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

	// A value that defines the real-time status of a 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 container for SnowconeDeviceConfiguration.
	DeviceConfiguration *DeviceConfiguration `type:"structure"`

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

	// The 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 (https://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
	// (https://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 SnowballCapacity `type:"string" enum:"true"`

	// The type of device used with this job.
	SnowballType SnowballType `type:"string" enum:"true"`

	// The metadata associated with the tax documents required in your AWS Region.
	TaxDocuments *TaxDocuments `type:"structure"`
	// contains filtered or unexported fields
}

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

func (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.

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 

func (enum JobState) MarshalValue() (string, error)

func (JobState) MarshalValueBuf added in v0.3.0 

func (enum JobState) MarshalValueBuf(b []byte) ([]byte, error)

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 

func (enum JobType) MarshalValue() (string, error)

func (JobType) MarshalValueBuf added in v0.3.0 

func (enum JobType) MarshalValueBuf(b []byte) ([]byte, error)

type KeyRange 

type KeyRange struct {

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

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

Contains a key range. For export jobs, a S3Resource object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

func (KeyRange) String 

func (s KeyRange) String() string

String returns the string representation

func (*KeyRange) Validate 

func (s *KeyRange) Validate() error

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

type 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

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
}

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
}

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 the request type for the ListClusterJobs API operation.

func (ListClusterJobsRequest) Send 

func (r ListClusterJobsRequest) Send(ctx context.Context) (*ListClusterJobsResponse, error)

Send marshals and sends the ListClusterJobs API request.

type ListClusterJobsResponse added in v0.9.0 

type ListClusterJobsResponse struct {
	*ListClusterJobsOutput
	// contains filtered or unexported fields
}

ListClusterJobsResponse is the response type for the ListClusterJobs API operation.

func (*ListClusterJobsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListClusterJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListClusterJobs 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
}

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
}

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 the request type for the ListClusters API operation.

func (ListClustersRequest) Send 

func (r ListClustersRequest) Send(ctx context.Context) (*ListClustersResponse, error)

Send marshals and sends the ListClusters API request.

type ListClustersResponse added in v0.9.0 

type ListClustersResponse struct {
	*ListClustersOutput
	// contains filtered or unexported fields
}

ListClustersResponse is the response type for the ListClusters API operation.

func (*ListClustersResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListClustersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListClusters request.

type ListCompatibleImagesInput added in v0.5.0 

type ListCompatibleImagesInput struct {

	// The maximum number of results for the list of compatible images. Currently,
	// a Snowball Edge device can store 10 AMIs.
	MaxResults *int64 `type:"integer"`

	// HTTP requests are stateless. To identify what object comes "next" in the
	// list of compatible images, you can specify a value for NextToken as the starting
	// point for your list of returned images.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (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, including the ID
	// and name for a Snowball Edge AMI.
	CompatibleImages []CompatibleImage `type:"list"`

	// Because HTTP requests are stateless, this is the starting point for your
	// next list of returned images.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (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 the request type for the ListCompatibleImages API operation.

func (ListCompatibleImagesRequest) Send added in v0.5.0 

func (r ListCompatibleImagesRequest) Send(ctx context.Context) (*ListCompatibleImagesResponse, error)

Send marshals and sends the ListCompatibleImages API request.

type ListCompatibleImagesResponse added in v0.9.0 

type ListCompatibleImagesResponse struct {
	*ListCompatibleImagesOutput
	// contains filtered or unexported fields
}

ListCompatibleImagesResponse is the response type for the ListCompatibleImages API operation.

func (*ListCompatibleImagesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListCompatibleImagesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListCompatibleImages 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
}

func (ListJobsInput) String 

func (s ListJobsInput) String() string

String returns the string representation

func (*ListJobsInput) Validate 

func (s *ListJobsInput) Validate() error

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

type ListJobsOutput 

type ListJobsOutput struct {

	// Each JobListEntry object contains a job's state, a job's ID, and a value
	// that indicates whether the job is a job part, in the case of export jobs.
	JobListEntries []JobListEntry `type:"list"`

	// HTTP requests are stateless. If you use this automatically generated NextToken
	// value in your next ListJobs call, your returned JobListEntry objects will
	// start from this point in the array.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListJobsOutput) String 

func (s ListJobsOutput) String() string

String returns the string representation

type ListJobsPaginator added in v0.9.0 

type ListJobsPaginator struct {
	aws.Pager
}

ListJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListJobsPaginator added in v0.9.0 

func NewListJobsPaginator(req ListJobsRequest) ListJobsPaginator

NewListJobsRequestPaginator returns a paginator for ListJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListJobsRequest(input)
p := snowball.NewListJobsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListJobsPaginator) CurrentPage added in v0.9.0 

func (p *ListJobsPaginator) CurrentPage() *ListJobsOutput

type ListJobsRequest 

type ListJobsRequest struct {
	*aws.Request
	Input *ListJobsInput
	Copy  func(*ListJobsInput) ListJobsRequest
}

ListJobsRequest is the request type for the ListJobs API operation.

func (ListJobsRequest) Send 

func (r ListJobsRequest) Send(ctx context.Context) (*ListJobsResponse, error)

Send marshals and sends the ListJobs API request.

type ListJobsResponse added in v0.9.0 

type ListJobsResponse struct {
	*ListJobsOutput
	// contains filtered or unexported fields
}

ListJobsResponse is the response type for the ListJobs API operation.

func (*ListJobsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListJobs 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 (https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html)
	// Amazon SNS API action.
	//
	// You can subscribe email addresses to an Amazon SNS topic through the AWS
	// Management Console, or by using the Subscribe (https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)
	// AWS Simple Notification Service (SNS) API action.
	SnsTopicARN *string `type:"string"`
	// contains filtered or unexported fields
}

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

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

func (Notification) String 

func (s Notification) String() string

String returns the string representation

type S3Resource 

type S3Resource struct {

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

	// For export jobs, you can provide an optional KeyRange within a specific Amazon
	// S3 bucket. The length of the range is defined at job creation, and has either
	// an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8
	// binary sorted.
	KeyRange *KeyRange `type:"structure"`
	// contains filtered or unexported fields
}

Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

func (S3Resource) 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.

func (Shipment) String 

func (s Shipment) String() string

String returns the string representation

type ShippingDetails 

type ShippingDetails struct {

	// The Status and TrackingNumber values for a Snowball being 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.

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 SnowballCapacity added in v0.9.0 

type SnowballCapacity string
const (
	SnowballCapacityT50          SnowballCapacity = "T50"
	SnowballCapacityT80          SnowballCapacity = "T80"
	SnowballCapacityT100         SnowballCapacity = "T100"
	SnowballCapacityT42          SnowballCapacity = "T42"
	SnowballCapacityT98          SnowballCapacity = "T98"
	SnowballCapacityT8           SnowballCapacity = "T8"
	SnowballCapacityNoPreference SnowballCapacity = "NoPreference"
)

Enum values for SnowballCapacity

func (SnowballCapacity) MarshalValue added in v0.9.0 

func (enum SnowballCapacity) MarshalValue() (string, error)

func (SnowballCapacity) MarshalValueBuf added in v0.9.0 

func (enum SnowballCapacity) MarshalValueBuf(b []byte) ([]byte, error)

type SnowballType added in v0.9.0 

type SnowballType string
const (
	SnowballTypeStandard SnowballType = "STANDARD"
	SnowballTypeEdge     SnowballType = "EDGE"
	SnowballTypeEdgeC    SnowballType = "EDGE_C"
	SnowballTypeEdgeCg   SnowballType = "EDGE_CG"
	SnowballTypeEdgeS    SnowballType = "EDGE_S"
	SnowballTypeSnc1Hdd  SnowballType = "SNC1_HDD"
)

Enum values for SnowballType

func (SnowballType) MarshalValue added in v0.9.0 

func (enum SnowballType) MarshalValue() (string, error)

func (SnowballType) MarshalValueBuf added in v0.9.0 

func (enum SnowballType) MarshalValueBuf(b []byte) ([]byte, error)

type SnowconeDeviceConfiguration added in v0.24.0 

type SnowconeDeviceConfiguration struct {

	// Configures the wireless connection for the AWS Snowcone device.
	WirelessConnection *WirelessConnection `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the device configuration for an AWS Snowcone job.

func (SnowconeDeviceConfiguration) String added in v0.24.0 

func (s SnowconeDeviceConfiguration) String() string

String returns the string representation

type TaxDocuments added in v0.20.0 

type TaxDocuments struct {

	// The tax documents required in AWS Regions in India.
	IND *INDTaxDocuments `type:"structure"`
	// contains filtered or unexported fields
}

The tax documents required in your AWS Region.

func (TaxDocuments) String added in v0.20.0 

func (s TaxDocuments) String() string

String returns the string representation

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 (https://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
}

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
}

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 the request type for the UpdateCluster API operation.

func (UpdateClusterRequest) Send 

func (r UpdateClusterRequest) Send(ctx context.Context) (*UpdateClusterResponse, error)

Send marshals and sends the UpdateCluster API request.

type UpdateClusterResponse added in v0.9.0 

type UpdateClusterResponse struct {
	*UpdateClusterOutput
	// contains filtered or unexported fields
}

UpdateClusterResponse is the response type for the UpdateCluster API operation.

func (*UpdateClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateCluster 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 (https://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 SnowballCapacity `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateJobInput) String 

func (s UpdateJobInput) String() string

String returns the string representation

func (*UpdateJobInput) Validate 

func (s *UpdateJobInput) Validate() error

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

type UpdateJobOutput 

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

func (UpdateJobOutput) 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 the request type for the UpdateJob API operation.

func (UpdateJobRequest) Send 

func (r UpdateJobRequest) Send(ctx context.Context) (*UpdateJobResponse, error)

Send marshals and sends the UpdateJob API request.

type UpdateJobResponse added in v0.9.0 

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

UpdateJobResponse is the response type for the UpdateJob API operation.

func (*UpdateJobResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateJob request.

type WirelessConnection added in v0.24.0 

type WirelessConnection struct {

	// Enables the Wi-Fi adapter on an AWS Snowcone device.
	IsWifiEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Configures the wireless connection on an AWS Snowcone device.

func (WirelessConnection) String added in v0.24.0 

func (s WirelessConnection) String() string

String returns the string representation

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

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