storagegateway

package
v1.14.11 Latest Latest
Warning

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

 Go to latest Published: Jun 21, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package storagegateway provides the client and types for making API requests to AWS Storage Gateway.

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.

Use the following links to get started using the AWS Storage Gateway Service API Reference:

AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs (https://aws.amazon.com/ec2/faqs/#longer-ids). 

For example, a volume Amazon Resource Name (ARN) with the longer volume

ID format looks like the following:

arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.

For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016 (https://forums.aws.amazon.com/ann.jspa?annID=3557).

See https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30 for more information on this service.

See storagegateway package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/storagegateway/

Using the Client

To contact AWS Storage Gateway 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 AWS Storage Gateway client StorageGateway for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/storagegateway/#New

Index

Examples

Constants

View Source 
const (
	// ErrorCodeActivationKeyExpired is a ErrorCode enum value
	ErrorCodeActivationKeyExpired = "ActivationKeyExpired"

	// ErrorCodeActivationKeyInvalid is a ErrorCode enum value
	ErrorCodeActivationKeyInvalid = "ActivationKeyInvalid"

	// ErrorCodeActivationKeyNotFound is a ErrorCode enum value
	ErrorCodeActivationKeyNotFound = "ActivationKeyNotFound"

	// ErrorCodeGatewayInternalError is a ErrorCode enum value
	ErrorCodeGatewayInternalError = "GatewayInternalError"

	// ErrorCodeGatewayNotConnected is a ErrorCode enum value
	ErrorCodeGatewayNotConnected = "GatewayNotConnected"

	// ErrorCodeGatewayNotFound is a ErrorCode enum value
	ErrorCodeGatewayNotFound = "GatewayNotFound"

	// ErrorCodeGatewayProxyNetworkConnectionBusy is a ErrorCode enum value
	ErrorCodeGatewayProxyNetworkConnectionBusy = "GatewayProxyNetworkConnectionBusy"

	// ErrorCodeAuthenticationFailure is a ErrorCode enum value
	ErrorCodeAuthenticationFailure = "AuthenticationFailure"

	// ErrorCodeBandwidthThrottleScheduleNotFound is a ErrorCode enum value
	ErrorCodeBandwidthThrottleScheduleNotFound = "BandwidthThrottleScheduleNotFound"

	// ErrorCodeBlocked is a ErrorCode enum value
	ErrorCodeBlocked = "Blocked"

	// ErrorCodeCannotExportSnapshot is a ErrorCode enum value
	ErrorCodeCannotExportSnapshot = "CannotExportSnapshot"

	// ErrorCodeChapCredentialNotFound is a ErrorCode enum value
	ErrorCodeChapCredentialNotFound = "ChapCredentialNotFound"

	// ErrorCodeDiskAlreadyAllocated is a ErrorCode enum value
	ErrorCodeDiskAlreadyAllocated = "DiskAlreadyAllocated"

	// ErrorCodeDiskDoesNotExist is a ErrorCode enum value
	ErrorCodeDiskDoesNotExist = "DiskDoesNotExist"

	// ErrorCodeDiskSizeGreaterThanVolumeMaxSize is a ErrorCode enum value
	ErrorCodeDiskSizeGreaterThanVolumeMaxSize = "DiskSizeGreaterThanVolumeMaxSize"

	// ErrorCodeDiskSizeLessThanVolumeSize is a ErrorCode enum value
	ErrorCodeDiskSizeLessThanVolumeSize = "DiskSizeLessThanVolumeSize"

	// ErrorCodeDiskSizeNotGigAligned is a ErrorCode enum value
	ErrorCodeDiskSizeNotGigAligned = "DiskSizeNotGigAligned"

	// ErrorCodeDuplicateCertificateInfo is a ErrorCode enum value
	ErrorCodeDuplicateCertificateInfo = "DuplicateCertificateInfo"

	// ErrorCodeDuplicateSchedule is a ErrorCode enum value
	ErrorCodeDuplicateSchedule = "DuplicateSchedule"

	// ErrorCodeEndpointNotFound is a ErrorCode enum value
	ErrorCodeEndpointNotFound = "EndpointNotFound"

	// ErrorCodeIamnotSupported is a ErrorCode enum value
	ErrorCodeIamnotSupported = "IAMNotSupported"

	// ErrorCodeInitiatorInvalid is a ErrorCode enum value
	ErrorCodeInitiatorInvalid = "InitiatorInvalid"

	// ErrorCodeInitiatorNotFound is a ErrorCode enum value
	ErrorCodeInitiatorNotFound = "InitiatorNotFound"

	// ErrorCodeInternalError is a ErrorCode enum value
	ErrorCodeInternalError = "InternalError"

	// ErrorCodeInvalidGateway is a ErrorCode enum value
	ErrorCodeInvalidGateway = "InvalidGateway"

	// ErrorCodeInvalidEndpoint is a ErrorCode enum value
	ErrorCodeInvalidEndpoint = "InvalidEndpoint"

	// ErrorCodeInvalidParameters is a ErrorCode enum value
	ErrorCodeInvalidParameters = "InvalidParameters"

	// ErrorCodeInvalidSchedule is a ErrorCode enum value
	ErrorCodeInvalidSchedule = "InvalidSchedule"

	// ErrorCodeLocalStorageLimitExceeded is a ErrorCode enum value
	ErrorCodeLocalStorageLimitExceeded = "LocalStorageLimitExceeded"

	// ErrorCodeLunAlreadyAllocated is a ErrorCode enum value
	ErrorCodeLunAlreadyAllocated = "LunAlreadyAllocated "

	// ErrorCodeLunInvalid is a ErrorCode enum value
	ErrorCodeLunInvalid = "LunInvalid"

	// ErrorCodeMaximumContentLengthExceeded is a ErrorCode enum value
	ErrorCodeMaximumContentLengthExceeded = "MaximumContentLengthExceeded"

	// ErrorCodeMaximumTapeCartridgeCountExceeded is a ErrorCode enum value
	ErrorCodeMaximumTapeCartridgeCountExceeded = "MaximumTapeCartridgeCountExceeded"

	// ErrorCodeMaximumVolumeCountExceeded is a ErrorCode enum value
	ErrorCodeMaximumVolumeCountExceeded = "MaximumVolumeCountExceeded"

	// ErrorCodeNetworkConfigurationChanged is a ErrorCode enum value
	ErrorCodeNetworkConfigurationChanged = "NetworkConfigurationChanged"

	// ErrorCodeNoDisksAvailable is a ErrorCode enum value
	ErrorCodeNoDisksAvailable = "NoDisksAvailable"

	// ErrorCodeNotImplemented is a ErrorCode enum value
	ErrorCodeNotImplemented = "NotImplemented"

	// ErrorCodeNotSupported is a ErrorCode enum value
	ErrorCodeNotSupported = "NotSupported"

	// ErrorCodeOperationAborted is a ErrorCode enum value
	ErrorCodeOperationAborted = "OperationAborted"

	// ErrorCodeOutdatedGateway is a ErrorCode enum value
	ErrorCodeOutdatedGateway = "OutdatedGateway"

	// ErrorCodeParametersNotImplemented is a ErrorCode enum value
	ErrorCodeParametersNotImplemented = "ParametersNotImplemented"

	// ErrorCodeRegionInvalid is a ErrorCode enum value
	ErrorCodeRegionInvalid = "RegionInvalid"

	// ErrorCodeRequestTimeout is a ErrorCode enum value
	ErrorCodeRequestTimeout = "RequestTimeout"

	// ErrorCodeServiceUnavailable is a ErrorCode enum value
	ErrorCodeServiceUnavailable = "ServiceUnavailable"

	// ErrorCodeSnapshotDeleted is a ErrorCode enum value
	ErrorCodeSnapshotDeleted = "SnapshotDeleted"

	// ErrorCodeSnapshotIdInvalid is a ErrorCode enum value
	ErrorCodeSnapshotIdInvalid = "SnapshotIdInvalid"

	// ErrorCodeSnapshotInProgress is a ErrorCode enum value
	ErrorCodeSnapshotInProgress = "SnapshotInProgress"

	// ErrorCodeSnapshotNotFound is a ErrorCode enum value
	ErrorCodeSnapshotNotFound = "SnapshotNotFound"

	// ErrorCodeSnapshotScheduleNotFound is a ErrorCode enum value
	ErrorCodeSnapshotScheduleNotFound = "SnapshotScheduleNotFound"

	// ErrorCodeStagingAreaFull is a ErrorCode enum value
	ErrorCodeStagingAreaFull = "StagingAreaFull"

	// ErrorCodeStorageFailure is a ErrorCode enum value
	ErrorCodeStorageFailure = "StorageFailure"

	// ErrorCodeTapeCartridgeNotFound is a ErrorCode enum value
	ErrorCodeTapeCartridgeNotFound = "TapeCartridgeNotFound"

	// ErrorCodeTargetAlreadyExists is a ErrorCode enum value
	ErrorCodeTargetAlreadyExists = "TargetAlreadyExists"

	// ErrorCodeTargetInvalid is a ErrorCode enum value
	ErrorCodeTargetInvalid = "TargetInvalid"

	// ErrorCodeTargetNotFound is a ErrorCode enum value
	ErrorCodeTargetNotFound = "TargetNotFound"

	// ErrorCodeUnauthorizedOperation is a ErrorCode enum value
	ErrorCodeUnauthorizedOperation = "UnauthorizedOperation"

	// ErrorCodeVolumeAlreadyExists is a ErrorCode enum value
	ErrorCodeVolumeAlreadyExists = "VolumeAlreadyExists"

	// ErrorCodeVolumeIdInvalid is a ErrorCode enum value
	ErrorCodeVolumeIdInvalid = "VolumeIdInvalid"

	// ErrorCodeVolumeInUse is a ErrorCode enum value
	ErrorCodeVolumeInUse = "VolumeInUse"

	// ErrorCodeVolumeNotFound is a ErrorCode enum value
	ErrorCodeVolumeNotFound = "VolumeNotFound"

	// ErrorCodeVolumeNotReady is a ErrorCode enum value
	ErrorCodeVolumeNotReady = "VolumeNotReady"
)
View Source 
const (
	// ObjectACLPrivate is a ObjectACL enum value
	ObjectACLPrivate = "private"

	// ObjectACLPublicRead is a ObjectACL enum value
	ObjectACLPublicRead = "public-read"

	// ObjectACLPublicReadWrite is a ObjectACL enum value
	ObjectACLPublicReadWrite = "public-read-write"

	// ObjectACLAuthenticatedRead is a ObjectACL enum value
	ObjectACLAuthenticatedRead = "authenticated-read"

	// ObjectACLBucketOwnerRead is a ObjectACL enum value
	ObjectACLBucketOwnerRead = "bucket-owner-read"

	// ObjectACLBucketOwnerFullControl is a ObjectACL enum value
	ObjectACLBucketOwnerFullControl = "bucket-owner-full-control"

	// ObjectACLAwsExecRead is a ObjectACL enum value
	ObjectACLAwsExecRead = "aws-exec-read"
)

Sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

View Source 
const (

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// An internal server error has occurred during the request. For more information,
	// see the error and message fields.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeInvalidGatewayRequestException for service response error code
	// "InvalidGatewayRequestException".
	//
	// An exception occurred because an invalid gateway request was issued to the
	// service. For more information, see the error and message fields.
	ErrCodeInvalidGatewayRequestException = "InvalidGatewayRequestException"

	// ErrCodeServiceUnavailableError for service response error code
	// "ServiceUnavailableError".
	//
	// An internal server error has occurred because the service is unavailable.
	// For more information, see the error and message fields.
	ErrCodeServiceUnavailableError = "ServiceUnavailableError"
)
View Source 
const (
	ServiceName = "storagegateway"  // Name of service.
	EndpointsID = ServiceName       // ID to lookup a service endpoint with.
	ServiceID   = "Storage Gateway" // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateGatewayInput 

type ActivateGatewayInput struct {

	// Your gateway activation key. You can obtain the activation key by sending
	// an HTTP GET request with redirects enabled to the gateway IP address (port
	// 80). The redirect URL returned in the response provides you the activation
	// key for your gateway in the query string parameter activationKey. It may
	// also include other activation-related parameters, however, these are merely
	// defaults -- the arguments you pass to the ActivateGateway API call determine
	// the actual configuration of your gateway.
	//
	// For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html
	// in the Storage Gateway User Guide.
	//
	// ActivationKey is a required field
	ActivationKey *string `min:"1" type:"string" required:"true"`

	// The name you configured for your gateway.
	//
	// GatewayName is a required field
	GatewayName *string `min:"2" type:"string" required:"true"`

	// A value that indicates the region where you want to store your data. The
	// gateway region specified must be the same region as the region in your Host
	// header in the request. For more information about available regions and endpoints
	// for AWS Storage Gateway, see Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region)
	// in the Amazon Web Services Glossary.
	//
	// Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1",
	// "eu-west-1", "eu-central-1", "eu-west-2", "eu-west-3", "ap-northeast-1",
	// "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"
	//
	// GatewayRegion is a required field
	GatewayRegion *string `min:"1" type:"string" required:"true"`

	// A value that indicates the time zone you want to set for the gateway. The
	// time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00
	// indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is
	// 2 hours ahead of GMT. The time zone is used, for example, for scheduling
	// snapshots and your gateway's maintenance schedule.
	//
	// GatewayTimezone is a required field
	GatewayTimezone *string `min:"3" type:"string" required:"true"`

	// A value that defines the type of gateway to activate. The type specified
	// is critical to all later functions of the gateway and cannot be changed after
	// activation. The default value is STORED.
	//
	// Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
	GatewayType *string `min:"2" type:"string"`

	// The value that indicates the type of medium changer to use for tape gateway.
	// This field is optional.
	//
	// Valid Values: "STK-L700", "AWS-Gateway-VTL"
	MediumChangerType *string `min:"2" type:"string"`

	// The value that indicates the type of tape drive to use for tape gateway.
	// This field is optional.
	//
	// Valid Values: "IBM-ULT3580-TD5"
	TapeDriveType *string `min:"2" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing one or more of the following fields:

  • ActivateGatewayInput$ActivationKey

  • ActivateGatewayInput$GatewayName

  • ActivateGatewayInput$GatewayRegion

  • ActivateGatewayInput$GatewayTimezone

  • ActivateGatewayInput$GatewayType

  • ActivateGatewayInput$TapeDriveType

  • ActivateGatewayInput$MediumChangerType

func (ActivateGatewayInput) GoString added in v0.6.5 

func (s ActivateGatewayInput) GoString() string

GoString returns the string representation

func (*ActivateGatewayInput) SetActivationKey added in v1.5.0 

func (s *ActivateGatewayInput) SetActivationKey(v string) *ActivateGatewayInput

SetActivationKey sets the ActivationKey field's value.

func (*ActivateGatewayInput) SetGatewayName added in v1.5.0 

func (s *ActivateGatewayInput) SetGatewayName(v string) *ActivateGatewayInput

SetGatewayName sets the GatewayName field's value.

func (*ActivateGatewayInput) SetGatewayRegion added in v1.5.0 

func (s *ActivateGatewayInput) SetGatewayRegion(v string) *ActivateGatewayInput

SetGatewayRegion sets the GatewayRegion field's value.

func (*ActivateGatewayInput) SetGatewayTimezone added in v1.5.0 

func (s *ActivateGatewayInput) SetGatewayTimezone(v string) *ActivateGatewayInput

SetGatewayTimezone sets the GatewayTimezone field's value.

func (*ActivateGatewayInput) SetGatewayType added in v1.5.0 

func (s *ActivateGatewayInput) SetGatewayType(v string) *ActivateGatewayInput

SetGatewayType sets the GatewayType field's value.

func (*ActivateGatewayInput) SetMediumChangerType added in v1.5.0 

func (s *ActivateGatewayInput) SetMediumChangerType(v string) *ActivateGatewayInput

SetMediumChangerType sets the MediumChangerType field's value.

func (*ActivateGatewayInput) SetTapeDriveType added in v1.5.0 

func (s *ActivateGatewayInput) SetTapeDriveType(v string) *ActivateGatewayInput

SetTapeDriveType sets the TapeDriveType field's value.

func (ActivateGatewayInput) String added in v0.6.5 

func (s ActivateGatewayInput) String() string

String returns the string representation

func (*ActivateGatewayInput) Validate added in v1.1.21 

func (s *ActivateGatewayInput) Validate() error

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

type ActivateGatewayOutput 

type ActivateGatewayOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.

For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.

func (ActivateGatewayOutput) GoString added in v0.6.5 

func (s ActivateGatewayOutput) GoString() string

GoString returns the string representation

func (*ActivateGatewayOutput) SetGatewayARN added in v1.5.0 

func (s *ActivateGatewayOutput) SetGatewayARN(v string) *ActivateGatewayOutput

SetGatewayARN sets the GatewayARN field's value.

func (ActivateGatewayOutput) String added in v0.6.5 

func (s ActivateGatewayOutput) String() string

String returns the string representation

type AddCacheInput 

type AddCacheInput struct {

	// DiskIds is a required field
	DiskIds []*string `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddCacheInput) GoString added in v0.6.5 

func (s AddCacheInput) GoString() string

GoString returns the string representation

func (*AddCacheInput) SetDiskIds added in v1.5.0 

func (s *AddCacheInput) SetDiskIds(v []*string) *AddCacheInput

SetDiskIds sets the DiskIds field's value.

func (*AddCacheInput) SetGatewayARN added in v1.5.0 

func (s *AddCacheInput) SetGatewayARN(v string) *AddCacheInput

SetGatewayARN sets the GatewayARN field's value.

func (AddCacheInput) String added in v0.6.5 

func (s AddCacheInput) String() string

String returns the string representation

func (*AddCacheInput) Validate added in v1.1.21 

func (s *AddCacheInput) Validate() error

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

type AddCacheOutput 

type AddCacheOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (AddCacheOutput) GoString added in v0.6.5 

func (s AddCacheOutput) GoString() string

GoString returns the string representation

func (*AddCacheOutput) SetGatewayARN added in v1.5.0 

func (s *AddCacheOutput) SetGatewayARN(v string) *AddCacheOutput

SetGatewayARN sets the GatewayARN field's value.

func (AddCacheOutput) String added in v0.6.5 

func (s AddCacheOutput) String() string

String returns the string representation

type AddTagsToResourceInput added in v0.9.5 

type AddTagsToResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource you want to add tags to.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"50" type:"string" required:"true"`

	// The key-value pair that represents the tag you want to add to the resource.
	// The value can be an empty string.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

AddTagsToResourceInput

func (AddTagsToResourceInput) GoString added in v0.9.5 

func (s AddTagsToResourceInput) GoString() string

GoString returns the string representation

func (*AddTagsToResourceInput) SetResourceARN added in v1.5.0 

func (s *AddTagsToResourceInput) SetResourceARN(v string) *AddTagsToResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*AddTagsToResourceInput) SetTags added in v1.5.0 

func (s *AddTagsToResourceInput) SetTags(v []*Tag) *AddTagsToResourceInput

SetTags sets the Tags field's value.

func (AddTagsToResourceInput) String added in v0.9.5 

func (s AddTagsToResourceInput) String() string

String returns the string representation

func (*AddTagsToResourceInput) Validate added in v1.1.21 

func (s *AddTagsToResourceInput) Validate() error

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

type AddTagsToResourceOutput added in v0.9.5 

type AddTagsToResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resource you want to add tags to.
	ResourceARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

AddTagsToResourceOutput

func (AddTagsToResourceOutput) GoString added in v0.9.5 

func (s AddTagsToResourceOutput) GoString() string

GoString returns the string representation

func (*AddTagsToResourceOutput) SetResourceARN added in v1.5.0 

func (s *AddTagsToResourceOutput) SetResourceARN(v string) *AddTagsToResourceOutput

SetResourceARN sets the ResourceARN field's value.

func (AddTagsToResourceOutput) String added in v0.9.5 

func (s AddTagsToResourceOutput) String() string

String returns the string representation

type AddUploadBufferInput 

type AddUploadBufferInput struct {

	// DiskIds is a required field
	DiskIds []*string `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddUploadBufferInput) GoString added in v0.6.5 

func (s AddUploadBufferInput) GoString() string

GoString returns the string representation

func (*AddUploadBufferInput) SetDiskIds added in v1.5.0 

func (s *AddUploadBufferInput) SetDiskIds(v []*string) *AddUploadBufferInput

SetDiskIds sets the DiskIds field's value.

func (*AddUploadBufferInput) SetGatewayARN added in v1.5.0 

func (s *AddUploadBufferInput) SetGatewayARN(v string) *AddUploadBufferInput

SetGatewayARN sets the GatewayARN field's value.

func (AddUploadBufferInput) String added in v0.6.5 

func (s AddUploadBufferInput) String() string

String returns the string representation

func (*AddUploadBufferInput) Validate added in v1.1.21 

func (s *AddUploadBufferInput) Validate() error

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

type AddUploadBufferOutput 

type AddUploadBufferOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (AddUploadBufferOutput) GoString added in v0.6.5 

func (s AddUploadBufferOutput) GoString() string

GoString returns the string representation

func (*AddUploadBufferOutput) SetGatewayARN added in v1.5.0 

func (s *AddUploadBufferOutput) SetGatewayARN(v string) *AddUploadBufferOutput

SetGatewayARN sets the GatewayARN field's value.

func (AddUploadBufferOutput) String added in v0.6.5 

func (s AddUploadBufferOutput) String() string

String returns the string representation

type AddWorkingStorageInput 

type AddWorkingStorageInput struct {

	// An array of strings that identify disks that are to be configured as working
	// storage. Each string have a minimum length of 1 and maximum length of 300.
	// You can get the disk IDs from the ListLocalDisks API.
	//
	// DiskIds is a required field
	DiskIds []*string `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing one or more of the following fields:

  • AddWorkingStorageInput$DiskIds

func (AddWorkingStorageInput) GoString added in v0.6.5 

func (s AddWorkingStorageInput) GoString() string

GoString returns the string representation

func (*AddWorkingStorageInput) SetDiskIds added in v1.5.0 

func (s *AddWorkingStorageInput) SetDiskIds(v []*string) *AddWorkingStorageInput

SetDiskIds sets the DiskIds field's value.

func (*AddWorkingStorageInput) SetGatewayARN added in v1.5.0 

func (s *AddWorkingStorageInput) SetGatewayARN(v string) *AddWorkingStorageInput

SetGatewayARN sets the GatewayARN field's value.

func (AddWorkingStorageInput) String added in v0.6.5 

func (s AddWorkingStorageInput) String() string

String returns the string representation

func (*AddWorkingStorageInput) Validate added in v1.1.21 

func (s *AddWorkingStorageInput) Validate() error

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

type AddWorkingStorageOutput 

type AddWorkingStorageOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway for which working storage was configured.

func (AddWorkingStorageOutput) GoString added in v0.6.5 

func (s AddWorkingStorageOutput) GoString() string

GoString returns the string representation

func (*AddWorkingStorageOutput) SetGatewayARN added in v1.5.0 

func (s *AddWorkingStorageOutput) SetGatewayARN(v string) *AddWorkingStorageOutput

SetGatewayARN sets the GatewayARN field's value.

func (AddWorkingStorageOutput) String added in v0.6.5 

func (s AddWorkingStorageOutput) String() string

String returns the string representation

type CachediSCSIVolume 

type CachediSCSIVolume struct {

	// The date the volume was created. Volumes created prior to March 28, 2017
	// don’t have this time stamp.
	CreatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side
	// encryption. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"20" type:"string"`

	// If the cached volume was created from a snapshot, this field contains the
	// snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
	SourceSnapshotId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the storage volume.
	VolumeARN *string `min:"50" type:"string"`

	// The unique identifier of the volume, e.g. vol-AE4B946D.
	VolumeId *string `min:"12" type:"string"`

	// Represents the percentage complete if the volume is restoring or bootstrapping
	// that represents the percent of data transferred. This field does not appear
	// in the response if the cached volume is not restoring or bootstrapping.
	VolumeProgress *float64 `type:"double"`

	// The size, in bytes, of the volume capacity.
	VolumeSizeInBytes *int64 `type:"long"`

	// One of the VolumeStatus values that indicates the state of the storage volume.
	VolumeStatus *string `min:"3" type:"string"`

	// One of the VolumeType enumeration values that describes the type of the volume.
	VolumeType *string `min:"3" type:"string"`

	// The size of the data stored on the volume in bytes.
	//
	// This value is not available for volumes created prior to May 13, 2015, until
	// you store data on the volume.
	VolumeUsedInBytes *int64 `type:"long"`

	// An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes
	// for one stored volume.
	VolumeiSCSIAttributes *VolumeiSCSIAttributes `type:"structure"`
	// contains filtered or unexported fields
}

Describes an iSCSI cached volume.

func (CachediSCSIVolume) GoString added in v0.6.5 

func (s CachediSCSIVolume) GoString() string

GoString returns the string representation

func (*CachediSCSIVolume) SetCreatedDate added in v1.6.6 

func (s *CachediSCSIVolume) SetCreatedDate(v time.Time) *CachediSCSIVolume

SetCreatedDate sets the CreatedDate field's value.

func (*CachediSCSIVolume) SetKMSKey added in v1.14.4 

func (s *CachediSCSIVolume) SetKMSKey(v string) *CachediSCSIVolume

SetKMSKey sets the KMSKey field's value.

func (*CachediSCSIVolume) SetSourceSnapshotId added in v1.5.0 

func (s *CachediSCSIVolume) SetSourceSnapshotId(v string) *CachediSCSIVolume

SetSourceSnapshotId sets the SourceSnapshotId field's value.

func (*CachediSCSIVolume) SetVolumeARN added in v1.5.0 

func (s *CachediSCSIVolume) SetVolumeARN(v string) *CachediSCSIVolume

SetVolumeARN sets the VolumeARN field's value.

func (*CachediSCSIVolume) SetVolumeId added in v1.5.0 

func (s *CachediSCSIVolume) SetVolumeId(v string) *CachediSCSIVolume

SetVolumeId sets the VolumeId field's value.

func (*CachediSCSIVolume) SetVolumeProgress added in v1.5.0 

func (s *CachediSCSIVolume) SetVolumeProgress(v float64) *CachediSCSIVolume

SetVolumeProgress sets the VolumeProgress field's value.

func (*CachediSCSIVolume) SetVolumeSizeInBytes added in v1.5.0 

func (s *CachediSCSIVolume) SetVolumeSizeInBytes(v int64) *CachediSCSIVolume

SetVolumeSizeInBytes sets the VolumeSizeInBytes field's value.

func (*CachediSCSIVolume) SetVolumeStatus added in v1.5.0 

func (s *CachediSCSIVolume) SetVolumeStatus(v string) *CachediSCSIVolume

SetVolumeStatus sets the VolumeStatus field's value.

func (*CachediSCSIVolume) SetVolumeType added in v1.5.0 

func (s *CachediSCSIVolume) SetVolumeType(v string) *CachediSCSIVolume

SetVolumeType sets the VolumeType field's value.

func (*CachediSCSIVolume) SetVolumeUsedInBytes added in v1.12.32 

func (s *CachediSCSIVolume) SetVolumeUsedInBytes(v int64) *CachediSCSIVolume

SetVolumeUsedInBytes sets the VolumeUsedInBytes field's value.

func (*CachediSCSIVolume) SetVolumeiSCSIAttributes added in v1.5.0 

func (s *CachediSCSIVolume) SetVolumeiSCSIAttributes(v *VolumeiSCSIAttributes) *CachediSCSIVolume

SetVolumeiSCSIAttributes sets the VolumeiSCSIAttributes field's value.

func (CachediSCSIVolume) String added in v0.6.5 

func (s CachediSCSIVolume) String() string

String returns the string representation

type CancelArchivalInput 

type CancelArchivalInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving
	// for.
	//
	// TapeARN is a required field
	TapeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

CancelArchivalInput

func (CancelArchivalInput) GoString added in v0.6.5 

func (s CancelArchivalInput) GoString() string

GoString returns the string representation

func (*CancelArchivalInput) SetGatewayARN added in v1.5.0 

func (s *CancelArchivalInput) SetGatewayARN(v string) *CancelArchivalInput

SetGatewayARN sets the GatewayARN field's value.

func (*CancelArchivalInput) SetTapeARN added in v1.5.0 

func (s *CancelArchivalInput) SetTapeARN(v string) *CancelArchivalInput

SetTapeARN sets the TapeARN field's value.

func (CancelArchivalInput) String added in v0.6.5 

func (s CancelArchivalInput) String() string

String returns the string representation

func (*CancelArchivalInput) Validate added in v1.1.21 

func (s *CancelArchivalInput) Validate() error

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

type CancelArchivalOutput 

type CancelArchivalOutput struct {

	// The Amazon Resource Name (ARN) of the virtual tape for which archiving was
	// canceled.
	TapeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

CancelArchivalOutput

func (CancelArchivalOutput) GoString added in v0.6.5 

func (s CancelArchivalOutput) GoString() string

GoString returns the string representation

func (*CancelArchivalOutput) SetTapeARN added in v1.5.0 

func (s *CancelArchivalOutput) SetTapeARN(v string) *CancelArchivalOutput

SetTapeARN sets the TapeARN field's value.

func (CancelArchivalOutput) String added in v0.6.5 

func (s CancelArchivalOutput) String() string

String returns the string representation

type CancelRetrievalInput 

type CancelRetrievalInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval
	// for.
	//
	// TapeARN is a required field
	TapeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

CancelRetrievalInput

func (CancelRetrievalInput) GoString added in v0.6.5 

func (s CancelRetrievalInput) GoString() string

GoString returns the string representation

func (*CancelRetrievalInput) SetGatewayARN added in v1.5.0 

func (s *CancelRetrievalInput) SetGatewayARN(v string) *CancelRetrievalInput

SetGatewayARN sets the GatewayARN field's value.

func (*CancelRetrievalInput) SetTapeARN added in v1.5.0 

func (s *CancelRetrievalInput) SetTapeARN(v string) *CancelRetrievalInput

SetTapeARN sets the TapeARN field's value.

func (CancelRetrievalInput) String added in v0.6.5 

func (s CancelRetrievalInput) String() string

String returns the string representation

func (*CancelRetrievalInput) Validate added in v1.1.21 

func (s *CancelRetrievalInput) Validate() error

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

type CancelRetrievalOutput 

type CancelRetrievalOutput struct {

	// The Amazon Resource Name (ARN) of the virtual tape for which retrieval was
	// canceled.
	TapeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

CancelRetrievalOutput

func (CancelRetrievalOutput) GoString added in v0.6.5 

func (s CancelRetrievalOutput) GoString() string

GoString returns the string representation

func (*CancelRetrievalOutput) SetTapeARN added in v1.5.0 

func (s *CancelRetrievalOutput) SetTapeARN(v string) *CancelRetrievalOutput

SetTapeARN sets the TapeARN field's value.

func (CancelRetrievalOutput) String added in v0.6.5 

func (s CancelRetrievalOutput) String() string

String returns the string representation

type ChapInfo 

type ChapInfo struct {

	// The iSCSI initiator that connects to the target.
	InitiatorName *string `min:"1" type:"string"`

	// The secret key that the initiator (for example, the Windows client) must
	// provide to participate in mutual CHAP with the target.
	SecretToAuthenticateInitiator *string `min:"1" type:"string"`

	// The secret key that the target must provide to participate in mutual CHAP
	// with the initiator (e.g. Windows client).
	SecretToAuthenticateTarget *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the volume.
	//
	// Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens
	// (-).
	TargetARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.

func (ChapInfo) GoString added in v0.6.5 

func (s ChapInfo) GoString() string

GoString returns the string representation

func (*ChapInfo) SetInitiatorName added in v1.5.0 

func (s *ChapInfo) SetInitiatorName(v string) *ChapInfo

SetInitiatorName sets the InitiatorName field's value.

func (*ChapInfo) SetSecretToAuthenticateInitiator added in v1.5.0 

func (s *ChapInfo) SetSecretToAuthenticateInitiator(v string) *ChapInfo

SetSecretToAuthenticateInitiator sets the SecretToAuthenticateInitiator field's value.

func (*ChapInfo) SetSecretToAuthenticateTarget added in v1.5.0 

func (s *ChapInfo) SetSecretToAuthenticateTarget(v string) *ChapInfo

SetSecretToAuthenticateTarget sets the SecretToAuthenticateTarget field's value.

func (*ChapInfo) SetTargetARN added in v1.5.0 

func (s *ChapInfo) SetTargetARN(v string) *ChapInfo

SetTargetARN sets the TargetARN field's value.

func (ChapInfo) String added in v0.6.5 

func (s ChapInfo) String() string

String returns the string representation

type CreateCachediSCSIVolumeInput 

type CreateCachediSCSIVolumeInput struct {

	// ClientToken is a required field
	ClientToken *string `min:"5" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// True to use Amazon S3 server side encryption with your own AWS KMS key, or
	// false to use a key managed by Amazon S3. Optional.
	KMSEncrypted *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side
	// encryption. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"20" type:"string"`

	// NetworkInterfaceId is a required field
	NetworkInterfaceId *string `type:"string" required:"true"`

	SnapshotId *string `type:"string"`

	// The ARN for an existing volume. Specifying this ARN makes the new volume
	// into an exact copy of the specified existing volume's latest recovery point.
	// The VolumeSizeInBytes value for this new volume must be equal to or larger
	// than the size of the existing volume, in bytes.
	SourceVolumeARN *string `min:"50" type:"string"`

	// TargetName is a required field
	TargetName *string `min:"1" type:"string" required:"true"`

	// VolumeSizeInBytes is a required field
	VolumeSizeInBytes *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCachediSCSIVolumeInput) GoString added in v0.6.5 

func (s CreateCachediSCSIVolumeInput) GoString() string

GoString returns the string representation

func (*CreateCachediSCSIVolumeInput) SetClientToken added in v1.5.0 

func (s *CreateCachediSCSIVolumeInput) SetClientToken(v string) *CreateCachediSCSIVolumeInput

SetClientToken sets the ClientToken field's value.

func (*CreateCachediSCSIVolumeInput) SetGatewayARN added in v1.5.0 

func (s *CreateCachediSCSIVolumeInput) SetGatewayARN(v string) *CreateCachediSCSIVolumeInput

SetGatewayARN sets the GatewayARN field's value.

func (*CreateCachediSCSIVolumeInput) SetKMSEncrypted added in v1.14.4 

func (s *CreateCachediSCSIVolumeInput) SetKMSEncrypted(v bool) *CreateCachediSCSIVolumeInput

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*CreateCachediSCSIVolumeInput) SetKMSKey added in v1.14.4 

func (s *CreateCachediSCSIVolumeInput) SetKMSKey(v string) *CreateCachediSCSIVolumeInput

SetKMSKey sets the KMSKey field's value.

func (*CreateCachediSCSIVolumeInput) SetNetworkInterfaceId added in v1.5.0 

func (s *CreateCachediSCSIVolumeInput) SetNetworkInterfaceId(v string) *CreateCachediSCSIVolumeInput

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*CreateCachediSCSIVolumeInput) SetSnapshotId added in v1.5.0 

func (s *CreateCachediSCSIVolumeInput) SetSnapshotId(v string) *CreateCachediSCSIVolumeInput

SetSnapshotId sets the SnapshotId field's value.

func (*CreateCachediSCSIVolumeInput) SetSourceVolumeARN added in v1.6.6 

func (s *CreateCachediSCSIVolumeInput) SetSourceVolumeARN(v string) *CreateCachediSCSIVolumeInput

SetSourceVolumeARN sets the SourceVolumeARN field's value.

func (*CreateCachediSCSIVolumeInput) SetTargetName added in v1.5.0 

func (s *CreateCachediSCSIVolumeInput) SetTargetName(v string) *CreateCachediSCSIVolumeInput

SetTargetName sets the TargetName field's value.

func (*CreateCachediSCSIVolumeInput) SetVolumeSizeInBytes added in v1.5.0 

func (s *CreateCachediSCSIVolumeInput) SetVolumeSizeInBytes(v int64) *CreateCachediSCSIVolumeInput

SetVolumeSizeInBytes sets the VolumeSizeInBytes field's value.

func (CreateCachediSCSIVolumeInput) String added in v0.6.5 

func (s CreateCachediSCSIVolumeInput) String() string

String returns the string representation

func (*CreateCachediSCSIVolumeInput) Validate added in v1.1.21 

func (s *CreateCachediSCSIVolumeInput) Validate() error

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

type CreateCachediSCSIVolumeOutput 

type CreateCachediSCSIVolumeOutput struct {
	TargetARN *string `min:"50" type:"string"`

	VolumeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (CreateCachediSCSIVolumeOutput) GoString added in v0.6.5 

func (s CreateCachediSCSIVolumeOutput) GoString() string

GoString returns the string representation

func (*CreateCachediSCSIVolumeOutput) SetTargetARN added in v1.5.0 

func (s *CreateCachediSCSIVolumeOutput) SetTargetARN(v string) *CreateCachediSCSIVolumeOutput

SetTargetARN sets the TargetARN field's value.

func (*CreateCachediSCSIVolumeOutput) SetVolumeARN added in v1.5.0 

func (s *CreateCachediSCSIVolumeOutput) SetVolumeARN(v string) *CreateCachediSCSIVolumeOutput

SetVolumeARN sets the VolumeARN field's value.

func (CreateCachediSCSIVolumeOutput) String added in v0.6.5 

func (s CreateCachediSCSIVolumeOutput) String() string

String returns the string representation

type CreateNFSFileShareInput added in v1.6.6 

type CreateNFSFileShareInput struct {

	// The list of clients that are allowed to access the file gateway. The list
	// must contain either valid IP addresses or valid CIDR blocks.
	ClientList []*string `min:"1" type:"list"`

	// A unique string value that you supply that is used by file gateway to ensure
	// idempotent file share creation.
	//
	// ClientToken is a required field
	ClientToken *string `min:"5" type:"string" required:"true"`

	// The default storage class for objects put into an Amazon S3 bucket by file
	// gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA.
	// If this field is not populated, the default value S3_STANDARD is used. Optional.
	DefaultStorageClass *string `min:"5" type:"string"`

	// The Amazon Resource Name (ARN) of the file gateway on which you want to create
	// a file share.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// Enables guessing of the MIME type for uploaded objects based on file extensions.
	// Set this value to true to enable MIME type guessing, and otherwise to false.
	// The default value is true.
	GuessMIMETypeEnabled *bool `type:"boolean"`

	// True to use Amazon S3 server side encryption with your own AWS KMS key, or
	// false to use a key managed by Amazon S3. Optional.
	KMSEncrypted *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side encryption.
	// This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"20" type:"string"`

	// The ARN of the backed storage used for storing file data.
	//
	// LocationARN is a required field
	LocationARN *string `min:"16" type:"string" required:"true"`

	// File share default values. Optional.
	NFSFileShareDefaults *NFSFileShareDefaults `type:"structure"`

	// Sets the access control list permission for objects in the Amazon S3 bucket
	// that a file gateway puts objects into. The default value is "private".
	ObjectACL *string `type:"string" enum:"ObjectACL"`

	// Sets the write status of a file share. This value is true if the write status
	// is read-only, and otherwise false.
	ReadOnly *bool `type:"boolean"`

	// Sets who pays the cost of the request and the data download from the Amazon
	// S3 bucket. Set this value to true if you want the requester to pay instead
	// of the bucket owner, and otherwise to false.
	RequesterPays *bool `type:"boolean"`

	// The ARN of the AWS Identity and Access Management (IAM) role that a file
	// gateway assumes when it accesses the underlying storage.
	//
	// Role is a required field
	Role *string `min:"20" type:"string" required:"true"`

	// Maps a user to anonymous user. Valid options are the following:
	//
	//    * "RootSquash" - Only root is mapped to anonymous user.
	//
	//    * "NoSquash" - No one is mapped to anonymous user.
	//
	//    * "AllSquash" - Everyone is mapped to anonymous user.
	Squash *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

CreateNFSFileShareInput

func (CreateNFSFileShareInput) GoString added in v1.6.6 

func (s CreateNFSFileShareInput) GoString() string

GoString returns the string representation

func (*CreateNFSFileShareInput) SetClientList added in v1.6.21 

func (s *CreateNFSFileShareInput) SetClientList(v []*string) *CreateNFSFileShareInput

SetClientList sets the ClientList field's value.

func (*CreateNFSFileShareInput) SetClientToken added in v1.6.6 

func (s *CreateNFSFileShareInput) SetClientToken(v string) *CreateNFSFileShareInput

SetClientToken sets the ClientToken field's value.

func (*CreateNFSFileShareInput) SetDefaultStorageClass added in v1.6.6 

func (s *CreateNFSFileShareInput) SetDefaultStorageClass(v string) *CreateNFSFileShareInput

SetDefaultStorageClass sets the DefaultStorageClass field's value.

func (*CreateNFSFileShareInput) SetGatewayARN added in v1.6.6 

func (s *CreateNFSFileShareInput) SetGatewayARN(v string) *CreateNFSFileShareInput

SetGatewayARN sets the GatewayARN field's value.

func (*CreateNFSFileShareInput) SetGuessMIMETypeEnabled added in v1.12.32 

func (s *CreateNFSFileShareInput) SetGuessMIMETypeEnabled(v bool) *CreateNFSFileShareInput

SetGuessMIMETypeEnabled sets the GuessMIMETypeEnabled field's value.

func (*CreateNFSFileShareInput) SetKMSEncrypted added in v1.6.6 

func (s *CreateNFSFileShareInput) SetKMSEncrypted(v bool) *CreateNFSFileShareInput

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*CreateNFSFileShareInput) SetKMSKey added in v1.6.6 

func (s *CreateNFSFileShareInput) SetKMSKey(v string) *CreateNFSFileShareInput

SetKMSKey sets the KMSKey field's value.

func (*CreateNFSFileShareInput) SetLocationARN added in v1.6.6 

func (s *CreateNFSFileShareInput) SetLocationARN(v string) *CreateNFSFileShareInput

SetLocationARN sets the LocationARN field's value.

func (*CreateNFSFileShareInput) SetNFSFileShareDefaults added in v1.6.6 

func (s *CreateNFSFileShareInput) SetNFSFileShareDefaults(v *NFSFileShareDefaults) *CreateNFSFileShareInput

SetNFSFileShareDefaults sets the NFSFileShareDefaults field's value.

func (*CreateNFSFileShareInput) SetObjectACL added in v1.13.8 

func (s *CreateNFSFileShareInput) SetObjectACL(v string) *CreateNFSFileShareInput

SetObjectACL sets the ObjectACL field's value.

func (*CreateNFSFileShareInput) SetReadOnly added in v1.8.5 

func (s *CreateNFSFileShareInput) SetReadOnly(v bool) *CreateNFSFileShareInput

SetReadOnly sets the ReadOnly field's value.

func (*CreateNFSFileShareInput) SetRequesterPays added in v1.13.8 

func (s *CreateNFSFileShareInput) SetRequesterPays(v bool) *CreateNFSFileShareInput

SetRequesterPays sets the RequesterPays field's value.

func (*CreateNFSFileShareInput) SetRole added in v1.6.6 

func (s *CreateNFSFileShareInput) SetRole(v string) *CreateNFSFileShareInput

SetRole sets the Role field's value.

func (*CreateNFSFileShareInput) SetSquash added in v1.8.5 

func (s *CreateNFSFileShareInput) SetSquash(v string) *CreateNFSFileShareInput

SetSquash sets the Squash field's value.

func (CreateNFSFileShareInput) String added in v1.6.6 

func (s CreateNFSFileShareInput) String() string

String returns the string representation

func (*CreateNFSFileShareInput) Validate added in v1.6.6 

func (s *CreateNFSFileShareInput) Validate() error

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

type CreateNFSFileShareOutput added in v1.6.6 

type CreateNFSFileShareOutput struct {

	// The Amazon Resource Name (ARN) of the newly created file share.
	FileShareARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

CreateNFSFileShareOutput

func (CreateNFSFileShareOutput) GoString added in v1.6.6 

func (s CreateNFSFileShareOutput) GoString() string

GoString returns the string representation

func (*CreateNFSFileShareOutput) SetFileShareARN added in v1.6.6 

func (s *CreateNFSFileShareOutput) SetFileShareARN(v string) *CreateNFSFileShareOutput

SetFileShareARN sets the FileShareARN field's value.

func (CreateNFSFileShareOutput) String added in v1.6.6 

func (s CreateNFSFileShareOutput) String() string

String returns the string representation

type CreateSnapshotFromVolumeRecoveryPointInput 

type CreateSnapshotFromVolumeRecoveryPointInput struct {

	// SnapshotDescription is a required field
	SnapshotDescription *string `min:"1" type:"string" required:"true"`

	// VolumeARN is a required field
	VolumeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSnapshotFromVolumeRecoveryPointInput) GoString added in v0.6.5 

func (s CreateSnapshotFromVolumeRecoveryPointInput) GoString() string

GoString returns the string representation

func (*CreateSnapshotFromVolumeRecoveryPointInput) SetSnapshotDescription added in v1.5.0 

func (s *CreateSnapshotFromVolumeRecoveryPointInput) SetSnapshotDescription(v string) *CreateSnapshotFromVolumeRecoveryPointInput

SetSnapshotDescription sets the SnapshotDescription field's value.

func (*CreateSnapshotFromVolumeRecoveryPointInput) SetVolumeARN added in v1.5.0 

func (s *CreateSnapshotFromVolumeRecoveryPointInput) SetVolumeARN(v string) *CreateSnapshotFromVolumeRecoveryPointInput

SetVolumeARN sets the VolumeARN field's value.

func (CreateSnapshotFromVolumeRecoveryPointInput) String added in v0.6.5 

func (s CreateSnapshotFromVolumeRecoveryPointInput) String() string

String returns the string representation

func (*CreateSnapshotFromVolumeRecoveryPointInput) Validate added in v1.1.21 

func (s *CreateSnapshotFromVolumeRecoveryPointInput) Validate() error

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

type CreateSnapshotFromVolumeRecoveryPointOutput 

type CreateSnapshotFromVolumeRecoveryPointOutput struct {
	SnapshotId *string `type:"string"`

	VolumeARN *string `min:"50" type:"string"`

	VolumeRecoveryPointTime *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateSnapshotFromVolumeRecoveryPointOutput) GoString added in v0.6.5 

func (s CreateSnapshotFromVolumeRecoveryPointOutput) GoString() string

GoString returns the string representation

func (*CreateSnapshotFromVolumeRecoveryPointOutput) SetSnapshotId added in v1.5.0 

func (s *CreateSnapshotFromVolumeRecoveryPointOutput) SetSnapshotId(v string) *CreateSnapshotFromVolumeRecoveryPointOutput

SetSnapshotId sets the SnapshotId field's value.

func (*CreateSnapshotFromVolumeRecoveryPointOutput) SetVolumeARN added in v1.5.0 

func (s *CreateSnapshotFromVolumeRecoveryPointOutput) SetVolumeARN(v string) *CreateSnapshotFromVolumeRecoveryPointOutput

SetVolumeARN sets the VolumeARN field's value.

func (*CreateSnapshotFromVolumeRecoveryPointOutput) SetVolumeRecoveryPointTime added in v1.5.0 

func (s *CreateSnapshotFromVolumeRecoveryPointOutput) SetVolumeRecoveryPointTime(v string) *CreateSnapshotFromVolumeRecoveryPointOutput

SetVolumeRecoveryPointTime sets the VolumeRecoveryPointTime field's value.

func (CreateSnapshotFromVolumeRecoveryPointOutput) String added in v0.6.5 

func (s CreateSnapshotFromVolumeRecoveryPointOutput) String() string

String returns the string representation

type CreateSnapshotInput 

type CreateSnapshotInput struct {

	// Textual description of the snapshot that appears in the Amazon EC2 console,
	// Elastic Block Store snapshots panel in the Description field, and in the
	// AWS Storage Gateway snapshot Details pane, Description field
	//
	// SnapshotDescription is a required field
	SnapshotDescription *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
	// to return a list of gateway volumes.
	//
	// VolumeARN is a required field
	VolumeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing one or more of the following fields:

  • CreateSnapshotInput$SnapshotDescription

  • CreateSnapshotInput$VolumeARN

func (CreateSnapshotInput) GoString added in v0.6.5 

func (s CreateSnapshotInput) GoString() string

GoString returns the string representation

func (*CreateSnapshotInput) SetSnapshotDescription added in v1.5.0 

func (s *CreateSnapshotInput) SetSnapshotDescription(v string) *CreateSnapshotInput

SetSnapshotDescription sets the SnapshotDescription field's value.

func (*CreateSnapshotInput) SetVolumeARN added in v1.5.0 

func (s *CreateSnapshotInput) SetVolumeARN(v string) *CreateSnapshotInput

SetVolumeARN sets the VolumeARN field's value.

func (CreateSnapshotInput) String added in v0.6.5 

func (s CreateSnapshotInput) String() string

String returns the string representation

func (*CreateSnapshotInput) Validate added in v1.1.21 

func (s *CreateSnapshotInput) Validate() error

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

type CreateSnapshotOutput 

type CreateSnapshotOutput struct {

	// The snapshot ID that is used to refer to the snapshot in future operations
	// such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots)
	// or creating a volume from a snapshot (CreateStorediSCSIVolume).
	SnapshotId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
	VolumeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

func (CreateSnapshotOutput) GoString added in v0.6.5 

func (s CreateSnapshotOutput) GoString() string

GoString returns the string representation

func (*CreateSnapshotOutput) SetSnapshotId added in v1.5.0 

func (s *CreateSnapshotOutput) SetSnapshotId(v string) *CreateSnapshotOutput

SetSnapshotId sets the SnapshotId field's value.

func (*CreateSnapshotOutput) SetVolumeARN added in v1.5.0 

func (s *CreateSnapshotOutput) SetVolumeARN(v string) *CreateSnapshotOutput

SetVolumeARN sets the VolumeARN field's value.

func (CreateSnapshotOutput) String added in v0.6.5 

func (s CreateSnapshotOutput) String() string

String returns the string representation

type CreateStorediSCSIVolumeInput 

type CreateStorediSCSIVolumeInput struct {

	// The unique identifier for the gateway local disk that is configured as a
	// stored volume. Use ListLocalDisks (http://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html)
	// to list disk IDs for a gateway.
	//
	// DiskId is a required field
	DiskId *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The network interface of the gateway on which to expose the iSCSI target.
	// Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a
	// list of the network interfaces available on a gateway.
	//
	// Valid Values: A valid IP address.
	//
	// NetworkInterfaceId is a required field
	NetworkInterfaceId *string `type:"string" required:"true"`

	// Specify this field as true if you want to preserve the data on the local
	// disk. Otherwise, specifying this field as false creates an empty volume.
	//
	// Valid Values: true, false
	//
	// PreserveExistingData is a required field
	PreserveExistingData *bool `type:"boolean" required:"true"`

	// The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the
	// new stored volume. Specify this field if you want to create the iSCSI storage
	// volume from a snapshot otherwise do not include this field. To list snapshots
	// for your account use DescribeSnapshots (http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html)
	// in the Amazon Elastic Compute Cloud API Reference.
	SnapshotId *string `type:"string"`

	// The name of the iSCSI target used by initiators to connect to the target
	// and as a suffix for the target ARN. For example, specifying TargetName as
	// myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
	// The target name must be unique across all volumes of a gateway.
	//
	// TargetName is a required field
	TargetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing one or more of the following fields:

  • CreateStorediSCSIVolumeInput$DiskId

  • CreateStorediSCSIVolumeInput$NetworkInterfaceId

  • CreateStorediSCSIVolumeInput$PreserveExistingData

  • CreateStorediSCSIVolumeInput$SnapshotId

  • CreateStorediSCSIVolumeInput$TargetName

func (CreateStorediSCSIVolumeInput) GoString added in v0.6.5 

func (s CreateStorediSCSIVolumeInput) GoString() string

GoString returns the string representation

func (*CreateStorediSCSIVolumeInput) SetDiskId added in v1.5.0 

func (s *CreateStorediSCSIVolumeInput) SetDiskId(v string) *CreateStorediSCSIVolumeInput

SetDiskId sets the DiskId field's value.

func (*CreateStorediSCSIVolumeInput) SetGatewayARN added in v1.5.0 

func (s *CreateStorediSCSIVolumeInput) SetGatewayARN(v string) *CreateStorediSCSIVolumeInput

SetGatewayARN sets the GatewayARN field's value.

func (*CreateStorediSCSIVolumeInput) SetNetworkInterfaceId added in v1.5.0 

func (s *CreateStorediSCSIVolumeInput) SetNetworkInterfaceId(v string) *CreateStorediSCSIVolumeInput

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*CreateStorediSCSIVolumeInput) SetPreserveExistingData added in v1.5.0 

func (s *CreateStorediSCSIVolumeInput) SetPreserveExistingData(v bool) *CreateStorediSCSIVolumeInput

SetPreserveExistingData sets the PreserveExistingData field's value.

func (*CreateStorediSCSIVolumeInput) SetSnapshotId added in v1.5.0 

func (s *CreateStorediSCSIVolumeInput) SetSnapshotId(v string) *CreateStorediSCSIVolumeInput

SetSnapshotId sets the SnapshotId field's value.

func (*CreateStorediSCSIVolumeInput) SetTargetName added in v1.5.0 

func (s *CreateStorediSCSIVolumeInput) SetTargetName(v string) *CreateStorediSCSIVolumeInput

SetTargetName sets the TargetName field's value.

func (CreateStorediSCSIVolumeInput) String added in v0.6.5 

func (s CreateStorediSCSIVolumeInput) String() string

String returns the string representation

func (*CreateStorediSCSIVolumeInput) Validate added in v1.1.21 

func (s *CreateStorediSCSIVolumeInput) Validate() error

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

type CreateStorediSCSIVolumeOutput 

type CreateStorediSCSIVolumeOutput struct {

	// he Amazon Resource Name (ARN) of the volume target that includes the iSCSI
	// name that initiators can use to connect to the target.
	TargetARN *string `min:"50" type:"string"`

	// The Amazon Resource Name (ARN) of the configured volume.
	VolumeARN *string `min:"50" type:"string"`

	// The size of the volume in bytes.
	VolumeSizeInBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

func (CreateStorediSCSIVolumeOutput) GoString added in v0.6.5 

func (s CreateStorediSCSIVolumeOutput) GoString() string

GoString returns the string representation

func (*CreateStorediSCSIVolumeOutput) SetTargetARN added in v1.5.0 

func (s *CreateStorediSCSIVolumeOutput) SetTargetARN(v string) *CreateStorediSCSIVolumeOutput

SetTargetARN sets the TargetARN field's value.

func (*CreateStorediSCSIVolumeOutput) SetVolumeARN added in v1.5.0 

func (s *CreateStorediSCSIVolumeOutput) SetVolumeARN(v string) *CreateStorediSCSIVolumeOutput

SetVolumeARN sets the VolumeARN field's value.

func (*CreateStorediSCSIVolumeOutput) SetVolumeSizeInBytes added in v1.5.0 

func (s *CreateStorediSCSIVolumeOutput) SetVolumeSizeInBytes(v int64) *CreateStorediSCSIVolumeOutput

SetVolumeSizeInBytes sets the VolumeSizeInBytes field's value.

func (CreateStorediSCSIVolumeOutput) String added in v0.6.5 

func (s CreateStorediSCSIVolumeOutput) String() string

String returns the string representation

type CreateTapeWithBarcodeInput added in v1.1.4 

type CreateTapeWithBarcodeInput struct {

	// The unique Amazon Resource Name (ARN) that represents the gateway to associate
	// the virtual tape with. Use the ListGateways operation to return a list of
	// gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// True to use Amazon S3 server side encryption with your own AWS KMS key, or
	// false to use a key managed by Amazon S3. Optional.
	KMSEncrypted *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the KMS Key used for Amazon S3 server side
	// encryption. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"20" type:"string"`

	// The barcode that you want to assign to the tape.
	//
	// Barcodes cannot be reused. This includes barcodes used for tapes that have
	// been deleted.
	//
	// TapeBarcode is a required field
	TapeBarcode *string `min:"7" type:"string" required:"true"`

	// The size, in bytes, of the virtual tape that you want to create.
	//
	// The size must be aligned by gigabyte (1024*1024*1024 byte).
	//
	// TapeSizeInBytes is a required field
	TapeSizeInBytes *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

CreateTapeWithBarcodeInput

func (CreateTapeWithBarcodeInput) GoString added in v1.1.4 

func (s CreateTapeWithBarcodeInput) GoString() string

GoString returns the string representation

func (*CreateTapeWithBarcodeInput) SetGatewayARN added in v1.5.0 

func (s *CreateTapeWithBarcodeInput) SetGatewayARN(v string) *CreateTapeWithBarcodeInput

SetGatewayARN sets the GatewayARN field's value.

func (*CreateTapeWithBarcodeInput) SetKMSEncrypted added in v1.14.4 

func (s *CreateTapeWithBarcodeInput) SetKMSEncrypted(v bool) *CreateTapeWithBarcodeInput

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*CreateTapeWithBarcodeInput) SetKMSKey added in v1.14.4 

func (s *CreateTapeWithBarcodeInput) SetKMSKey(v string) *CreateTapeWithBarcodeInput

SetKMSKey sets the KMSKey field's value.

func (*CreateTapeWithBarcodeInput) SetTapeBarcode added in v1.5.0 

func (s *CreateTapeWithBarcodeInput) SetTapeBarcode(v string) *CreateTapeWithBarcodeInput

SetTapeBarcode sets the TapeBarcode field's value.

func (*CreateTapeWithBarcodeInput) SetTapeSizeInBytes added in v1.5.0 

func (s *CreateTapeWithBarcodeInput) SetTapeSizeInBytes(v int64) *CreateTapeWithBarcodeInput

SetTapeSizeInBytes sets the TapeSizeInBytes field's value.

func (CreateTapeWithBarcodeInput) String added in v1.1.4 

func (s CreateTapeWithBarcodeInput) String() string

String returns the string representation

func (*CreateTapeWithBarcodeInput) Validate added in v1.1.21 

func (s *CreateTapeWithBarcodeInput) Validate() error

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

type CreateTapeWithBarcodeOutput added in v1.1.4 

type CreateTapeWithBarcodeOutput struct {

	// A unique Amazon Resource Name (ARN) that represents the virtual tape that
	// was created.
	TapeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

CreateTapeOutput

func (CreateTapeWithBarcodeOutput) GoString added in v1.1.4 

func (s CreateTapeWithBarcodeOutput) GoString() string

GoString returns the string representation

func (*CreateTapeWithBarcodeOutput) SetTapeARN added in v1.5.0 

func (s *CreateTapeWithBarcodeOutput) SetTapeARN(v string) *CreateTapeWithBarcodeOutput

SetTapeARN sets the TapeARN field's value.

func (CreateTapeWithBarcodeOutput) String added in v1.1.4 

func (s CreateTapeWithBarcodeOutput) String() string

String returns the string representation

type CreateTapesInput 

type CreateTapesInput struct {

	// A unique identifier that you use to retry a request. If you retry a request,
	// use the same ClientToken you specified in the initial request.
	//
	// Using the same ClientToken prevents creating the tape multiple times.
	//
	// ClientToken is a required field
	ClientToken *string `min:"5" type:"string" required:"true"`

	// The unique Amazon Resource Name (ARN) that represents the gateway to associate
	// the virtual tapes with. Use the ListGateways operation to return a list of
	// gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// True to use Amazon S3 server side encryption with your own AWS KMS key, or
	// false to use a key managed by Amazon S3. Optional.
	KMSEncrypted *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side
	// encryption. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"20" type:"string"`

	// The number of virtual tapes that you want to create.
	//
	// NumTapesToCreate is a required field
	NumTapesToCreate *int64 `min:"1" type:"integer" required:"true"`

	// A prefix that you append to the barcode of the virtual tape you are creating.
	// This prefix makes the barcode unique.
	//
	// The prefix must be 1 to 4 characters in length and must be one of the uppercase
	// letters from A to Z.
	//
	// TapeBarcodePrefix is a required field
	TapeBarcodePrefix *string `min:"1" type:"string" required:"true"`

	// The size, in bytes, of the virtual tapes that you want to create.
	//
	// The size must be aligned by gigabyte (1024*1024*1024 byte).
	//
	// TapeSizeInBytes is a required field
	TapeSizeInBytes *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

CreateTapesInput

func (CreateTapesInput) GoString added in v0.6.5 

func (s CreateTapesInput) GoString() string

GoString returns the string representation

func (*CreateTapesInput) SetClientToken added in v1.5.0 

func (s *CreateTapesInput) SetClientToken(v string) *CreateTapesInput

SetClientToken sets the ClientToken field's value.

func (*CreateTapesInput) SetGatewayARN added in v1.5.0 

func (s *CreateTapesInput) SetGatewayARN(v string) *CreateTapesInput

SetGatewayARN sets the GatewayARN field's value.

func (*CreateTapesInput) SetKMSEncrypted added in v1.14.4 

func (s *CreateTapesInput) SetKMSEncrypted(v bool) *CreateTapesInput

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*CreateTapesInput) SetKMSKey added in v1.14.4 

func (s *CreateTapesInput) SetKMSKey(v string) *CreateTapesInput

SetKMSKey sets the KMSKey field's value.

func (*CreateTapesInput) SetNumTapesToCreate added in v1.5.0 

func (s *CreateTapesInput) SetNumTapesToCreate(v int64) *CreateTapesInput

SetNumTapesToCreate sets the NumTapesToCreate field's value.

func (*CreateTapesInput) SetTapeBarcodePrefix added in v1.5.0 

func (s *CreateTapesInput) SetTapeBarcodePrefix(v string) *CreateTapesInput

SetTapeBarcodePrefix sets the TapeBarcodePrefix field's value.

func (*CreateTapesInput) SetTapeSizeInBytes added in v1.5.0 

func (s *CreateTapesInput) SetTapeSizeInBytes(v int64) *CreateTapesInput

SetTapeSizeInBytes sets the TapeSizeInBytes field's value.

func (CreateTapesInput) String added in v0.6.5 

func (s CreateTapesInput) String() string

String returns the string representation

func (*CreateTapesInput) Validate added in v1.1.21 

func (s *CreateTapesInput) Validate() error

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

type CreateTapesOutput 

type CreateTapesOutput struct {

	// A list of unique Amazon Resource Names (ARNs) that represents the virtual
	// tapes that were created.
	TapeARNs []*string `type:"list"`
	// contains filtered or unexported fields
}

CreateTapeOutput

func (CreateTapesOutput) GoString added in v0.6.5 

func (s CreateTapesOutput) GoString() string

GoString returns the string representation

func (*CreateTapesOutput) SetTapeARNs added in v1.5.0 

func (s *CreateTapesOutput) SetTapeARNs(v []*string) *CreateTapesOutput

SetTapeARNs sets the TapeARNs field's value.

func (CreateTapesOutput) String added in v0.6.5 

func (s CreateTapesOutput) String() string

String returns the string representation

type DeleteBandwidthRateLimitInput 

type DeleteBandwidthRateLimitInput struct {

	// One of the BandwidthType values that indicates the gateway bandwidth rate
	// limit to delete.
	//
	// Valid Values: Upload, Download, All.
	//
	// BandwidthType is a required field
	BandwidthType *string `min:"3" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

  • DeleteBandwidthRateLimitInput$BandwidthType

func (DeleteBandwidthRateLimitInput) GoString added in v0.6.5 

func (s DeleteBandwidthRateLimitInput) GoString() string

GoString returns the string representation

func (*DeleteBandwidthRateLimitInput) SetBandwidthType added in v1.5.0 

func (s *DeleteBandwidthRateLimitInput) SetBandwidthType(v string) *DeleteBandwidthRateLimitInput

SetBandwidthType sets the BandwidthType field's value.

func (*DeleteBandwidthRateLimitInput) SetGatewayARN added in v1.5.0 

func (s *DeleteBandwidthRateLimitInput) SetGatewayARN(v string) *DeleteBandwidthRateLimitInput

SetGatewayARN sets the GatewayARN field's value.

func (DeleteBandwidthRateLimitInput) String added in v0.6.5 

func (s DeleteBandwidthRateLimitInput) String() string

String returns the string representation

func (*DeleteBandwidthRateLimitInput) Validate added in v1.1.21 

func (s *DeleteBandwidthRateLimitInput) Validate() error

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

type DeleteBandwidthRateLimitOutput 

type DeleteBandwidthRateLimitOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway whose bandwidth rate information was deleted.

func (DeleteBandwidthRateLimitOutput) GoString added in v0.6.5 

func (s DeleteBandwidthRateLimitOutput) GoString() string

GoString returns the string representation

func (*DeleteBandwidthRateLimitOutput) SetGatewayARN added in v1.5.0 

func (s *DeleteBandwidthRateLimitOutput) SetGatewayARN(v string) *DeleteBandwidthRateLimitOutput

SetGatewayARN sets the GatewayARN field's value.

func (DeleteBandwidthRateLimitOutput) String added in v0.6.5 

func (s DeleteBandwidthRateLimitOutput) String() string

String returns the string representation

type DeleteChapCredentialsInput 

type DeleteChapCredentialsInput struct {

	// The iSCSI initiator that connects to the target.
	//
	// InitiatorName is a required field
	InitiatorName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
	// operation to return to retrieve the TargetARN for specified VolumeARN.
	//
	// TargetARN is a required field
	TargetARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing one or more of the following fields:

  • DeleteChapCredentialsInput$InitiatorName

  • DeleteChapCredentialsInput$TargetARN

func (DeleteChapCredentialsInput) GoString added in v0.6.5 

func (s DeleteChapCredentialsInput) GoString() string

GoString returns the string representation

func (*DeleteChapCredentialsInput) SetInitiatorName added in v1.5.0 

func (s *DeleteChapCredentialsInput) SetInitiatorName(v string) *DeleteChapCredentialsInput

SetInitiatorName sets the InitiatorName field's value.

func (*DeleteChapCredentialsInput) SetTargetARN added in v1.5.0 

func (s *DeleteChapCredentialsInput) SetTargetARN(v string) *DeleteChapCredentialsInput

SetTargetARN sets the TargetARN field's value.

func (DeleteChapCredentialsInput) String added in v0.6.5 

func (s DeleteChapCredentialsInput) String() string

String returns the string representation

func (*DeleteChapCredentialsInput) Validate added in v1.1.21 

func (s *DeleteChapCredentialsInput) Validate() error

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

type DeleteChapCredentialsOutput 

type DeleteChapCredentialsOutput struct {

	// The iSCSI initiator that connects to the target.
	InitiatorName *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the target.
	TargetARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

func (DeleteChapCredentialsOutput) GoString added in v0.6.5 

func (s DeleteChapCredentialsOutput) GoString() string

GoString returns the string representation

func (*DeleteChapCredentialsOutput) SetInitiatorName added in v1.5.0 

func (s *DeleteChapCredentialsOutput) SetInitiatorName(v string) *DeleteChapCredentialsOutput

SetInitiatorName sets the InitiatorName field's value.

func (*DeleteChapCredentialsOutput) SetTargetARN added in v1.5.0 

func (s *DeleteChapCredentialsOutput) SetTargetARN(v string) *DeleteChapCredentialsOutput

SetTargetARN sets the TargetARN field's value.

func (DeleteChapCredentialsOutput) String added in v0.6.5 

func (s DeleteChapCredentialsOutput) String() string

String returns the string representation

type DeleteFileShareInput added in v1.6.6 

type DeleteFileShareInput struct {

	// The Amazon Resource Name (ARN) of the file share to be deleted.
	//
	// FileShareARN is a required field
	FileShareARN *string `min:"50" type:"string" required:"true"`

	// If this value is set to true, the operation deletes a file share immediately
	// and aborts all data uploads to AWS. Otherwise, the file share is not deleted
	// until all data is uploaded to AWS. This process aborts the data upload process,
	// and the file share enters the FORCE_DELETING status.
	ForceDelete *bool `type:"boolean"`
	// contains filtered or unexported fields
}

DeleteFileShareInput

func (DeleteFileShareInput) GoString added in v1.6.6 

func (s DeleteFileShareInput) GoString() string

GoString returns the string representation

func (*DeleteFileShareInput) SetFileShareARN added in v1.6.6 

func (s *DeleteFileShareInput) SetFileShareARN(v string) *DeleteFileShareInput

SetFileShareARN sets the FileShareARN field's value.

func (*DeleteFileShareInput) SetForceDelete added in v1.10.25 

func (s *DeleteFileShareInput) SetForceDelete(v bool) *DeleteFileShareInput

SetForceDelete sets the ForceDelete field's value.

func (DeleteFileShareInput) String added in v1.6.6 

func (s DeleteFileShareInput) String() string

String returns the string representation

func (*DeleteFileShareInput) Validate added in v1.6.6 

func (s *DeleteFileShareInput) Validate() error

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

type DeleteFileShareOutput added in v1.6.6 

type DeleteFileShareOutput struct {

	// The Amazon Resource Name (ARN) of the deleted file share.
	FileShareARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

DeleteFileShareOutput

func (DeleteFileShareOutput) GoString added in v1.6.6 

func (s DeleteFileShareOutput) GoString() string

GoString returns the string representation

func (*DeleteFileShareOutput) SetFileShareARN added in v1.6.6 

func (s *DeleteFileShareOutput) SetFileShareARN(v string) *DeleteFileShareOutput

SetFileShareARN sets the FileShareARN field's value.

func (DeleteFileShareOutput) String added in v1.6.6 

func (s DeleteFileShareOutput) String() string

String returns the string representation

type DeleteGatewayInput 

type DeleteGatewayInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the ID of the gateway to delete.

func (DeleteGatewayInput) GoString added in v0.6.5 

func (s DeleteGatewayInput) GoString() string

GoString returns the string representation

func (*DeleteGatewayInput) SetGatewayARN added in v1.5.0 

func (s *DeleteGatewayInput) SetGatewayARN(v string) *DeleteGatewayInput

SetGatewayARN sets the GatewayARN field's value.

func (DeleteGatewayInput) String added in v0.6.5 

func (s DeleteGatewayInput) String() string

String returns the string representation

func (*DeleteGatewayInput) Validate added in v1.1.21 

func (s *DeleteGatewayInput) Validate() error

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

type DeleteGatewayOutput 

type DeleteGatewayOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the ID of the deleted gateway.

func (DeleteGatewayOutput) GoString added in v0.6.5 

func (s DeleteGatewayOutput) GoString() string

GoString returns the string representation

func (*DeleteGatewayOutput) SetGatewayARN added in v1.5.0 

func (s *DeleteGatewayOutput) SetGatewayARN(v string) *DeleteGatewayOutput

SetGatewayARN sets the GatewayARN field's value.

func (DeleteGatewayOutput) String added in v0.6.5 

func (s DeleteGatewayOutput) String() string

String returns the string representation

type DeleteSnapshotScheduleInput 

type DeleteSnapshotScheduleInput struct {

	// VolumeARN is a required field
	VolumeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSnapshotScheduleInput) GoString added in v0.6.5 

func (s DeleteSnapshotScheduleInput) GoString() string

GoString returns the string representation

func (*DeleteSnapshotScheduleInput) SetVolumeARN added in v1.5.0 

func (s *DeleteSnapshotScheduleInput) SetVolumeARN(v string) *DeleteSnapshotScheduleInput

SetVolumeARN sets the VolumeARN field's value.

func (DeleteSnapshotScheduleInput) String added in v0.6.5 

func (s DeleteSnapshotScheduleInput) String() string

String returns the string representation

func (*DeleteSnapshotScheduleInput) Validate added in v1.1.21 

func (s *DeleteSnapshotScheduleInput) Validate() error

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

type DeleteSnapshotScheduleOutput 

type DeleteSnapshotScheduleOutput struct {
	VolumeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSnapshotScheduleOutput) GoString added in v0.6.5 

func (s DeleteSnapshotScheduleOutput) GoString() string

GoString returns the string representation

func (*DeleteSnapshotScheduleOutput) SetVolumeARN added in v1.5.0 

func (s *DeleteSnapshotScheduleOutput) SetVolumeARN(v string) *DeleteSnapshotScheduleOutput

SetVolumeARN sets the VolumeARN field's value.

func (DeleteSnapshotScheduleOutput) String added in v0.6.5 

func (s DeleteSnapshotScheduleOutput) String() string

String returns the string representation

type DeleteTapeArchiveInput 

type DeleteTapeArchiveInput struct {

	// The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual
	// tape shelf (VTS).
	//
	// TapeARN is a required field
	TapeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

DeleteTapeArchiveInput

func (DeleteTapeArchiveInput) GoString added in v0.6.5 

func (s DeleteTapeArchiveInput) GoString() string

GoString returns the string representation

func (*DeleteTapeArchiveInput) SetTapeARN added in v1.5.0 

func (s *DeleteTapeArchiveInput) SetTapeARN(v string) *DeleteTapeArchiveInput

SetTapeARN sets the TapeARN field's value.

func (DeleteTapeArchiveInput) String added in v0.6.5 

func (s DeleteTapeArchiveInput) String() string

String returns the string representation

func (*DeleteTapeArchiveInput) Validate added in v1.1.21 

func (s *DeleteTapeArchiveInput) Validate() error

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

type DeleteTapeArchiveOutput 

type DeleteTapeArchiveOutput struct {

	// The Amazon Resource Name (ARN) of the virtual tape that was deleted from
	// the virtual tape shelf (VTS).
	TapeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

DeleteTapeArchiveOutput

func (DeleteTapeArchiveOutput) GoString added in v0.6.5 

func (s DeleteTapeArchiveOutput) GoString() string

GoString returns the string representation

func (*DeleteTapeArchiveOutput) SetTapeARN added in v1.5.0 

func (s *DeleteTapeArchiveOutput) SetTapeARN(v string) *DeleteTapeArchiveOutput

SetTapeARN sets the TapeARN field's value.

func (DeleteTapeArchiveOutput) String added in v0.6.5 

func (s DeleteTapeArchiveOutput) String() string

String returns the string representation

type DeleteTapeInput 

type DeleteTapeInput struct {

	// The unique Amazon Resource Name (ARN) of the gateway that the virtual tape
	// to delete is associated with. Use the ListGateways operation to return a
	// list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the virtual tape to delete.
	//
	// TapeARN is a required field
	TapeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

DeleteTapeInput

func (DeleteTapeInput) GoString added in v0.6.5 

func (s DeleteTapeInput) GoString() string

GoString returns the string representation

func (*DeleteTapeInput) SetGatewayARN added in v1.5.0 

func (s *DeleteTapeInput) SetGatewayARN(v string) *DeleteTapeInput

SetGatewayARN sets the GatewayARN field's value.

func (*DeleteTapeInput) SetTapeARN added in v1.5.0 

func (s *DeleteTapeInput) SetTapeARN(v string) *DeleteTapeInput

SetTapeARN sets the TapeARN field's value.

func (DeleteTapeInput) String added in v0.6.5 

func (s DeleteTapeInput) String() string

String returns the string representation

func (*DeleteTapeInput) Validate added in v1.1.21 

func (s *DeleteTapeInput) Validate() error

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

type DeleteTapeOutput 

type DeleteTapeOutput struct {

	// The Amazon Resource Name (ARN) of the deleted virtual tape.
	TapeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

DeleteTapeOutput

func (DeleteTapeOutput) GoString added in v0.6.5 

func (s DeleteTapeOutput) GoString() string

GoString returns the string representation

func (*DeleteTapeOutput) SetTapeARN added in v1.5.0 

func (s *DeleteTapeOutput) SetTapeARN(v string) *DeleteTapeOutput

SetTapeARN sets the TapeARN field's value.

func (DeleteTapeOutput) String added in v0.6.5 

func (s DeleteTapeOutput) String() string

String returns the string representation

type DeleteVolumeInput 

type DeleteVolumeInput struct {

	// The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
	// to return a list of gateway volumes.
	//
	// VolumeARN is a required field
	VolumeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the DeleteVolumeInput$VolumeARN to delete.

func (DeleteVolumeInput) GoString added in v0.6.5 

func (s DeleteVolumeInput) GoString() string

GoString returns the string representation

func (*DeleteVolumeInput) SetVolumeARN added in v1.5.0 

func (s *DeleteVolumeInput) SetVolumeARN(v string) *DeleteVolumeInput

SetVolumeARN sets the VolumeARN field's value.

func (DeleteVolumeInput) String added in v0.6.5 

func (s DeleteVolumeInput) String() string

String returns the string representation

func (*DeleteVolumeInput) Validate added in v1.1.21 

func (s *DeleteVolumeInput) Validate() error

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

type DeleteVolumeOutput 

type DeleteVolumeOutput struct {

	// The Amazon Resource Name (ARN) of the storage volume that was deleted. It
	// is the same ARN you provided in the request.
	VolumeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the of the storage volume that was deleted

func (DeleteVolumeOutput) GoString added in v0.6.5 

func (s DeleteVolumeOutput) GoString() string

GoString returns the string representation

func (*DeleteVolumeOutput) SetVolumeARN added in v1.5.0 

func (s *DeleteVolumeOutput) SetVolumeARN(v string) *DeleteVolumeOutput

SetVolumeARN sets the VolumeARN field's value.

func (DeleteVolumeOutput) String added in v0.6.5 

func (s DeleteVolumeOutput) String() string

String returns the string representation

type DescribeBandwidthRateLimitInput 

type DescribeBandwidthRateLimitInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway.

func (DescribeBandwidthRateLimitInput) GoString added in v0.6.5 

func (s DescribeBandwidthRateLimitInput) GoString() string

GoString returns the string representation

func (*DescribeBandwidthRateLimitInput) SetGatewayARN added in v1.5.0 

func (s *DescribeBandwidthRateLimitInput) SetGatewayARN(v string) *DescribeBandwidthRateLimitInput

SetGatewayARN sets the GatewayARN field's value.

func (DescribeBandwidthRateLimitInput) String added in v0.6.5 

func (s DescribeBandwidthRateLimitInput) String() string

String returns the string representation

func (*DescribeBandwidthRateLimitInput) Validate added in v1.1.21 

func (s *DescribeBandwidthRateLimitInput) Validate() error

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

type DescribeBandwidthRateLimitOutput 

type DescribeBandwidthRateLimitOutput struct {

	// The average download bandwidth rate limit in bits per second. This field
	// does not appear in the response if the download rate limit is not set.
	AverageDownloadRateLimitInBitsPerSec *int64 `min:"102400" type:"long"`

	// The average upload bandwidth rate limit in bits per second. This field does
	// not appear in the response if the upload rate limit is not set.
	AverageUploadRateLimitInBitsPerSec *int64 `min:"51200" type:"long"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

func (DescribeBandwidthRateLimitOutput) GoString added in v0.6.5 

func (s DescribeBandwidthRateLimitOutput) GoString() string

GoString returns the string representation

func (*DescribeBandwidthRateLimitOutput) SetAverageDownloadRateLimitInBitsPerSec added in v1.5.0 

func (s *DescribeBandwidthRateLimitOutput) SetAverageDownloadRateLimitInBitsPerSec(v int64) *DescribeBandwidthRateLimitOutput

SetAverageDownloadRateLimitInBitsPerSec sets the AverageDownloadRateLimitInBitsPerSec field's value.

func (*DescribeBandwidthRateLimitOutput) SetAverageUploadRateLimitInBitsPerSec added in v1.5.0 

func (s *DescribeBandwidthRateLimitOutput) SetAverageUploadRateLimitInBitsPerSec(v int64) *DescribeBandwidthRateLimitOutput

SetAverageUploadRateLimitInBitsPerSec sets the AverageUploadRateLimitInBitsPerSec field's value.

func (*DescribeBandwidthRateLimitOutput) SetGatewayARN added in v1.5.0 

func (s *DescribeBandwidthRateLimitOutput) SetGatewayARN(v string) *DescribeBandwidthRateLimitOutput

SetGatewayARN sets the GatewayARN field's value.

func (DescribeBandwidthRateLimitOutput) String added in v0.6.5 

func (s DescribeBandwidthRateLimitOutput) String() string

String returns the string representation

type DescribeCacheInput 

type DescribeCacheInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCacheInput) GoString added in v0.6.5 

func (s DescribeCacheInput) GoString() string

GoString returns the string representation

func (*DescribeCacheInput) SetGatewayARN added in v1.5.0 

func (s *DescribeCacheInput) SetGatewayARN(v string) *DescribeCacheInput

SetGatewayARN sets the GatewayARN field's value.

func (DescribeCacheInput) String added in v0.6.5 

func (s DescribeCacheInput) String() string

String returns the string representation

func (*DescribeCacheInput) Validate added in v1.1.21 

func (s *DescribeCacheInput) Validate() error

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

type DescribeCacheOutput 

type DescribeCacheOutput struct {
	CacheAllocatedInBytes *int64 `type:"long"`

	CacheDirtyPercentage *float64 `type:"double"`

	CacheHitPercentage *float64 `type:"double"`

	CacheMissPercentage *float64 `type:"double"`

	CacheUsedPercentage *float64 `type:"double"`

	DiskIds []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeCacheOutput) GoString added in v0.6.5 

func (s DescribeCacheOutput) GoString() string

GoString returns the string representation

func (*DescribeCacheOutput) SetCacheAllocatedInBytes added in v1.5.0 

func (s *DescribeCacheOutput) SetCacheAllocatedInBytes(v int64) *DescribeCacheOutput

SetCacheAllocatedInBytes sets the CacheAllocatedInBytes field's value.

func (*DescribeCacheOutput) SetCacheDirtyPercentage added in v1.5.0 

func (s *DescribeCacheOutput) SetCacheDirtyPercentage(v float64) *DescribeCacheOutput

SetCacheDirtyPercentage sets the CacheDirtyPercentage field's value.

func (*DescribeCacheOutput) SetCacheHitPercentage added in v1.5.0 

func (s *DescribeCacheOutput) SetCacheHitPercentage(v float64) *DescribeCacheOutput

SetCacheHitPercentage sets the CacheHitPercentage field's value.

func (*DescribeCacheOutput) SetCacheMissPercentage added in v1.5.0 

func (s *DescribeCacheOutput) SetCacheMissPercentage(v float64) *DescribeCacheOutput

SetCacheMissPercentage sets the CacheMissPercentage field's value.

func (*DescribeCacheOutput) SetCacheUsedPercentage added in v1.5.0 

func (s *DescribeCacheOutput) SetCacheUsedPercentage(v float64) *DescribeCacheOutput

SetCacheUsedPercentage sets the CacheUsedPercentage field's value.

func (*DescribeCacheOutput) SetDiskIds added in v1.5.0 

func (s *DescribeCacheOutput) SetDiskIds(v []*string) *DescribeCacheOutput

SetDiskIds sets the DiskIds field's value.

func (*DescribeCacheOutput) SetGatewayARN added in v1.5.0 

func (s *DescribeCacheOutput) SetGatewayARN(v string) *DescribeCacheOutput

SetGatewayARN sets the GatewayARN field's value.

func (DescribeCacheOutput) String added in v0.6.5 

func (s DescribeCacheOutput) String() string

String returns the string representation

type DescribeCachediSCSIVolumesInput 

type DescribeCachediSCSIVolumesInput struct {

	// VolumeARNs is a required field
	VolumeARNs []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCachediSCSIVolumesInput) GoString added in v0.6.5 

func (s DescribeCachediSCSIVolumesInput) GoString() string

GoString returns the string representation

func (*DescribeCachediSCSIVolumesInput) SetVolumeARNs added in v1.5.0 

func (s *DescribeCachediSCSIVolumesInput) SetVolumeARNs(v []*string) *DescribeCachediSCSIVolumesInput

SetVolumeARNs sets the VolumeARNs field's value.

func (DescribeCachediSCSIVolumesInput) String added in v0.6.5 

func (s DescribeCachediSCSIVolumesInput) String() string

String returns the string representation

func (*DescribeCachediSCSIVolumesInput) Validate added in v1.1.21 

func (s *DescribeCachediSCSIVolumesInput) Validate() error

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

type DescribeCachediSCSIVolumesOutput 

type DescribeCachediSCSIVolumesOutput struct {

	// An array of objects where each object contains metadata about one cached
	// volume.
	CachediSCSIVolumes []*CachediSCSIVolume `type:"list"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

func (DescribeCachediSCSIVolumesOutput) GoString added in v0.6.5 

func (s DescribeCachediSCSIVolumesOutput) GoString() string

GoString returns the string representation

func (*DescribeCachediSCSIVolumesOutput) SetCachediSCSIVolumes added in v1.5.0 

func (s *DescribeCachediSCSIVolumesOutput) SetCachediSCSIVolumes(v []*CachediSCSIVolume) *DescribeCachediSCSIVolumesOutput

SetCachediSCSIVolumes sets the CachediSCSIVolumes field's value.

func (DescribeCachediSCSIVolumesOutput) String added in v0.6.5 

func (s DescribeCachediSCSIVolumesOutput) String() string

String returns the string representation

type DescribeChapCredentialsInput 

type DescribeChapCredentialsInput struct {

	// The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
	// operation to return to retrieve the TargetARN for specified VolumeARN.
	//
	// TargetARN is a required field
	TargetARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.

func (DescribeChapCredentialsInput) GoString added in v0.6.5 

func (s DescribeChapCredentialsInput) GoString() string

GoString returns the string representation

func (*DescribeChapCredentialsInput) SetTargetARN added in v1.5.0 

func (s *DescribeChapCredentialsInput) SetTargetARN(v string) *DescribeChapCredentialsInput

SetTargetARN sets the TargetARN field's value.

func (DescribeChapCredentialsInput) String added in v0.6.5 

func (s DescribeChapCredentialsInput) String() string

String returns the string representation

func (*DescribeChapCredentialsInput) Validate added in v1.1.21 

func (s *DescribeChapCredentialsInput) Validate() error

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

type DescribeChapCredentialsOutput 

type DescribeChapCredentialsOutput struct {

	// An array of ChapInfo objects that represent CHAP credentials. Each object
	// in the array contains CHAP credential information for one target-initiator
	// pair. If no CHAP credentials are set, an empty array is returned. CHAP credential
	// information is provided in a JSON object with the following fields:
	//
	//    * InitiatorName: The iSCSI initiator that connects to the target.
	//
	//    * SecretToAuthenticateInitiator: The secret key that the initiator (for
	//    example, the Windows client) must provide to participate in mutual CHAP
	//    with the target.
	//
	//    * SecretToAuthenticateTarget: The secret key that the target must provide
	//    to participate in mutual CHAP with the initiator (e.g. Windows client).
	//
	//    * TargetARN: The Amazon Resource Name (ARN) of the storage volume.
	ChapCredentials []*ChapInfo `type:"list"`
	// contains filtered or unexported fields
}

A JSON object containing a .

func (DescribeChapCredentialsOutput) GoString added in v0.6.5 

func (s DescribeChapCredentialsOutput) GoString() string

GoString returns the string representation

func (*DescribeChapCredentialsOutput) SetChapCredentials added in v1.5.0 

func (s *DescribeChapCredentialsOutput) SetChapCredentials(v []*ChapInfo) *DescribeChapCredentialsOutput

SetChapCredentials sets the ChapCredentials field's value.

func (DescribeChapCredentialsOutput) String added in v0.6.5 

func (s DescribeChapCredentialsOutput) String() string

String returns the string representation

type DescribeGatewayInformationInput 

type DescribeGatewayInformationInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the ID of the gateway.

func (DescribeGatewayInformationInput) GoString added in v0.6.5 

func (s DescribeGatewayInformationInput) GoString() string

GoString returns the string representation

func (*DescribeGatewayInformationInput) SetGatewayARN added in v1.5.0 

func (s *DescribeGatewayInformationInput) SetGatewayARN(v string) *DescribeGatewayInformationInput

SetGatewayARN sets the GatewayARN field's value.

func (DescribeGatewayInformationInput) String added in v0.6.5 

func (s DescribeGatewayInformationInput) String() string

String returns the string representation

func (*DescribeGatewayInformationInput) Validate added in v1.1.21 

func (s *DescribeGatewayInformationInput) Validate() error

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

type DescribeGatewayInformationOutput 

type DescribeGatewayInformationOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// The unique identifier assigned to your gateway during activation. This ID
	// becomes part of the gateway Amazon Resource Name (ARN), which you use as
	// input for other operations.
	GatewayId *string `min:"12" type:"string"`

	// The name you configured for your gateway.
	GatewayName *string `type:"string"`

	// A NetworkInterface array that contains descriptions of the gateway network
	// interfaces.
	GatewayNetworkInterfaces []*NetworkInterface `type:"list"`

	// A value that indicates the operating state of the gateway.
	GatewayState *string `min:"2" type:"string"`

	// A value that indicates the time zone configured for the gateway.
	GatewayTimezone *string `min:"3" type:"string"`

	// The type of the gateway.
	GatewayType *string `min:"2" type:"string"`

	// The date on which the last software update was applied to the gateway. If
	// the gateway has never been updated, this field does not return a value in
	// the response.
	LastSoftwareUpdate *string `min:"1" type:"string"`

	// The date on which an update to the gateway is available. This date is in
	// the time zone of the gateway. If the gateway is not available for an update
	// this field is not returned in the response.
	NextUpdateAvailabilityDate *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

func (DescribeGatewayInformationOutput) GoString added in v0.6.5 

func (s DescribeGatewayInformationOutput) GoString() string

GoString returns the string representation

func (*DescribeGatewayInformationOutput) SetGatewayARN added in v1.5.0 

func (s *DescribeGatewayInformationOutput) SetGatewayARN(v string) *DescribeGatewayInformationOutput

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeGatewayInformationOutput) SetGatewayId added in v1.5.0 

func (s *DescribeGatewayInformationOutput) SetGatewayId(v string) *DescribeGatewayInformationOutput

SetGatewayId sets the GatewayId field's value.

func (*DescribeGatewayInformationOutput) SetGatewayName added in v1.5.0 

func (s *DescribeGatewayInformationOutput) SetGatewayName(v string) *DescribeGatewayInformationOutput

SetGatewayName sets the GatewayName field's value.

func (*DescribeGatewayInformationOutput) SetGatewayNetworkInterfaces added in v1.5.0 

func (s *DescribeGatewayInformationOutput) SetGatewayNetworkInterfaces(v []*NetworkInterface) *DescribeGatewayInformationOutput

SetGatewayNetworkInterfaces sets the GatewayNetworkInterfaces field's value.

func (*DescribeGatewayInformationOutput) SetGatewayState added in v1.5.0 

func (s *DescribeGatewayInformationOutput) SetGatewayState(v string) *DescribeGatewayInformationOutput

SetGatewayState sets the GatewayState field's value.

func (*DescribeGatewayInformationOutput) SetGatewayTimezone added in v1.5.0 

func (s *DescribeGatewayInformationOutput) SetGatewayTimezone(v string) *DescribeGatewayInformationOutput

SetGatewayTimezone sets the GatewayTimezone field's value.

func (*DescribeGatewayInformationOutput) SetGatewayType added in v1.5.0 

func (s *DescribeGatewayInformationOutput) SetGatewayType(v string) *DescribeGatewayInformationOutput

SetGatewayType sets the GatewayType field's value.

func (*DescribeGatewayInformationOutput) SetLastSoftwareUpdate added in v1.5.0 

func (s *DescribeGatewayInformationOutput) SetLastSoftwareUpdate(v string) *DescribeGatewayInformationOutput

SetLastSoftwareUpdate sets the LastSoftwareUpdate field's value.

func (*DescribeGatewayInformationOutput) SetNextUpdateAvailabilityDate added in v1.5.0 

func (s *DescribeGatewayInformationOutput) SetNextUpdateAvailabilityDate(v string) *DescribeGatewayInformationOutput

SetNextUpdateAvailabilityDate sets the NextUpdateAvailabilityDate field's value.

func (DescribeGatewayInformationOutput) String added in v0.6.5 

func (s DescribeGatewayInformationOutput) String() string

String returns the string representation

type DescribeMaintenanceStartTimeInput 

type DescribeMaintenanceStartTimeInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway.

func (DescribeMaintenanceStartTimeInput) GoString added in v0.6.5 

func (s DescribeMaintenanceStartTimeInput) GoString() string

GoString returns the string representation

func (*DescribeMaintenanceStartTimeInput) SetGatewayARN added in v1.5.0 

func (s *DescribeMaintenanceStartTimeInput) SetGatewayARN(v string) *DescribeMaintenanceStartTimeInput

SetGatewayARN sets the GatewayARN field's value.

func (DescribeMaintenanceStartTimeInput) String added in v0.6.5 

func (s DescribeMaintenanceStartTimeInput) String() string

String returns the string representation

func (*DescribeMaintenanceStartTimeInput) Validate added in v1.1.21 

func (s *DescribeMaintenanceStartTimeInput) Validate() error

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

type DescribeMaintenanceStartTimeOutput 

type DescribeMaintenanceStartTimeOutput struct {

	// An ordinal number between 0 and 6 that represents the day of the week, where
	// 0 represents Sunday and 6 represents Saturday. The day of week is in the
	// time zone of the gateway.
	DayOfWeek *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// The hour component of the maintenance start time represented as hh, where
	// hh is the hour (0 to 23). The hour of the day is in the time zone of the
	// gateway.
	HourOfDay *int64 `type:"integer"`

	// The minute component of the maintenance start time represented as mm, where
	// mm is the minute (0 to 59). The minute of the hour is in the time zone of
	// the gateway.
	MinuteOfHour *int64 `type:"integer"`

	Timezone *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

  • DescribeMaintenanceStartTimeOutput$DayOfWeek

  • DescribeMaintenanceStartTimeOutput$HourOfDay

  • DescribeMaintenanceStartTimeOutput$MinuteOfHour

  • DescribeMaintenanceStartTimeOutput$Timezone

func (DescribeMaintenanceStartTimeOutput) GoString added in v0.6.5 

func (s DescribeMaintenanceStartTimeOutput) GoString() string

GoString returns the string representation

func (*DescribeMaintenanceStartTimeOutput) SetDayOfWeek added in v1.5.0 

func (s *DescribeMaintenanceStartTimeOutput) SetDayOfWeek(v int64) *DescribeMaintenanceStartTimeOutput

SetDayOfWeek sets the DayOfWeek field's value.

func (*DescribeMaintenanceStartTimeOutput) SetGatewayARN added in v1.5.0 

func (s *DescribeMaintenanceStartTimeOutput) SetGatewayARN(v string) *DescribeMaintenanceStartTimeOutput

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeMaintenanceStartTimeOutput) SetHourOfDay added in v1.5.0 

func (s *DescribeMaintenanceStartTimeOutput) SetHourOfDay(v int64) *DescribeMaintenanceStartTimeOutput

SetHourOfDay sets the HourOfDay field's value.

func (*DescribeMaintenanceStartTimeOutput) SetMinuteOfHour added in v1.5.0 

func (s *DescribeMaintenanceStartTimeOutput) SetMinuteOfHour(v int64) *DescribeMaintenanceStartTimeOutput

SetMinuteOfHour sets the MinuteOfHour field's value.

func (*DescribeMaintenanceStartTimeOutput) SetTimezone added in v1.5.0 

func (s *DescribeMaintenanceStartTimeOutput) SetTimezone(v string) *DescribeMaintenanceStartTimeOutput

SetTimezone sets the Timezone field's value.

func (DescribeMaintenanceStartTimeOutput) String added in v0.6.5 

func (s DescribeMaintenanceStartTimeOutput) String() string

String returns the string representation

type DescribeNFSFileSharesInput added in v1.6.6 

type DescribeNFSFileSharesInput struct {

	// An array containing the Amazon Resource Name (ARN) of each file share to
	// be described.
	//
	// FileShareARNList is a required field
	FileShareARNList []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

DescribeNFSFileSharesInput

func (DescribeNFSFileSharesInput) GoString added in v1.6.6 

func (s DescribeNFSFileSharesInput) GoString() string

GoString returns the string representation

func (*DescribeNFSFileSharesInput) SetFileShareARNList added in v1.6.6 

func (s *DescribeNFSFileSharesInput) SetFileShareARNList(v []*string) *DescribeNFSFileSharesInput

SetFileShareARNList sets the FileShareARNList field's value.

func (DescribeNFSFileSharesInput) String added in v1.6.6 

func (s DescribeNFSFileSharesInput) String() string

String returns the string representation

func (*DescribeNFSFileSharesInput) Validate added in v1.6.6 

func (s *DescribeNFSFileSharesInput) Validate() error

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

type DescribeNFSFileSharesOutput added in v1.6.6 

type DescribeNFSFileSharesOutput struct {

	// An array containing a description for each requested file share.
	NFSFileShareInfoList []*NFSFileShareInfo `type:"list"`
	// contains filtered or unexported fields
}

DescribeNFSFileSharesOutput

func (DescribeNFSFileSharesOutput) GoString added in v1.6.6 

func (s DescribeNFSFileSharesOutput) GoString() string

GoString returns the string representation

func (*DescribeNFSFileSharesOutput) SetNFSFileShareInfoList added in v1.6.6 

func (s *DescribeNFSFileSharesOutput) SetNFSFileShareInfoList(v []*NFSFileShareInfo) *DescribeNFSFileSharesOutput

SetNFSFileShareInfoList sets the NFSFileShareInfoList field's value.

func (DescribeNFSFileSharesOutput) String added in v1.6.6 

func (s DescribeNFSFileSharesOutput) String() string

String returns the string representation

type DescribeSnapshotScheduleInput 

type DescribeSnapshotScheduleInput struct {

	// The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
	// to return a list of gateway volumes.
	//
	// VolumeARN is a required field
	VolumeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.

func (DescribeSnapshotScheduleInput) GoString added in v0.6.5 

func (s DescribeSnapshotScheduleInput) GoString() string

GoString returns the string representation

func (*DescribeSnapshotScheduleInput) SetVolumeARN added in v1.5.0 

func (s *DescribeSnapshotScheduleInput) SetVolumeARN(v string) *DescribeSnapshotScheduleInput

SetVolumeARN sets the VolumeARN field's value.

func (DescribeSnapshotScheduleInput) String added in v0.6.5 

func (s DescribeSnapshotScheduleInput) String() string

String returns the string representation

func (*DescribeSnapshotScheduleInput) Validate added in v1.1.21 

func (s *DescribeSnapshotScheduleInput) Validate() error

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

type DescribeSnapshotScheduleOutput 

type DescribeSnapshotScheduleOutput struct {
	Description *string `min:"1" type:"string"`

	RecurrenceInHours *int64 `min:"1" type:"integer"`

	StartAt *int64 `type:"integer"`

	Timezone *string `min:"3" type:"string"`

	VolumeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeSnapshotScheduleOutput) GoString added in v0.6.5 

func (s DescribeSnapshotScheduleOutput) GoString() string

GoString returns the string representation

func (*DescribeSnapshotScheduleOutput) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*DescribeSnapshotScheduleOutput) SetRecurrenceInHours added in v1.5.0 

func (s *DescribeSnapshotScheduleOutput) SetRecurrenceInHours(v int64) *DescribeSnapshotScheduleOutput

SetRecurrenceInHours sets the RecurrenceInHours field's value.

func (*DescribeSnapshotScheduleOutput) SetStartAt added in v1.5.0 

func (s *DescribeSnapshotScheduleOutput) SetStartAt(v int64) *DescribeSnapshotScheduleOutput

SetStartAt sets the StartAt field's value.

func (*DescribeSnapshotScheduleOutput) SetTimezone added in v1.5.0 

func (s *DescribeSnapshotScheduleOutput) SetTimezone(v string) *DescribeSnapshotScheduleOutput

SetTimezone sets the Timezone field's value.

func (*DescribeSnapshotScheduleOutput) SetVolumeARN added in v1.5.0 

func (s *DescribeSnapshotScheduleOutput) SetVolumeARN(v string) *DescribeSnapshotScheduleOutput

SetVolumeARN sets the VolumeARN field's value.

func (DescribeSnapshotScheduleOutput) String added in v0.6.5 

func (s DescribeSnapshotScheduleOutput) String() string

String returns the string representation

type DescribeStorediSCSIVolumesInput 

type DescribeStorediSCSIVolumesInput struct {

	// An array of strings where each string represents the Amazon Resource Name
	// (ARN) of a stored volume. All of the specified stored volumes must from the
	// same gateway. Use ListVolumes to get volume ARNs for a gateway.
	//
	// VolumeARNs is a required field
	VolumeARNs []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

func (DescribeStorediSCSIVolumesInput) GoString added in v0.6.5 

func (s DescribeStorediSCSIVolumesInput) GoString() string

GoString returns the string representation

func (*DescribeStorediSCSIVolumesInput) SetVolumeARNs added in v1.5.0 

func (s *DescribeStorediSCSIVolumesInput) SetVolumeARNs(v []*string) *DescribeStorediSCSIVolumesInput

SetVolumeARNs sets the VolumeARNs field's value.

func (DescribeStorediSCSIVolumesInput) String added in v0.6.5 

func (s DescribeStorediSCSIVolumesInput) String() string

String returns the string representation

func (*DescribeStorediSCSIVolumesInput) Validate added in v1.1.21 

func (s *DescribeStorediSCSIVolumesInput) Validate() error

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

type DescribeStorediSCSIVolumesOutput 

type DescribeStorediSCSIVolumesOutput struct {
	StorediSCSIVolumes []*StorediSCSIVolume `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeStorediSCSIVolumesOutput) GoString added in v0.6.5 

func (s DescribeStorediSCSIVolumesOutput) GoString() string

GoString returns the string representation

func (*DescribeStorediSCSIVolumesOutput) SetStorediSCSIVolumes added in v1.5.0 

func (s *DescribeStorediSCSIVolumesOutput) SetStorediSCSIVolumes(v []*StorediSCSIVolume) *DescribeStorediSCSIVolumesOutput

SetStorediSCSIVolumes sets the StorediSCSIVolumes field's value.

func (DescribeStorediSCSIVolumesOutput) String added in v0.6.5 

func (s DescribeStorediSCSIVolumesOutput) String() string

String returns the string representation

type DescribeTapeArchivesInput 

type DescribeTapeArchivesInput struct {

	// Specifies that the number of virtual tapes descried be limited to the specified
	// number.
	Limit *int64 `min:"1" type:"integer"`

	// An opaque string that indicates the position at which to begin describing
	// virtual tapes.
	Marker *string `min:"1" type:"string"`

	// Specifies one or more unique Amazon Resource Names (ARNs) that represent
	// the virtual tapes you want to describe.
	TapeARNs []*string `type:"list"`
	// contains filtered or unexported fields
}

DescribeTapeArchivesInput

func (DescribeTapeArchivesInput) GoString added in v0.6.5 

func (s DescribeTapeArchivesInput) GoString() string

GoString returns the string representation

func (*DescribeTapeArchivesInput) SetLimit added in v1.5.0 

func (s *DescribeTapeArchivesInput) SetLimit(v int64) *DescribeTapeArchivesInput

SetLimit sets the Limit field's value.

func (*DescribeTapeArchivesInput) SetMarker added in v1.5.0 

func (s *DescribeTapeArchivesInput) SetMarker(v string) *DescribeTapeArchivesInput

SetMarker sets the Marker field's value.

func (*DescribeTapeArchivesInput) SetTapeARNs added in v1.5.0 

func (s *DescribeTapeArchivesInput) SetTapeARNs(v []*string) *DescribeTapeArchivesInput

SetTapeARNs sets the TapeARNs field's value.

func (DescribeTapeArchivesInput) String added in v0.6.5 

func (s DescribeTapeArchivesInput) String() string

String returns the string representation

func (*DescribeTapeArchivesInput) Validate added in v1.1.21 

func (s *DescribeTapeArchivesInput) Validate() error

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

type DescribeTapeArchivesOutput 

type DescribeTapeArchivesOutput struct {

	// An opaque string that indicates the position at which the virtual tapes that
	// were fetched for description ended. Use this marker in your next request
	// to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If
	// there are no more virtual tapes to describe, this field does not appear in
	// the response.
	Marker *string `min:"1" type:"string"`

	// An array of virtual tape objects in the virtual tape shelf (VTS). The description
	// includes of the Amazon Resource Name(ARN) of the virtual tapes. The information
	// returned includes the Amazon Resource Names (ARNs) of the tapes, size of
	// the tapes, status of the tapes, progress of the description and tape barcode.
	TapeArchives []*TapeArchive `type:"list"`
	// contains filtered or unexported fields
}

DescribeTapeArchivesOutput

func (DescribeTapeArchivesOutput) GoString added in v0.6.5 

func (s DescribeTapeArchivesOutput) GoString() string

GoString returns the string representation

func (*DescribeTapeArchivesOutput) SetMarker added in v1.5.0 

func (s *DescribeTapeArchivesOutput) SetMarker(v string) *DescribeTapeArchivesOutput

SetMarker sets the Marker field's value.

func (*DescribeTapeArchivesOutput) SetTapeArchives added in v1.5.0 

func (s *DescribeTapeArchivesOutput) SetTapeArchives(v []*TapeArchive) *DescribeTapeArchivesOutput

SetTapeArchives sets the TapeArchives field's value.

func (DescribeTapeArchivesOutput) String added in v0.6.5 

func (s DescribeTapeArchivesOutput) String() string

String returns the string representation

type DescribeTapeRecoveryPointsInput 

type DescribeTapeRecoveryPointsInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// Specifies that the number of virtual tape recovery points that are described
	// be limited to the specified number.
	Limit *int64 `min:"1" type:"integer"`

	// An opaque string that indicates the position at which to begin describing
	// the virtual tape recovery points.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

DescribeTapeRecoveryPointsInput

func (DescribeTapeRecoveryPointsInput) GoString added in v0.6.5 

func (s DescribeTapeRecoveryPointsInput) GoString() string

GoString returns the string representation

func (*DescribeTapeRecoveryPointsInput) SetGatewayARN added in v1.5.0 

func (s *DescribeTapeRecoveryPointsInput) SetGatewayARN(v string) *DescribeTapeRecoveryPointsInput

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeTapeRecoveryPointsInput) SetLimit added in v1.5.0 

func (s *DescribeTapeRecoveryPointsInput) SetLimit(v int64) *DescribeTapeRecoveryPointsInput

SetLimit sets the Limit field's value.

func (*DescribeTapeRecoveryPointsInput) SetMarker added in v1.5.0 

func (s *DescribeTapeRecoveryPointsInput) SetMarker(v string) *DescribeTapeRecoveryPointsInput

SetMarker sets the Marker field's value.

func (DescribeTapeRecoveryPointsInput) String added in v0.6.5 

func (s DescribeTapeRecoveryPointsInput) String() string

String returns the string representation

func (*DescribeTapeRecoveryPointsInput) Validate added in v1.1.21 

func (s *DescribeTapeRecoveryPointsInput) Validate() error

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

type DescribeTapeRecoveryPointsOutput 

type DescribeTapeRecoveryPointsOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// An opaque string that indicates the position at which the virtual tape recovery
	// points that were listed for description ended.
	//
	// Use this marker in your next request to list the next set of virtual tape
	// recovery points in the list. If there are no more recovery points to describe,
	// this field does not appear in the response.
	Marker *string `min:"1" type:"string"`

	// An array of TapeRecoveryPointInfos that are available for the specified gateway.
	TapeRecoveryPointInfos []*TapeRecoveryPointInfo `type:"list"`
	// contains filtered or unexported fields
}

DescribeTapeRecoveryPointsOutput

func (DescribeTapeRecoveryPointsOutput) GoString added in v0.6.5 

func (s DescribeTapeRecoveryPointsOutput) GoString() string

GoString returns the string representation

func (*DescribeTapeRecoveryPointsOutput) SetGatewayARN added in v1.5.0 

func (s *DescribeTapeRecoveryPointsOutput) SetGatewayARN(v string) *DescribeTapeRecoveryPointsOutput

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeTapeRecoveryPointsOutput) SetMarker added in v1.5.0 

func (s *DescribeTapeRecoveryPointsOutput) SetMarker(v string) *DescribeTapeRecoveryPointsOutput

SetMarker sets the Marker field's value.

func (*DescribeTapeRecoveryPointsOutput) SetTapeRecoveryPointInfos added in v1.5.0 

func (s *DescribeTapeRecoveryPointsOutput) SetTapeRecoveryPointInfos(v []*TapeRecoveryPointInfo) *DescribeTapeRecoveryPointsOutput

SetTapeRecoveryPointInfos sets the TapeRecoveryPointInfos field's value.

func (DescribeTapeRecoveryPointsOutput) String added in v0.6.5 

func (s DescribeTapeRecoveryPointsOutput) String() string

String returns the string representation

type DescribeTapesInput 

type DescribeTapesInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// Specifies that the number of virtual tapes described be limited to the specified
	// number.
	//
	// Amazon Web Services may impose its own limit, if this field is not set.
	Limit *int64 `min:"1" type:"integer"`

	// A marker value, obtained in a previous call to DescribeTapes. This marker
	// indicates which page of results to retrieve.
	//
	// If not specified, the first page of results is retrieved.
	Marker *string `min:"1" type:"string"`

	// Specifies one or more unique Amazon Resource Names (ARNs) that represent
	// the virtual tapes you want to describe. If this parameter is not specified,
	// Tape gateway returns a description of all virtual tapes associated with the
	// specified gateway.
	TapeARNs []*string `type:"list"`
	// contains filtered or unexported fields
}

DescribeTapesInput

func (DescribeTapesInput) GoString added in v0.6.5 

func (s DescribeTapesInput) GoString() string

GoString returns the string representation

func (*DescribeTapesInput) SetGatewayARN added in v1.5.0 

func (s *DescribeTapesInput) SetGatewayARN(v string) *DescribeTapesInput

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeTapesInput) SetLimit added in v1.5.0 

func (s *DescribeTapesInput) SetLimit(v int64) *DescribeTapesInput

SetLimit sets the Limit field's value.

func (*DescribeTapesInput) SetMarker added in v1.5.0 

func (s *DescribeTapesInput) SetMarker(v string) *DescribeTapesInput

SetMarker sets the Marker field's value.

func (*DescribeTapesInput) SetTapeARNs added in v1.5.0 

func (s *DescribeTapesInput) SetTapeARNs(v []*string) *DescribeTapesInput

SetTapeARNs sets the TapeARNs field's value.

func (DescribeTapesInput) String added in v0.6.5 

func (s DescribeTapesInput) String() string

String returns the string representation

func (*DescribeTapesInput) Validate added in v1.1.21 

func (s *DescribeTapesInput) Validate() error

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

type DescribeTapesOutput 

type DescribeTapesOutput struct {

	// An opaque string which can be used as part of a subsequent DescribeTapes
	// call to retrieve the next page of results.
	//
	// If a response does not contain a marker, then there are no more results to
	// be retrieved.
	Marker *string `min:"1" type:"string"`

	// An array of virtual tape descriptions.
	Tapes []*Tape `type:"list"`
	// contains filtered or unexported fields
}

DescribeTapesOutput

func (DescribeTapesOutput) GoString added in v0.6.5 

func (s DescribeTapesOutput) GoString() string

GoString returns the string representation

func (*DescribeTapesOutput) SetMarker added in v1.5.0 

func (s *DescribeTapesOutput) SetMarker(v string) *DescribeTapesOutput

SetMarker sets the Marker field's value.

func (*DescribeTapesOutput) SetTapes added in v1.5.0 

func (s *DescribeTapesOutput) SetTapes(v []*Tape) *DescribeTapesOutput

SetTapes sets the Tapes field's value.

func (DescribeTapesOutput) String added in v0.6.5 

func (s DescribeTapesOutput) String() string

String returns the string representation

type DescribeUploadBufferInput 

type DescribeUploadBufferInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeUploadBufferInput) GoString added in v0.6.5 

func (s DescribeUploadBufferInput) GoString() string

GoString returns the string representation

func (*DescribeUploadBufferInput) SetGatewayARN added in v1.5.0 

func (s *DescribeUploadBufferInput) SetGatewayARN(v string) *DescribeUploadBufferInput

SetGatewayARN sets the GatewayARN field's value.

func (DescribeUploadBufferInput) String added in v0.6.5 

func (s DescribeUploadBufferInput) String() string

String returns the string representation

func (*DescribeUploadBufferInput) Validate added in v1.1.21 

func (s *DescribeUploadBufferInput) Validate() error

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

type DescribeUploadBufferOutput 

type DescribeUploadBufferOutput struct {
	DiskIds []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	UploadBufferAllocatedInBytes *int64 `type:"long"`

	UploadBufferUsedInBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (DescribeUploadBufferOutput) GoString added in v0.6.5 

func (s DescribeUploadBufferOutput) GoString() string

GoString returns the string representation

func (*DescribeUploadBufferOutput) SetDiskIds added in v1.5.0 

func (s *DescribeUploadBufferOutput) SetDiskIds(v []*string) *DescribeUploadBufferOutput

SetDiskIds sets the DiskIds field's value.

func (*DescribeUploadBufferOutput) SetGatewayARN added in v1.5.0 

func (s *DescribeUploadBufferOutput) SetGatewayARN(v string) *DescribeUploadBufferOutput

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeUploadBufferOutput) SetUploadBufferAllocatedInBytes added in v1.5.0 

func (s *DescribeUploadBufferOutput) SetUploadBufferAllocatedInBytes(v int64) *DescribeUploadBufferOutput

SetUploadBufferAllocatedInBytes sets the UploadBufferAllocatedInBytes field's value.

func (*DescribeUploadBufferOutput) SetUploadBufferUsedInBytes added in v1.5.0 

func (s *DescribeUploadBufferOutput) SetUploadBufferUsedInBytes(v int64) *DescribeUploadBufferOutput

SetUploadBufferUsedInBytes sets the UploadBufferUsedInBytes field's value.

func (DescribeUploadBufferOutput) String added in v0.6.5 

func (s DescribeUploadBufferOutput) String() string

String returns the string representation

type DescribeVTLDevicesInput 

type DescribeVTLDevicesInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// Specifies that the number of VTL devices described be limited to the specified
	// number.
	Limit *int64 `min:"1" type:"integer"`

	// An opaque string that indicates the position at which to begin describing
	// the VTL devices.
	Marker *string `min:"1" type:"string"`

	// An array of strings, where each string represents the Amazon Resource Name
	// (ARN) of a VTL device.
	//
	// All of the specified VTL devices must be from the same gateway. If no VTL
	// devices are specified, the result will contain all devices on the specified
	// gateway.
	VTLDeviceARNs []*string `type:"list"`
	// contains filtered or unexported fields
}

DescribeVTLDevicesInput

func (DescribeVTLDevicesInput) GoString added in v0.6.5 

func (s DescribeVTLDevicesInput) GoString() string

GoString returns the string representation

func (*DescribeVTLDevicesInput) SetGatewayARN added in v1.5.0 

func (s *DescribeVTLDevicesInput) SetGatewayARN(v string) *DescribeVTLDevicesInput

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeVTLDevicesInput) SetLimit added in v1.5.0 

func (s *DescribeVTLDevicesInput) SetLimit(v int64) *DescribeVTLDevicesInput

SetLimit sets the Limit field's value.

func (*DescribeVTLDevicesInput) SetMarker added in v1.5.0 

func (s *DescribeVTLDevicesInput) SetMarker(v string) *DescribeVTLDevicesInput

SetMarker sets the Marker field's value.

func (*DescribeVTLDevicesInput) SetVTLDeviceARNs added in v1.5.0 

func (s *DescribeVTLDevicesInput) SetVTLDeviceARNs(v []*string) *DescribeVTLDevicesInput

SetVTLDeviceARNs sets the VTLDeviceARNs field's value.

func (DescribeVTLDevicesInput) String added in v0.6.5 

func (s DescribeVTLDevicesInput) String() string

String returns the string representation

func (*DescribeVTLDevicesInput) Validate added in v1.1.21 

func (s *DescribeVTLDevicesInput) Validate() error

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

type DescribeVTLDevicesOutput 

type DescribeVTLDevicesOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// An opaque string that indicates the position at which the VTL devices that
	// were fetched for description ended. Use the marker in your next request to
	// fetch the next set of VTL devices in the list. If there are no more VTL devices
	// to describe, this field does not appear in the response.
	Marker *string `min:"1" type:"string"`

	// An array of VTL device objects composed of the Amazon Resource Name(ARN)
	// of the VTL devices.
	VTLDevices []*VTLDevice `type:"list"`
	// contains filtered or unexported fields
}

DescribeVTLDevicesOutput

func (DescribeVTLDevicesOutput) GoString added in v0.6.5 

func (s DescribeVTLDevicesOutput) GoString() string

GoString returns the string representation

func (*DescribeVTLDevicesOutput) SetGatewayARN added in v1.5.0 

func (s *DescribeVTLDevicesOutput) SetGatewayARN(v string) *DescribeVTLDevicesOutput

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeVTLDevicesOutput) SetMarker added in v1.5.0 

func (s *DescribeVTLDevicesOutput) SetMarker(v string) *DescribeVTLDevicesOutput

SetMarker sets the Marker field's value.

func (*DescribeVTLDevicesOutput) SetVTLDevices added in v1.5.0 

func (s *DescribeVTLDevicesOutput) SetVTLDevices(v []*VTLDevice) *DescribeVTLDevicesOutput

SetVTLDevices sets the VTLDevices field's value.

func (DescribeVTLDevicesOutput) String added in v0.6.5 

func (s DescribeVTLDevicesOutput) String() string

String returns the string representation

type DescribeWorkingStorageInput 

type DescribeWorkingStorageInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway.

func (DescribeWorkingStorageInput) GoString added in v0.6.5 

func (s DescribeWorkingStorageInput) GoString() string

GoString returns the string representation

func (*DescribeWorkingStorageInput) SetGatewayARN added in v1.5.0 

func (s *DescribeWorkingStorageInput) SetGatewayARN(v string) *DescribeWorkingStorageInput

SetGatewayARN sets the GatewayARN field's value.

func (DescribeWorkingStorageInput) String added in v0.6.5 

func (s DescribeWorkingStorageInput) String() string

String returns the string representation

func (*DescribeWorkingStorageInput) Validate added in v1.1.21 

func (s *DescribeWorkingStorageInput) Validate() error

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

type DescribeWorkingStorageOutput 

type DescribeWorkingStorageOutput struct {

	// An array of the gateway's local disk IDs that are configured as working storage.
	// Each local disk ID is specified as a string (minimum length of 1 and maximum
	// length of 300). If no local disks are configured as working storage, then
	// the DiskIds array is empty.
	DiskIds []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// The total working storage in bytes allocated for the gateway. If no working
	// storage is configured for the gateway, this field returns 0.
	WorkingStorageAllocatedInBytes *int64 `type:"long"`

	// The total working storage in bytes in use by the gateway. If no working storage
	// is configured for the gateway, this field returns 0.
	WorkingStorageUsedInBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

func (DescribeWorkingStorageOutput) GoString added in v0.6.5 

func (s DescribeWorkingStorageOutput) GoString() string

GoString returns the string representation

func (*DescribeWorkingStorageOutput) SetDiskIds added in v1.5.0 

func (s *DescribeWorkingStorageOutput) SetDiskIds(v []*string) *DescribeWorkingStorageOutput

SetDiskIds sets the DiskIds field's value.

func (*DescribeWorkingStorageOutput) SetGatewayARN added in v1.5.0 

func (s *DescribeWorkingStorageOutput) SetGatewayARN(v string) *DescribeWorkingStorageOutput

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeWorkingStorageOutput) SetWorkingStorageAllocatedInBytes added in v1.5.0 

func (s *DescribeWorkingStorageOutput) SetWorkingStorageAllocatedInBytes(v int64) *DescribeWorkingStorageOutput

SetWorkingStorageAllocatedInBytes sets the WorkingStorageAllocatedInBytes field's value.

func (*DescribeWorkingStorageOutput) SetWorkingStorageUsedInBytes added in v1.5.0 

func (s *DescribeWorkingStorageOutput) SetWorkingStorageUsedInBytes(v int64) *DescribeWorkingStorageOutput

SetWorkingStorageUsedInBytes sets the WorkingStorageUsedInBytes field's value.

func (DescribeWorkingStorageOutput) String added in v0.6.5 

func (s DescribeWorkingStorageOutput) String() string

String returns the string representation

type DeviceiSCSIAttributes 

type DeviceiSCSIAttributes struct {

	// Indicates whether mutual CHAP is enabled for the iSCSI target.
	ChapEnabled *bool `type:"boolean"`

	// The network interface identifier of the VTL device.
	NetworkInterfaceId *string `type:"string"`

	// The port used to communicate with iSCSI VTL device targets.
	NetworkInterfacePort *int64 `type:"integer"`

	// Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified
	// name(iqn) of a tape drive or media changer target.
	TargetARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

Lists iSCSI information about a VTL device.

func (DeviceiSCSIAttributes) GoString added in v0.6.5 

func (s DeviceiSCSIAttributes) GoString() string

GoString returns the string representation

func (*DeviceiSCSIAttributes) SetChapEnabled added in v1.5.0 

func (s *DeviceiSCSIAttributes) SetChapEnabled(v bool) *DeviceiSCSIAttributes

SetChapEnabled sets the ChapEnabled field's value.

func (*DeviceiSCSIAttributes) SetNetworkInterfaceId added in v1.5.0 

func (s *DeviceiSCSIAttributes) SetNetworkInterfaceId(v string) *DeviceiSCSIAttributes

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*DeviceiSCSIAttributes) SetNetworkInterfacePort added in v1.5.0 

func (s *DeviceiSCSIAttributes) SetNetworkInterfacePort(v int64) *DeviceiSCSIAttributes

SetNetworkInterfacePort sets the NetworkInterfacePort field's value.

func (*DeviceiSCSIAttributes) SetTargetARN added in v1.5.0 

func (s *DeviceiSCSIAttributes) SetTargetARN(v string) *DeviceiSCSIAttributes

SetTargetARN sets the TargetARN field's value.

func (DeviceiSCSIAttributes) String added in v0.6.5 

func (s DeviceiSCSIAttributes) String() string

String returns the string representation

type DisableGatewayInput 

type DisableGatewayInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

DisableGatewayInput

func (DisableGatewayInput) GoString added in v0.6.5 

func (s DisableGatewayInput) GoString() string

GoString returns the string representation

func (*DisableGatewayInput) SetGatewayARN added in v1.5.0 

func (s *DisableGatewayInput) SetGatewayARN(v string) *DisableGatewayInput

SetGatewayARN sets the GatewayARN field's value.

func (DisableGatewayInput) String added in v0.6.5 

func (s DisableGatewayInput) String() string

String returns the string representation

func (*DisableGatewayInput) Validate added in v1.1.21 

func (s *DisableGatewayInput) Validate() error

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

type DisableGatewayOutput 

type DisableGatewayOutput struct {

	// The unique Amazon Resource Name of the disabled gateway.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

DisableGatewayOutput

func (DisableGatewayOutput) GoString added in v0.6.5 

func (s DisableGatewayOutput) GoString() string

GoString returns the string representation

func (*DisableGatewayOutput) SetGatewayARN added in v1.5.0 

func (s *DisableGatewayOutput) SetGatewayARN(v string) *DisableGatewayOutput

SetGatewayARN sets the GatewayARN field's value.

func (DisableGatewayOutput) String added in v0.6.5 

func (s DisableGatewayOutput) String() string

String returns the string representation

type Disk 

type Disk struct {
	DiskAllocationResource *string `type:"string"`

	DiskAllocationType *string `min:"3" type:"string"`

	DiskId *string `min:"1" type:"string"`

	DiskNode *string `type:"string"`

	DiskPath *string `type:"string"`

	DiskSizeInBytes *int64 `type:"long"`

	DiskStatus *string `type:"string"`
	// contains filtered or unexported fields
}

func (Disk) GoString added in v0.6.5 

func (s Disk) GoString() string

GoString returns the string representation

func (*Disk) SetDiskAllocationResource added in v1.5.0 

func (s *Disk) SetDiskAllocationResource(v string) *Disk

SetDiskAllocationResource sets the DiskAllocationResource field's value.

func (*Disk) SetDiskAllocationType added in v1.5.0 

func (s *Disk) SetDiskAllocationType(v string) *Disk

SetDiskAllocationType sets the DiskAllocationType field's value.

func (*Disk) SetDiskId added in v1.5.0 

func (s *Disk) SetDiskId(v string) *Disk

SetDiskId sets the DiskId field's value.

func (*Disk) SetDiskNode added in v1.5.0 

func (s *Disk) SetDiskNode(v string) *Disk

SetDiskNode sets the DiskNode field's value.

func (*Disk) SetDiskPath added in v1.5.0 

func (s *Disk) SetDiskPath(v string) *Disk

SetDiskPath sets the DiskPath field's value.

func (*Disk) SetDiskSizeInBytes added in v1.5.0 

func (s *Disk) SetDiskSizeInBytes(v int64) *Disk

SetDiskSizeInBytes sets the DiskSizeInBytes field's value.

func (*Disk) SetDiskStatus added in v1.5.0 

func (s *Disk) SetDiskStatus(v string) *Disk

SetDiskStatus sets the DiskStatus field's value.

func (Disk) String added in v0.6.5 

func (s Disk) String() string

String returns the string representation

type Error 

type Error struct {

	// Additional information about the error.
	ErrorCode *string `locationName:"errorCode" type:"string" enum:"ErrorCode"`

	// Human-readable text that provides detail about the error that occurred.
	ErrorDetails map[string]*string `locationName:"errorDetails" type:"map"`
	// contains filtered or unexported fields
}

Provides additional information about an error that was returned by the service as an or. See the errorCode and errorDetails members for more information about the error.

func (Error) GoString added in v0.6.5 

func (s Error) GoString() string

GoString returns the string representation

func (*Error) SetErrorCode added in v1.5.0 

func (s *Error) SetErrorCode(v string) *Error

SetErrorCode sets the ErrorCode field's value.

func (*Error) SetErrorDetails added in v1.5.0 

func (s *Error) SetErrorDetails(v map[string]*string) *Error

SetErrorDetails sets the ErrorDetails field's value.

func (Error) String added in v0.6.5 

func (s Error) String() string

String returns the string representation

type FileShareInfo added in v1.6.6 

type FileShareInfo struct {

	// The Amazon Resource Name (ARN) of the file share.
	FileShareARN *string `min:"50" type:"string"`

	// The ID of the file share.
	FileShareId *string `min:"12" type:"string"`

	// The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE
	// and DELETING.
	FileShareStatus *string `min:"3" type:"string"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

Describes a file share.

func (FileShareInfo) GoString added in v1.6.6 

func (s FileShareInfo) GoString() string

GoString returns the string representation

func (*FileShareInfo) SetFileShareARN added in v1.6.6 

func (s *FileShareInfo) SetFileShareARN(v string) *FileShareInfo

SetFileShareARN sets the FileShareARN field's value.

func (*FileShareInfo) SetFileShareId added in v1.6.6 

func (s *FileShareInfo) SetFileShareId(v string) *FileShareInfo

SetFileShareId sets the FileShareId field's value.

func (*FileShareInfo) SetFileShareStatus added in v1.6.6 

func (s *FileShareInfo) SetFileShareStatus(v string) *FileShareInfo

SetFileShareStatus sets the FileShareStatus field's value.

func (*FileShareInfo) SetGatewayARN added in v1.6.6 

func (s *FileShareInfo) SetGatewayARN(v string) *FileShareInfo

SetGatewayARN sets the GatewayARN field's value.

func (FileShareInfo) String added in v1.6.6 

func (s FileShareInfo) String() string

String returns the string representation

type GatewayInfo 

type GatewayInfo struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// The unique identifier assigned to your gateway during activation. This ID
	// becomes part of the gateway Amazon Resource Name (ARN), which you use as
	// input for other operations.
	GatewayId *string `min:"12" type:"string"`

	// The name of the gateway.
	GatewayName *string `type:"string"`

	// The state of the gateway.
	//
	// Valid Values: DISABLED or ACTIVE
	GatewayOperationalState *string `min:"2" type:"string"`

	// The type of the gateway.
	GatewayType *string `min:"2" type:"string"`
	// contains filtered or unexported fields
}

Describes a gateway object.

func (GatewayInfo) GoString added in v0.6.5 

func (s GatewayInfo) GoString() string

GoString returns the string representation

func (*GatewayInfo) SetGatewayARN added in v1.5.0 

func (s *GatewayInfo) SetGatewayARN(v string) *GatewayInfo

SetGatewayARN sets the GatewayARN field's value.

func (*GatewayInfo) SetGatewayId added in v1.5.0 

func (s *GatewayInfo) SetGatewayId(v string) *GatewayInfo

SetGatewayId sets the GatewayId field's value.

func (*GatewayInfo) SetGatewayName added in v1.5.0 

func (s *GatewayInfo) SetGatewayName(v string) *GatewayInfo

SetGatewayName sets the GatewayName field's value.

func (*GatewayInfo) SetGatewayOperationalState added in v1.5.0 

func (s *GatewayInfo) SetGatewayOperationalState(v string) *GatewayInfo

SetGatewayOperationalState sets the GatewayOperationalState field's value.

func (*GatewayInfo) SetGatewayType added in v1.5.0 

func (s *GatewayInfo) SetGatewayType(v string) *GatewayInfo

SetGatewayType sets the GatewayType field's value.

func (GatewayInfo) String added in v0.6.5 

func (s GatewayInfo) String() string

String returns the string representation

type ListFileSharesInput added in v1.6.6 

type ListFileSharesInput struct {

	// The Amazon resource Name (ARN) of the gateway whose file shares you want
	// to list. If this field is not present, all file shares under your account
	// are listed.
	GatewayARN *string `min:"50" type:"string"`

	// The maximum number of file shares to return in the response. The value must
	// be an integer with a value greater than zero. Optional.
	Limit *int64 `min:"1" type:"integer"`

	// Opaque pagination token returned from a previous ListFileShares operation.
	// If present, Marker specifies where to continue the list from after a previous
	// call to ListFileShares. Optional.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

ListFileShareInput

func (ListFileSharesInput) GoString added in v1.6.6 

func (s ListFileSharesInput) GoString() string

GoString returns the string representation

func (*ListFileSharesInput) SetGatewayARN added in v1.6.6 

func (s *ListFileSharesInput) SetGatewayARN(v string) *ListFileSharesInput

SetGatewayARN sets the GatewayARN field's value.

func (*ListFileSharesInput) SetLimit added in v1.6.6 

func (s *ListFileSharesInput) SetLimit(v int64) *ListFileSharesInput

SetLimit sets the Limit field's value.

func (*ListFileSharesInput) SetMarker added in v1.6.6 

func (s *ListFileSharesInput) SetMarker(v string) *ListFileSharesInput

SetMarker sets the Marker field's value.

func (ListFileSharesInput) String added in v1.6.6 

func (s ListFileSharesInput) String() string

String returns the string representation

func (*ListFileSharesInput) Validate added in v1.6.6 

func (s *ListFileSharesInput) Validate() error

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

type ListFileSharesOutput added in v1.6.6 

type ListFileSharesOutput struct {

	// An array of information about the file gateway's file shares.
	FileShareInfoList []*FileShareInfo `type:"list"`

	// If the request includes Marker, the response returns that value in this field.
	Marker *string `min:"1" type:"string"`

	// If a value is present, there are more file shares to return. In a subsequent
	// request, use NextMarker as the value for Marker to retrieve the next set
	// of file shares.
	NextMarker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

ListFileShareOutput

func (ListFileSharesOutput) GoString added in v1.6.6 

func (s ListFileSharesOutput) GoString() string

GoString returns the string representation

func (*ListFileSharesOutput) SetFileShareInfoList added in v1.6.6 

func (s *ListFileSharesOutput) SetFileShareInfoList(v []*FileShareInfo) *ListFileSharesOutput

SetFileShareInfoList sets the FileShareInfoList field's value.

func (*ListFileSharesOutput) SetMarker added in v1.6.6 

func (s *ListFileSharesOutput) SetMarker(v string) *ListFileSharesOutput

SetMarker sets the Marker field's value.

func (*ListFileSharesOutput) SetNextMarker added in v1.6.6 

func (s *ListFileSharesOutput) SetNextMarker(v string) *ListFileSharesOutput

SetNextMarker sets the NextMarker field's value.

func (ListFileSharesOutput) String added in v1.6.6 

func (s ListFileSharesOutput) String() string

String returns the string representation

type ListGatewaysInput 

type ListGatewaysInput struct {

	// Specifies that the list of gateways returned be limited to the specified
	// number of items.
	Limit *int64 `min:"1" type:"integer"`

	// An opaque string that indicates the position at which to begin the returned
	// list of gateways.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing zero or more of the following fields:

  • ListGatewaysInput$Limit

  • ListGatewaysInput$Marker

func (ListGatewaysInput) GoString added in v0.6.5 

func (s ListGatewaysInput) GoString() string

GoString returns the string representation

func (*ListGatewaysInput) SetLimit added in v1.5.0 

func (s *ListGatewaysInput) SetLimit(v int64) *ListGatewaysInput

SetLimit sets the Limit field's value.

func (*ListGatewaysInput) SetMarker added in v1.5.0 

func (s *ListGatewaysInput) SetMarker(v string) *ListGatewaysInput

SetMarker sets the Marker field's value.

func (ListGatewaysInput) String added in v0.6.5 

func (s ListGatewaysInput) String() string

String returns the string representation

func (*ListGatewaysInput) Validate added in v1.1.21 

func (s *ListGatewaysInput) Validate() error

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

type ListGatewaysOutput 

type ListGatewaysOutput struct {
	Gateways []*GatewayInfo `type:"list"`

	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGatewaysOutput) GoString added in v0.6.5 

func (s ListGatewaysOutput) GoString() string

GoString returns the string representation

func (*ListGatewaysOutput) SetGateways added in v1.5.0 

func (s *ListGatewaysOutput) SetGateways(v []*GatewayInfo) *ListGatewaysOutput

SetGateways sets the Gateways field's value.

func (*ListGatewaysOutput) SetMarker added in v1.5.0 

func (s *ListGatewaysOutput) SetMarker(v string) *ListGatewaysOutput

SetMarker sets the Marker field's value.

func (ListGatewaysOutput) String added in v0.6.5 

func (s ListGatewaysOutput) String() string

String returns the string representation

type ListLocalDisksInput 

type ListLocalDisksInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway.

func (ListLocalDisksInput) GoString added in v0.6.5 

func (s ListLocalDisksInput) GoString() string

GoString returns the string representation

func (*ListLocalDisksInput) SetGatewayARN added in v1.5.0 

func (s *ListLocalDisksInput) SetGatewayARN(v string) *ListLocalDisksInput

SetGatewayARN sets the GatewayARN field's value.

func (ListLocalDisksInput) String added in v0.6.5 

func (s ListLocalDisksInput) String() string

String returns the string representation

func (*ListLocalDisksInput) Validate added in v1.1.21 

func (s *ListLocalDisksInput) Validate() error

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

type ListLocalDisksOutput 

type ListLocalDisksOutput struct {
	Disks []*Disk `type:"list"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (ListLocalDisksOutput) GoString added in v0.6.5 

func (s ListLocalDisksOutput) GoString() string

GoString returns the string representation

func (*ListLocalDisksOutput) SetDisks added in v1.5.0 

func (s *ListLocalDisksOutput) SetDisks(v []*Disk) *ListLocalDisksOutput

SetDisks sets the Disks field's value.

func (*ListLocalDisksOutput) SetGatewayARN added in v1.5.0 

func (s *ListLocalDisksOutput) SetGatewayARN(v string) *ListLocalDisksOutput

SetGatewayARN sets the GatewayARN field's value.

func (ListLocalDisksOutput) String added in v0.6.5 

func (s ListLocalDisksOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v0.9.5 

type ListTagsForResourceInput struct {

	// Specifies that the list of tags returned be limited to the specified number
	// of items.
	Limit *int64 `min:"1" type:"integer"`

	// An opaque string that indicates the position at which to begin returning
	// the list of tags.
	Marker *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the resource for which you want to list
	// tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

ListTagsForResourceInput

func (ListTagsForResourceInput) GoString added in v0.9.5 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetLimit added in v1.5.0 

func (s *ListTagsForResourceInput) SetLimit(v int64) *ListTagsForResourceInput

SetLimit sets the Limit field's value.

func (*ListTagsForResourceInput) SetMarker added in v1.5.0 

func (s *ListTagsForResourceInput) SetMarker(v string) *ListTagsForResourceInput

SetMarker sets the Marker field's value.

func (*ListTagsForResourceInput) SetResourceARN added in v1.5.0 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v0.9.5 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.1.21 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v0.9.5 

type ListTagsForResourceOutput struct {

	// An opaque string that indicates the position at which to stop returning the
	// list of tags.
	Marker *string `min:"1" type:"string"`

	// he Amazon Resource Name (ARN) of the resource for which you want to list
	// tags.
	ResourceARN *string `min:"50" type:"string"`

	// An array that contains the tags for the specified resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

ListTagsForResourceOutput

func (ListTagsForResourceOutput) GoString added in v0.9.5 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetMarker added in v1.5.0 

func (s *ListTagsForResourceOutput) SetMarker(v string) *ListTagsForResourceOutput

SetMarker sets the Marker field's value.

func (*ListTagsForResourceOutput) SetResourceARN added in v1.5.0 

func (s *ListTagsForResourceOutput) SetResourceARN(v string) *ListTagsForResourceOutput

SetResourceARN sets the ResourceARN field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.5.0 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v0.9.5 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTapesInput added in v1.1.25 

type ListTapesInput struct {

	// An optional number limit for the tapes in the list returned by this call.
	Limit *int64 `min:"1" type:"integer"`

	// A string that indicates the position at which to begin the returned list
	// of tapes.
	Marker *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of each of the tapes you want to list. If
	// you don't specify a tape ARN, the response lists all tapes in both your VTL
	// and VTS.
	TapeARNs []*string `type:"list"`
	// contains filtered or unexported fields
}

A JSON object that contains one or more of the following fields:

  • ListTapesInput$Limit

  • ListTapesInput$Marker

  • ListTapesInput$TapeARNs

func (ListTapesInput) GoString added in v1.1.25 

func (s ListTapesInput) GoString() string

GoString returns the string representation

func (*ListTapesInput) SetLimit added in v1.5.0 

func (s *ListTapesInput) SetLimit(v int64) *ListTapesInput

SetLimit sets the Limit field's value.

func (*ListTapesInput) SetMarker added in v1.5.0 

func (s *ListTapesInput) SetMarker(v string) *ListTapesInput

SetMarker sets the Marker field's value.

func (*ListTapesInput) SetTapeARNs added in v1.5.0 

func (s *ListTapesInput) SetTapeARNs(v []*string) *ListTapesInput

SetTapeARNs sets the TapeARNs field's value.

func (ListTapesInput) String added in v1.1.25 

func (s ListTapesInput) String() string

String returns the string representation

func (*ListTapesInput) Validate added in v1.1.25 

func (s *ListTapesInput) Validate() error

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

type ListTapesOutput added in v1.1.25 

type ListTapesOutput struct {

	// A string that indicates the position at which to begin returning the next
	// list of tapes. Use the marker in your next request to continue pagination
	// of tapes. If there are no more tapes to list, this element does not appear
	// in the response body.
	Marker *string `min:"1" type:"string"`

	// An array of TapeInfo objects, where each object describes an a single tape.
	// If there not tapes in the tape library or VTS, then the TapeInfos is an empty
	// array.
	TapeInfos []*TapeInfo `type:"list"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

  • ListTapesOutput$Marker

  • ListTapesOutput$VolumeInfos

func (ListTapesOutput) GoString added in v1.1.25 

func (s ListTapesOutput) GoString() string

GoString returns the string representation

func (*ListTapesOutput) SetMarker added in v1.5.0 

func (s *ListTapesOutput) SetMarker(v string) *ListTapesOutput

SetMarker sets the Marker field's value.

func (*ListTapesOutput) SetTapeInfos added in v1.5.0 

func (s *ListTapesOutput) SetTapeInfos(v []*TapeInfo) *ListTapesOutput

SetTapeInfos sets the TapeInfos field's value.

func (ListTapesOutput) String added in v1.1.25 

func (s ListTapesOutput) String() string

String returns the string representation

type ListVolumeInitiatorsInput added in v0.6.1 

type ListVolumeInitiatorsInput struct {

	// The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
	// to return a list of gateway volumes for the gateway.
	//
	// VolumeARN is a required field
	VolumeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

ListVolumeInitiatorsInput

func (ListVolumeInitiatorsInput) GoString added in v0.6.5 

func (s ListVolumeInitiatorsInput) GoString() string

GoString returns the string representation

func (*ListVolumeInitiatorsInput) SetVolumeARN added in v1.5.0 

func (s *ListVolumeInitiatorsInput) SetVolumeARN(v string) *ListVolumeInitiatorsInput

SetVolumeARN sets the VolumeARN field's value.

func (ListVolumeInitiatorsInput) String added in v0.6.5 

func (s ListVolumeInitiatorsInput) String() string

String returns the string representation

func (*ListVolumeInitiatorsInput) Validate added in v1.1.21 

func (s *ListVolumeInitiatorsInput) Validate() error

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

type ListVolumeInitiatorsOutput added in v0.6.1 

type ListVolumeInitiatorsOutput struct {

	// The host names and port numbers of all iSCSI initiators that are connected
	// to the gateway.
	Initiators []*string `type:"list"`
	// contains filtered or unexported fields
}

ListVolumeInitiatorsOutput

func (ListVolumeInitiatorsOutput) GoString added in v0.6.5 

func (s ListVolumeInitiatorsOutput) GoString() string

GoString returns the string representation

func (*ListVolumeInitiatorsOutput) SetInitiators added in v1.5.0 

func (s *ListVolumeInitiatorsOutput) SetInitiators(v []*string) *ListVolumeInitiatorsOutput

SetInitiators sets the Initiators field's value.

func (ListVolumeInitiatorsOutput) String added in v0.6.5 

func (s ListVolumeInitiatorsOutput) String() string

String returns the string representation

type ListVolumeRecoveryPointsInput 

type ListVolumeRecoveryPointsInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListVolumeRecoveryPointsInput) GoString added in v0.6.5 

func (s ListVolumeRecoveryPointsInput) GoString() string

GoString returns the string representation

func (*ListVolumeRecoveryPointsInput) SetGatewayARN added in v1.5.0 

func (s *ListVolumeRecoveryPointsInput) SetGatewayARN(v string) *ListVolumeRecoveryPointsInput

SetGatewayARN sets the GatewayARN field's value.

func (ListVolumeRecoveryPointsInput) String added in v0.6.5 

func (s ListVolumeRecoveryPointsInput) String() string

String returns the string representation

func (*ListVolumeRecoveryPointsInput) Validate added in v1.1.21 

func (s *ListVolumeRecoveryPointsInput) Validate() error

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

type ListVolumeRecoveryPointsOutput 

type ListVolumeRecoveryPointsOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	VolumeRecoveryPointInfos []*VolumeRecoveryPointInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListVolumeRecoveryPointsOutput) GoString added in v0.6.5 

func (s ListVolumeRecoveryPointsOutput) GoString() string

GoString returns the string representation

func (*ListVolumeRecoveryPointsOutput) SetGatewayARN added in v1.5.0 

func (s *ListVolumeRecoveryPointsOutput) SetGatewayARN(v string) *ListVolumeRecoveryPointsOutput

SetGatewayARN sets the GatewayARN field's value.

func (*ListVolumeRecoveryPointsOutput) SetVolumeRecoveryPointInfos added in v1.5.0 

func (s *ListVolumeRecoveryPointsOutput) SetVolumeRecoveryPointInfos(v []*VolumeRecoveryPointInfo) *ListVolumeRecoveryPointsOutput

SetVolumeRecoveryPointInfos sets the VolumeRecoveryPointInfos field's value.

func (ListVolumeRecoveryPointsOutput) String added in v0.6.5 

func (s ListVolumeRecoveryPointsOutput) String() string

String returns the string representation

type ListVolumesInput 

type ListVolumesInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// Specifies that the list of volumes returned be limited to the specified number
	// of items.
	Limit *int64 `min:"1" type:"integer"`

	// A string that indicates the position at which to begin the returned list
	// of volumes. Obtain the marker from the response of a previous List iSCSI
	// Volumes request.
	Marker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A JSON object that contains one or more of the following fields:

  • ListVolumesInput$Limit

  • ListVolumesInput$Marker

func (ListVolumesInput) GoString added in v0.6.5 

func (s ListVolumesInput) GoString() string

GoString returns the string representation

func (*ListVolumesInput) SetGatewayARN added in v1.5.0 

func (s *ListVolumesInput) SetGatewayARN(v string) *ListVolumesInput

SetGatewayARN sets the GatewayARN field's value.

func (*ListVolumesInput) SetLimit added in v1.5.0 

func (s *ListVolumesInput) SetLimit(v int64) *ListVolumesInput

SetLimit sets the Limit field's value.

func (*ListVolumesInput) SetMarker added in v1.5.0 

func (s *ListVolumesInput) SetMarker(v string) *ListVolumesInput

SetMarker sets the Marker field's value.

func (ListVolumesInput) String added in v0.6.5 

func (s ListVolumesInput) String() string

String returns the string representation

func (*ListVolumesInput) Validate added in v1.1.21 

func (s *ListVolumesInput) Validate() error

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

type ListVolumesOutput 

type ListVolumesOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	Marker *string `min:"1" type:"string"`

	VolumeInfos []*VolumeInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListVolumesOutput) GoString added in v0.6.5 

func (s ListVolumesOutput) GoString() string

GoString returns the string representation

func (*ListVolumesOutput) SetGatewayARN added in v1.5.0 

func (s *ListVolumesOutput) SetGatewayARN(v string) *ListVolumesOutput

SetGatewayARN sets the GatewayARN field's value.

func (*ListVolumesOutput) SetMarker added in v1.5.0 

func (s *ListVolumesOutput) SetMarker(v string) *ListVolumesOutput

SetMarker sets the Marker field's value.

func (*ListVolumesOutput) SetVolumeInfos added in v1.5.0 

func (s *ListVolumesOutput) SetVolumeInfos(v []*VolumeInfo) *ListVolumesOutput

SetVolumeInfos sets the VolumeInfos field's value.

func (ListVolumesOutput) String added in v0.6.5 

func (s ListVolumesOutput) String() string

String returns the string representation

type NFSFileShareDefaults added in v1.6.6 

type NFSFileShareDefaults struct {

	// The Unix directory mode in the form "nnnn". For example, "0666" represents
	// the default access mode for all directories inside the file share. The default
	// value is 0777.
	DirectoryMode *string `min:"1" type:"string"`

	// The Unix file mode in the form "nnnn". For example, "0666" represents the
	// default file mode inside the file share. The default value is 0666.
	FileMode *string `min:"1" type:"string"`

	// The default group ID for the file share (unless the files have another group
	// ID specified). The default value is nfsnobody.
	GroupId *int64 `type:"long"`

	// The default owner ID for files in the file share (unless the files have another
	// owner ID specified). The default value is nfsnobody.
	OwnerId *int64 `type:"long"`
	// contains filtered or unexported fields
}

Describes file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported in the file gateway type.

func (NFSFileShareDefaults) GoString added in v1.6.6 

func (s NFSFileShareDefaults) GoString() string

GoString returns the string representation

func (*NFSFileShareDefaults) SetDirectoryMode added in v1.6.6 

func (s *NFSFileShareDefaults) SetDirectoryMode(v string) *NFSFileShareDefaults

SetDirectoryMode sets the DirectoryMode field's value.

func (*NFSFileShareDefaults) SetFileMode added in v1.6.6 

func (s *NFSFileShareDefaults) SetFileMode(v string) *NFSFileShareDefaults

SetFileMode sets the FileMode field's value.

func (*NFSFileShareDefaults) SetGroupId added in v1.6.6 

func (s *NFSFileShareDefaults) SetGroupId(v int64) *NFSFileShareDefaults

SetGroupId sets the GroupId field's value.

func (*NFSFileShareDefaults) SetOwnerId added in v1.6.6 

func (s *NFSFileShareDefaults) SetOwnerId(v int64) *NFSFileShareDefaults

SetOwnerId sets the OwnerId field's value.

func (NFSFileShareDefaults) String added in v1.6.6 

func (s NFSFileShareDefaults) String() string

String returns the string representation

func (*NFSFileShareDefaults) Validate added in v1.6.6 

func (s *NFSFileShareDefaults) Validate() error

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

type NFSFileShareInfo added in v1.6.6 

type NFSFileShareInfo struct {

	// The list of clients that are allowed to access the file gateway. The list
	// must contain either valid IP addresses or valid CIDR blocks.
	ClientList []*string `min:"1" type:"list"`

	// The default storage class for objects put into an Amazon S3 bucket by file
	// gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA.
	// If this field is not populated, the default value S3_STANDARD is used. Optional.
	DefaultStorageClass *string `min:"5" type:"string"`

	// The Amazon Resource Name (ARN) of the file share.
	FileShareARN *string `min:"50" type:"string"`

	// The ID of the file share.
	FileShareId *string `min:"12" type:"string"`

	// The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE
	// and DELETING.
	FileShareStatus *string `min:"3" type:"string"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// Enables guessing of the MIME type for uploaded objects based on file extensions.
	// Set this value to true to enable MIME type guessing, and otherwise to false.
	// The default value is true.
	GuessMIMETypeEnabled *bool `type:"boolean"`

	// True to use Amazon S3 server side encryption with your own KMS key, or false
	// to use a key managed by Amazon S3. Optional.
	KMSEncrypted *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side
	// encryption. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"20" type:"string"`

	// The ARN of the backend storage used for storing file data.
	LocationARN *string `min:"16" type:"string"`

	// Describes file share default values. Files and folders stored as Amazon S3
	// objects in S3 buckets don't, by default, have Unix file permissions assigned
	// to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects
	// that represent files and folders are assigned these default Unix permissions.
	// This operation is only supported in the file gateway type.
	NFSFileShareDefaults *NFSFileShareDefaults `type:"structure"`

	// Sets the access control list permission for objects in the S3 bucket that
	// a file gateway puts objects into. The default value is "private".
	ObjectACL *string `type:"string" enum:"ObjectACL"`

	// The file share path used by the NFS client to identify the mount point.
	Path *string `type:"string"`

	// Sets the write status of a file share. This value is true if the write status
	// is read-only, and otherwise false.
	ReadOnly *bool `type:"boolean"`

	// Sets who pays the cost of the request and the data download from the Amazon
	// S3 bucket. Set this value to true if you want the requester to pay instead
	// of the bucket owner, and otherwise to false.
	RequesterPays *bool `type:"boolean"`

	// The ARN of the IAM role that file gateway assumes when it accesses the underlying
	// storage.
	Role *string `min:"20" type:"string"`

	// The user mapped to anonymous user. Valid options are the following:
	//
	//    * "RootSquash" - Only root is mapped to anonymous user.
	//
	//    * "NoSquash" - No one is mapped to anonymous user
	//
	//    * "AllSquash" - Everyone is mapped to anonymous user.
	Squash *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.

func (NFSFileShareInfo) GoString added in v1.6.6 

func (s NFSFileShareInfo) GoString() string

GoString returns the string representation

func (*NFSFileShareInfo) SetClientList added in v1.6.21 

func (s *NFSFileShareInfo) SetClientList(v []*string) *NFSFileShareInfo

SetClientList sets the ClientList field's value.

func (*NFSFileShareInfo) SetDefaultStorageClass added in v1.6.6 

func (s *NFSFileShareInfo) SetDefaultStorageClass(v string) *NFSFileShareInfo

SetDefaultStorageClass sets the DefaultStorageClass field's value.

func (*NFSFileShareInfo) SetFileShareARN added in v1.6.6 

func (s *NFSFileShareInfo) SetFileShareARN(v string) *NFSFileShareInfo

SetFileShareARN sets the FileShareARN field's value.

func (*NFSFileShareInfo) SetFileShareId added in v1.6.6 

func (s *NFSFileShareInfo) SetFileShareId(v string) *NFSFileShareInfo

SetFileShareId sets the FileShareId field's value.

func (*NFSFileShareInfo) SetFileShareStatus added in v1.6.6 

func (s *NFSFileShareInfo) SetFileShareStatus(v string) *NFSFileShareInfo

SetFileShareStatus sets the FileShareStatus field's value.

func (*NFSFileShareInfo) SetGatewayARN added in v1.6.6 

func (s *NFSFileShareInfo) SetGatewayARN(v string) *NFSFileShareInfo

SetGatewayARN sets the GatewayARN field's value.

func (*NFSFileShareInfo) SetGuessMIMETypeEnabled added in v1.12.32 

func (s *NFSFileShareInfo) SetGuessMIMETypeEnabled(v bool) *NFSFileShareInfo

SetGuessMIMETypeEnabled sets the GuessMIMETypeEnabled field's value.

func (*NFSFileShareInfo) SetKMSEncrypted added in v1.6.6 

func (s *NFSFileShareInfo) SetKMSEncrypted(v bool) *NFSFileShareInfo

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*NFSFileShareInfo) SetKMSKey added in v1.6.6 

func (s *NFSFileShareInfo) SetKMSKey(v string) *NFSFileShareInfo

SetKMSKey sets the KMSKey field's value.

func (*NFSFileShareInfo) SetLocationARN added in v1.6.6 

func (s *NFSFileShareInfo) SetLocationARN(v string) *NFSFileShareInfo

SetLocationARN sets the LocationARN field's value.

func (*NFSFileShareInfo) SetNFSFileShareDefaults added in v1.6.6 

func (s *NFSFileShareInfo) SetNFSFileShareDefaults(v *NFSFileShareDefaults) *NFSFileShareInfo

SetNFSFileShareDefaults sets the NFSFileShareDefaults field's value.

func (*NFSFileShareInfo) SetObjectACL added in v1.13.8 

func (s *NFSFileShareInfo) SetObjectACL(v string) *NFSFileShareInfo

SetObjectACL sets the ObjectACL field's value.

func (*NFSFileShareInfo) SetPath added in v1.6.6 

func (s *NFSFileShareInfo) SetPath(v string) *NFSFileShareInfo

SetPath sets the Path field's value.

func (*NFSFileShareInfo) SetReadOnly added in v1.8.5 

func (s *NFSFileShareInfo) SetReadOnly(v bool) *NFSFileShareInfo

SetReadOnly sets the ReadOnly field's value.

func (*NFSFileShareInfo) SetRequesterPays added in v1.13.8 

func (s *NFSFileShareInfo) SetRequesterPays(v bool) *NFSFileShareInfo

SetRequesterPays sets the RequesterPays field's value.

func (*NFSFileShareInfo) SetRole added in v1.6.6 

func (s *NFSFileShareInfo) SetRole(v string) *NFSFileShareInfo

SetRole sets the Role field's value.

func (*NFSFileShareInfo) SetSquash added in v1.8.5 

func (s *NFSFileShareInfo) SetSquash(v string) *NFSFileShareInfo

SetSquash sets the Squash field's value.

func (NFSFileShareInfo) String added in v1.6.6 

func (s NFSFileShareInfo) String() string

String returns the string representation

type NetworkInterface 

type NetworkInterface struct {

	// The Internet Protocol version 4 (IPv4) address of the interface.
	Ipv4Address *string `type:"string"`

	// The Internet Protocol version 6 (IPv6) address of the interface. Currently
	// not supported.
	Ipv6Address *string `type:"string"`

	// The Media Access Control (MAC) address of the interface.
	//
	// This is currently unsupported and will not be returned in output.
	MacAddress *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a gateway's network interface.

func (NetworkInterface) GoString added in v0.6.5 

func (s NetworkInterface) GoString() string

GoString returns the string representation

func (*NetworkInterface) SetIpv4Address added in v1.5.0 

func (s *NetworkInterface) SetIpv4Address(v string) *NetworkInterface

SetIpv4Address sets the Ipv4Address field's value.

func (*NetworkInterface) SetIpv6Address added in v1.5.0 

func (s *NetworkInterface) SetIpv6Address(v string) *NetworkInterface

SetIpv6Address sets the Ipv6Address field's value.

func (*NetworkInterface) SetMacAddress added in v1.5.0 

func (s *NetworkInterface) SetMacAddress(v string) *NetworkInterface

SetMacAddress sets the MacAddress field's value.

func (NetworkInterface) String added in v0.6.5 

func (s NetworkInterface) String() string

String returns the string representation

type NotifyWhenUploadedInput added in v1.12.32 

type NotifyWhenUploadedInput struct {

	// The Amazon Resource Name (ARN) of the file share.
	//
	// FileShareARN is a required field
	FileShareARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (NotifyWhenUploadedInput) GoString added in v1.12.32 

func (s NotifyWhenUploadedInput) GoString() string

GoString returns the string representation

func (*NotifyWhenUploadedInput) SetFileShareARN added in v1.12.32 

func (s *NotifyWhenUploadedInput) SetFileShareARN(v string) *NotifyWhenUploadedInput

SetFileShareARN sets the FileShareARN field's value.

func (NotifyWhenUploadedInput) String added in v1.12.32 

func (s NotifyWhenUploadedInput) String() string

String returns the string representation

func (*NotifyWhenUploadedInput) Validate added in v1.12.32 

func (s *NotifyWhenUploadedInput) Validate() error

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

type NotifyWhenUploadedOutput added in v1.12.32 

type NotifyWhenUploadedOutput struct {

	// The Amazon Resource Name (ARN) of the file share.
	FileShareARN *string `min:"50" type:"string"`

	// The randomly generated ID of the notification that was sent. This ID is in
	// UUID format.
	NotificationId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (NotifyWhenUploadedOutput) GoString added in v1.12.32 

func (s NotifyWhenUploadedOutput) GoString() string

GoString returns the string representation

func (*NotifyWhenUploadedOutput) SetFileShareARN added in v1.12.32 

func (s *NotifyWhenUploadedOutput) SetFileShareARN(v string) *NotifyWhenUploadedOutput

SetFileShareARN sets the FileShareARN field's value.

func (*NotifyWhenUploadedOutput) SetNotificationId added in v1.12.32 

func (s *NotifyWhenUploadedOutput) SetNotificationId(v string) *NotifyWhenUploadedOutput

SetNotificationId sets the NotificationId field's value.

func (NotifyWhenUploadedOutput) String added in v1.12.32 

func (s NotifyWhenUploadedOutput) String() string

String returns the string representation

type RefreshCacheInput added in v1.8.5 

type RefreshCacheInput struct {

	// The Amazon Resource Name (ARN) of the file share.
	//
	// FileShareARN is a required field
	FileShareARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RefreshCacheInput) GoString added in v1.8.5 

func (s RefreshCacheInput) GoString() string

GoString returns the string representation

func (*RefreshCacheInput) SetFileShareARN added in v1.8.5 

func (s *RefreshCacheInput) SetFileShareARN(v string) *RefreshCacheInput

SetFileShareARN sets the FileShareARN field's value.

func (RefreshCacheInput) String added in v1.8.5 

func (s RefreshCacheInput) String() string

String returns the string representation

func (*RefreshCacheInput) Validate added in v1.8.5 

func (s *RefreshCacheInput) Validate() error

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

type RefreshCacheOutput added in v1.8.5 

type RefreshCacheOutput struct {

	// The Amazon Resource Name (ARN) of the file share.
	FileShareARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (RefreshCacheOutput) GoString added in v1.8.5 

func (s RefreshCacheOutput) GoString() string

GoString returns the string representation

func (*RefreshCacheOutput) SetFileShareARN added in v1.8.5 

func (s *RefreshCacheOutput) SetFileShareARN(v string) *RefreshCacheOutput

SetFileShareARN sets the FileShareARN field's value.

func (RefreshCacheOutput) String added in v1.8.5 

func (s RefreshCacheOutput) String() string

String returns the string representation

type RemoveTagsFromResourceInput added in v0.9.5 

type RemoveTagsFromResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource you want to remove the tags
	// from.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"50" type:"string" required:"true"`

	// The keys of the tags you want to remove from the specified resource. A tag
	// is composed of a key/value pair.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

RemoveTagsFromResourceInput

func (RemoveTagsFromResourceInput) GoString added in v0.9.5 

func (s RemoveTagsFromResourceInput) GoString() string

GoString returns the string representation

func (*RemoveTagsFromResourceInput) SetResourceARN added in v1.5.0 

func (s *RemoveTagsFromResourceInput) SetResourceARN(v string) *RemoveTagsFromResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*RemoveTagsFromResourceInput) SetTagKeys added in v1.5.0 

func (s *RemoveTagsFromResourceInput) SetTagKeys(v []*string) *RemoveTagsFromResourceInput

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsFromResourceInput) String added in v0.9.5 

func (s RemoveTagsFromResourceInput) String() string

String returns the string representation

func (*RemoveTagsFromResourceInput) Validate added in v1.1.21 

func (s *RemoveTagsFromResourceInput) Validate() error

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

type RemoveTagsFromResourceOutput added in v0.9.5 

type RemoveTagsFromResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resource that the tags were removed
	// from.
	ResourceARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

RemoveTagsFromResourceOutput

func (RemoveTagsFromResourceOutput) GoString added in v0.9.5 

func (s RemoveTagsFromResourceOutput) GoString() string

GoString returns the string representation

func (*RemoveTagsFromResourceOutput) SetResourceARN added in v1.5.0 

func (s *RemoveTagsFromResourceOutput) SetResourceARN(v string) *RemoveTagsFromResourceOutput

SetResourceARN sets the ResourceARN field's value.

func (RemoveTagsFromResourceOutput) String added in v0.9.5 

func (s RemoveTagsFromResourceOutput) String() string

String returns the string representation

type ResetCacheInput 

type ResetCacheInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResetCacheInput) GoString added in v0.6.5 

func (s ResetCacheInput) GoString() string

GoString returns the string representation

func (*ResetCacheInput) SetGatewayARN added in v1.5.0 

func (s *ResetCacheInput) SetGatewayARN(v string) *ResetCacheInput

SetGatewayARN sets the GatewayARN field's value.

func (ResetCacheInput) String added in v0.6.5 

func (s ResetCacheInput) String() string

String returns the string representation

func (*ResetCacheInput) Validate added in v1.1.21 

func (s *ResetCacheInput) Validate() error

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

type ResetCacheOutput 

type ResetCacheOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (ResetCacheOutput) GoString added in v0.6.5 

func (s ResetCacheOutput) GoString() string

GoString returns the string representation

func (*ResetCacheOutput) SetGatewayARN added in v1.5.0 

func (s *ResetCacheOutput) SetGatewayARN(v string) *ResetCacheOutput

SetGatewayARN sets the GatewayARN field's value.

func (ResetCacheOutput) String added in v0.6.5 

func (s ResetCacheOutput) String() string

String returns the string representation

type RetrieveTapeArchiveInput 

type RetrieveTapeArchiveInput struct {

	// The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual
	// tape to. Use the ListGateways operation to return a list of gateways for
	// your account and region.
	//
	// You retrieve archived virtual tapes to only one gateway and the gateway must
	// be a tape gateway.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from
	// the virtual tape shelf (VTS).
	//
	// TapeARN is a required field
	TapeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

RetrieveTapeArchiveInput

func (RetrieveTapeArchiveInput) GoString added in v0.6.5 

func (s RetrieveTapeArchiveInput) GoString() string

GoString returns the string representation

func (*RetrieveTapeArchiveInput) SetGatewayARN added in v1.5.0 

func (s *RetrieveTapeArchiveInput) SetGatewayARN(v string) *RetrieveTapeArchiveInput

SetGatewayARN sets the GatewayARN field's value.

func (*RetrieveTapeArchiveInput) SetTapeARN added in v1.5.0 

func (s *RetrieveTapeArchiveInput) SetTapeARN(v string) *RetrieveTapeArchiveInput

SetTapeARN sets the TapeARN field's value.

func (RetrieveTapeArchiveInput) String added in v0.6.5 

func (s RetrieveTapeArchiveInput) String() string

String returns the string representation

func (*RetrieveTapeArchiveInput) Validate added in v1.1.21 

func (s *RetrieveTapeArchiveInput) Validate() error

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

type RetrieveTapeArchiveOutput 

type RetrieveTapeArchiveOutput struct {

	// The Amazon Resource Name (ARN) of the retrieved virtual tape.
	TapeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

RetrieveTapeArchiveOutput

func (RetrieveTapeArchiveOutput) GoString added in v0.6.5 

func (s RetrieveTapeArchiveOutput) GoString() string

GoString returns the string representation

func (*RetrieveTapeArchiveOutput) SetTapeARN added in v1.5.0 

func (s *RetrieveTapeArchiveOutput) SetTapeARN(v string) *RetrieveTapeArchiveOutput

SetTapeARN sets the TapeARN field's value.

func (RetrieveTapeArchiveOutput) String added in v0.6.5 

func (s RetrieveTapeArchiveOutput) String() string

String returns the string representation

type RetrieveTapeRecoveryPointInput 

type RetrieveTapeRecoveryPointInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the virtual tape for which you want to
	// retrieve the recovery point.
	//
	// TapeARN is a required field
	TapeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

RetrieveTapeRecoveryPointInput

func (RetrieveTapeRecoveryPointInput) GoString added in v0.6.5 

func (s RetrieveTapeRecoveryPointInput) GoString() string

GoString returns the string representation

func (*RetrieveTapeRecoveryPointInput) SetGatewayARN added in v1.5.0 

func (s *RetrieveTapeRecoveryPointInput) SetGatewayARN(v string) *RetrieveTapeRecoveryPointInput

SetGatewayARN sets the GatewayARN field's value.

func (*RetrieveTapeRecoveryPointInput) SetTapeARN added in v1.5.0 

func (s *RetrieveTapeRecoveryPointInput) SetTapeARN(v string) *RetrieveTapeRecoveryPointInput

SetTapeARN sets the TapeARN field's value.

func (RetrieveTapeRecoveryPointInput) String added in v0.6.5 

func (s RetrieveTapeRecoveryPointInput) String() string

String returns the string representation

func (*RetrieveTapeRecoveryPointInput) Validate added in v1.1.21 

func (s *RetrieveTapeRecoveryPointInput) Validate() error

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

type RetrieveTapeRecoveryPointOutput 

type RetrieveTapeRecoveryPointOutput struct {

	// The Amazon Resource Name (ARN) of the virtual tape for which the recovery
	// point was retrieved.
	TapeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

RetrieveTapeRecoveryPointOutput

func (RetrieveTapeRecoveryPointOutput) GoString added in v0.6.5 

func (s RetrieveTapeRecoveryPointOutput) GoString() string

GoString returns the string representation

func (*RetrieveTapeRecoveryPointOutput) SetTapeARN added in v1.5.0 

func (s *RetrieveTapeRecoveryPointOutput) SetTapeARN(v string) *RetrieveTapeRecoveryPointOutput

SetTapeARN sets the TapeARN field's value.

func (RetrieveTapeRecoveryPointOutput) String added in v0.6.5 

func (s RetrieveTapeRecoveryPointOutput) String() string

String returns the string representation

type SetLocalConsolePasswordInput added in v1.1.14 

type SetLocalConsolePasswordInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The password you want to set for your VM local console.
	//
	// LocalConsolePassword is a required field
	LocalConsolePassword *string `min:"6" type:"string" required:"true"`
	// contains filtered or unexported fields
}

SetLocalConsolePasswordInput

func (SetLocalConsolePasswordInput) GoString added in v1.1.14 

func (s SetLocalConsolePasswordInput) GoString() string

GoString returns the string representation

func (*SetLocalConsolePasswordInput) SetGatewayARN added in v1.5.0 

func (s *SetLocalConsolePasswordInput) SetGatewayARN(v string) *SetLocalConsolePasswordInput

SetGatewayARN sets the GatewayARN field's value.

func (*SetLocalConsolePasswordInput) SetLocalConsolePassword added in v1.5.0 

func (s *SetLocalConsolePasswordInput) SetLocalConsolePassword(v string) *SetLocalConsolePasswordInput

SetLocalConsolePassword sets the LocalConsolePassword field's value.

func (SetLocalConsolePasswordInput) String added in v1.1.14 

func (s SetLocalConsolePasswordInput) String() string

String returns the string representation

func (*SetLocalConsolePasswordInput) Validate added in v1.1.21 

func (s *SetLocalConsolePasswordInput) Validate() error

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

type SetLocalConsolePasswordOutput added in v1.1.14 

type SetLocalConsolePasswordOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (SetLocalConsolePasswordOutput) GoString added in v1.1.14 

func (s SetLocalConsolePasswordOutput) GoString() string

GoString returns the string representation

func (*SetLocalConsolePasswordOutput) SetGatewayARN added in v1.5.0 

func (s *SetLocalConsolePasswordOutput) SetGatewayARN(v string) *SetLocalConsolePasswordOutput

SetGatewayARN sets the GatewayARN field's value.

func (SetLocalConsolePasswordOutput) String added in v1.1.14 

func (s SetLocalConsolePasswordOutput) String() string

String returns the string representation

type ShutdownGatewayInput 

type ShutdownGatewayInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway to shut down.

func (ShutdownGatewayInput) GoString added in v0.6.5 

func (s ShutdownGatewayInput) GoString() string

GoString returns the string representation

func (*ShutdownGatewayInput) SetGatewayARN added in v1.5.0 

func (s *ShutdownGatewayInput) SetGatewayARN(v string) *ShutdownGatewayInput

SetGatewayARN sets the GatewayARN field's value.

func (ShutdownGatewayInput) String added in v0.6.5 

func (s ShutdownGatewayInput) String() string

String returns the string representation

func (*ShutdownGatewayInput) Validate added in v1.1.21 

func (s *ShutdownGatewayInput) Validate() error

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

type ShutdownGatewayOutput 

type ShutdownGatewayOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway that was shut down.

func (ShutdownGatewayOutput) GoString added in v0.6.5 

func (s ShutdownGatewayOutput) GoString() string

GoString returns the string representation

func (*ShutdownGatewayOutput) SetGatewayARN added in v1.5.0 

func (s *ShutdownGatewayOutput) SetGatewayARN(v string) *ShutdownGatewayOutput

SetGatewayARN sets the GatewayARN field's value.

func (ShutdownGatewayOutput) String added in v0.6.5 

func (s ShutdownGatewayOutput) String() string

String returns the string representation

type StartGatewayInput 

type StartGatewayInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway to start.

func (StartGatewayInput) GoString added in v0.6.5 

func (s StartGatewayInput) GoString() string

GoString returns the string representation

func (*StartGatewayInput) SetGatewayARN added in v1.5.0 

func (s *StartGatewayInput) SetGatewayARN(v string) *StartGatewayInput

SetGatewayARN sets the GatewayARN field's value.

func (StartGatewayInput) String added in v0.6.5 

func (s StartGatewayInput) String() string

String returns the string representation

func (*StartGatewayInput) Validate added in v1.1.21 

func (s *StartGatewayInput) Validate() error

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

type StartGatewayOutput 

type StartGatewayOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway that was restarted.

func (StartGatewayOutput) GoString added in v0.6.5 

func (s StartGatewayOutput) GoString() string

GoString returns the string representation

func (*StartGatewayOutput) SetGatewayARN added in v1.5.0 

func (s *StartGatewayOutput) SetGatewayARN(v string) *StartGatewayOutput

SetGatewayARN sets the GatewayARN field's value.

func (StartGatewayOutput) String added in v0.6.5 

func (s StartGatewayOutput) String() string

String returns the string representation

type StorageGateway 

type StorageGateway struct {
	*client.Client
}

StorageGateway provides the API operation methods for making requests to AWS Storage Gateway. See this package's package overview docs for details on the service.

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *StorageGateway

New creates a new instance of the StorageGateway client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a StorageGateway client from just a session.
svc := storagegateway.New(mySession)

// Create a StorageGateway client with additional configuration
svc := storagegateway.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*StorageGateway) ActivateGateway 

func (c *StorageGateway) ActivateGateway(input *ActivateGatewayInput) (*ActivateGatewayOutput, error)

ActivateGateway API operation for AWS Storage Gateway.

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.

You must turn on the gateway VM before you can activate your gateway.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ActivateGateway for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ActivateGateway

Example (Shared00)

To activate the gateway

Activates the gateway you previously deployed on your host. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.ActivateGatewayInput{
		ActivationKey:     aws.String("29AV1-3OFV9-VVIUB-NKT0I-LRO6V"),
		GatewayName:       aws.String("My_Gateway"),
		GatewayRegion:     aws.String("us-east-1"),
		GatewayTimezone:   aws.String("GMT-12:00"),
		GatewayType:       aws.String("STORED"),
		MediumChangerType: aws.String("AWS-Gateway-VTL"),
		TapeDriveType:     aws.String("IBM-ULT3580-TD5"),
	}

	result, err := svc.ActivateGateway(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) ActivateGatewayRequest 

func (c *StorageGateway) ActivateGatewayRequest(input *ActivateGatewayInput) (req *request.Request, output *ActivateGatewayOutput)

ActivateGatewayRequest generates a "aws/request.Request" representing the client's request for the ActivateGateway operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ActivateGateway for more information on using the ActivateGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ActivateGatewayRequest method.
req, resp := client.ActivateGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ActivateGateway

func (*StorageGateway) ActivateGatewayWithContext added in v1.8.0 

func (c *StorageGateway) ActivateGatewayWithContext(ctx aws.Context, input *ActivateGatewayInput, opts ...request.Option) (*ActivateGatewayOutput, error)

ActivateGatewayWithContext is the same as ActivateGateway with the addition of the ability to pass a context and additional request options.

See ActivateGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) AddCache 

func (c *StorageGateway) AddCache(input *AddCacheInput) (*AddCacheOutput, error)

AddCache API operation for AWS Storage Gateway.

Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts (http://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html)).

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation AddCache for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddCache

Example (Shared00)

To add a cache

The following example shows a request that activates a gateway-stored volume. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.AddCacheInput{
		DiskIds: []*string{
			aws.String("pci-0000:03:00.0-scsi-0:0:0:0"),
			aws.String("pci-0000:03:00.0-scsi-0:0:1:0"),
		},
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.AddCache(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) AddCacheRequest 

func (c *StorageGateway) AddCacheRequest(input *AddCacheInput) (req *request.Request, output *AddCacheOutput)

AddCacheRequest generates a "aws/request.Request" representing the client's request for the AddCache operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddCache for more information on using the AddCache API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AddCacheRequest method.
req, resp := client.AddCacheRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddCache

func (*StorageGateway) AddCacheWithContext added in v1.8.0 

func (c *StorageGateway) AddCacheWithContext(ctx aws.Context, input *AddCacheInput, opts ...request.Option) (*AddCacheOutput, error)

AddCacheWithContext is the same as AddCache with the addition of the ability to pass a context and additional request options.

See AddCache for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) AddTagsToResource added in v0.9.5 

func (c *StorageGateway) AddTagsToResource(input *AddTagsToResourceInput) (*AddTagsToResourceOutput, error)

AddTagsToResource API operation for AWS Storage Gateway.

Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:

  • Storage gateways of all types

  • Storage Volumes

  • Virtual Tapes

You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation AddTagsToResource for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddTagsToResource

Example (Shared00)

To add tags to resource

Adds one or more tags to the specified resource. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.AddTagsToResourceInput{
		ResourceARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"),
		Tags: []*storagegateway.Tag{
			{
				Key:   aws.String("Dev Gatgeway Region"),
				Value: aws.String("East Coast"),
			},
		},
	}

	result, err := svc.AddTagsToResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) AddTagsToResourceRequest added in v0.9.5 

func (c *StorageGateway) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *AddTagsToResourceOutput)

AddTagsToResourceRequest generates a "aws/request.Request" representing the client's request for the AddTagsToResource operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTagsToResource for more information on using the AddTagsToResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AddTagsToResourceRequest method.
req, resp := client.AddTagsToResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddTagsToResource

func (*StorageGateway) AddTagsToResourceWithContext added in v1.8.0 

func (c *StorageGateway) AddTagsToResourceWithContext(ctx aws.Context, input *AddTagsToResourceInput, opts ...request.Option) (*AddTagsToResourceOutput, error)

AddTagsToResourceWithContext is the same as AddTagsToResource with the addition of the ability to pass a context and additional request options.

See AddTagsToResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) AddUploadBuffer 

func (c *StorageGateway) AddUploadBuffer(input *AddUploadBufferInput) (*AddUploadBufferOutput, error)

AddUploadBuffer API operation for AWS Storage Gateway.

Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation AddUploadBuffer for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddUploadBuffer

Example (Shared00)

To add upload buffer on local disk

Configures one or more gateway local disks as upload buffer for a specified gateway. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.AddUploadBufferInput{
		DiskIds: []*string{
			aws.String("pci-0000:03:00.0-scsi-0:0:0:0"),
			aws.String("pci-0000:03:00.0-scsi-0:0:1:0"),
		},
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.AddUploadBuffer(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) AddUploadBufferRequest 

func (c *StorageGateway) AddUploadBufferRequest(input *AddUploadBufferInput) (req *request.Request, output *AddUploadBufferOutput)

AddUploadBufferRequest generates a "aws/request.Request" representing the client's request for the AddUploadBuffer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddUploadBuffer for more information on using the AddUploadBuffer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AddUploadBufferRequest method.
req, resp := client.AddUploadBufferRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddUploadBuffer

func (*StorageGateway) AddUploadBufferWithContext added in v1.8.0 

func (c *StorageGateway) AddUploadBufferWithContext(ctx aws.Context, input *AddUploadBufferInput, opts ...request.Option) (*AddUploadBufferOutput, error)

AddUploadBufferWithContext is the same as AddUploadBuffer with the addition of the ability to pass a context and additional request options.

See AddUploadBuffer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) AddWorkingStorage 

func (c *StorageGateway) AddWorkingStorage(input *AddWorkingStorageInput) (*AddWorkingStorageOutput, error)

AddWorkingStorage API operation for AWS Storage Gateway.

Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.

Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation AddWorkingStorage for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddWorkingStorage

Example (Shared00)

To add storage on local disk

Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.) 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.AddWorkingStorageInput{
		DiskIds: []*string{
			aws.String("pci-0000:03:00.0-scsi-0:0:0:0"),
			aws.String("pci-0000:03:00.0-scsi-0:0:1:0"),
		},
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.AddWorkingStorage(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) AddWorkingStorageRequest 

func (c *StorageGateway) AddWorkingStorageRequest(input *AddWorkingStorageInput) (req *request.Request, output *AddWorkingStorageOutput)

AddWorkingStorageRequest generates a "aws/request.Request" representing the client's request for the AddWorkingStorage operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddWorkingStorage for more information on using the AddWorkingStorage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AddWorkingStorageRequest method.
req, resp := client.AddWorkingStorageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddWorkingStorage

func (*StorageGateway) AddWorkingStorageWithContext added in v1.8.0 

func (c *StorageGateway) AddWorkingStorageWithContext(ctx aws.Context, input *AddWorkingStorageInput, opts ...request.Option) (*AddWorkingStorageOutput, error)

AddWorkingStorageWithContext is the same as AddWorkingStorage with the addition of the ability to pass a context and additional request options.

See AddWorkingStorage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) CancelArchival 

func (c *StorageGateway) CancelArchival(input *CancelArchivalInput) (*CancelArchivalOutput, error)

CancelArchival API operation for AWS Storage Gateway.

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation CancelArchival for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CancelArchival

Example (Shared00)

To cancel virtual tape archiving

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.CancelArchivalInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		TapeARN:    aws.String("arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"),
	}

	result, err := svc.CancelArchival(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) CancelArchivalRequest 

func (c *StorageGateway) CancelArchivalRequest(input *CancelArchivalInput) (req *request.Request, output *CancelArchivalOutput)

CancelArchivalRequest generates a "aws/request.Request" representing the client's request for the CancelArchival operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelArchival for more information on using the CancelArchival API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CancelArchivalRequest method.
req, resp := client.CancelArchivalRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CancelArchival

func (*StorageGateway) CancelArchivalWithContext added in v1.8.0 

func (c *StorageGateway) CancelArchivalWithContext(ctx aws.Context, input *CancelArchivalInput, opts ...request.Option) (*CancelArchivalOutput, error)

CancelArchivalWithContext is the same as CancelArchival with the addition of the ability to pass a context and additional request options.

See CancelArchival for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) CancelRetrieval 

func (c *StorageGateway) CancelRetrieval(input *CancelRetrievalInput) (*CancelRetrievalOutput, error)

CancelRetrieval API operation for AWS Storage Gateway.

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation CancelRetrieval for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CancelRetrieval

Example (Shared00)

To cancel virtual tape retrieval

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.CancelRetrievalInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		TapeARN:    aws.String("arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"),
	}

	result, err := svc.CancelRetrieval(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) CancelRetrievalRequest 

func (c *StorageGateway) CancelRetrievalRequest(input *CancelRetrievalInput) (req *request.Request, output *CancelRetrievalOutput)

CancelRetrievalRequest generates a "aws/request.Request" representing the client's request for the CancelRetrieval operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelRetrieval for more information on using the CancelRetrieval API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CancelRetrievalRequest method.
req, resp := client.CancelRetrievalRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CancelRetrieval

func (*StorageGateway) CancelRetrievalWithContext added in v1.8.0 

func (c *StorageGateway) CancelRetrievalWithContext(ctx aws.Context, input *CancelRetrievalInput, opts ...request.Option) (*CancelRetrievalOutput, error)

CancelRetrievalWithContext is the same as CancelRetrieval with the addition of the ability to pass a context and additional request options.

See CancelRetrieval for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) CreateCachediSCSIVolume 

func (c *StorageGateway) CreateCachediSCSIVolume(input *CreateCachediSCSIVolumeInput) (*CreateCachediSCSIVolumeOutput, error)

CreateCachediSCSIVolume API operation for AWS Storage Gateway.

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation CreateCachediSCSIVolume for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateCachediSCSIVolume

Example (Shared00)

To create a cached iSCSI volume

Creates a cached volume on a specified cached gateway. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.CreateCachediSCSIVolumeInput{
		ClientToken:        aws.String("cachedvol112233"),
		GatewayARN:         aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		NetworkInterfaceId: aws.String("10.1.1.1"),
		SnapshotId:         aws.String("snap-f47b7b94"),
		TargetName:         aws.String("my-volume"),
		VolumeSizeInBytes:  aws.Int64(536870912000),
	}

	result, err := svc.CreateCachediSCSIVolume(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) CreateCachediSCSIVolumeRequest 

func (c *StorageGateway) CreateCachediSCSIVolumeRequest(input *CreateCachediSCSIVolumeInput) (req *request.Request, output *CreateCachediSCSIVolumeOutput)

CreateCachediSCSIVolumeRequest generates a "aws/request.Request" representing the client's request for the CreateCachediSCSIVolume operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCachediSCSIVolume for more information on using the CreateCachediSCSIVolume API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateCachediSCSIVolumeRequest method.
req, resp := client.CreateCachediSCSIVolumeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateCachediSCSIVolume

func (*StorageGateway) CreateCachediSCSIVolumeWithContext added in v1.8.0 

func (c *StorageGateway) CreateCachediSCSIVolumeWithContext(ctx aws.Context, input *CreateCachediSCSIVolumeInput, opts ...request.Option) (*CreateCachediSCSIVolumeOutput, error)

CreateCachediSCSIVolumeWithContext is the same as CreateCachediSCSIVolume with the addition of the ability to pass a context and additional request options.

See CreateCachediSCSIVolume for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) CreateNFSFileShare added in v1.6.6 

func (c *StorageGateway) CreateNFSFileShare(input *CreateNFSFileShareInput) (*CreateNFSFileShareOutput, error)

CreateNFSFileShare API operation for AWS Storage Gateway.

Creates a file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a Network File System (NFS) interface. This operation is only supported in the file gateway type.

File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateway does not support creating hard or symbolic links on a file share.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation CreateNFSFileShare for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateNFSFileShare

func (*StorageGateway) CreateNFSFileShareRequest added in v1.6.6 

func (c *StorageGateway) CreateNFSFileShareRequest(input *CreateNFSFileShareInput) (req *request.Request, output *CreateNFSFileShareOutput)

CreateNFSFileShareRequest generates a "aws/request.Request" representing the client's request for the CreateNFSFileShare operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateNFSFileShare for more information on using the CreateNFSFileShare API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateNFSFileShareRequest method.
req, resp := client.CreateNFSFileShareRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateNFSFileShare

func (*StorageGateway) CreateNFSFileShareWithContext added in v1.8.0 

func (c *StorageGateway) CreateNFSFileShareWithContext(ctx aws.Context, input *CreateNFSFileShareInput, opts ...request.Option) (*CreateNFSFileShareOutput, error)

CreateNFSFileShareWithContext is the same as CreateNFSFileShare with the addition of the ability to pass a context and additional request options.

See CreateNFSFileShare for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) CreateSnapshot 

func (c *StorageGateway) CreateSnapshot(input *CreateSnapshotInput) (*CreateSnapshotOutput, error)

CreateSnapshot API operation for AWS Storage Gateway.

Initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule (http://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot).

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference (http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html).

Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome (http://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html) page.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation CreateSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

  • ErrCodeServiceUnavailableError "ServiceUnavailableError" An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateSnapshot

Example (Shared00)

To create a snapshot of a gateway volume

Initiates an ad-hoc snapshot of a gateway volume. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.CreateSnapshotInput{
		SnapshotDescription: aws.String("My root volume snapshot as of 10/03/2017"),
		VolumeARN:           aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
	}

	result, err := svc.CreateSnapshot(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, aerr.Error())
			case storagegateway.ErrCodeServiceUnavailableError:
				fmt.Println(storagegateway.ErrCodeServiceUnavailableError, 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 (*StorageGateway) CreateSnapshotFromVolumeRecoveryPoint 

func (c *StorageGateway) CreateSnapshotFromVolumeRecoveryPoint(input *CreateSnapshotFromVolumeRecoveryPointInput) (*CreateSnapshotFromVolumeRecoveryPointOutput, error)

CreateSnapshotFromVolumeRecoveryPoint API operation for AWS Storage Gateway.

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation CreateSnapshotFromVolumeRecoveryPoint for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

  • ErrCodeServiceUnavailableError "ServiceUnavailableError" An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint

Example (Shared00)

To create a snapshot of a gateway volume

Initiates a snapshot of a gateway from a volume recovery point. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.CreateSnapshotFromVolumeRecoveryPointInput{
		SnapshotDescription: aws.String("My root volume snapshot as of 2017-06-30T10:10:10.000Z"),
		VolumeARN:           aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
	}

	result, err := svc.CreateSnapshotFromVolumeRecoveryPoint(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, aerr.Error())
			case storagegateway.ErrCodeServiceUnavailableError:
				fmt.Println(storagegateway.ErrCodeServiceUnavailableError, 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 (*StorageGateway) CreateSnapshotFromVolumeRecoveryPointRequest 

func (c *StorageGateway) CreateSnapshotFromVolumeRecoveryPointRequest(input *CreateSnapshotFromVolumeRecoveryPointInput) (req *request.Request, output *CreateSnapshotFromVolumeRecoveryPointOutput)

CreateSnapshotFromVolumeRecoveryPointRequest generates a "aws/request.Request" representing the client's request for the CreateSnapshotFromVolumeRecoveryPoint operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSnapshotFromVolumeRecoveryPoint for more information on using the CreateSnapshotFromVolumeRecoveryPoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateSnapshotFromVolumeRecoveryPointRequest method.
req, resp := client.CreateSnapshotFromVolumeRecoveryPointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint

func (*StorageGateway) CreateSnapshotFromVolumeRecoveryPointWithContext added in v1.8.0 

func (c *StorageGateway) CreateSnapshotFromVolumeRecoveryPointWithContext(ctx aws.Context, input *CreateSnapshotFromVolumeRecoveryPointInput, opts ...request.Option) (*CreateSnapshotFromVolumeRecoveryPointOutput, error)

CreateSnapshotFromVolumeRecoveryPointWithContext is the same as CreateSnapshotFromVolumeRecoveryPoint with the addition of the ability to pass a context and additional request options.

See CreateSnapshotFromVolumeRecoveryPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) CreateSnapshotRequest 

func (c *StorageGateway) CreateSnapshotRequest(input *CreateSnapshotInput) (req *request.Request, output *CreateSnapshotOutput)

CreateSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSnapshot for more information on using the CreateSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateSnapshotRequest method.
req, resp := client.CreateSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateSnapshot

func (*StorageGateway) CreateSnapshotWithContext added in v1.8.0 

func (c *StorageGateway) CreateSnapshotWithContext(ctx aws.Context, input *CreateSnapshotInput, opts ...request.Option) (*CreateSnapshotOutput, error)

CreateSnapshotWithContext is the same as CreateSnapshot with the addition of the ability to pass a context and additional request options.

See CreateSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) CreateStorediSCSIVolume 

func (c *StorageGateway) CreateStorediSCSIVolume(input *CreateStorediSCSIVolumeInput) (*CreateStorediSCSIVolumeOutput, error)

CreateStorediSCSIVolume API operation for AWS Storage Gateway.

Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation CreateStorediSCSIVolume for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateStorediSCSIVolume

Example (Shared00)

To create a stored iSCSI volume

Creates a stored volume on a specified stored gateway. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.CreateStorediSCSIVolumeInput{
		DiskId:               aws.String("pci-0000:03:00.0-scsi-0:0:0:0"),
		GatewayARN:           aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		NetworkInterfaceId:   aws.String("10.1.1.1"),
		PreserveExistingData: aws.Bool(true),
		SnapshotId:           aws.String("snap-f47b7b94"),
		TargetName:           aws.String("my-volume"),
	}

	result, err := svc.CreateStorediSCSIVolume(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) CreateStorediSCSIVolumeRequest 

func (c *StorageGateway) CreateStorediSCSIVolumeRequest(input *CreateStorediSCSIVolumeInput) (req *request.Request, output *CreateStorediSCSIVolumeOutput)

CreateStorediSCSIVolumeRequest generates a "aws/request.Request" representing the client's request for the CreateStorediSCSIVolume operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStorediSCSIVolume for more information on using the CreateStorediSCSIVolume API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateStorediSCSIVolumeRequest method.
req, resp := client.CreateStorediSCSIVolumeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateStorediSCSIVolume

func (*StorageGateway) CreateStorediSCSIVolumeWithContext added in v1.8.0 

func (c *StorageGateway) CreateStorediSCSIVolumeWithContext(ctx aws.Context, input *CreateStorediSCSIVolumeInput, opts ...request.Option) (*CreateStorediSCSIVolumeOutput, error)

CreateStorediSCSIVolumeWithContext is the same as CreateStorediSCSIVolume with the addition of the ability to pass a context and additional request options.

See CreateStorediSCSIVolume for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) CreateTapeWithBarcode added in v1.1.4 

func (c *StorageGateway) CreateTapeWithBarcode(input *CreateTapeWithBarcodeInput) (*CreateTapeWithBarcodeOutput, error)

CreateTapeWithBarcode API operation for AWS Storage Gateway.

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation CreateTapeWithBarcode for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapeWithBarcode

Example (Shared00)

To create a virtual tape using a barcode

Creates a virtual tape by using your own barcode. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.CreateTapeWithBarcodeInput{
		GatewayARN:      aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		TapeBarcode:     aws.String("TEST12345"),
		TapeSizeInBytes: aws.Int64(107374182400),
	}

	result, err := svc.CreateTapeWithBarcode(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) CreateTapeWithBarcodeRequest added in v1.1.4 

func (c *StorageGateway) CreateTapeWithBarcodeRequest(input *CreateTapeWithBarcodeInput) (req *request.Request, output *CreateTapeWithBarcodeOutput)

CreateTapeWithBarcodeRequest generates a "aws/request.Request" representing the client's request for the CreateTapeWithBarcode operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTapeWithBarcode for more information on using the CreateTapeWithBarcode API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateTapeWithBarcodeRequest method.
req, resp := client.CreateTapeWithBarcodeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapeWithBarcode

func (*StorageGateway) CreateTapeWithBarcodeWithContext added in v1.8.0 

func (c *StorageGateway) CreateTapeWithBarcodeWithContext(ctx aws.Context, input *CreateTapeWithBarcodeInput, opts ...request.Option) (*CreateTapeWithBarcodeOutput, error)

CreateTapeWithBarcodeWithContext is the same as CreateTapeWithBarcode with the addition of the ability to pass a context and additional request options.

See CreateTapeWithBarcode for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) CreateTapes 

func (c *StorageGateway) CreateTapes(input *CreateTapesInput) (*CreateTapesOutput, error)

CreateTapes API operation for AWS Storage Gateway.

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation CreateTapes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapes

Example (Shared00)

To create a virtual tape

Creates one or more virtual tapes. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.CreateTapesInput{
		ClientToken:       aws.String("77777"),
		GatewayARN:        aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		NumTapesToCreate:  aws.Int64(3),
		TapeBarcodePrefix: aws.String("TEST"),
		TapeSizeInBytes:   aws.Int64(107374182400),
	}

	result, err := svc.CreateTapes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) CreateTapesRequest 

func (c *StorageGateway) CreateTapesRequest(input *CreateTapesInput) (req *request.Request, output *CreateTapesOutput)

CreateTapesRequest generates a "aws/request.Request" representing the client's request for the CreateTapes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTapes for more information on using the CreateTapes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateTapesRequest method.
req, resp := client.CreateTapesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapes

func (*StorageGateway) CreateTapesWithContext added in v1.8.0 

func (c *StorageGateway) CreateTapesWithContext(ctx aws.Context, input *CreateTapesInput, opts ...request.Option) (*CreateTapesOutput, error)

CreateTapesWithContext is the same as CreateTapes with the addition of the ability to pass a context and additional request options.

See CreateTapes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DeleteBandwidthRateLimit 

func (c *StorageGateway) DeleteBandwidthRateLimit(input *DeleteBandwidthRateLimitInput) (*DeleteBandwidthRateLimitOutput, error)

DeleteBandwidthRateLimit API operation for AWS Storage Gateway.

Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DeleteBandwidthRateLimit for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteBandwidthRateLimit

Example (Shared00)

To delete bandwidth rate limits of gateway

Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DeleteBandwidthRateLimitInput{
		BandwidthType: aws.String("All"),
		GatewayARN:    aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DeleteBandwidthRateLimit(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DeleteBandwidthRateLimitRequest 

func (c *StorageGateway) DeleteBandwidthRateLimitRequest(input *DeleteBandwidthRateLimitInput) (req *request.Request, output *DeleteBandwidthRateLimitOutput)

DeleteBandwidthRateLimitRequest generates a "aws/request.Request" representing the client's request for the DeleteBandwidthRateLimit operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBandwidthRateLimit for more information on using the DeleteBandwidthRateLimit API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBandwidthRateLimitRequest method.
req, resp := client.DeleteBandwidthRateLimitRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteBandwidthRateLimit

func (*StorageGateway) DeleteBandwidthRateLimitWithContext added in v1.8.0 

func (c *StorageGateway) DeleteBandwidthRateLimitWithContext(ctx aws.Context, input *DeleteBandwidthRateLimitInput, opts ...request.Option) (*DeleteBandwidthRateLimitOutput, error)

DeleteBandwidthRateLimitWithContext is the same as DeleteBandwidthRateLimit with the addition of the ability to pass a context and additional request options.

See DeleteBandwidthRateLimit for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DeleteChapCredentials 

func (c *StorageGateway) DeleteChapCredentials(input *DeleteChapCredentialsInput) (*DeleteChapCredentialsOutput, error)

DeleteChapCredentials API operation for AWS Storage Gateway.

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DeleteChapCredentials for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteChapCredentials

Example (Shared00)

To delete CHAP credentials

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DeleteChapCredentialsInput{
		InitiatorName: aws.String("iqn.1991-05.com.microsoft:computername.domain.example.com"),
		TargetARN:     aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"),
	}

	result, err := svc.DeleteChapCredentials(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DeleteChapCredentialsRequest 

func (c *StorageGateway) DeleteChapCredentialsRequest(input *DeleteChapCredentialsInput) (req *request.Request, output *DeleteChapCredentialsOutput)

DeleteChapCredentialsRequest generates a "aws/request.Request" representing the client's request for the DeleteChapCredentials operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteChapCredentials for more information on using the DeleteChapCredentials API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteChapCredentialsRequest method.
req, resp := client.DeleteChapCredentialsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteChapCredentials

func (*StorageGateway) DeleteChapCredentialsWithContext added in v1.8.0 

func (c *StorageGateway) DeleteChapCredentialsWithContext(ctx aws.Context, input *DeleteChapCredentialsInput, opts ...request.Option) (*DeleteChapCredentialsOutput, error)

DeleteChapCredentialsWithContext is the same as DeleteChapCredentials with the addition of the ability to pass a context and additional request options.

See DeleteChapCredentials for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DeleteFileShare added in v1.6.6 

func (c *StorageGateway) DeleteFileShare(input *DeleteFileShareInput) (*DeleteFileShareOutput, error)

DeleteFileShare API operation for AWS Storage Gateway.

Deletes a file share from a file gateway. This operation is only supported in the file gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DeleteFileShare for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteFileShare

func (*StorageGateway) DeleteFileShareRequest added in v1.6.6 

func (c *StorageGateway) DeleteFileShareRequest(input *DeleteFileShareInput) (req *request.Request, output *DeleteFileShareOutput)

DeleteFileShareRequest generates a "aws/request.Request" representing the client's request for the DeleteFileShare operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFileShare for more information on using the DeleteFileShare API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteFileShareRequest method.
req, resp := client.DeleteFileShareRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteFileShare

func (*StorageGateway) DeleteFileShareWithContext added in v1.8.0 

func (c *StorageGateway) DeleteFileShareWithContext(ctx aws.Context, input *DeleteFileShareInput, opts ...request.Option) (*DeleteFileShareOutput, error)

DeleteFileShareWithContext is the same as DeleteFileShare with the addition of the ability to pass a context and additional request options.

See DeleteFileShare for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DeleteGateway 

func (c *StorageGateway) DeleteGateway(input *DeleteGatewayInput) (*DeleteGatewayOutput, error)

DeleteGateway API operation for AWS Storage Gateway.

Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page (http://aws.amazon.com/storagegateway).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DeleteGateway for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteGateway

Example (Shared00)

To delete a gatgeway

This operation deletes the gateway, but not the gateway's VM from the host computer. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DeleteGatewayInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DeleteGateway(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DeleteGatewayRequest 

func (c *StorageGateway) DeleteGatewayRequest(input *DeleteGatewayInput) (req *request.Request, output *DeleteGatewayOutput)

DeleteGatewayRequest generates a "aws/request.Request" representing the client's request for the DeleteGateway operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGateway for more information on using the DeleteGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteGatewayRequest method.
req, resp := client.DeleteGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteGateway

func (*StorageGateway) DeleteGatewayWithContext added in v1.8.0 

func (c *StorageGateway) DeleteGatewayWithContext(ctx aws.Context, input *DeleteGatewayInput, opts ...request.Option) (*DeleteGatewayOutput, error)

DeleteGatewayWithContext is the same as DeleteGateway with the addition of the ability to pass a context and additional request options.

See DeleteGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DeleteSnapshotSchedule 

func (c *StorageGateway) DeleteSnapshotSchedule(input *DeleteSnapshotScheduleInput) (*DeleteSnapshotScheduleOutput, error)

DeleteSnapshotSchedule API operation for AWS Storage Gateway.

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots (http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html). In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.

To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DeleteSnapshotSchedule for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteSnapshotSchedule

Example (Shared00)

To delete a snapshot of a volume

This action enables you to delete a snapshot schedule for a volume. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DeleteSnapshotScheduleInput{
		VolumeARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
	}

	result, err := svc.DeleteSnapshotSchedule(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DeleteSnapshotScheduleRequest 

func (c *StorageGateway) DeleteSnapshotScheduleRequest(input *DeleteSnapshotScheduleInput) (req *request.Request, output *DeleteSnapshotScheduleOutput)

DeleteSnapshotScheduleRequest generates a "aws/request.Request" representing the client's request for the DeleteSnapshotSchedule operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSnapshotSchedule for more information on using the DeleteSnapshotSchedule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSnapshotScheduleRequest method.
req, resp := client.DeleteSnapshotScheduleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteSnapshotSchedule

func (*StorageGateway) DeleteSnapshotScheduleWithContext added in v1.8.0 

func (c *StorageGateway) DeleteSnapshotScheduleWithContext(ctx aws.Context, input *DeleteSnapshotScheduleInput, opts ...request.Option) (*DeleteSnapshotScheduleOutput, error)

DeleteSnapshotScheduleWithContext is the same as DeleteSnapshotSchedule with the addition of the ability to pass a context and additional request options.

See DeleteSnapshotSchedule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DeleteTape 

func (c *StorageGateway) DeleteTape(input *DeleteTapeInput) (*DeleteTapeOutput, error)

DeleteTape API operation for AWS Storage Gateway.

Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DeleteTape for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTape

Example (Shared00)

To delete a virtual tape

This example deletes the specified virtual tape. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DeleteTapeInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B"),
		TapeARN:    aws.String("arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"),
	}

	result, err := svc.DeleteTape(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DeleteTapeArchive 

func (c *StorageGateway) DeleteTapeArchive(input *DeleteTapeArchiveInput) (*DeleteTapeArchiveOutput, error)

DeleteTapeArchive API operation for AWS Storage Gateway.

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DeleteTapeArchive for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTapeArchive

Example (Shared00)

To delete a virtual tape from the shelf (VTS)

Deletes the specified virtual tape from the virtual tape shelf (VTS). 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DeleteTapeArchiveInput{
		TapeARN: aws.String("arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"),
	}

	result, err := svc.DeleteTapeArchive(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DeleteTapeArchiveRequest 

func (c *StorageGateway) DeleteTapeArchiveRequest(input *DeleteTapeArchiveInput) (req *request.Request, output *DeleteTapeArchiveOutput)

DeleteTapeArchiveRequest generates a "aws/request.Request" representing the client's request for the DeleteTapeArchive operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTapeArchive for more information on using the DeleteTapeArchive API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteTapeArchiveRequest method.
req, resp := client.DeleteTapeArchiveRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTapeArchive

func (*StorageGateway) DeleteTapeArchiveWithContext added in v1.8.0 

func (c *StorageGateway) DeleteTapeArchiveWithContext(ctx aws.Context, input *DeleteTapeArchiveInput, opts ...request.Option) (*DeleteTapeArchiveOutput, error)

DeleteTapeArchiveWithContext is the same as DeleteTapeArchive with the addition of the ability to pass a context and additional request options.

See DeleteTapeArchive for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DeleteTapeRequest 

func (c *StorageGateway) DeleteTapeRequest(input *DeleteTapeInput) (req *request.Request, output *DeleteTapeOutput)

DeleteTapeRequest generates a "aws/request.Request" representing the client's request for the DeleteTape operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTape for more information on using the DeleteTape API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteTapeRequest method.
req, resp := client.DeleteTapeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTape

func (*StorageGateway) DeleteTapeWithContext added in v1.8.0 

func (c *StorageGateway) DeleteTapeWithContext(ctx aws.Context, input *DeleteTapeInput, opts ...request.Option) (*DeleteTapeOutput, error)

DeleteTapeWithContext is the same as DeleteTape with the addition of the ability to pass a context and additional request options.

See DeleteTape for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DeleteVolume 

func (c *StorageGateway) DeleteVolume(input *DeleteVolumeInput) (*DeleteVolumeOutput, error)

DeleteVolume API operation for AWS Storage Gateway.

Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots (http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) in the Amazon Elastic Compute Cloud API Reference.

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DeleteVolume for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteVolume

Example (Shared00)

To delete a gateway volume

Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DeleteVolumeInput{
		VolumeARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
	}

	result, err := svc.DeleteVolume(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DeleteVolumeRequest 

func (c *StorageGateway) DeleteVolumeRequest(input *DeleteVolumeInput) (req *request.Request, output *DeleteVolumeOutput)

DeleteVolumeRequest generates a "aws/request.Request" representing the client's request for the DeleteVolume operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteVolume for more information on using the DeleteVolume API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteVolumeRequest method.
req, resp := client.DeleteVolumeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteVolume

func (*StorageGateway) DeleteVolumeWithContext added in v1.8.0 

func (c *StorageGateway) DeleteVolumeWithContext(ctx aws.Context, input *DeleteVolumeInput, opts ...request.Option) (*DeleteVolumeOutput, error)

DeleteVolumeWithContext is the same as DeleteVolume with the addition of the ability to pass a context and additional request options.

See DeleteVolume for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeBandwidthRateLimit 

func (c *StorageGateway) DescribeBandwidthRateLimit(input *DescribeBandwidthRateLimitInput) (*DescribeBandwidthRateLimitOutput, error)

DescribeBandwidthRateLimit API operation for AWS Storage Gateway.

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeBandwidthRateLimit for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeBandwidthRateLimit

Example (Shared00)

To describe the bandwidth rate limits of a gateway

Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeBandwidthRateLimitInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DescribeBandwidthRateLimit(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeBandwidthRateLimitRequest 

func (c *StorageGateway) DescribeBandwidthRateLimitRequest(input *DescribeBandwidthRateLimitInput) (req *request.Request, output *DescribeBandwidthRateLimitOutput)

DescribeBandwidthRateLimitRequest generates a "aws/request.Request" representing the client's request for the DescribeBandwidthRateLimit operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBandwidthRateLimit for more information on using the DescribeBandwidthRateLimit API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBandwidthRateLimitRequest method.
req, resp := client.DescribeBandwidthRateLimitRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeBandwidthRateLimit

func (*StorageGateway) DescribeBandwidthRateLimitWithContext added in v1.8.0 

func (c *StorageGateway) DescribeBandwidthRateLimitWithContext(ctx aws.Context, input *DescribeBandwidthRateLimitInput, opts ...request.Option) (*DescribeBandwidthRateLimitOutput, error)

DescribeBandwidthRateLimitWithContext is the same as DescribeBandwidthRateLimit with the addition of the ability to pass a context and additional request options.

See DescribeBandwidthRateLimit for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeCache 

func (c *StorageGateway) DescribeCache(input *DescribeCacheInput) (*DescribeCacheOutput, error)

DescribeCache API operation for AWS Storage Gateway.

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeCache for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeCache

Example (Shared00)

To describe cache information

Returns information about the cache of a gateway. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeCacheInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DescribeCache(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeCacheRequest 

func (c *StorageGateway) DescribeCacheRequest(input *DescribeCacheInput) (req *request.Request, output *DescribeCacheOutput)

DescribeCacheRequest generates a "aws/request.Request" representing the client's request for the DescribeCache operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCache for more information on using the DescribeCache API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeCacheRequest method.
req, resp := client.DescribeCacheRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeCache

func (*StorageGateway) DescribeCacheWithContext added in v1.8.0 

func (c *StorageGateway) DescribeCacheWithContext(ctx aws.Context, input *DescribeCacheInput, opts ...request.Option) (*DescribeCacheOutput, error)

DescribeCacheWithContext is the same as DescribeCache with the addition of the ability to pass a context and additional request options.

See DescribeCache for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeCachediSCSIVolumes 

func (c *StorageGateway) DescribeCachediSCSIVolumes(input *DescribeCachediSCSIVolumesInput) (*DescribeCachediSCSIVolumesOutput, error)

DescribeCachediSCSIVolumes API operation for AWS Storage Gateway.

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeCachediSCSIVolumes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeCachediSCSIVolumes

Example (Shared00)

To describe gateway cached iSCSI volumes

Returns a description of the gateway cached iSCSI volumes specified in the request. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeCachediSCSIVolumesInput{
		VolumeARNs: []*string{
			aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
		},
	}

	result, err := svc.DescribeCachediSCSIVolumes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeCachediSCSIVolumesRequest 

func (c *StorageGateway) DescribeCachediSCSIVolumesRequest(input *DescribeCachediSCSIVolumesInput) (req *request.Request, output *DescribeCachediSCSIVolumesOutput)

DescribeCachediSCSIVolumesRequest generates a "aws/request.Request" representing the client's request for the DescribeCachediSCSIVolumes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCachediSCSIVolumes for more information on using the DescribeCachediSCSIVolumes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeCachediSCSIVolumesRequest method.
req, resp := client.DescribeCachediSCSIVolumesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeCachediSCSIVolumes

func (*StorageGateway) DescribeCachediSCSIVolumesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeCachediSCSIVolumesWithContext(ctx aws.Context, input *DescribeCachediSCSIVolumesInput, opts ...request.Option) (*DescribeCachediSCSIVolumesOutput, error)

DescribeCachediSCSIVolumesWithContext is the same as DescribeCachediSCSIVolumes with the addition of the ability to pass a context and additional request options.

See DescribeCachediSCSIVolumes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeChapCredentials 

func (c *StorageGateway) DescribeChapCredentials(input *DescribeChapCredentialsInput) (*DescribeChapCredentialsOutput, error)

DescribeChapCredentials API operation for AWS Storage Gateway.

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeChapCredentials for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeChapCredentials

Example (Shared00)

To describe CHAP credetnitals for an iSCSI

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeChapCredentialsInput{
		TargetARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"),
	}

	result, err := svc.DescribeChapCredentials(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeChapCredentialsRequest 

func (c *StorageGateway) DescribeChapCredentialsRequest(input *DescribeChapCredentialsInput) (req *request.Request, output *DescribeChapCredentialsOutput)

DescribeChapCredentialsRequest generates a "aws/request.Request" representing the client's request for the DescribeChapCredentials operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeChapCredentials for more information on using the DescribeChapCredentials API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeChapCredentialsRequest method.
req, resp := client.DescribeChapCredentialsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeChapCredentials

func (*StorageGateway) DescribeChapCredentialsWithContext added in v1.8.0 

func (c *StorageGateway) DescribeChapCredentialsWithContext(ctx aws.Context, input *DescribeChapCredentialsInput, opts ...request.Option) (*DescribeChapCredentialsOutput, error)

DescribeChapCredentialsWithContext is the same as DescribeChapCredentials with the addition of the ability to pass a context and additional request options.

See DescribeChapCredentials for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeGatewayInformation 

func (c *StorageGateway) DescribeGatewayInformation(input *DescribeGatewayInformationInput) (*DescribeGatewayInformationOutput, error)

DescribeGatewayInformation API operation for AWS Storage Gateway.

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeGatewayInformation for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformation

Example (Shared00)

To describe metadata about the gateway

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeGatewayInformationInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DescribeGatewayInformation(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeGatewayInformationRequest 

func (c *StorageGateway) DescribeGatewayInformationRequest(input *DescribeGatewayInformationInput) (req *request.Request, output *DescribeGatewayInformationOutput)

DescribeGatewayInformationRequest generates a "aws/request.Request" representing the client's request for the DescribeGatewayInformation operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGatewayInformation for more information on using the DescribeGatewayInformation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeGatewayInformationRequest method.
req, resp := client.DescribeGatewayInformationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformation

func (*StorageGateway) DescribeGatewayInformationWithContext added in v1.8.0 

func (c *StorageGateway) DescribeGatewayInformationWithContext(ctx aws.Context, input *DescribeGatewayInformationInput, opts ...request.Option) (*DescribeGatewayInformationOutput, error)

DescribeGatewayInformationWithContext is the same as DescribeGatewayInformation with the addition of the ability to pass a context and additional request options.

See DescribeGatewayInformation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeMaintenanceStartTime 

func (c *StorageGateway) DescribeMaintenanceStartTime(input *DescribeMaintenanceStartTimeInput) (*DescribeMaintenanceStartTimeOutput, error)

DescribeMaintenanceStartTime API operation for AWS Storage Gateway.

Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeMaintenanceStartTime for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeMaintenanceStartTime

Example (Shared00)

To describe gateway's maintenance start time

Returns your gateway's weekly maintenance start time including the day and time of the week. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeMaintenanceStartTimeInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DescribeMaintenanceStartTime(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeMaintenanceStartTimeRequest 

func (c *StorageGateway) DescribeMaintenanceStartTimeRequest(input *DescribeMaintenanceStartTimeInput) (req *request.Request, output *DescribeMaintenanceStartTimeOutput)

DescribeMaintenanceStartTimeRequest generates a "aws/request.Request" representing the client's request for the DescribeMaintenanceStartTime operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMaintenanceStartTime for more information on using the DescribeMaintenanceStartTime API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeMaintenanceStartTimeRequest method.
req, resp := client.DescribeMaintenanceStartTimeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeMaintenanceStartTime

func (*StorageGateway) DescribeMaintenanceStartTimeWithContext added in v1.8.0 

func (c *StorageGateway) DescribeMaintenanceStartTimeWithContext(ctx aws.Context, input *DescribeMaintenanceStartTimeInput, opts ...request.Option) (*DescribeMaintenanceStartTimeOutput, error)

DescribeMaintenanceStartTimeWithContext is the same as DescribeMaintenanceStartTime with the addition of the ability to pass a context and additional request options.

See DescribeMaintenanceStartTime for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeNFSFileShares added in v1.6.6 

func (c *StorageGateway) DescribeNFSFileShares(input *DescribeNFSFileSharesInput) (*DescribeNFSFileSharesOutput, error)

DescribeNFSFileShares API operation for AWS Storage Gateway.

Gets a description for one or more file shares from a file gateway. This operation is only supported in the file gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeNFSFileShares for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares

func (*StorageGateway) DescribeNFSFileSharesRequest added in v1.6.6 

func (c *StorageGateway) DescribeNFSFileSharesRequest(input *DescribeNFSFileSharesInput) (req *request.Request, output *DescribeNFSFileSharesOutput)

DescribeNFSFileSharesRequest generates a "aws/request.Request" representing the client's request for the DescribeNFSFileShares operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeNFSFileShares for more information on using the DescribeNFSFileShares API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeNFSFileSharesRequest method.
req, resp := client.DescribeNFSFileSharesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares

func (*StorageGateway) DescribeNFSFileSharesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeNFSFileSharesWithContext(ctx aws.Context, input *DescribeNFSFileSharesInput, opts ...request.Option) (*DescribeNFSFileSharesOutput, error)

DescribeNFSFileSharesWithContext is the same as DescribeNFSFileShares with the addition of the ability to pass a context and additional request options.

See DescribeNFSFileShares for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeSnapshotSchedule 

func (c *StorageGateway) DescribeSnapshotSchedule(input *DescribeSnapshotScheduleInput) (*DescribeSnapshotScheduleOutput, error)

DescribeSnapshotSchedule API operation for AWS Storage Gateway.

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeSnapshotSchedule for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSnapshotSchedule

Example (Shared00)

To describe snapshot schedule for gateway volume

Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeSnapshotScheduleInput{
		VolumeARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
	}

	result, err := svc.DescribeSnapshotSchedule(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeSnapshotScheduleRequest 

func (c *StorageGateway) DescribeSnapshotScheduleRequest(input *DescribeSnapshotScheduleInput) (req *request.Request, output *DescribeSnapshotScheduleOutput)

DescribeSnapshotScheduleRequest generates a "aws/request.Request" representing the client's request for the DescribeSnapshotSchedule operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSnapshotSchedule for more information on using the DescribeSnapshotSchedule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeSnapshotScheduleRequest method.
req, resp := client.DescribeSnapshotScheduleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSnapshotSchedule

func (*StorageGateway) DescribeSnapshotScheduleWithContext added in v1.8.0 

func (c *StorageGateway) DescribeSnapshotScheduleWithContext(ctx aws.Context, input *DescribeSnapshotScheduleInput, opts ...request.Option) (*DescribeSnapshotScheduleOutput, error)

DescribeSnapshotScheduleWithContext is the same as DescribeSnapshotSchedule with the addition of the ability to pass a context and additional request options.

See DescribeSnapshotSchedule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeStorediSCSIVolumes 

func (c *StorageGateway) DescribeStorediSCSIVolumes(input *DescribeStorediSCSIVolumesInput) (*DescribeStorediSCSIVolumesOutput, error)

DescribeStorediSCSIVolumes API operation for AWS Storage Gateway.

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeStorediSCSIVolumes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeStorediSCSIVolumes

Example (Shared00)

To describe the volumes of a gateway

Returns the description of the gateway volumes specified in the request belonging to the same gateway. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeStorediSCSIVolumesInput{
		VolumeARNs: []*string{
			aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
		},
	}

	result, err := svc.DescribeStorediSCSIVolumes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeStorediSCSIVolumesRequest 

func (c *StorageGateway) DescribeStorediSCSIVolumesRequest(input *DescribeStorediSCSIVolumesInput) (req *request.Request, output *DescribeStorediSCSIVolumesOutput)

DescribeStorediSCSIVolumesRequest generates a "aws/request.Request" representing the client's request for the DescribeStorediSCSIVolumes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStorediSCSIVolumes for more information on using the DescribeStorediSCSIVolumes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStorediSCSIVolumesRequest method.
req, resp := client.DescribeStorediSCSIVolumesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeStorediSCSIVolumes

func (*StorageGateway) DescribeStorediSCSIVolumesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeStorediSCSIVolumesWithContext(ctx aws.Context, input *DescribeStorediSCSIVolumesInput, opts ...request.Option) (*DescribeStorediSCSIVolumesOutput, error)

DescribeStorediSCSIVolumesWithContext is the same as DescribeStorediSCSIVolumes with the addition of the ability to pass a context and additional request options.

See DescribeStorediSCSIVolumes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeTapeArchives 

func (c *StorageGateway) DescribeTapeArchives(input *DescribeTapeArchivesInput) (*DescribeTapeArchivesOutput, error)

DescribeTapeArchives API operation for AWS Storage Gateway.

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeTapeArchives for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapeArchives

Example (Shared00)

To describe virtual tapes in the VTS

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeTapeArchivesInput{
		Limit:  aws.Int64(123),
		Marker: aws.String("1"),
		TapeARNs: []*string{
			aws.String("arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD"),
			aws.String("arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"),
		},
	}

	result, err := svc.DescribeTapeArchives(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeTapeArchivesPages 

func (c *StorageGateway) DescribeTapeArchivesPages(input *DescribeTapeArchivesInput, fn func(*DescribeTapeArchivesOutput, bool) bool) error

DescribeTapeArchivesPages iterates over the pages of a DescribeTapeArchives operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeTapeArchives method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeTapeArchives operation.
pageNum := 0
err := client.DescribeTapeArchivesPages(params,
    func(page *DescribeTapeArchivesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) DescribeTapeArchivesPagesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeTapeArchivesPagesWithContext(ctx aws.Context, input *DescribeTapeArchivesInput, fn func(*DescribeTapeArchivesOutput, bool) bool, opts ...request.Option) error

DescribeTapeArchivesPagesWithContext same as DescribeTapeArchivesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeTapeArchivesRequest 

func (c *StorageGateway) DescribeTapeArchivesRequest(input *DescribeTapeArchivesInput) (req *request.Request, output *DescribeTapeArchivesOutput)

DescribeTapeArchivesRequest generates a "aws/request.Request" representing the client's request for the DescribeTapeArchives operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTapeArchives for more information on using the DescribeTapeArchives API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTapeArchivesRequest method.
req, resp := client.DescribeTapeArchivesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapeArchives

func (*StorageGateway) DescribeTapeArchivesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeTapeArchivesWithContext(ctx aws.Context, input *DescribeTapeArchivesInput, opts ...request.Option) (*DescribeTapeArchivesOutput, error)

DescribeTapeArchivesWithContext is the same as DescribeTapeArchives with the addition of the ability to pass a context and additional request options.

See DescribeTapeArchives for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeTapeRecoveryPoints 

func (c *StorageGateway) DescribeTapeRecoveryPoints(input *DescribeTapeRecoveryPointsInput) (*DescribeTapeRecoveryPointsOutput, error)

DescribeTapeRecoveryPoints API operation for AWS Storage Gateway.

Returns a list of virtual tape recovery points that are available for the specified tape gateway.

A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeTapeRecoveryPoints for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapeRecoveryPoints

Example (Shared00)

To describe virtual tape recovery points

Returns a list of virtual tape recovery points that are available for the specified gateway-VTL. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeTapeRecoveryPointsInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		Limit:      aws.Int64(1),
		Marker:     aws.String("1"),
	}

	result, err := svc.DescribeTapeRecoveryPoints(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeTapeRecoveryPointsPages 

func (c *StorageGateway) DescribeTapeRecoveryPointsPages(input *DescribeTapeRecoveryPointsInput, fn func(*DescribeTapeRecoveryPointsOutput, bool) bool) error

DescribeTapeRecoveryPointsPages iterates over the pages of a DescribeTapeRecoveryPoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeTapeRecoveryPoints method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeTapeRecoveryPoints operation.
pageNum := 0
err := client.DescribeTapeRecoveryPointsPages(params,
    func(page *DescribeTapeRecoveryPointsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) DescribeTapeRecoveryPointsPagesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeTapeRecoveryPointsPagesWithContext(ctx aws.Context, input *DescribeTapeRecoveryPointsInput, fn func(*DescribeTapeRecoveryPointsOutput, bool) bool, opts ...request.Option) error

DescribeTapeRecoveryPointsPagesWithContext same as DescribeTapeRecoveryPointsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeTapeRecoveryPointsRequest 

func (c *StorageGateway) DescribeTapeRecoveryPointsRequest(input *DescribeTapeRecoveryPointsInput) (req *request.Request, output *DescribeTapeRecoveryPointsOutput)

DescribeTapeRecoveryPointsRequest generates a "aws/request.Request" representing the client's request for the DescribeTapeRecoveryPoints operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTapeRecoveryPoints for more information on using the DescribeTapeRecoveryPoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTapeRecoveryPointsRequest method.
req, resp := client.DescribeTapeRecoveryPointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapeRecoveryPoints

func (*StorageGateway) DescribeTapeRecoveryPointsWithContext added in v1.8.0 

func (c *StorageGateway) DescribeTapeRecoveryPointsWithContext(ctx aws.Context, input *DescribeTapeRecoveryPointsInput, opts ...request.Option) (*DescribeTapeRecoveryPointsOutput, error)

DescribeTapeRecoveryPointsWithContext is the same as DescribeTapeRecoveryPoints with the addition of the ability to pass a context and additional request options.

See DescribeTapeRecoveryPoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeTapes 

func (c *StorageGateway) DescribeTapes(input *DescribeTapesInput) (*DescribeTapesOutput, error)

DescribeTapes API operation for AWS Storage Gateway.

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeTapes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapes

Example (Shared00)

To describe virtual tape(s) associated with gateway

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeTapesInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		Limit:      aws.Int64(2),
		Marker:     aws.String("1"),
		TapeARNs: []*string{
			aws.String("arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1"),
			aws.String("arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0"),
		},
	}

	result, err := svc.DescribeTapes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeTapesPages 

func (c *StorageGateway) DescribeTapesPages(input *DescribeTapesInput, fn func(*DescribeTapesOutput, bool) bool) error

DescribeTapesPages iterates over the pages of a DescribeTapes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeTapes method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeTapes operation.
pageNum := 0
err := client.DescribeTapesPages(params,
    func(page *DescribeTapesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) DescribeTapesPagesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeTapesPagesWithContext(ctx aws.Context, input *DescribeTapesInput, fn func(*DescribeTapesOutput, bool) bool, opts ...request.Option) error

DescribeTapesPagesWithContext same as DescribeTapesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeTapesRequest 

func (c *StorageGateway) DescribeTapesRequest(input *DescribeTapesInput) (req *request.Request, output *DescribeTapesOutput)

DescribeTapesRequest generates a "aws/request.Request" representing the client's request for the DescribeTapes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTapes for more information on using the DescribeTapes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTapesRequest method.
req, resp := client.DescribeTapesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapes

func (*StorageGateway) DescribeTapesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeTapesWithContext(ctx aws.Context, input *DescribeTapesInput, opts ...request.Option) (*DescribeTapesOutput, error)

DescribeTapesWithContext is the same as DescribeTapes with the addition of the ability to pass a context and additional request options.

See DescribeTapes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeUploadBuffer 

func (c *StorageGateway) DescribeUploadBuffer(input *DescribeUploadBufferInput) (*DescribeUploadBufferOutput, error)

DescribeUploadBuffer API operation for AWS Storage Gateway.

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeUploadBuffer for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeUploadBuffer

Example (Shared00)

To describe upload buffer of gateway

Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeUploadBufferInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DescribeUploadBuffer(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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:
Example (Shared01)

To describe upload buffer of a gateway

Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeUploadBufferInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DescribeUploadBuffer(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeUploadBufferRequest 

func (c *StorageGateway) DescribeUploadBufferRequest(input *DescribeUploadBufferInput) (req *request.Request, output *DescribeUploadBufferOutput)

DescribeUploadBufferRequest generates a "aws/request.Request" representing the client's request for the DescribeUploadBuffer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUploadBuffer for more information on using the DescribeUploadBuffer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeUploadBufferRequest method.
req, resp := client.DescribeUploadBufferRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeUploadBuffer

func (*StorageGateway) DescribeUploadBufferWithContext added in v1.8.0 

func (c *StorageGateway) DescribeUploadBufferWithContext(ctx aws.Context, input *DescribeUploadBufferInput, opts ...request.Option) (*DescribeUploadBufferOutput, error)

DescribeUploadBufferWithContext is the same as DescribeUploadBuffer with the addition of the ability to pass a context and additional request options.

See DescribeUploadBuffer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeVTLDevices 

func (c *StorageGateway) DescribeVTLDevices(input *DescribeVTLDevicesInput) (*DescribeVTLDevicesOutput, error)

DescribeVTLDevices API operation for AWS Storage Gateway.

Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.

This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeVTLDevices for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeVTLDevices

Example (Shared00)

To describe virtual tape library (VTL) devices of a single gateway

Returns a description of virtual tape library (VTL) devices for the specified gateway. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeVTLDevicesInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		Limit:      aws.Int64(123),
		Marker:     aws.String("1"),
	}

	result, err := svc.DescribeVTLDevices(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeVTLDevicesPages 

func (c *StorageGateway) DescribeVTLDevicesPages(input *DescribeVTLDevicesInput, fn func(*DescribeVTLDevicesOutput, bool) bool) error

DescribeVTLDevicesPages iterates over the pages of a DescribeVTLDevices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeVTLDevices method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeVTLDevices operation.
pageNum := 0
err := client.DescribeVTLDevicesPages(params,
    func(page *DescribeVTLDevicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) DescribeVTLDevicesPagesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeVTLDevicesPagesWithContext(ctx aws.Context, input *DescribeVTLDevicesInput, fn func(*DescribeVTLDevicesOutput, bool) bool, opts ...request.Option) error

DescribeVTLDevicesPagesWithContext same as DescribeVTLDevicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeVTLDevicesRequest 

func (c *StorageGateway) DescribeVTLDevicesRequest(input *DescribeVTLDevicesInput) (req *request.Request, output *DescribeVTLDevicesOutput)

DescribeVTLDevicesRequest generates a "aws/request.Request" representing the client's request for the DescribeVTLDevices operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeVTLDevices for more information on using the DescribeVTLDevices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeVTLDevicesRequest method.
req, resp := client.DescribeVTLDevicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeVTLDevices

func (*StorageGateway) DescribeVTLDevicesWithContext added in v1.8.0 

func (c *StorageGateway) DescribeVTLDevicesWithContext(ctx aws.Context, input *DescribeVTLDevicesInput, opts ...request.Option) (*DescribeVTLDevicesOutput, error)

DescribeVTLDevicesWithContext is the same as DescribeVTLDevices with the addition of the ability to pass a context and additional request options.

See DescribeVTLDevices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DescribeWorkingStorage 

func (c *StorageGateway) DescribeWorkingStorage(input *DescribeWorkingStorageInput) (*DescribeWorkingStorageOutput, error)

DescribeWorkingStorage API operation for AWS Storage Gateway.

Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DescribeWorkingStorage for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeWorkingStorage

Example (Shared00)

To describe the working storage of a gateway [Depreciated]

This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DescribeWorkingStorageInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DescribeWorkingStorage(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DescribeWorkingStorageRequest 

func (c *StorageGateway) DescribeWorkingStorageRequest(input *DescribeWorkingStorageInput) (req *request.Request, output *DescribeWorkingStorageOutput)

DescribeWorkingStorageRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkingStorage operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkingStorage for more information on using the DescribeWorkingStorage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkingStorageRequest method.
req, resp := client.DescribeWorkingStorageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeWorkingStorage

func (*StorageGateway) DescribeWorkingStorageWithContext added in v1.8.0 

func (c *StorageGateway) DescribeWorkingStorageWithContext(ctx aws.Context, input *DescribeWorkingStorageInput, opts ...request.Option) (*DescribeWorkingStorageOutput, error)

DescribeWorkingStorageWithContext is the same as DescribeWorkingStorage with the addition of the ability to pass a context and additional request options.

See DescribeWorkingStorage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) DisableGateway 

func (c *StorageGateway) DisableGateway(input *DisableGatewayInput) (*DisableGatewayOutput, error)

DisableGateway API operation for AWS Storage Gateway.

Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

Once a gateway is disabled it cannot be enabled.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation DisableGateway for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DisableGateway

Example (Shared00)

To disable a gateway when it is no longer functioning

Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.DisableGatewayInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.DisableGateway(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) DisableGatewayRequest 

func (c *StorageGateway) DisableGatewayRequest(input *DisableGatewayInput) (req *request.Request, output *DisableGatewayOutput)

DisableGatewayRequest generates a "aws/request.Request" representing the client's request for the DisableGateway operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableGateway for more information on using the DisableGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisableGatewayRequest method.
req, resp := client.DisableGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DisableGateway

func (*StorageGateway) DisableGatewayWithContext added in v1.8.0 

func (c *StorageGateway) DisableGatewayWithContext(ctx aws.Context, input *DisableGatewayInput, opts ...request.Option) (*DisableGatewayOutput, error)

DisableGatewayWithContext is the same as DisableGateway with the addition of the ability to pass a context and additional request options.

See DisableGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListFileShares added in v1.6.6 

func (c *StorageGateway) ListFileShares(input *ListFileSharesInput) (*ListFileSharesOutput, error)

ListFileShares API operation for AWS Storage Gateway.

Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported in the file gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ListFileShares for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListFileShares

func (*StorageGateway) ListFileSharesRequest added in v1.6.6 

func (c *StorageGateway) ListFileSharesRequest(input *ListFileSharesInput) (req *request.Request, output *ListFileSharesOutput)

ListFileSharesRequest generates a "aws/request.Request" representing the client's request for the ListFileShares operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFileShares for more information on using the ListFileShares API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFileSharesRequest method.
req, resp := client.ListFileSharesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListFileShares

func (*StorageGateway) ListFileSharesWithContext added in v1.8.0 

func (c *StorageGateway) ListFileSharesWithContext(ctx aws.Context, input *ListFileSharesInput, opts ...request.Option) (*ListFileSharesOutput, error)

ListFileSharesWithContext is the same as ListFileShares with the addition of the ability to pass a context and additional request options.

See ListFileShares for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListGateways 

func (c *StorageGateway) ListGateways(input *ListGatewaysInput) (*ListGatewaysOutput, error)

ListGateways API operation for AWS Storage Gateway.

Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ListGateways for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListGateways

Example (Shared00)

To lists region specific gateways per AWS account

Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.ListGatewaysInput{
		Limit:  aws.Int64(2),
		Marker: aws.String("1"),
	}

	result, err := svc.ListGateways(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) ListGatewaysPages 

func (c *StorageGateway) ListGatewaysPages(input *ListGatewaysInput, fn func(*ListGatewaysOutput, bool) bool) error

ListGatewaysPages iterates over the pages of a ListGateways operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGateways method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListGateways operation.
pageNum := 0
err := client.ListGatewaysPages(params,
    func(page *ListGatewaysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) ListGatewaysPagesWithContext added in v1.8.0 

func (c *StorageGateway) ListGatewaysPagesWithContext(ctx aws.Context, input *ListGatewaysInput, fn func(*ListGatewaysOutput, bool) bool, opts ...request.Option) error

ListGatewaysPagesWithContext same as ListGatewaysPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListGatewaysRequest 

func (c *StorageGateway) ListGatewaysRequest(input *ListGatewaysInput) (req *request.Request, output *ListGatewaysOutput)

ListGatewaysRequest generates a "aws/request.Request" representing the client's request for the ListGateways operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGateways for more information on using the ListGateways API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGatewaysRequest method.
req, resp := client.ListGatewaysRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListGateways

func (*StorageGateway) ListGatewaysWithContext added in v1.8.0 

func (c *StorageGateway) ListGatewaysWithContext(ctx aws.Context, input *ListGatewaysInput, opts ...request.Option) (*ListGatewaysOutput, error)

ListGatewaysWithContext is the same as ListGateways with the addition of the ability to pass a context and additional request options.

See ListGateways for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListLocalDisks 

func (c *StorageGateway) ListLocalDisks(input *ListLocalDisksInput) (*ListLocalDisksOutput, error)

ListLocalDisks API operation for AWS Storage Gateway.

Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ListLocalDisks for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListLocalDisks

Example (Shared00)

To list the gateway's local disks

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.ListLocalDisksInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.ListLocalDisks(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) ListLocalDisksRequest 

func (c *StorageGateway) ListLocalDisksRequest(input *ListLocalDisksInput) (req *request.Request, output *ListLocalDisksOutput)

ListLocalDisksRequest generates a "aws/request.Request" representing the client's request for the ListLocalDisks operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLocalDisks for more information on using the ListLocalDisks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListLocalDisksRequest method.
req, resp := client.ListLocalDisksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListLocalDisks

func (*StorageGateway) ListLocalDisksWithContext added in v1.8.0 

func (c *StorageGateway) ListLocalDisksWithContext(ctx aws.Context, input *ListLocalDisksInput, opts ...request.Option) (*ListLocalDisksOutput, error)

ListLocalDisksWithContext is the same as ListLocalDisks with the addition of the ability to pass a context and additional request options.

See ListLocalDisks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListTagsForResource added in v0.9.5 

func (c *StorageGateway) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Storage Gateway.

Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTagsForResource

Example (Shared00)

To list tags that have been added to a resource

Lists the tags that have been added to the specified resource. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.ListTagsForResourceInput{
		Limit:       aws.Int64(1),
		Marker:      aws.String("1"),
		ResourceARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"),
	}

	result, err := svc.ListTagsForResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) ListTagsForResourceRequest added in v0.9.5 

func (c *StorageGateway) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTagsForResource

func (*StorageGateway) ListTagsForResourceWithContext added in v1.8.0 

func (c *StorageGateway) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListTapes added in v1.1.25 

func (c *StorageGateway) ListTapes(input *ListTapesInput) (*ListTapesOutput, error)

ListTapes API operation for AWS Storage Gateway.

Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ListTapes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapes

func (*StorageGateway) ListTapesRequest added in v1.1.25 

func (c *StorageGateway) ListTapesRequest(input *ListTapesInput) (req *request.Request, output *ListTapesOutput)

ListTapesRequest generates a "aws/request.Request" representing the client's request for the ListTapes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTapes for more information on using the ListTapes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTapesRequest method.
req, resp := client.ListTapesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapes

func (*StorageGateway) ListTapesWithContext added in v1.8.0 

func (c *StorageGateway) ListTapesWithContext(ctx aws.Context, input *ListTapesInput, opts ...request.Option) (*ListTapesOutput, error)

ListTapesWithContext is the same as ListTapes with the addition of the ability to pass a context and additional request options.

See ListTapes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListVolumeInitiators added in v0.6.1 

func (c *StorageGateway) ListVolumeInitiators(input *ListVolumeInitiatorsInput) (*ListVolumeInitiatorsOutput, error)

ListVolumeInitiators API operation for AWS Storage Gateway.

Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ListVolumeInitiators for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListVolumeInitiators

func (*StorageGateway) ListVolumeInitiatorsRequest added in v0.6.1 

func (c *StorageGateway) ListVolumeInitiatorsRequest(input *ListVolumeInitiatorsInput) (req *request.Request, output *ListVolumeInitiatorsOutput)

ListVolumeInitiatorsRequest generates a "aws/request.Request" representing the client's request for the ListVolumeInitiators operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListVolumeInitiators for more information on using the ListVolumeInitiators API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListVolumeInitiatorsRequest method.
req, resp := client.ListVolumeInitiatorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListVolumeInitiators

func (*StorageGateway) ListVolumeInitiatorsWithContext added in v1.8.0 

func (c *StorageGateway) ListVolumeInitiatorsWithContext(ctx aws.Context, input *ListVolumeInitiatorsInput, opts ...request.Option) (*ListVolumeInitiatorsOutput, error)

ListVolumeInitiatorsWithContext is the same as ListVolumeInitiators with the addition of the ability to pass a context and additional request options.

See ListVolumeInitiators for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListVolumeRecoveryPoints 

func (c *StorageGateway) ListVolumeRecoveryPoints(input *ListVolumeRecoveryPointsInput) (*ListVolumeRecoveryPointsOutput, error)

ListVolumeRecoveryPoints API operation for AWS Storage Gateway.

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ListVolumeRecoveryPoints for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListVolumeRecoveryPoints

Example (Shared00)

To list recovery points for a gateway

Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.ListVolumeRecoveryPointsInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.ListVolumeRecoveryPoints(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) ListVolumeRecoveryPointsRequest 

func (c *StorageGateway) ListVolumeRecoveryPointsRequest(input *ListVolumeRecoveryPointsInput) (req *request.Request, output *ListVolumeRecoveryPointsOutput)

ListVolumeRecoveryPointsRequest generates a "aws/request.Request" representing the client's request for the ListVolumeRecoveryPoints operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListVolumeRecoveryPoints for more information on using the ListVolumeRecoveryPoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListVolumeRecoveryPointsRequest method.
req, resp := client.ListVolumeRecoveryPointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListVolumeRecoveryPoints

func (*StorageGateway) ListVolumeRecoveryPointsWithContext added in v1.8.0 

func (c *StorageGateway) ListVolumeRecoveryPointsWithContext(ctx aws.Context, input *ListVolumeRecoveryPointsInput, opts ...request.Option) (*ListVolumeRecoveryPointsOutput, error)

ListVolumeRecoveryPointsWithContext is the same as ListVolumeRecoveryPoints with the addition of the ability to pass a context and additional request options.

See ListVolumeRecoveryPoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListVolumes 

func (c *StorageGateway) ListVolumes(input *ListVolumesInput) (*ListVolumesOutput, error)

ListVolumes API operation for AWS Storage Gateway.

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ListVolumes for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListVolumes

Example (Shared00)

To list the iSCSI stored volumes of a gateway

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.ListVolumesInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		Limit:      aws.Int64(2),
		Marker:     aws.String("1"),
	}

	result, err := svc.ListVolumes(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) ListVolumesPages 

func (c *StorageGateway) ListVolumesPages(input *ListVolumesInput, fn func(*ListVolumesOutput, bool) bool) error

ListVolumesPages iterates over the pages of a ListVolumes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListVolumes method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListVolumes operation.
pageNum := 0
err := client.ListVolumesPages(params,
    func(page *ListVolumesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) ListVolumesPagesWithContext added in v1.8.0 

func (c *StorageGateway) ListVolumesPagesWithContext(ctx aws.Context, input *ListVolumesInput, fn func(*ListVolumesOutput, bool) bool, opts ...request.Option) error

ListVolumesPagesWithContext same as ListVolumesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ListVolumesRequest 

func (c *StorageGateway) ListVolumesRequest(input *ListVolumesInput) (req *request.Request, output *ListVolumesOutput)

ListVolumesRequest generates a "aws/request.Request" representing the client's request for the ListVolumes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListVolumes for more information on using the ListVolumes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListVolumesRequest method.
req, resp := client.ListVolumesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListVolumes

func (*StorageGateway) ListVolumesWithContext added in v1.8.0 

func (c *StorageGateway) ListVolumesWithContext(ctx aws.Context, input *ListVolumesInput, opts ...request.Option) (*ListVolumesOutput, error)

ListVolumesWithContext is the same as ListVolumes with the addition of the ability to pass a context and additional request options.

See ListVolumes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) NotifyWhenUploaded added in v1.12.32 

func (c *StorageGateway) NotifyWhenUploaded(input *NotifyWhenUploadedInput) (*NotifyWhenUploadedOutput, error)

NotifyWhenUploaded API operation for AWS Storage Gateway.

Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded to Amazon S3.

AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the NFS file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported in the file gateway type.

For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation NotifyWhenUploaded for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/NotifyWhenUploaded

func (*StorageGateway) NotifyWhenUploadedRequest added in v1.12.32 

func (c *StorageGateway) NotifyWhenUploadedRequest(input *NotifyWhenUploadedInput) (req *request.Request, output *NotifyWhenUploadedOutput)

NotifyWhenUploadedRequest generates a "aws/request.Request" representing the client's request for the NotifyWhenUploaded operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See NotifyWhenUploaded for more information on using the NotifyWhenUploaded API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the NotifyWhenUploadedRequest method.
req, resp := client.NotifyWhenUploadedRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/NotifyWhenUploaded

func (*StorageGateway) NotifyWhenUploadedWithContext added in v1.12.32 

func (c *StorageGateway) NotifyWhenUploadedWithContext(ctx aws.Context, input *NotifyWhenUploadedInput, opts ...request.Option) (*NotifyWhenUploadedOutput, error)

NotifyWhenUploadedWithContext is the same as NotifyWhenUploaded with the addition of the ability to pass a context and additional request options.

See NotifyWhenUploaded for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) RefreshCache added in v1.8.5 

func (c *StorageGateway) RefreshCache(input *RefreshCacheInput) (*RefreshCacheOutput, error)

RefreshCache API operation for AWS Storage Gateway.

Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation RefreshCache for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RefreshCache

func (*StorageGateway) RefreshCacheRequest added in v1.8.5 

func (c *StorageGateway) RefreshCacheRequest(input *RefreshCacheInput) (req *request.Request, output *RefreshCacheOutput)

RefreshCacheRequest generates a "aws/request.Request" representing the client's request for the RefreshCache operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RefreshCache for more information on using the RefreshCache API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RefreshCacheRequest method.
req, resp := client.RefreshCacheRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RefreshCache

func (*StorageGateway) RefreshCacheWithContext added in v1.8.5 

func (c *StorageGateway) RefreshCacheWithContext(ctx aws.Context, input *RefreshCacheInput, opts ...request.Option) (*RefreshCacheOutput, error)

RefreshCacheWithContext is the same as RefreshCache with the addition of the ability to pass a context and additional request options.

See RefreshCache for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) RemoveTagsFromResource added in v0.9.5 

func (c *StorageGateway) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResource API operation for AWS Storage Gateway.

Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation RemoveTagsFromResource for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RemoveTagsFromResource

Example (Shared00)

To remove tags from a resource

Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.RemoveTagsFromResourceInput{
		ResourceARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"),
		TagKeys: []*string{
			aws.String("Dev Gatgeway Region"),
			aws.String("East Coast"),
		},
	}

	result, err := svc.RemoveTagsFromResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) RemoveTagsFromResourceRequest added in v0.9.5 

func (c *StorageGateway) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *RemoveTagsFromResourceOutput)

RemoveTagsFromResourceRequest generates a "aws/request.Request" representing the client's request for the RemoveTagsFromResource operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTagsFromResource for more information on using the RemoveTagsFromResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RemoveTagsFromResourceRequest method.
req, resp := client.RemoveTagsFromResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RemoveTagsFromResource

func (*StorageGateway) RemoveTagsFromResourceWithContext added in v1.8.0 

func (c *StorageGateway) RemoveTagsFromResourceWithContext(ctx aws.Context, input *RemoveTagsFromResourceInput, opts ...request.Option) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResourceWithContext is the same as RemoveTagsFromResource with the addition of the ability to pass a context and additional request options.

See RemoveTagsFromResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ResetCache 

func (c *StorageGateway) ResetCache(input *ResetCacheInput) (*ResetCacheOutput, error)

ResetCache API operation for AWS Storage Gateway.

Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ResetCache for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ResetCache

Example (Shared00)

To reset cache disks in error status

Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.ResetCacheInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C"),
	}

	result, err := svc.ResetCache(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) ResetCacheRequest 

func (c *StorageGateway) ResetCacheRequest(input *ResetCacheInput) (req *request.Request, output *ResetCacheOutput)

ResetCacheRequest generates a "aws/request.Request" representing the client's request for the ResetCache operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResetCache for more information on using the ResetCache API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ResetCacheRequest method.
req, resp := client.ResetCacheRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ResetCache

func (*StorageGateway) ResetCacheWithContext added in v1.8.0 

func (c *StorageGateway) ResetCacheWithContext(ctx aws.Context, input *ResetCacheInput, opts ...request.Option) (*ResetCacheOutput, error)

ResetCacheWithContext is the same as ResetCache with the addition of the ability to pass a context and additional request options.

See ResetCache for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) RetrieveTapeArchive 

func (c *StorageGateway) RetrieveTapeArchive(input *RetrieveTapeArchiveInput) (*RetrieveTapeArchiveOutput, error)

RetrieveTapeArchive API operation for AWS Storage Gateway.

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation RetrieveTapeArchive for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RetrieveTapeArchive

Example (Shared00)

To retrieve an archived tape from the VTS

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.RetrieveTapeArchiveInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		TapeARN:    aws.String("arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"),
	}

	result, err := svc.RetrieveTapeArchive(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) RetrieveTapeArchiveRequest 

func (c *StorageGateway) RetrieveTapeArchiveRequest(input *RetrieveTapeArchiveInput) (req *request.Request, output *RetrieveTapeArchiveOutput)

RetrieveTapeArchiveRequest generates a "aws/request.Request" representing the client's request for the RetrieveTapeArchive operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RetrieveTapeArchive for more information on using the RetrieveTapeArchive API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RetrieveTapeArchiveRequest method.
req, resp := client.RetrieveTapeArchiveRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RetrieveTapeArchive

func (*StorageGateway) RetrieveTapeArchiveWithContext added in v1.8.0 

func (c *StorageGateway) RetrieveTapeArchiveWithContext(ctx aws.Context, input *RetrieveTapeArchiveInput, opts ...request.Option) (*RetrieveTapeArchiveOutput, error)

RetrieveTapeArchiveWithContext is the same as RetrieveTapeArchive with the addition of the ability to pass a context and additional request options.

See RetrieveTapeArchive for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) RetrieveTapeRecoveryPoint 

func (c *StorageGateway) RetrieveTapeRecoveryPoint(input *RetrieveTapeRecoveryPointInput) (*RetrieveTapeRecoveryPointOutput, error)

RetrieveTapeRecoveryPoint API operation for AWS Storage Gateway.

Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.

A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation RetrieveTapeRecoveryPoint for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint

Example (Shared00)

To retrieve the recovery point of a virtual tape

Retrieves the recovery point for the specified virtual tape. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.RetrieveTapeRecoveryPointInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		TapeARN:    aws.String("arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"),
	}

	result, err := svc.RetrieveTapeRecoveryPoint(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) RetrieveTapeRecoveryPointRequest 

func (c *StorageGateway) RetrieveTapeRecoveryPointRequest(input *RetrieveTapeRecoveryPointInput) (req *request.Request, output *RetrieveTapeRecoveryPointOutput)

RetrieveTapeRecoveryPointRequest generates a "aws/request.Request" representing the client's request for the RetrieveTapeRecoveryPoint operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RetrieveTapeRecoveryPoint for more information on using the RetrieveTapeRecoveryPoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RetrieveTapeRecoveryPointRequest method.
req, resp := client.RetrieveTapeRecoveryPointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint

func (*StorageGateway) RetrieveTapeRecoveryPointWithContext added in v1.8.0 

func (c *StorageGateway) RetrieveTapeRecoveryPointWithContext(ctx aws.Context, input *RetrieveTapeRecoveryPointInput, opts ...request.Option) (*RetrieveTapeRecoveryPointOutput, error)

RetrieveTapeRecoveryPointWithContext is the same as RetrieveTapeRecoveryPoint with the addition of the ability to pass a context and additional request options.

See RetrieveTapeRecoveryPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) SetLocalConsolePassword added in v1.1.14 

func (c *StorageGateway) SetLocalConsolePassword(input *SetLocalConsolePasswordInput) (*SetLocalConsolePasswordOutput, error)

SetLocalConsolePassword API operation for AWS Storage Gateway.

Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation SetLocalConsolePassword for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SetLocalConsolePassword

Example (Shared00)

To set a password for your VM

Sets the password for your VM local console. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.SetLocalConsolePasswordInput{
		GatewayARN:           aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		LocalConsolePassword: aws.String("PassWordMustBeAtLeast6Chars."),
	}

	result, err := svc.SetLocalConsolePassword(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) SetLocalConsolePasswordRequest added in v1.1.14 

func (c *StorageGateway) SetLocalConsolePasswordRequest(input *SetLocalConsolePasswordInput) (req *request.Request, output *SetLocalConsolePasswordOutput)

SetLocalConsolePasswordRequest generates a "aws/request.Request" representing the client's request for the SetLocalConsolePassword operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetLocalConsolePassword for more information on using the SetLocalConsolePassword API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SetLocalConsolePasswordRequest method.
req, resp := client.SetLocalConsolePasswordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SetLocalConsolePassword

func (*StorageGateway) SetLocalConsolePasswordWithContext added in v1.8.0 

func (c *StorageGateway) SetLocalConsolePasswordWithContext(ctx aws.Context, input *SetLocalConsolePasswordInput, opts ...request.Option) (*SetLocalConsolePasswordOutput, error)

SetLocalConsolePasswordWithContext is the same as SetLocalConsolePassword with the addition of the ability to pass a context and additional request options.

See SetLocalConsolePassword for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) ShutdownGateway 

func (c *StorageGateway) ShutdownGateway(input *ShutdownGatewayInput) (*ShutdownGatewayOutput, error)

ShutdownGateway API operation for AWS Storage Gateway.

Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation ShutdownGateway for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ShutdownGateway

Example (Shared00)

To shut down a gateway service

This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.ShutdownGatewayInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
	}

	result, err := svc.ShutdownGateway(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) ShutdownGatewayRequest 

func (c *StorageGateway) ShutdownGatewayRequest(input *ShutdownGatewayInput) (req *request.Request, output *ShutdownGatewayOutput)

ShutdownGatewayRequest generates a "aws/request.Request" representing the client's request for the ShutdownGateway operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ShutdownGateway for more information on using the ShutdownGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ShutdownGatewayRequest method.
req, resp := client.ShutdownGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ShutdownGateway

func (*StorageGateway) ShutdownGatewayWithContext added in v1.8.0 

func (c *StorageGateway) ShutdownGatewayWithContext(ctx aws.Context, input *ShutdownGatewayInput, opts ...request.Option) (*ShutdownGatewayOutput, error)

ShutdownGatewayWithContext is the same as ShutdownGateway with the addition of the ability to pass a context and additional request options.

See ShutdownGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) StartGateway 

func (c *StorageGateway) StartGateway(input *StartGatewayInput) (*StartGatewayOutput, error)

StartGateway API operation for AWS Storage Gateway.

Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation StartGateway for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartGateway

Example (Shared00)

To start a gateway service

Starts a gateway service that was previously shut down. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.StartGatewayInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
	}

	result, err := svc.StartGateway(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) StartGatewayRequest 

func (c *StorageGateway) StartGatewayRequest(input *StartGatewayInput) (req *request.Request, output *StartGatewayOutput)

StartGatewayRequest generates a "aws/request.Request" representing the client's request for the StartGateway operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartGateway for more information on using the StartGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartGatewayRequest method.
req, resp := client.StartGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartGateway

func (*StorageGateway) StartGatewayWithContext added in v1.8.0 

func (c *StorageGateway) StartGatewayWithContext(ctx aws.Context, input *StartGatewayInput, opts ...request.Option) (*StartGatewayOutput, error)

StartGatewayWithContext is the same as StartGateway with the addition of the ability to pass a context and additional request options.

See StartGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) UpdateBandwidthRateLimit 

func (c *StorageGateway) UpdateBandwidthRateLimit(input *UpdateBandwidthRateLimitInput) (*UpdateBandwidthRateLimitOutput, error)

UpdateBandwidthRateLimit API operation for AWS Storage Gateway.

Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation UpdateBandwidthRateLimit for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateBandwidthRateLimit

Example (Shared00)

To update the bandwidth rate limits of a gateway

Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.UpdateBandwidthRateLimitInput{
		AverageDownloadRateLimitInBitsPerSec: aws.Int64(102400),
		AverageUploadRateLimitInBitsPerSec:   aws.Int64(51200),
		GatewayARN:                           aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.UpdateBandwidthRateLimit(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) UpdateBandwidthRateLimitRequest 

func (c *StorageGateway) UpdateBandwidthRateLimitRequest(input *UpdateBandwidthRateLimitInput) (req *request.Request, output *UpdateBandwidthRateLimitOutput)

UpdateBandwidthRateLimitRequest generates a "aws/request.Request" representing the client's request for the UpdateBandwidthRateLimit operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateBandwidthRateLimit for more information on using the UpdateBandwidthRateLimit API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateBandwidthRateLimitRequest method.
req, resp := client.UpdateBandwidthRateLimitRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateBandwidthRateLimit

func (*StorageGateway) UpdateBandwidthRateLimitWithContext added in v1.8.0 

func (c *StorageGateway) UpdateBandwidthRateLimitWithContext(ctx aws.Context, input *UpdateBandwidthRateLimitInput, opts ...request.Option) (*UpdateBandwidthRateLimitOutput, error)

UpdateBandwidthRateLimitWithContext is the same as UpdateBandwidthRateLimit with the addition of the ability to pass a context and additional request options.

See UpdateBandwidthRateLimit for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) UpdateChapCredentials 

func (c *StorageGateway) UpdateChapCredentials(input *UpdateChapCredentialsInput) (*UpdateChapCredentialsOutput, error)

UpdateChapCredentials API operation for AWS Storage Gateway.

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation UpdateChapCredentials for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateChapCredentials

Example (Shared00)

To update CHAP credentials for an iSCSI target

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.UpdateChapCredentialsInput{
		InitiatorName:                 aws.String("iqn.1991-05.com.microsoft:computername.domain.example.com"),
		SecretToAuthenticateInitiator: aws.String("111111111111"),
		SecretToAuthenticateTarget:    aws.String("222222222222"),
		TargetARN:                     aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"),
	}

	result, err := svc.UpdateChapCredentials(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) UpdateChapCredentialsRequest 

func (c *StorageGateway) UpdateChapCredentialsRequest(input *UpdateChapCredentialsInput) (req *request.Request, output *UpdateChapCredentialsOutput)

UpdateChapCredentialsRequest generates a "aws/request.Request" representing the client's request for the UpdateChapCredentials operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateChapCredentials for more information on using the UpdateChapCredentials API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateChapCredentialsRequest method.
req, resp := client.UpdateChapCredentialsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateChapCredentials

func (*StorageGateway) UpdateChapCredentialsWithContext added in v1.8.0 

func (c *StorageGateway) UpdateChapCredentialsWithContext(ctx aws.Context, input *UpdateChapCredentialsInput, opts ...request.Option) (*UpdateChapCredentialsOutput, error)

UpdateChapCredentialsWithContext is the same as UpdateChapCredentials with the addition of the ability to pass a context and additional request options.

See UpdateChapCredentials for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) UpdateGatewayInformation 

func (c *StorageGateway) UpdateGatewayInformation(input *UpdateGatewayInformationInput) (*UpdateGatewayInformationOutput, error)

UpdateGatewayInformation API operation for AWS Storage Gateway.

Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation UpdateGatewayInformation for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateGatewayInformation

Example (Shared00)

To update a gateway's metadata

Updates a gateway's metadata, which includes the gateway's name and time zone. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.UpdateGatewayInformationInput{
		GatewayARN:      aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		GatewayName:     aws.String("MyGateway2"),
		GatewayTimezone: aws.String("GMT-12:00"),
	}

	result, err := svc.UpdateGatewayInformation(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) UpdateGatewayInformationRequest 

func (c *StorageGateway) UpdateGatewayInformationRequest(input *UpdateGatewayInformationInput) (req *request.Request, output *UpdateGatewayInformationOutput)

UpdateGatewayInformationRequest generates a "aws/request.Request" representing the client's request for the UpdateGatewayInformation operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGatewayInformation for more information on using the UpdateGatewayInformation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateGatewayInformationRequest method.
req, resp := client.UpdateGatewayInformationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateGatewayInformation

func (*StorageGateway) UpdateGatewayInformationWithContext added in v1.8.0 

func (c *StorageGateway) UpdateGatewayInformationWithContext(ctx aws.Context, input *UpdateGatewayInformationInput, opts ...request.Option) (*UpdateGatewayInformationOutput, error)

UpdateGatewayInformationWithContext is the same as UpdateGatewayInformation with the addition of the ability to pass a context and additional request options.

See UpdateGatewayInformation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) UpdateGatewaySoftwareNow 

func (c *StorageGateway) UpdateGatewaySoftwareNow(input *UpdateGatewaySoftwareNowInput) (*UpdateGatewaySoftwareNowOutput, error)

UpdateGatewaySoftwareNow API operation for AWS Storage Gateway.

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.

A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings (http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings) and Customizing Your Linux iSCSI Settings (http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings), respectively.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation UpdateGatewaySoftwareNow for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateGatewaySoftwareNow

Example (Shared00)

To update a gateway's VM software

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.UpdateGatewaySoftwareNowInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	result, err := svc.UpdateGatewaySoftwareNow(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) UpdateGatewaySoftwareNowRequest 

func (c *StorageGateway) UpdateGatewaySoftwareNowRequest(input *UpdateGatewaySoftwareNowInput) (req *request.Request, output *UpdateGatewaySoftwareNowOutput)

UpdateGatewaySoftwareNowRequest generates a "aws/request.Request" representing the client's request for the UpdateGatewaySoftwareNow operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGatewaySoftwareNow for more information on using the UpdateGatewaySoftwareNow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateGatewaySoftwareNowRequest method.
req, resp := client.UpdateGatewaySoftwareNowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateGatewaySoftwareNow

func (*StorageGateway) UpdateGatewaySoftwareNowWithContext added in v1.8.0 

func (c *StorageGateway) UpdateGatewaySoftwareNowWithContext(ctx aws.Context, input *UpdateGatewaySoftwareNowInput, opts ...request.Option) (*UpdateGatewaySoftwareNowOutput, error)

UpdateGatewaySoftwareNowWithContext is the same as UpdateGatewaySoftwareNow with the addition of the ability to pass a context and additional request options.

See UpdateGatewaySoftwareNow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) UpdateMaintenanceStartTime 

func (c *StorageGateway) UpdateMaintenanceStartTime(input *UpdateMaintenanceStartTimeInput) (*UpdateMaintenanceStartTimeOutput, error)

UpdateMaintenanceStartTime API operation for AWS Storage Gateway.

Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation UpdateMaintenanceStartTime for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateMaintenanceStartTime

Example (Shared00)

To update a gateway's maintenance start time

Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is in your gateway's time zone. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.UpdateMaintenanceStartTimeInput{
		DayOfWeek:    aws.Int64(2),
		GatewayARN:   aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		HourOfDay:    aws.Int64(0),
		MinuteOfHour: aws.Int64(30),
	}

	result, err := svc.UpdateMaintenanceStartTime(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) UpdateMaintenanceStartTimeRequest 

func (c *StorageGateway) UpdateMaintenanceStartTimeRequest(input *UpdateMaintenanceStartTimeInput) (req *request.Request, output *UpdateMaintenanceStartTimeOutput)

UpdateMaintenanceStartTimeRequest generates a "aws/request.Request" representing the client's request for the UpdateMaintenanceStartTime operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMaintenanceStartTime for more information on using the UpdateMaintenanceStartTime API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateMaintenanceStartTimeRequest method.
req, resp := client.UpdateMaintenanceStartTimeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateMaintenanceStartTime

func (*StorageGateway) UpdateMaintenanceStartTimeWithContext added in v1.8.0 

func (c *StorageGateway) UpdateMaintenanceStartTimeWithContext(ctx aws.Context, input *UpdateMaintenanceStartTimeInput, opts ...request.Option) (*UpdateMaintenanceStartTimeOutput, error)

UpdateMaintenanceStartTimeWithContext is the same as UpdateMaintenanceStartTime with the addition of the ability to pass a context and additional request options.

See UpdateMaintenanceStartTime for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) UpdateNFSFileShare added in v1.6.6 

func (c *StorageGateway) UpdateNFSFileShare(input *UpdateNFSFileShareInput) (*UpdateNFSFileShareOutput, error)

UpdateNFSFileShare API operation for AWS Storage Gateway.

Updates a file share. This operation is only supported in the file gateway type.

To leave a file share field unchanged, set the corresponding input field to null.

Updates the following file share setting:

  • Default storage class for your S3 bucket

  • Metadata defaults for your S3 bucket

  • Allowed NFS clients for your file share

  • Squash settings

  • Write status of your file share

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation UpdateNFSFileShare for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateNFSFileShare

func (*StorageGateway) UpdateNFSFileShareRequest added in v1.6.6 

func (c *StorageGateway) UpdateNFSFileShareRequest(input *UpdateNFSFileShareInput) (req *request.Request, output *UpdateNFSFileShareOutput)

UpdateNFSFileShareRequest generates a "aws/request.Request" representing the client's request for the UpdateNFSFileShare operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateNFSFileShare for more information on using the UpdateNFSFileShare API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateNFSFileShareRequest method.
req, resp := client.UpdateNFSFileShareRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateNFSFileShare

func (*StorageGateway) UpdateNFSFileShareWithContext added in v1.8.0 

func (c *StorageGateway) UpdateNFSFileShareWithContext(ctx aws.Context, input *UpdateNFSFileShareInput, opts ...request.Option) (*UpdateNFSFileShareOutput, error)

UpdateNFSFileShareWithContext is the same as UpdateNFSFileShare with the addition of the ability to pass a context and additional request options.

See UpdateNFSFileShare for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) UpdateSnapshotSchedule 

func (c *StorageGateway) UpdateSnapshotSchedule(input *UpdateSnapshotScheduleInput) (*UpdateSnapshotScheduleOutput, error)

UpdateSnapshotSchedule API operation for AWS Storage Gateway.

Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation UpdateSnapshotSchedule for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSnapshotSchedule

Example (Shared00)

To update a volume snapshot schedule

Updates a snapshot schedule configured for a gateway volume. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.UpdateSnapshotScheduleInput{
		Description:       aws.String("Hourly snapshot"),
		RecurrenceInHours: aws.Int64(1),
		StartAt:           aws.Int64(0),
		VolumeARN:         aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
	}

	result, err := svc.UpdateSnapshotSchedule(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) UpdateSnapshotScheduleRequest 

func (c *StorageGateway) UpdateSnapshotScheduleRequest(input *UpdateSnapshotScheduleInput) (req *request.Request, output *UpdateSnapshotScheduleOutput)

UpdateSnapshotScheduleRequest generates a "aws/request.Request" representing the client's request for the UpdateSnapshotSchedule operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSnapshotSchedule for more information on using the UpdateSnapshotSchedule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateSnapshotScheduleRequest method.
req, resp := client.UpdateSnapshotScheduleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSnapshotSchedule

func (*StorageGateway) UpdateSnapshotScheduleWithContext added in v1.8.0 

func (c *StorageGateway) UpdateSnapshotScheduleWithContext(ctx aws.Context, input *UpdateSnapshotScheduleInput, opts ...request.Option) (*UpdateSnapshotScheduleOutput, error)

UpdateSnapshotScheduleWithContext is the same as UpdateSnapshotSchedule with the addition of the ability to pass a context and additional request options.

See UpdateSnapshotSchedule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*StorageGateway) UpdateVTLDeviceType 

func (c *StorageGateway) UpdateVTLDeviceType(input *UpdateVTLDeviceTypeInput) (*UpdateVTLDeviceTypeOutput, error)

UpdateVTLDeviceType API operation for AWS Storage Gateway.

Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Storage Gateway's API operation UpdateVTLDeviceType for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidGatewayRequestException "InvalidGatewayRequestException" An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • ErrCodeInternalServerError "InternalServerError" An internal server error has occurred during the request. For more information, see the error and message fields.

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateVTLDeviceType

Example (Shared00)

To update a VTL device type

Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated. 

package main

import (
	"fmt"

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

func main() {
	svc := storagegateway.New(session.New())
	input := &storagegateway.UpdateVTLDeviceTypeInput{
		DeviceType:   aws.String("Medium Changer"),
		VTLDeviceARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001"),
	}

	result, err := svc.UpdateVTLDeviceType(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case storagegateway.ErrCodeInvalidGatewayRequestException:
				fmt.Println(storagegateway.ErrCodeInvalidGatewayRequestException, aerr.Error())
			case storagegateway.ErrCodeInternalServerError:
				fmt.Println(storagegateway.ErrCodeInternalServerError, 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 (*StorageGateway) UpdateVTLDeviceTypeRequest 

func (c *StorageGateway) UpdateVTLDeviceTypeRequest(input *UpdateVTLDeviceTypeInput) (req *request.Request, output *UpdateVTLDeviceTypeOutput)

UpdateVTLDeviceTypeRequest generates a "aws/request.Request" representing the client's request for the UpdateVTLDeviceType operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateVTLDeviceType for more information on using the UpdateVTLDeviceType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateVTLDeviceTypeRequest method.
req, resp := client.UpdateVTLDeviceTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateVTLDeviceType

func (*StorageGateway) UpdateVTLDeviceTypeWithContext added in v1.8.0 

func (c *StorageGateway) UpdateVTLDeviceTypeWithContext(ctx aws.Context, input *UpdateVTLDeviceTypeInput, opts ...request.Option) (*UpdateVTLDeviceTypeOutput, error)

UpdateVTLDeviceTypeWithContext is the same as UpdateVTLDeviceType with the addition of the ability to pass a context and additional request options.

See UpdateVTLDeviceType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type StorediSCSIVolume 

type StorediSCSIVolume struct {

	// The date the volume was created. Volumes created prior to March 28, 2017
	// don’t have this time stamp.
	CreatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Indicates if when the stored volume was created, existing data on the underlying
	// local disk was preserved.
	//
	// Valid Values: true, false
	PreservedExistingData *bool `type:"boolean"`

	// If the stored volume was created from a snapshot, this field contains the
	// snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
	SourceSnapshotId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the storage volume.
	VolumeARN *string `min:"50" type:"string"`

	// The ID of the local disk that was specified in the CreateStorediSCSIVolume
	// operation.
	VolumeDiskId *string `min:"1" type:"string"`

	// The unique identifier of the volume, e.g. vol-AE4B946D.
	VolumeId *string `min:"12" type:"string"`

	// Represents the percentage complete if the volume is restoring or bootstrapping
	// that represents the percent of data transferred. This field does not appear
	// in the response if the stored volume is not restoring or bootstrapping.
	VolumeProgress *float64 `type:"double"`

	// The size of the volume in bytes.
	VolumeSizeInBytes *int64 `type:"long"`

	// One of the VolumeStatus values that indicates the state of the storage volume.
	VolumeStatus *string `min:"3" type:"string"`

	// One of the VolumeType enumeration values describing the type of the volume.
	VolumeType *string `min:"3" type:"string"`

	// The size of the data stored on the volume in bytes.
	//
	// This value is not available for volumes created prior to May 13, 2015, until
	// you store data on the volume.
	VolumeUsedInBytes *int64 `type:"long"`

	// An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes
	// for one stored volume.
	VolumeiSCSIAttributes *VolumeiSCSIAttributes `type:"structure"`
	// contains filtered or unexported fields
}

Describes an iSCSI stored volume.

func (StorediSCSIVolume) GoString added in v0.6.5 

func (s StorediSCSIVolume) GoString() string

GoString returns the string representation

func (*StorediSCSIVolume) SetCreatedDate added in v1.6.6 

func (s *StorediSCSIVolume) SetCreatedDate(v time.Time) *StorediSCSIVolume

SetCreatedDate sets the CreatedDate field's value.

func (*StorediSCSIVolume) SetPreservedExistingData added in v1.5.0 

func (s *StorediSCSIVolume) SetPreservedExistingData(v bool) *StorediSCSIVolume

SetPreservedExistingData sets the PreservedExistingData field's value.

func (*StorediSCSIVolume) SetSourceSnapshotId added in v1.5.0 

func (s *StorediSCSIVolume) SetSourceSnapshotId(v string) *StorediSCSIVolume

SetSourceSnapshotId sets the SourceSnapshotId field's value.

func (*StorediSCSIVolume) SetVolumeARN added in v1.5.0 

func (s *StorediSCSIVolume) SetVolumeARN(v string) *StorediSCSIVolume

SetVolumeARN sets the VolumeARN field's value.

func (*StorediSCSIVolume) SetVolumeDiskId added in v1.5.0 

func (s *StorediSCSIVolume) SetVolumeDiskId(v string) *StorediSCSIVolume

SetVolumeDiskId sets the VolumeDiskId field's value.

func (*StorediSCSIVolume) SetVolumeId added in v1.5.0 

func (s *StorediSCSIVolume) SetVolumeId(v string) *StorediSCSIVolume

SetVolumeId sets the VolumeId field's value.

func (*StorediSCSIVolume) SetVolumeProgress added in v1.5.0 

func (s *StorediSCSIVolume) SetVolumeProgress(v float64) *StorediSCSIVolume

SetVolumeProgress sets the VolumeProgress field's value.

func (*StorediSCSIVolume) SetVolumeSizeInBytes added in v1.5.0 

func (s *StorediSCSIVolume) SetVolumeSizeInBytes(v int64) *StorediSCSIVolume

SetVolumeSizeInBytes sets the VolumeSizeInBytes field's value.

func (*StorediSCSIVolume) SetVolumeStatus added in v1.5.0 

func (s *StorediSCSIVolume) SetVolumeStatus(v string) *StorediSCSIVolume

SetVolumeStatus sets the VolumeStatus field's value.

func (*StorediSCSIVolume) SetVolumeType added in v1.5.0 

func (s *StorediSCSIVolume) SetVolumeType(v string) *StorediSCSIVolume

SetVolumeType sets the VolumeType field's value.

func (*StorediSCSIVolume) SetVolumeUsedInBytes added in v1.12.32 

func (s *StorediSCSIVolume) SetVolumeUsedInBytes(v int64) *StorediSCSIVolume

SetVolumeUsedInBytes sets the VolumeUsedInBytes field's value.

func (*StorediSCSIVolume) SetVolumeiSCSIAttributes added in v1.5.0 

func (s *StorediSCSIVolume) SetVolumeiSCSIAttributes(v *VolumeiSCSIAttributes) *StorediSCSIVolume

SetVolumeiSCSIAttributes sets the VolumeiSCSIAttributes field's value.

func (StorediSCSIVolume) String added in v0.6.5 

func (s StorediSCSIVolume) String() string

String returns the string representation

type Tag added in v0.9.5 

type Tag struct {

	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (Tag) GoString added in v0.9.5 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.5.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.9.5 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.1.21 

func (s *Tag) Validate() error

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

type Tape 

type Tape struct {

	// The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side
	// encryption. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"20" type:"string"`

	// For archiving virtual tapes, indicates how much data remains to be uploaded
	// before archiving is complete.
	//
	// Range: 0 (not started) to 100 (complete).
	Progress *float64 `type:"double"`

	// The Amazon Resource Name (ARN) of the virtual tape.
	TapeARN *string `min:"50" type:"string"`

	// The barcode that identifies a specific virtual tape.
	TapeBarcode *string `min:"7" type:"string"`

	// The date the virtual tape was created.
	TapeCreatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The size, in bytes, of the virtual tape capacity.
	TapeSizeInBytes *int64 `type:"long"`

	// The current state of the virtual tape.
	TapeStatus *string `type:"string"`

	// The size, in bytes, of data stored on the virtual tape.
	//
	// This value is not available for tapes created prior to May 13, 2015.
	TapeUsedInBytes *int64 `type:"long"`

	// The virtual tape library (VTL) device that the virtual tape is associated
	// with.
	VTLDevice *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

Describes a virtual tape object.

func (Tape) GoString added in v0.6.5 

func (s Tape) GoString() string

GoString returns the string representation

func (*Tape) SetKMSKey added in v1.14.4 

func (s *Tape) SetKMSKey(v string) *Tape

SetKMSKey sets the KMSKey field's value.

func (*Tape) SetProgress added in v1.5.0 

func (s *Tape) SetProgress(v float64) *Tape

SetProgress sets the Progress field's value.

func (*Tape) SetTapeARN added in v1.5.0 

func (s *Tape) SetTapeARN(v string) *Tape

SetTapeARN sets the TapeARN field's value.

func (*Tape) SetTapeBarcode added in v1.5.0 

func (s *Tape) SetTapeBarcode(v string) *Tape

SetTapeBarcode sets the TapeBarcode field's value.

func (*Tape) SetTapeCreatedDate added in v1.6.6 

func (s *Tape) SetTapeCreatedDate(v time.Time) *Tape

SetTapeCreatedDate sets the TapeCreatedDate field's value.

func (*Tape) SetTapeSizeInBytes added in v1.5.0 

func (s *Tape) SetTapeSizeInBytes(v int64) *Tape

SetTapeSizeInBytes sets the TapeSizeInBytes field's value.

func (*Tape) SetTapeStatus added in v1.5.0 

func (s *Tape) SetTapeStatus(v string) *Tape

SetTapeStatus sets the TapeStatus field's value.

func (*Tape) SetTapeUsedInBytes added in v1.8.29 

func (s *Tape) SetTapeUsedInBytes(v int64) *Tape

SetTapeUsedInBytes sets the TapeUsedInBytes field's value.

func (*Tape) SetVTLDevice added in v1.5.0 

func (s *Tape) SetVTLDevice(v string) *Tape

SetVTLDevice sets the VTLDevice field's value.

func (Tape) String added in v0.6.5 

func (s Tape) String() string

String returns the string representation

type TapeArchive 

type TapeArchive struct {

	// The time that the archiving of the virtual tape was completed.
	//
	// The default time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'
	// format.
	CompletionTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side
	// encryption. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"20" type:"string"`

	// The Amazon Resource Name (ARN) of the tape gateway that the virtual tape
	// is being retrieved to.
	//
	// The virtual tape is retrieved from the virtual tape shelf (VTS).
	RetrievedTo *string `min:"50" type:"string"`

	// The Amazon Resource Name (ARN) of an archived virtual tape.
	TapeARN *string `min:"50" type:"string"`

	// The barcode that identifies the archived virtual tape.
	TapeBarcode *string `min:"7" type:"string"`

	// The date the virtual tape was created.
	TapeCreatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The size, in bytes, of the archived virtual tape.
	TapeSizeInBytes *int64 `type:"long"`

	// The current state of the archived virtual tape.
	TapeStatus *string `type:"string"`

	// The size, in bytes, of data stored on the virtual tape.
	//
	// This value is not available for tapes created prior to May 13, 2015.
	TapeUsedInBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

Represents a virtual tape that is archived in the virtual tape shelf (VTS).

func (TapeArchive) GoString added in v0.6.5 

func (s TapeArchive) GoString() string

GoString returns the string representation

func (*TapeArchive) SetCompletionTime added in v1.5.0 

func (s *TapeArchive) SetCompletionTime(v time.Time) *TapeArchive

SetCompletionTime sets the CompletionTime field's value.

func (*TapeArchive) SetKMSKey added in v1.14.4 

func (s *TapeArchive) SetKMSKey(v string) *TapeArchive

SetKMSKey sets the KMSKey field's value.

func (*TapeArchive) SetRetrievedTo added in v1.5.0 

func (s *TapeArchive) SetRetrievedTo(v string) *TapeArchive

SetRetrievedTo sets the RetrievedTo field's value.

func (*TapeArchive) SetTapeARN added in v1.5.0 

func (s *TapeArchive) SetTapeARN(v string) *TapeArchive

SetTapeARN sets the TapeARN field's value.

func (*TapeArchive) SetTapeBarcode added in v1.5.0 

func (s *TapeArchive) SetTapeBarcode(v string) *TapeArchive

SetTapeBarcode sets the TapeBarcode field's value.

func (*TapeArchive) SetTapeCreatedDate added in v1.6.6 

func (s *TapeArchive) SetTapeCreatedDate(v time.Time) *TapeArchive

SetTapeCreatedDate sets the TapeCreatedDate field's value.

func (*TapeArchive) SetTapeSizeInBytes added in v1.5.0 

func (s *TapeArchive) SetTapeSizeInBytes(v int64) *TapeArchive

SetTapeSizeInBytes sets the TapeSizeInBytes field's value.

func (*TapeArchive) SetTapeStatus added in v1.5.0 

func (s *TapeArchive) SetTapeStatus(v string) *TapeArchive

SetTapeStatus sets the TapeStatus field's value.

func (*TapeArchive) SetTapeUsedInBytes added in v1.8.29 

func (s *TapeArchive) SetTapeUsedInBytes(v int64) *TapeArchive

SetTapeUsedInBytes sets the TapeUsedInBytes field's value.

func (TapeArchive) String added in v0.6.5 

func (s TapeArchive) String() string

String returns the string representation

type TapeInfo added in v1.1.25 

type TapeInfo struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// The Amazon Resource Name (ARN) of a virtual tape.
	TapeARN *string `min:"50" type:"string"`

	// The barcode that identifies a specific virtual tape.
	TapeBarcode *string `min:"7" type:"string"`

	// The size, in bytes, of a virtual tape.
	TapeSizeInBytes *int64 `type:"long"`

	// The status of the tape.
	TapeStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a virtual tape.

func (TapeInfo) GoString added in v1.1.25 

func (s TapeInfo) GoString() string

GoString returns the string representation

func (*TapeInfo) SetGatewayARN added in v1.5.0 

func (s *TapeInfo) SetGatewayARN(v string) *TapeInfo

SetGatewayARN sets the GatewayARN field's value.

func (*TapeInfo) SetTapeARN added in v1.5.0 

func (s *TapeInfo) SetTapeARN(v string) *TapeInfo

SetTapeARN sets the TapeARN field's value.

func (*TapeInfo) SetTapeBarcode added in v1.5.0 

func (s *TapeInfo) SetTapeBarcode(v string) *TapeInfo

SetTapeBarcode sets the TapeBarcode field's value.

func (*TapeInfo) SetTapeSizeInBytes added in v1.5.0 

func (s *TapeInfo) SetTapeSizeInBytes(v int64) *TapeInfo

SetTapeSizeInBytes sets the TapeSizeInBytes field's value.

func (*TapeInfo) SetTapeStatus added in v1.5.0 

func (s *TapeInfo) SetTapeStatus(v string) *TapeInfo

SetTapeStatus sets the TapeStatus field's value.

func (TapeInfo) String added in v1.1.25 

func (s TapeInfo) String() string

String returns the string representation

type TapeRecoveryPointInfo 

type TapeRecoveryPointInfo struct {

	// The Amazon Resource Name (ARN) of the virtual tape.
	TapeARN *string `min:"50" type:"string"`

	// The time when the point-in-time view of the virtual tape was replicated for
	// later recovery.
	//
	// The default time stamp format of the tape recovery point time is in the ISO8601
	// extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
	TapeRecoveryPointTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The size, in bytes, of the virtual tapes to recover.
	TapeSizeInBytes *int64 `type:"long"`

	TapeStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a recovery point.

func (TapeRecoveryPointInfo) GoString added in v0.6.5 

func (s TapeRecoveryPointInfo) GoString() string

GoString returns the string representation

func (*TapeRecoveryPointInfo) SetTapeARN added in v1.5.0 

func (s *TapeRecoveryPointInfo) SetTapeARN(v string) *TapeRecoveryPointInfo

SetTapeARN sets the TapeARN field's value.

func (*TapeRecoveryPointInfo) SetTapeRecoveryPointTime added in v1.5.0 

func (s *TapeRecoveryPointInfo) SetTapeRecoveryPointTime(v time.Time) *TapeRecoveryPointInfo

SetTapeRecoveryPointTime sets the TapeRecoveryPointTime field's value.

func (*TapeRecoveryPointInfo) SetTapeSizeInBytes added in v1.5.0 

func (s *TapeRecoveryPointInfo) SetTapeSizeInBytes(v int64) *TapeRecoveryPointInfo

SetTapeSizeInBytes sets the TapeSizeInBytes field's value.

func (*TapeRecoveryPointInfo) SetTapeStatus added in v1.5.0 

func (s *TapeRecoveryPointInfo) SetTapeStatus(v string) *TapeRecoveryPointInfo

SetTapeStatus sets the TapeStatus field's value.

func (TapeRecoveryPointInfo) String added in v0.6.5 

func (s TapeRecoveryPointInfo) String() string

String returns the string representation

type UpdateBandwidthRateLimitInput 

type UpdateBandwidthRateLimitInput struct {

	// The average download bandwidth rate limit in bits per second.
	AverageDownloadRateLimitInBitsPerSec *int64 `min:"102400" type:"long"`

	// The average upload bandwidth rate limit in bits per second.
	AverageUploadRateLimitInBitsPerSec *int64 `min:"51200" type:"long"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing one or more of the following fields:

  • UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec

  • UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec

func (UpdateBandwidthRateLimitInput) GoString added in v0.6.5 

func (s UpdateBandwidthRateLimitInput) GoString() string

GoString returns the string representation

func (*UpdateBandwidthRateLimitInput) SetAverageDownloadRateLimitInBitsPerSec added in v1.5.0 

func (s *UpdateBandwidthRateLimitInput) SetAverageDownloadRateLimitInBitsPerSec(v int64) *UpdateBandwidthRateLimitInput

SetAverageDownloadRateLimitInBitsPerSec sets the AverageDownloadRateLimitInBitsPerSec field's value.

func (*UpdateBandwidthRateLimitInput) SetAverageUploadRateLimitInBitsPerSec added in v1.5.0 

func (s *UpdateBandwidthRateLimitInput) SetAverageUploadRateLimitInBitsPerSec(v int64) *UpdateBandwidthRateLimitInput

SetAverageUploadRateLimitInBitsPerSec sets the AverageUploadRateLimitInBitsPerSec field's value.

func (*UpdateBandwidthRateLimitInput) SetGatewayARN added in v1.5.0 

func (s *UpdateBandwidthRateLimitInput) SetGatewayARN(v string) *UpdateBandwidthRateLimitInput

SetGatewayARN sets the GatewayARN field's value.

func (UpdateBandwidthRateLimitInput) String added in v0.6.5 

func (s UpdateBandwidthRateLimitInput) String() string

String returns the string representation

func (*UpdateBandwidthRateLimitInput) Validate added in v1.1.21 

func (s *UpdateBandwidthRateLimitInput) Validate() error

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

type UpdateBandwidthRateLimitOutput 

type UpdateBandwidthRateLimitOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway whose throttle information was updated.

func (UpdateBandwidthRateLimitOutput) GoString added in v0.6.5 

func (s UpdateBandwidthRateLimitOutput) GoString() string

GoString returns the string representation

func (*UpdateBandwidthRateLimitOutput) SetGatewayARN added in v1.5.0 

func (s *UpdateBandwidthRateLimitOutput) SetGatewayARN(v string) *UpdateBandwidthRateLimitOutput

SetGatewayARN sets the GatewayARN field's value.

func (UpdateBandwidthRateLimitOutput) String added in v0.6.5 

func (s UpdateBandwidthRateLimitOutput) String() string

String returns the string representation

type UpdateChapCredentialsInput 

type UpdateChapCredentialsInput struct {

	// The iSCSI initiator that connects to the target.
	//
	// InitiatorName is a required field
	InitiatorName *string `min:"1" type:"string" required:"true"`

	// The secret key that the initiator (for example, the Windows client) must
	// provide to participate in mutual CHAP with the target.
	//
	// The secret key must be between 12 and 16 bytes when encoded in UTF-8.
	//
	// SecretToAuthenticateInitiator is a required field
	SecretToAuthenticateInitiator *string `min:"1" type:"string" required:"true"`

	// The secret key that the target must provide to participate in mutual CHAP
	// with the initiator (e.g. Windows client).
	//
	// Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
	//
	// The secret key must be between 12 and 16 bytes when encoded in UTF-8.
	SecretToAuthenticateTarget *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
	// operation to return the TargetARN for specified VolumeARN.
	//
	// TargetARN is a required field
	TargetARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing one or more of the following fields:

  • UpdateChapCredentialsInput$InitiatorName

  • UpdateChapCredentialsInput$SecretToAuthenticateInitiator

  • UpdateChapCredentialsInput$SecretToAuthenticateTarget

  • UpdateChapCredentialsInput$TargetARN

func (UpdateChapCredentialsInput) GoString added in v0.6.5 

func (s UpdateChapCredentialsInput) GoString() string

GoString returns the string representation

func (*UpdateChapCredentialsInput) SetInitiatorName added in v1.5.0 

func (s *UpdateChapCredentialsInput) SetInitiatorName(v string) *UpdateChapCredentialsInput

SetInitiatorName sets the InitiatorName field's value.

func (*UpdateChapCredentialsInput) SetSecretToAuthenticateInitiator added in v1.5.0 

func (s *UpdateChapCredentialsInput) SetSecretToAuthenticateInitiator(v string) *UpdateChapCredentialsInput

SetSecretToAuthenticateInitiator sets the SecretToAuthenticateInitiator field's value.

func (*UpdateChapCredentialsInput) SetSecretToAuthenticateTarget added in v1.5.0 

func (s *UpdateChapCredentialsInput) SetSecretToAuthenticateTarget(v string) *UpdateChapCredentialsInput

SetSecretToAuthenticateTarget sets the SecretToAuthenticateTarget field's value.

func (*UpdateChapCredentialsInput) SetTargetARN added in v1.5.0 

func (s *UpdateChapCredentialsInput) SetTargetARN(v string) *UpdateChapCredentialsInput

SetTargetARN sets the TargetARN field's value.

func (UpdateChapCredentialsInput) String added in v0.6.5 

func (s UpdateChapCredentialsInput) String() string

String returns the string representation

func (*UpdateChapCredentialsInput) Validate added in v1.1.21 

func (s *UpdateChapCredentialsInput) Validate() error

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

type UpdateChapCredentialsOutput 

type UpdateChapCredentialsOutput struct {

	// The iSCSI initiator that connects to the target. This is the same initiator
	// name specified in the request.
	InitiatorName *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the target. This is the same target specified
	// in the request.
	TargetARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

func (UpdateChapCredentialsOutput) GoString added in v0.6.5 

func (s UpdateChapCredentialsOutput) GoString() string

GoString returns the string representation

func (*UpdateChapCredentialsOutput) SetInitiatorName added in v1.5.0 

func (s *UpdateChapCredentialsOutput) SetInitiatorName(v string) *UpdateChapCredentialsOutput

SetInitiatorName sets the InitiatorName field's value.

func (*UpdateChapCredentialsOutput) SetTargetARN added in v1.5.0 

func (s *UpdateChapCredentialsOutput) SetTargetARN(v string) *UpdateChapCredentialsOutput

SetTargetARN sets the TargetARN field's value.

func (UpdateChapCredentialsOutput) String added in v0.6.5 

func (s UpdateChapCredentialsOutput) String() string

String returns the string representation

type UpdateGatewayInformationInput 

type UpdateGatewayInformationInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The name you configured for your gateway.
	GatewayName *string `min:"2" type:"string"`

	GatewayTimezone *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateGatewayInformationInput) GoString added in v0.6.5 

func (s UpdateGatewayInformationInput) GoString() string

GoString returns the string representation

func (*UpdateGatewayInformationInput) SetGatewayARN added in v1.5.0 

func (s *UpdateGatewayInformationInput) SetGatewayARN(v string) *UpdateGatewayInformationInput

SetGatewayARN sets the GatewayARN field's value.

func (*UpdateGatewayInformationInput) SetGatewayName added in v1.5.0 

func (s *UpdateGatewayInformationInput) SetGatewayName(v string) *UpdateGatewayInformationInput

SetGatewayName sets the GatewayName field's value.

func (*UpdateGatewayInformationInput) SetGatewayTimezone added in v1.5.0 

func (s *UpdateGatewayInformationInput) SetGatewayTimezone(v string) *UpdateGatewayInformationInput

SetGatewayTimezone sets the GatewayTimezone field's value.

func (UpdateGatewayInformationInput) String added in v0.6.5 

func (s UpdateGatewayInformationInput) String() string

String returns the string representation

func (*UpdateGatewayInformationInput) Validate added in v1.1.21 

func (s *UpdateGatewayInformationInput) Validate() error

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

type UpdateGatewayInformationOutput 

type UpdateGatewayInformationOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	GatewayName *string `type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the ARN of the gateway that was updated.

func (UpdateGatewayInformationOutput) GoString added in v0.6.5 

func (s UpdateGatewayInformationOutput) GoString() string

GoString returns the string representation

func (*UpdateGatewayInformationOutput) SetGatewayARN added in v1.5.0 

func (s *UpdateGatewayInformationOutput) SetGatewayARN(v string) *UpdateGatewayInformationOutput

SetGatewayARN sets the GatewayARN field's value.

func (*UpdateGatewayInformationOutput) SetGatewayName added in v1.5.0 

func (s *UpdateGatewayInformationOutput) SetGatewayName(v string) *UpdateGatewayInformationOutput

SetGatewayName sets the GatewayName field's value.

func (UpdateGatewayInformationOutput) String added in v0.6.5 

func (s UpdateGatewayInformationOutput) String() string

String returns the string representation

type UpdateGatewaySoftwareNowInput 

type UpdateGatewaySoftwareNowInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway to update.

func (UpdateGatewaySoftwareNowInput) GoString added in v0.6.5 

func (s UpdateGatewaySoftwareNowInput) GoString() string

GoString returns the string representation

func (*UpdateGatewaySoftwareNowInput) SetGatewayARN added in v1.5.0 

func (s *UpdateGatewaySoftwareNowInput) SetGatewayARN(v string) *UpdateGatewaySoftwareNowInput

SetGatewayARN sets the GatewayARN field's value.

func (UpdateGatewaySoftwareNowInput) String added in v0.6.5 

func (s UpdateGatewaySoftwareNowInput) String() string

String returns the string representation

func (*UpdateGatewaySoftwareNowInput) Validate added in v1.1.21 

func (s *UpdateGatewaySoftwareNowInput) Validate() error

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

type UpdateGatewaySoftwareNowOutput 

type UpdateGatewaySoftwareNowOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway that was updated.

func (UpdateGatewaySoftwareNowOutput) GoString added in v0.6.5 

func (s UpdateGatewaySoftwareNowOutput) GoString() string

GoString returns the string representation

func (*UpdateGatewaySoftwareNowOutput) SetGatewayARN added in v1.5.0 

func (s *UpdateGatewaySoftwareNowOutput) SetGatewayARN(v string) *UpdateGatewaySoftwareNowOutput

SetGatewayARN sets the GatewayARN field's value.

func (UpdateGatewaySoftwareNowOutput) String added in v0.6.5 

func (s UpdateGatewaySoftwareNowOutput) String() string

String returns the string representation

type UpdateMaintenanceStartTimeInput 

type UpdateMaintenanceStartTimeInput struct {

	// The maintenance start time day of the week represented as an ordinal number
	// from 0 to 6, where 0 represents Sunday and 6 Saturday.
	//
	// DayOfWeek is a required field
	DayOfWeek *int64 `type:"integer" required:"true"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The hour component of the maintenance start time represented as hh, where
	// hh is the hour (00 to 23). The hour of the day is in the time zone of the
	// gateway.
	//
	// HourOfDay is a required field
	HourOfDay *int64 `type:"integer" required:"true"`

	// The minute component of the maintenance start time represented as mm, where
	// mm is the minute (00 to 59). The minute of the hour is in the time zone of
	// the gateway.
	//
	// MinuteOfHour is a required field
	MinuteOfHour *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

  • UpdateMaintenanceStartTimeInput$DayOfWeek

  • UpdateMaintenanceStartTimeInput$HourOfDay

  • UpdateMaintenanceStartTimeInput$MinuteOfHour

func (UpdateMaintenanceStartTimeInput) GoString added in v0.6.5 

func (s UpdateMaintenanceStartTimeInput) GoString() string

GoString returns the string representation

func (*UpdateMaintenanceStartTimeInput) SetDayOfWeek added in v1.5.0 

func (s *UpdateMaintenanceStartTimeInput) SetDayOfWeek(v int64) *UpdateMaintenanceStartTimeInput

SetDayOfWeek sets the DayOfWeek field's value.

func (*UpdateMaintenanceStartTimeInput) SetGatewayARN added in v1.5.0 

func (s *UpdateMaintenanceStartTimeInput) SetGatewayARN(v string) *UpdateMaintenanceStartTimeInput

SetGatewayARN sets the GatewayARN field's value.

func (*UpdateMaintenanceStartTimeInput) SetHourOfDay added in v1.5.0 

func (s *UpdateMaintenanceStartTimeInput) SetHourOfDay(v int64) *UpdateMaintenanceStartTimeInput

SetHourOfDay sets the HourOfDay field's value.

func (*UpdateMaintenanceStartTimeInput) SetMinuteOfHour added in v1.5.0 

func (s *UpdateMaintenanceStartTimeInput) SetMinuteOfHour(v int64) *UpdateMaintenanceStartTimeInput

SetMinuteOfHour sets the MinuteOfHour field's value.

func (UpdateMaintenanceStartTimeInput) String added in v0.6.5 

func (s UpdateMaintenanceStartTimeInput) String() string

String returns the string representation

func (*UpdateMaintenanceStartTimeInput) Validate added in v1.1.21 

func (s *UpdateMaintenanceStartTimeInput) Validate() error

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

type UpdateMaintenanceStartTimeOutput 

type UpdateMaintenanceStartTimeOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the of the gateway whose maintenance start time is updated.

func (UpdateMaintenanceStartTimeOutput) GoString added in v0.6.5 

func (s UpdateMaintenanceStartTimeOutput) GoString() string

GoString returns the string representation

func (*UpdateMaintenanceStartTimeOutput) SetGatewayARN added in v1.5.0 

func (s *UpdateMaintenanceStartTimeOutput) SetGatewayARN(v string) *UpdateMaintenanceStartTimeOutput

SetGatewayARN sets the GatewayARN field's value.

func (UpdateMaintenanceStartTimeOutput) String added in v0.6.5 

func (s UpdateMaintenanceStartTimeOutput) String() string

String returns the string representation

type UpdateNFSFileShareInput added in v1.6.6 

type UpdateNFSFileShareInput struct {

	// The list of clients that are allowed to access the file gateway. The list
	// must contain either valid IP addresses or valid CIDR blocks.
	ClientList []*string `min:"1" type:"list"`

	// The default storage class for objects put into an Amazon S3 bucket by a file
	// gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA.
	// If this field is not populated, the default value S3_STANDARD is used. Optional.
	DefaultStorageClass *string `min:"5" type:"string"`

	// The Amazon Resource Name (ARN) of the file share to be updated.
	//
	// FileShareARN is a required field
	FileShareARN *string `min:"50" type:"string" required:"true"`

	// Enables guessing of the MIME type for uploaded objects based on file extensions.
	// Set this value to true to enable MIME type guessing, and otherwise to false.
	// The default value is true.
	GuessMIMETypeEnabled *bool `type:"boolean"`

	// True to use Amazon S3 server side encryption with your own AWS KMS key, or
	// false to use a key managed by Amazon S3. Optional.
	KMSEncrypted *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side
	// encryption. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"20" type:"string"`

	// The default values for the file share. Optional.
	NFSFileShareDefaults *NFSFileShareDefaults `type:"structure"`

	// Sets the access control list permission for objects in the S3 bucket that
	// a file gateway puts objects into. The default value is "private".
	ObjectACL *string `type:"string" enum:"ObjectACL"`

	// Sets the write status of a file share. This value is true if the write status
	// is read-only, and otherwise false.
	ReadOnly *bool `type:"boolean"`

	// Sets who pays the cost of the request and the data download from the Amazon
	// S3 bucket. Set this value to true if you want the requester to pay instead
	// of the bucket owner, and otherwise to false.
	RequesterPays *bool `type:"boolean"`

	// The user mapped to anonymous user. Valid options are the following:
	//
	//    * "RootSquash" - Only root is mapped to anonymous user.
	//
	//    * "NoSquash" - No one is mapped to anonymous user
	//
	//    * "AllSquash" - Everyone is mapped to anonymous user.
	Squash *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

UpdateNFSFileShareInput

func (UpdateNFSFileShareInput) GoString added in v1.6.6 

func (s UpdateNFSFileShareInput) GoString() string

GoString returns the string representation

func (*UpdateNFSFileShareInput) SetClientList added in v1.6.21 

func (s *UpdateNFSFileShareInput) SetClientList(v []*string) *UpdateNFSFileShareInput

SetClientList sets the ClientList field's value.

func (*UpdateNFSFileShareInput) SetDefaultStorageClass added in v1.6.6 

func (s *UpdateNFSFileShareInput) SetDefaultStorageClass(v string) *UpdateNFSFileShareInput

SetDefaultStorageClass sets the DefaultStorageClass field's value.

func (*UpdateNFSFileShareInput) SetFileShareARN added in v1.6.6 

func (s *UpdateNFSFileShareInput) SetFileShareARN(v string) *UpdateNFSFileShareInput

SetFileShareARN sets the FileShareARN field's value.

func (*UpdateNFSFileShareInput) SetGuessMIMETypeEnabled added in v1.12.32 

func (s *UpdateNFSFileShareInput) SetGuessMIMETypeEnabled(v bool) *UpdateNFSFileShareInput

SetGuessMIMETypeEnabled sets the GuessMIMETypeEnabled field's value.

func (*UpdateNFSFileShareInput) SetKMSEncrypted added in v1.6.6 

func (s *UpdateNFSFileShareInput) SetKMSEncrypted(v bool) *UpdateNFSFileShareInput

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*UpdateNFSFileShareInput) SetKMSKey added in v1.6.6 

func (s *UpdateNFSFileShareInput) SetKMSKey(v string) *UpdateNFSFileShareInput

SetKMSKey sets the KMSKey field's value.

func (*UpdateNFSFileShareInput) SetNFSFileShareDefaults added in v1.6.6 

func (s *UpdateNFSFileShareInput) SetNFSFileShareDefaults(v *NFSFileShareDefaults) *UpdateNFSFileShareInput

SetNFSFileShareDefaults sets the NFSFileShareDefaults field's value.

func (*UpdateNFSFileShareInput) SetObjectACL added in v1.13.8 

func (s *UpdateNFSFileShareInput) SetObjectACL(v string) *UpdateNFSFileShareInput

SetObjectACL sets the ObjectACL field's value.

func (*UpdateNFSFileShareInput) SetReadOnly added in v1.8.5 

func (s *UpdateNFSFileShareInput) SetReadOnly(v bool) *UpdateNFSFileShareInput

SetReadOnly sets the ReadOnly field's value.

func (*UpdateNFSFileShareInput) SetRequesterPays added in v1.13.8 

func (s *UpdateNFSFileShareInput) SetRequesterPays(v bool) *UpdateNFSFileShareInput

SetRequesterPays sets the RequesterPays field's value.

func (*UpdateNFSFileShareInput) SetSquash added in v1.8.5 

func (s *UpdateNFSFileShareInput) SetSquash(v string) *UpdateNFSFileShareInput

SetSquash sets the Squash field's value.

func (UpdateNFSFileShareInput) String added in v1.6.6 

func (s UpdateNFSFileShareInput) String() string

String returns the string representation

func (*UpdateNFSFileShareInput) Validate added in v1.6.6 

func (s *UpdateNFSFileShareInput) Validate() error

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

type UpdateNFSFileShareOutput added in v1.6.6 

type UpdateNFSFileShareOutput struct {

	// The Amazon Resource Name (ARN) of the updated file share.
	FileShareARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

UpdateNFSFileShareOutput

func (UpdateNFSFileShareOutput) GoString added in v1.6.6 

func (s UpdateNFSFileShareOutput) GoString() string

GoString returns the string representation

func (*UpdateNFSFileShareOutput) SetFileShareARN added in v1.6.6 

func (s *UpdateNFSFileShareOutput) SetFileShareARN(v string) *UpdateNFSFileShareOutput

SetFileShareARN sets the FileShareARN field's value.

func (UpdateNFSFileShareOutput) String added in v1.6.6 

func (s UpdateNFSFileShareOutput) String() string

String returns the string representation

type UpdateSnapshotScheduleInput 

type UpdateSnapshotScheduleInput struct {

	// Optional description of the snapshot that overwrites the existing description.
	Description *string `min:"1" type:"string"`

	// Frequency of snapshots. Specify the number of hours between snapshots.
	//
	// RecurrenceInHours is a required field
	RecurrenceInHours *int64 `min:"1" type:"integer" required:"true"`

	// The hour of the day at which the snapshot schedule begins represented as
	// hh, where hh is the hour (0 to 23). The hour of the day is in the time zone
	// of the gateway.
	//
	// StartAt is a required field
	StartAt *int64 `type:"integer" required:"true"`

	// The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
	// to return a list of gateway volumes.
	//
	// VolumeARN is a required field
	VolumeARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing one or more of the following fields:

  • UpdateSnapshotScheduleInput$Description

  • UpdateSnapshotScheduleInput$RecurrenceInHours

  • UpdateSnapshotScheduleInput$StartAt

  • UpdateSnapshotScheduleInput$VolumeARN

func (UpdateSnapshotScheduleInput) GoString added in v0.6.5 

func (s UpdateSnapshotScheduleInput) GoString() string

GoString returns the string representation

func (*UpdateSnapshotScheduleInput) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*UpdateSnapshotScheduleInput) SetRecurrenceInHours added in v1.5.0 

func (s *UpdateSnapshotScheduleInput) SetRecurrenceInHours(v int64) *UpdateSnapshotScheduleInput

SetRecurrenceInHours sets the RecurrenceInHours field's value.

func (*UpdateSnapshotScheduleInput) SetStartAt added in v1.5.0 

func (s *UpdateSnapshotScheduleInput) SetStartAt(v int64) *UpdateSnapshotScheduleInput

SetStartAt sets the StartAt field's value.

func (*UpdateSnapshotScheduleInput) SetVolumeARN added in v1.5.0 

func (s *UpdateSnapshotScheduleInput) SetVolumeARN(v string) *UpdateSnapshotScheduleInput

SetVolumeARN sets the VolumeARN field's value.

func (UpdateSnapshotScheduleInput) String added in v0.6.5 

func (s UpdateSnapshotScheduleInput) String() string

String returns the string representation

func (*UpdateSnapshotScheduleInput) Validate added in v1.1.21 

func (s *UpdateSnapshotScheduleInput) Validate() error

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

type UpdateSnapshotScheduleOutput 

type UpdateSnapshotScheduleOutput struct {
	VolumeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the of the updated storage volume.

func (UpdateSnapshotScheduleOutput) GoString added in v0.6.5 

func (s UpdateSnapshotScheduleOutput) GoString() string

GoString returns the string representation

func (*UpdateSnapshotScheduleOutput) SetVolumeARN added in v1.5.0 

func (s *UpdateSnapshotScheduleOutput) SetVolumeARN(v string) *UpdateSnapshotScheduleOutput

SetVolumeARN sets the VolumeARN field's value.

func (UpdateSnapshotScheduleOutput) String added in v0.6.5 

func (s UpdateSnapshotScheduleOutput) String() string

String returns the string representation

type UpdateVTLDeviceTypeInput 

type UpdateVTLDeviceTypeInput struct {

	// The type of medium changer you want to select.
	//
	// Valid Values: "STK-L700", "AWS-Gateway-VTL"
	//
	// DeviceType is a required field
	DeviceType *string `min:"2" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the medium changer you want to select.
	//
	// VTLDeviceARN is a required field
	VTLDeviceARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVTLDeviceTypeInput) GoString added in v0.6.5 

func (s UpdateVTLDeviceTypeInput) GoString() string

GoString returns the string representation

func (*UpdateVTLDeviceTypeInput) SetDeviceType added in v1.5.0 

func (s *UpdateVTLDeviceTypeInput) SetDeviceType(v string) *UpdateVTLDeviceTypeInput

SetDeviceType sets the DeviceType field's value.

func (*UpdateVTLDeviceTypeInput) SetVTLDeviceARN added in v1.5.0 

func (s *UpdateVTLDeviceTypeInput) SetVTLDeviceARN(v string) *UpdateVTLDeviceTypeInput

SetVTLDeviceARN sets the VTLDeviceARN field's value.

func (UpdateVTLDeviceTypeInput) String added in v0.6.5 

func (s UpdateVTLDeviceTypeInput) String() string

String returns the string representation

func (*UpdateVTLDeviceTypeInput) Validate added in v1.1.21 

func (s *UpdateVTLDeviceTypeInput) Validate() error

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

type UpdateVTLDeviceTypeOutput 

type UpdateVTLDeviceTypeOutput struct {

	// The Amazon Resource Name (ARN) of the medium changer you have selected.
	VTLDeviceARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

UpdateVTLDeviceTypeOutput

func (UpdateVTLDeviceTypeOutput) GoString added in v0.6.5 

func (s UpdateVTLDeviceTypeOutput) GoString() string

GoString returns the string representation

func (*UpdateVTLDeviceTypeOutput) SetVTLDeviceARN added in v1.5.0 

func (s *UpdateVTLDeviceTypeOutput) SetVTLDeviceARN(v string) *UpdateVTLDeviceTypeOutput

SetVTLDeviceARN sets the VTLDeviceARN field's value.

func (UpdateVTLDeviceTypeOutput) String added in v0.6.5 

func (s UpdateVTLDeviceTypeOutput) String() string

String returns the string representation

type VTLDevice 

type VTLDevice struct {

	// A list of iSCSI information about a VTL device.
	DeviceiSCSIAttributes *DeviceiSCSIAttributes `type:"structure"`

	// Specifies the unique Amazon Resource Name (ARN) of the device (tape drive
	// or media changer).
	VTLDeviceARN *string `min:"50" type:"string"`

	VTLDeviceProductIdentifier *string `type:"string"`

	VTLDeviceType *string `type:"string"`

	VTLDeviceVendor *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a device object associated with a tape gateway.

func (VTLDevice) GoString added in v0.6.5 

func (s VTLDevice) GoString() string

GoString returns the string representation

func (*VTLDevice) SetDeviceiSCSIAttributes added in v1.5.0 

func (s *VTLDevice) SetDeviceiSCSIAttributes(v *DeviceiSCSIAttributes) *VTLDevice

SetDeviceiSCSIAttributes sets the DeviceiSCSIAttributes field's value.

func (*VTLDevice) SetVTLDeviceARN added in v1.5.0 

func (s *VTLDevice) SetVTLDeviceARN(v string) *VTLDevice

SetVTLDeviceARN sets the VTLDeviceARN field's value.

func (*VTLDevice) SetVTLDeviceProductIdentifier added in v1.5.0 

func (s *VTLDevice) SetVTLDeviceProductIdentifier(v string) *VTLDevice

SetVTLDeviceProductIdentifier sets the VTLDeviceProductIdentifier field's value.

func (*VTLDevice) SetVTLDeviceType added in v1.5.0 

func (s *VTLDevice) SetVTLDeviceType(v string) *VTLDevice

SetVTLDeviceType sets the VTLDeviceType field's value.

func (*VTLDevice) SetVTLDeviceVendor added in v1.5.0 

func (s *VTLDevice) SetVTLDeviceVendor(v string) *VTLDevice

SetVTLDeviceVendor sets the VTLDeviceVendor field's value.

func (VTLDevice) String added in v0.6.5 

func (s VTLDevice) String() string

String returns the string representation

type VolumeInfo 

type VolumeInfo struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and region.
	GatewayARN *string `min:"50" type:"string"`

	// The unique identifier assigned to your gateway during activation. This ID
	// becomes part of the gateway Amazon Resource Name (ARN), which you use as
	// input for other operations.
	//
	// Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens
	// (-).
	GatewayId *string `min:"12" type:"string"`

	// The Amazon Resource Name (ARN) for the storage volume. For example, the following
	// is a valid ARN:
	//
	// arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
	//
	// Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens
	// (-).
	VolumeARN *string `min:"50" type:"string"`

	// The unique identifier assigned to the volume. This ID becomes part of the
	// volume Amazon Resource Name (ARN), which you use as input for other operations.
	//
	// Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens
	// (-).
	VolumeId *string `min:"12" type:"string"`

	// The size of the volume in bytes.
	//
	// Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens
	// (-).
	VolumeSizeInBytes *int64 `type:"long"`

	VolumeType *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Describes a storage volume object.

func (VolumeInfo) GoString added in v0.6.5 

func (s VolumeInfo) GoString() string

GoString returns the string representation

func (*VolumeInfo) SetGatewayARN added in v1.5.0 

func (s *VolumeInfo) SetGatewayARN(v string) *VolumeInfo

SetGatewayARN sets the GatewayARN field's value.

func (*VolumeInfo) SetGatewayId added in v1.5.0 

func (s *VolumeInfo) SetGatewayId(v string) *VolumeInfo

SetGatewayId sets the GatewayId field's value.

func (*VolumeInfo) SetVolumeARN added in v1.5.0 

func (s *VolumeInfo) SetVolumeARN(v string) *VolumeInfo

SetVolumeARN sets the VolumeARN field's value.

func (*VolumeInfo) SetVolumeId added in v1.5.0 

func (s *VolumeInfo) SetVolumeId(v string) *VolumeInfo

SetVolumeId sets the VolumeId field's value.

func (*VolumeInfo) SetVolumeSizeInBytes added in v1.5.0 

func (s *VolumeInfo) SetVolumeSizeInBytes(v int64) *VolumeInfo

SetVolumeSizeInBytes sets the VolumeSizeInBytes field's value.

func (*VolumeInfo) SetVolumeType added in v1.5.0 

func (s *VolumeInfo) SetVolumeType(v string) *VolumeInfo

SetVolumeType sets the VolumeType field's value.

func (VolumeInfo) String added in v0.6.5 

func (s VolumeInfo) String() string

String returns the string representation

type VolumeRecoveryPointInfo 

type VolumeRecoveryPointInfo struct {
	VolumeARN *string `min:"50" type:"string"`

	VolumeRecoveryPointTime *string `type:"string"`

	VolumeSizeInBytes *int64 `type:"long"`

	VolumeUsageInBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (VolumeRecoveryPointInfo) GoString added in v0.6.5 

func (s VolumeRecoveryPointInfo) GoString() string

GoString returns the string representation

func (*VolumeRecoveryPointInfo) SetVolumeARN added in v1.5.0 

func (s *VolumeRecoveryPointInfo) SetVolumeARN(v string) *VolumeRecoveryPointInfo

SetVolumeARN sets the VolumeARN field's value.

func (*VolumeRecoveryPointInfo) SetVolumeRecoveryPointTime added in v1.5.0 

func (s *VolumeRecoveryPointInfo) SetVolumeRecoveryPointTime(v string) *VolumeRecoveryPointInfo

SetVolumeRecoveryPointTime sets the VolumeRecoveryPointTime field's value.

func (*VolumeRecoveryPointInfo) SetVolumeSizeInBytes added in v1.5.0 

func (s *VolumeRecoveryPointInfo) SetVolumeSizeInBytes(v int64) *VolumeRecoveryPointInfo

SetVolumeSizeInBytes sets the VolumeSizeInBytes field's value.

func (*VolumeRecoveryPointInfo) SetVolumeUsageInBytes added in v1.5.0 

func (s *VolumeRecoveryPointInfo) SetVolumeUsageInBytes(v int64) *VolumeRecoveryPointInfo

SetVolumeUsageInBytes sets the VolumeUsageInBytes field's value.

func (VolumeRecoveryPointInfo) String added in v0.6.5 

func (s VolumeRecoveryPointInfo) String() string

String returns the string representation

type VolumeiSCSIAttributes 

type VolumeiSCSIAttributes struct {

	// Indicates whether mutual CHAP is enabled for the iSCSI target.
	ChapEnabled *bool `type:"boolean"`

	// The logical disk number.
	LunNumber *int64 `min:"1" type:"integer"`

	// The network interface identifier.
	NetworkInterfaceId *string `type:"string"`

	// The port used to communicate with iSCSI targets.
	NetworkInterfacePort *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) of the volume target.
	TargetARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

Lists iSCSI information about a volume.

func (VolumeiSCSIAttributes) GoString added in v0.6.5 

func (s VolumeiSCSIAttributes) GoString() string

GoString returns the string representation

func (*VolumeiSCSIAttributes) SetChapEnabled added in v1.5.0 

func (s *VolumeiSCSIAttributes) SetChapEnabled(v bool) *VolumeiSCSIAttributes

SetChapEnabled sets the ChapEnabled field's value.

func (*VolumeiSCSIAttributes) SetLunNumber added in v1.5.0 

func (s *VolumeiSCSIAttributes) SetLunNumber(v int64) *VolumeiSCSIAttributes

SetLunNumber sets the LunNumber field's value.

func (*VolumeiSCSIAttributes) SetNetworkInterfaceId added in v1.5.0 

func (s *VolumeiSCSIAttributes) SetNetworkInterfaceId(v string) *VolumeiSCSIAttributes

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*VolumeiSCSIAttributes) SetNetworkInterfacePort added in v1.5.0 

func (s *VolumeiSCSIAttributes) SetNetworkInterfacePort(v int64) *VolumeiSCSIAttributes

SetNetworkInterfacePort sets the NetworkInterfacePort field's value.

func (*VolumeiSCSIAttributes) SetTargetARN added in v1.5.0 

func (s *VolumeiSCSIAttributes) SetTargetARN(v string) *VolumeiSCSIAttributes

SetTargetARN sets the TargetARN field's value.

func (VolumeiSCSIAttributes) String added in v0.6.5 

func (s VolumeiSCSIAttributes) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package storagegatewayiface provides an interface to enable mocking the AWS Storage Gateway service client for testing your code.
 Package storagegatewayiface provides an interface to enable mocking the AWS Storage Gateway 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.