storagegateway

package
v1.50.6 Latest Latest
Warning

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

 Go to latest Published: Jan 29, 2024 License: Apache-2.0 Imports: 10 Imported by: 109

Documentation

Overview

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

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 the Amazon Web Services storage infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.

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

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 (http://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 Storage Gateway volume and snapshot IDs coming in 2016 (http://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 (
	// ActiveDirectoryStatusAccessDenied is a ActiveDirectoryStatus enum value
	ActiveDirectoryStatusAccessDenied = "ACCESS_DENIED"

	// ActiveDirectoryStatusDetached is a ActiveDirectoryStatus enum value
	ActiveDirectoryStatusDetached = "DETACHED"

	// ActiveDirectoryStatusJoined is a ActiveDirectoryStatus enum value
	ActiveDirectoryStatusJoined = "JOINED"

	// ActiveDirectoryStatusJoining is a ActiveDirectoryStatus enum value
	ActiveDirectoryStatusJoining = "JOINING"

	// ActiveDirectoryStatusNetworkError is a ActiveDirectoryStatus enum value
	ActiveDirectoryStatusNetworkError = "NETWORK_ERROR"

	// ActiveDirectoryStatusTimeout is a ActiveDirectoryStatus enum value
	ActiveDirectoryStatusTimeout = "TIMEOUT"

	// ActiveDirectoryStatusUnknownError is a ActiveDirectoryStatus enum value
	ActiveDirectoryStatusUnknownError = "UNKNOWN_ERROR"
)
View Source 
const (
	// AvailabilityMonitorTestStatusComplete is a AvailabilityMonitorTestStatus enum value
	AvailabilityMonitorTestStatusComplete = "COMPLETE"

	// AvailabilityMonitorTestStatusFailed is a AvailabilityMonitorTestStatus enum value
	AvailabilityMonitorTestStatusFailed = "FAILED"

	// AvailabilityMonitorTestStatusPending is a AvailabilityMonitorTestStatus enum value
	AvailabilityMonitorTestStatusPending = "PENDING"
)
View Source 
const (
	// CaseSensitivityClientSpecified is a CaseSensitivity enum value
	CaseSensitivityClientSpecified = "ClientSpecified"

	// CaseSensitivityCaseSensitive is a CaseSensitivity enum value
	CaseSensitivityCaseSensitive = "CaseSensitive"
)
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"

	// ErrorCodeJoinDomainInProgress is a ErrorCode enum value
	ErrorCodeJoinDomainInProgress = "JoinDomainInProgress"

	// 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 (
	// FileShareTypeNfs is a FileShareType enum value
	FileShareTypeNfs = "NFS"

	// FileShareTypeSmb is a FileShareType enum value
	FileShareTypeSmb = "SMB"
)

The type of the file share.

View Source 
const (
	// GatewayCapacitySmall is a GatewayCapacity enum value
	GatewayCapacitySmall = "Small"

	// GatewayCapacityMedium is a GatewayCapacity enum value
	GatewayCapacityMedium = "Medium"

	// GatewayCapacityLarge is a GatewayCapacity enum value
	GatewayCapacityLarge = "Large"
)
View Source 
const (
	// HostEnvironmentVmware is a HostEnvironment enum value
	HostEnvironmentVmware = "VMWARE"

	// HostEnvironmentHyperV is a HostEnvironment enum value
	HostEnvironmentHyperV = "HYPER-V"

	// HostEnvironmentEc2 is a HostEnvironment enum value
	HostEnvironmentEc2 = "EC2"

	// HostEnvironmentKvm is a HostEnvironment enum value
	HostEnvironmentKvm = "KVM"

	// HostEnvironmentOther is a HostEnvironment enum value
	HostEnvironmentOther = "OTHER"

	// HostEnvironmentSnowball is a HostEnvironment enum value
	HostEnvironmentSnowball = "SNOWBALL"
)
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"
)

A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private.

View Source 
const (
	// PoolStatusActive is a PoolStatus enum value
	PoolStatusActive = "ACTIVE"

	// PoolStatusDeleted is a PoolStatus enum value
	PoolStatusDeleted = "DELETED"
)
View Source 
const (
	// RetentionLockTypeCompliance is a RetentionLockType enum value
	RetentionLockTypeCompliance = "COMPLIANCE"

	// RetentionLockTypeGovernance is a RetentionLockType enum value
	RetentionLockTypeGovernance = "GOVERNANCE"

	// RetentionLockTypeNone is a RetentionLockType enum value
	RetentionLockTypeNone = "NONE"
)
View Source 
const (
	// SMBSecurityStrategyClientSpecified is a SMBSecurityStrategy enum value
	SMBSecurityStrategyClientSpecified = "ClientSpecified"

	// SMBSecurityStrategyMandatorySigning is a SMBSecurityStrategy enum value
	SMBSecurityStrategyMandatorySigning = "MandatorySigning"

	// SMBSecurityStrategyMandatoryEncryption is a SMBSecurityStrategy enum value
	SMBSecurityStrategyMandatoryEncryption = "MandatoryEncryption"
)
View Source 
const (
	// TapeStorageClassDeepArchive is a TapeStorageClass enum value
	TapeStorageClassDeepArchive = "DEEP_ARCHIVE"

	// TapeStorageClassGlacier is a TapeStorageClass enum value
	TapeStorageClassGlacier = "GLACIER"
)
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 identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ActiveDirectoryStatus_Values added in v1.34.3 

func ActiveDirectoryStatus_Values() []string

ActiveDirectoryStatus_Values returns all elements of the ActiveDirectoryStatus enum

func AvailabilityMonitorTestStatus_Values added in v1.34.3 

func AvailabilityMonitorTestStatus_Values() []string

AvailabilityMonitorTestStatus_Values returns all elements of the AvailabilityMonitorTestStatus enum

func CaseSensitivity_Values added in v1.34.3 

func CaseSensitivity_Values() []string

CaseSensitivity_Values returns all elements of the CaseSensitivity enum

func ErrorCode_Values added in v1.34.3 

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func FileShareType_Values added in v1.34.3 

func FileShareType_Values() []string

FileShareType_Values returns all elements of the FileShareType enum

func GatewayCapacity_Values added in v1.39.2 

func GatewayCapacity_Values() []string

GatewayCapacity_Values returns all elements of the GatewayCapacity enum

func HostEnvironment_Values added in v1.34.3 

func HostEnvironment_Values() []string

HostEnvironment_Values returns all elements of the HostEnvironment enum

func ObjectACL_Values added in v1.34.3 

func ObjectACL_Values() []string

ObjectACL_Values returns all elements of the ObjectACL enum

func PoolStatus_Values added in v1.34.8 

func PoolStatus_Values() []string

PoolStatus_Values returns all elements of the PoolStatus enum

func RetentionLockType_Values added in v1.34.8 

func RetentionLockType_Values() []string

RetentionLockType_Values returns all elements of the RetentionLockType enum

func SMBSecurityStrategy_Values added in v1.34.3 

func SMBSecurityStrategy_Values() []string

SMBSecurityStrategy_Values returns all elements of the SMBSecurityStrategy enum

func TapeStorageClass_Values added in v1.34.8 

func TapeStorageClass_Values() []string

TapeStorageClass_Values returns all elements of the TapeStorageClass enum

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 Getting activation key (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 Amazon Web Services Region where you want to store
	// your data. The gateway Amazon Web Services Region specified must be the same
	// Amazon Web Services Region as the Amazon Web Services Region in your Host
	// header in the request. For more information about available Amazon Web Services
	// Regions and endpoints for Storage Gateway, see Storage Gateway endpoints
	// and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the
	// Amazon Web Services General Reference.
	//
	// Valid Values: See Storage Gateway endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html)
	// in the Amazon Web Services General Reference.
	//
	// 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 CACHED.
	//
	// Valid Values: STORED | CACHED | VTL | VTL_SNOW | FILE_S3 | FILE_FSX_SMB
	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 | IBM-03584L32-0402
	MediumChangerType *string `min:"2" type:"string"`

	// A list of up to 50 tags that you can assign to the gateway. Each tag is a
	// key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers that
	// can be represented in UTF-8 format, and the following special characters:
	// + - = . _ : / @. The maximum length of a tag's key is 128 characters, and
	// the maximum length for a tag's value is 256 characters.
	Tags []*Tag `type:"list"`

	// 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$MediumChangerType

  • ActivateGatewayInput$TapeDriveType

func (ActivateGatewayInput) GoString added in v0.6.5 

func (s ActivateGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetTags added in v1.17.11 

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

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddCacheInput 

type AddCacheInput struct {

	// An array of strings that identify disks that are to be configured as working
	// storage. Each string has 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddUploadBufferInput 

type AddUploadBufferInput struct {

	// An array of strings that identify disks that are to be configured as working
	// storage. Each string has 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddWorkingStorageInput 

type AddWorkingStorageInput struct {

	// An array of strings that identify disks that are to be configured as working
	// storage. Each string has 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssignTapePoolInput added in v1.19.39 

type AssignTapePoolInput struct {

	// Set permissions to bypass governance retention. If the lock type of the archived
	// tape is Governance, the tape's archived age is not older than RetentionLockInDays,
	// and the user does not already have BypassGovernanceRetention, setting this
	// to TRUE enables the user to bypass the retention lock. This parameter is
	// set to true by default for calls from the console.
	//
	// Valid values: TRUE | FALSE
	BypassGovernanceRetention *bool `type:"boolean"`

	// The ID of the pool that you want to add your tape to for archiving. The tape
	// in this pool is archived in the S3 storage class that is associated with
	// the pool. When you use your backup application to eject the tape, the tape
	// is archived directly into the storage class (S3 Glacier or S3 Glacier Deep
	// Archive) that corresponds to the pool.
	//
	// PoolId is a required field
	PoolId *string `min:"1" type:"string" required:"true"`

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

func (AssignTapePoolInput) GoString added in v1.19.39 

func (s AssignTapePoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssignTapePoolInput) SetBypassGovernanceRetention added in v1.34.8 

func (s *AssignTapePoolInput) SetBypassGovernanceRetention(v bool) *AssignTapePoolInput

SetBypassGovernanceRetention sets the BypassGovernanceRetention field's value.

func (*AssignTapePoolInput) SetPoolId added in v1.19.39 

func (s *AssignTapePoolInput) SetPoolId(v string) *AssignTapePoolInput

SetPoolId sets the PoolId field's value.

func (*AssignTapePoolInput) SetTapeARN added in v1.19.39 

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

SetTapeARN sets the TapeARN field's value.

func (AssignTapePoolInput) String added in v1.19.39 

func (s AssignTapePoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssignTapePoolInput) Validate added in v1.19.39 

func (s *AssignTapePoolInput) Validate() error

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

type AssignTapePoolOutput added in v1.19.39 

type AssignTapePoolOutput struct {

	// The unique Amazon Resource Names (ARN) of the virtual tape that was added
	// to the tape pool.
	TapeARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (AssignTapePoolOutput) GoString added in v1.19.39 

func (s AssignTapePoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssignTapePoolOutput) SetTapeARN added in v1.19.39 

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

SetTapeARN sets the TapeARN field's value.

func (AssignTapePoolOutput) String added in v1.19.39 

func (s AssignTapePoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateFileSystemInput added in v1.38.15 

type AssociateFileSystemInput struct {

	// The Amazon Resource Name (ARN) of the storage used for the audit logs.
	AuditDestinationARN *string `type:"string"`

	// The refresh cache information for the file share or FSx file systems.
	CacheAttributes *CacheAttributes `type:"structure"`

	// A unique string value that you supply that is used by the FSx File Gateway
	// to ensure idempotent file system association creation.
	//
	// ClientToken is a required field
	ClientToken *string `min:"5" type:"string" required:"true"`

	// Specifies the network configuration information for the gateway associated
	// with the Amazon FSx file system.
	//
	// If multiple file systems are associated with this gateway, this parameter's
	// IpAddresses field is required.
	EndpointNetworkConfiguration *EndpointNetworkConfiguration `type:"structure"`

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

	// The Amazon Resource Name (ARN) of the Amazon FSx file system to associate
	// with the FSx File Gateway.
	//
	// LocationARN is a required field
	LocationARN *string `min:"8" type:"string" required:"true"`

	// The password of the user credential.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AssociateFileSystemInput's
	// String and GoString methods.
	//
	// Password is a required field
	Password *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// A list of up to 50 tags that can be assigned to the file system association.
	// Each tag is a key-value pair.
	Tags []*Tag `type:"list"`

	// The user name of the user credential that has permission to access the root
	// share D$ of the Amazon FSx file system. The user account must belong to the
	// Amazon FSx delegated admin user group.
	//
	// UserName is a required field
	UserName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateFileSystemInput) GoString added in v1.38.15 

func (s AssociateFileSystemInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFileSystemInput) SetAuditDestinationARN added in v1.38.15 

func (s *AssociateFileSystemInput) SetAuditDestinationARN(v string) *AssociateFileSystemInput

SetAuditDestinationARN sets the AuditDestinationARN field's value.

func (*AssociateFileSystemInput) SetCacheAttributes added in v1.38.15 

func (s *AssociateFileSystemInput) SetCacheAttributes(v *CacheAttributes) *AssociateFileSystemInput

SetCacheAttributes sets the CacheAttributes field's value.

func (*AssociateFileSystemInput) SetClientToken added in v1.38.15 

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

SetClientToken sets the ClientToken field's value.

func (*AssociateFileSystemInput) SetEndpointNetworkConfiguration added in v1.39.2 

func (s *AssociateFileSystemInput) SetEndpointNetworkConfiguration(v *EndpointNetworkConfiguration) *AssociateFileSystemInput

SetEndpointNetworkConfiguration sets the EndpointNetworkConfiguration field's value.

func (*AssociateFileSystemInput) SetGatewayARN added in v1.38.15 

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

SetGatewayARN sets the GatewayARN field's value.

func (*AssociateFileSystemInput) SetLocationARN added in v1.38.15 

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

SetLocationARN sets the LocationARN field's value.

func (*AssociateFileSystemInput) SetPassword added in v1.38.15 

func (s *AssociateFileSystemInput) SetPassword(v string) *AssociateFileSystemInput

SetPassword sets the Password field's value.

func (*AssociateFileSystemInput) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (*AssociateFileSystemInput) SetUserName added in v1.38.15 

func (s *AssociateFileSystemInput) SetUserName(v string) *AssociateFileSystemInput

SetUserName sets the UserName field's value.

func (AssociateFileSystemInput) String added in v1.38.15 

func (s AssociateFileSystemInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFileSystemInput) Validate added in v1.38.15 

func (s *AssociateFileSystemInput) Validate() error

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

type AssociateFileSystemOutput added in v1.38.15 

type AssociateFileSystemOutput struct {

	// The ARN of the newly created file system association.
	FileSystemAssociationARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateFileSystemOutput) GoString added in v1.38.15 

func (s AssociateFileSystemOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFileSystemOutput) SetFileSystemAssociationARN added in v1.38.15 

func (s *AssociateFileSystemOutput) SetFileSystemAssociationARN(v string) *AssociateFileSystemOutput

SetFileSystemAssociationARN sets the FileSystemAssociationARN field's value.

func (AssociateFileSystemOutput) String added in v1.38.15 

func (s AssociateFileSystemOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachVolumeInput added in v1.16.19 

type AttachVolumeInput struct {

	// The unique device ID or other distinguishing data that identifies the local
	// disk used to create the volume. This value is only required when you are
	// attaching a stored volume.
	DiskId *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the gateway that you want to attach the
	// volume to.
	//
	// 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"`

	// The name of the iSCSI target used by an initiator to connect to a volume
	// and used 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 on a gateway.
	//
	// If you don't specify a value, Storage Gateway uses the value that was previously
	// used for this volume as the new target name.
	TargetName *string `min:"1" type:"string"`

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

AttachVolumeInput

func (AttachVolumeInput) GoString added in v1.16.19 

func (s AttachVolumeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachVolumeInput) SetDiskId added in v1.16.19 

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

SetDiskId sets the DiskId field's value.

func (*AttachVolumeInput) SetGatewayARN added in v1.16.19 

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

SetGatewayARN sets the GatewayARN field's value.

func (*AttachVolumeInput) SetNetworkInterfaceId added in v1.16.19 

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

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*AttachVolumeInput) SetTargetName added in v1.16.19 

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

SetTargetName sets the TargetName field's value.

func (*AttachVolumeInput) SetVolumeARN added in v1.16.19 

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

SetVolumeARN sets the VolumeARN field's value.

func (AttachVolumeInput) String added in v1.16.19 

func (s AttachVolumeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachVolumeInput) Validate added in v1.16.19 

func (s *AttachVolumeInput) Validate() error

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

type AttachVolumeOutput added in v1.16.19 

type AttachVolumeOutput struct {

	// The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI
	// name for the initiator that was used to connect to the target.
	TargetARN *string `min:"50" type:"string"`

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

AttachVolumeOutput

func (AttachVolumeOutput) GoString added in v1.16.19 

func (s AttachVolumeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachVolumeOutput) SetTargetARN added in v1.16.19 

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

SetTargetARN sets the TargetARN field's value.

func (*AttachVolumeOutput) SetVolumeARN added in v1.16.19 

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

SetVolumeARN sets the VolumeARN field's value.

func (AttachVolumeOutput) String added in v1.16.19 

func (s AttachVolumeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutomaticTapeCreationPolicyInfo added in v1.30.13 

type AutomaticTapeCreationPolicyInfo struct {

	// An automatic tape creation policy consists of a list of automatic tape creation
	// rules. This returns the rules that determine when and how to automatically
	// create new tapes.
	AutomaticTapeCreationRules []*AutomaticTapeCreationRule `min:"1" type:"list"`

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

Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.

func (AutomaticTapeCreationPolicyInfo) GoString added in v1.30.13 

func (s AutomaticTapeCreationPolicyInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomaticTapeCreationPolicyInfo) SetAutomaticTapeCreationRules added in v1.30.13 

func (s *AutomaticTapeCreationPolicyInfo) SetAutomaticTapeCreationRules(v []*AutomaticTapeCreationRule) *AutomaticTapeCreationPolicyInfo

SetAutomaticTapeCreationRules sets the AutomaticTapeCreationRules field's value.

func (*AutomaticTapeCreationPolicyInfo) SetGatewayARN added in v1.30.13 

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

SetGatewayARN sets the GatewayARN field's value.

func (AutomaticTapeCreationPolicyInfo) String added in v1.30.13 

func (s AutomaticTapeCreationPolicyInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutomaticTapeCreationRule added in v1.30.13 

type AutomaticTapeCreationRule struct {

	// The minimum number of available virtual tapes that the gateway maintains
	// at all times. If the number of tapes on the gateway goes below this value,
	// the gateway creates as many new tapes as are needed to have MinimumNumTapes
	// on the gateway. For more information about automatic tape creation, see Creating
	// Tapes Automatically (https://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically).
	//
	// MinimumNumTapes is a required field
	MinimumNumTapes *int64 `min:"1" type:"integer" required:"true"`

	// The ID of the pool that you want to add your tape to for archiving. The tape
	// in this pool is archived in the Amazon S3 storage class that is associated
	// with the pool. When you use your backup application to eject the tape, the
	// tape is archived directly into the storage class (S3 Glacier or S3 Glacier
	// Deep Archive) that corresponds to the pool.
	//
	// PoolId is a required field
	PoolId *string `min:"1" type:"string" required:"true"`

	// A prefix that you append to the barcode of the virtual tape that you are
	// creating. This prefix makes the barcode unique.
	//
	// The prefix must be 1-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 tape capacity.
	//
	// TapeSizeInBytes is a required field
	TapeSizeInBytes *int64 `type:"long" required:"true"`

	// Set to true to indicate that tapes are to be archived as write-once-read-many
	// (WORM). Set to false when WORM is not enabled for tapes.
	Worm *bool `type:"boolean"`
	// contains filtered or unexported fields
}

An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically (https://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically).

func (AutomaticTapeCreationRule) GoString added in v1.30.13 

func (s AutomaticTapeCreationRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomaticTapeCreationRule) SetMinimumNumTapes added in v1.30.13 

func (s *AutomaticTapeCreationRule) SetMinimumNumTapes(v int64) *AutomaticTapeCreationRule

SetMinimumNumTapes sets the MinimumNumTapes field's value.

func (*AutomaticTapeCreationRule) SetPoolId added in v1.30.13 

func (s *AutomaticTapeCreationRule) SetPoolId(v string) *AutomaticTapeCreationRule

SetPoolId sets the PoolId field's value.

func (*AutomaticTapeCreationRule) SetTapeBarcodePrefix added in v1.30.13 

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

SetTapeBarcodePrefix sets the TapeBarcodePrefix field's value.

func (*AutomaticTapeCreationRule) SetTapeSizeInBytes added in v1.30.13 

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

SetTapeSizeInBytes sets the TapeSizeInBytes field's value.

func (*AutomaticTapeCreationRule) SetWorm added in v1.34.8 

func (s *AutomaticTapeCreationRule) SetWorm(v bool) *AutomaticTapeCreationRule

SetWorm sets the Worm field's value.

func (AutomaticTapeCreationRule) String added in v1.30.13 

func (s AutomaticTapeCreationRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomaticTapeCreationRule) Validate added in v1.30.13 

func (s *AutomaticTapeCreationRule) Validate() error

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

type BandwidthRateLimitInterval added in v1.35.24 

type BandwidthRateLimitInterval struct {

	// The average download rate limit component of the bandwidth rate limit interval,
	// 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 rate limit component of the bandwidth rate limit interval,
	// in bits per second. This field does not appear in the response if the upload
	// rate limit is not set.
	//
	// For Tape Gateway and Volume Gateway, the minimum value is 51200.
	//
	// For S3 File Gateway and FSx File Gateway, the minimum value is 104857600.
	AverageUploadRateLimitInBitsPerSec *int64 `min:"51200" type:"long"`

	// The days of the week component of the bandwidth rate limit interval, represented
	// as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents
	// Saturday.
	//
	// DaysOfWeek is a required field
	DaysOfWeek []*int64 `min:"1" type:"list" required:"true"`

	// The hour of the day to end the bandwidth rate limit interval.
	//
	// EndHourOfDay is a required field
	EndHourOfDay *int64 `type:"integer" required:"true"`

	// The minute of the hour to end the bandwidth rate limit interval.
	//
	// The bandwidth rate limit interval ends at the end of the minute. To end an
	// interval at the end of an hour, use the value 59.
	//
	// EndMinuteOfHour is a required field
	EndMinuteOfHour *int64 `type:"integer" required:"true"`

	// The hour of the day to start the bandwidth rate limit interval.
	//
	// StartHourOfDay is a required field
	StartHourOfDay *int64 `type:"integer" required:"true"`

	// The minute of the hour to start the bandwidth rate limit interval. The interval
	// begins at the start of that minute. To begin an interval exactly at the start
	// of the hour, use the value 0.
	//
	// StartMinuteOfHour is a required field
	StartMinuteOfHour *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

func (BandwidthRateLimitInterval) GoString added in v1.35.24 

func (s BandwidthRateLimitInterval) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BandwidthRateLimitInterval) SetAverageDownloadRateLimitInBitsPerSec added in v1.35.24 

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

SetAverageDownloadRateLimitInBitsPerSec sets the AverageDownloadRateLimitInBitsPerSec field's value.

func (*BandwidthRateLimitInterval) SetAverageUploadRateLimitInBitsPerSec added in v1.35.24 

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

SetAverageUploadRateLimitInBitsPerSec sets the AverageUploadRateLimitInBitsPerSec field's value.

func (*BandwidthRateLimitInterval) SetDaysOfWeek added in v1.35.24 

func (s *BandwidthRateLimitInterval) SetDaysOfWeek(v []*int64) *BandwidthRateLimitInterval

SetDaysOfWeek sets the DaysOfWeek field's value.

func (*BandwidthRateLimitInterval) SetEndHourOfDay added in v1.35.24 

func (s *BandwidthRateLimitInterval) SetEndHourOfDay(v int64) *BandwidthRateLimitInterval

SetEndHourOfDay sets the EndHourOfDay field's value.

func (*BandwidthRateLimitInterval) SetEndMinuteOfHour added in v1.35.24 

func (s *BandwidthRateLimitInterval) SetEndMinuteOfHour(v int64) *BandwidthRateLimitInterval

SetEndMinuteOfHour sets the EndMinuteOfHour field's value.

func (*BandwidthRateLimitInterval) SetStartHourOfDay added in v1.35.24 

func (s *BandwidthRateLimitInterval) SetStartHourOfDay(v int64) *BandwidthRateLimitInterval

SetStartHourOfDay sets the StartHourOfDay field's value.

func (*BandwidthRateLimitInterval) SetStartMinuteOfHour added in v1.35.24 

func (s *BandwidthRateLimitInterval) SetStartMinuteOfHour(v int64) *BandwidthRateLimitInterval

SetStartMinuteOfHour sets the StartMinuteOfHour field's value.

func (BandwidthRateLimitInterval) String added in v1.35.24 

func (s BandwidthRateLimitInterval) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BandwidthRateLimitInterval) Validate added in v1.35.24 

func (s *BandwidthRateLimitInterval) Validate() error

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

type CacheAttributes added in v1.33.3 

type CacheAttributes struct {

	// Refreshes a file share's cache by using Time To Live (TTL). TTL is the length
	// of time since the last refresh after which access to the directory would
	// cause the file gateway to first refresh that directory's contents from the
	// Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
	//
	// Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
	CacheStaleTimeoutInSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The refresh cache information for the file share or FSx file systems.

func (CacheAttributes) GoString added in v1.33.3 

func (s CacheAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheAttributes) SetCacheStaleTimeoutInSeconds added in v1.33.3 

func (s *CacheAttributes) SetCacheStaleTimeoutInSeconds(v int64) *CacheAttributes

SetCacheStaleTimeoutInSeconds sets the CacheStaleTimeoutInSeconds field's value.

func (CacheAttributes) String added in v1.33.3 

func (s CacheAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CachediSCSIVolume 

type CachediSCSIVolume struct {

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" 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 name of the iSCSI target used by an initiator to connect to a volume
	// and used 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 on a gateway.
	//
	// If you don't specify a value, Storage Gateway uses the value that was previously
	// used for this volume as the new target name.
	TargetName *string `min:"1" type:"string"`

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

	// A value that indicates whether a storage volume is attached to or detached
	// from a gateway. For more information, see Moving your volumes to a different
	// gateway (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume).
	VolumeAttachmentStatus *string `min:"3" 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 calculated
	// based on the number of blocks that are touched, instead of the actual amount
	// of data written. This value can be useful for sequential write patterns but
	// less accurate for random write patterns. VolumeUsedInBytes is different from
	// the compressed size of the volume, which is the value that is used to calculate
	// your bill.
	//
	// This value is not available for volumes created prior to May 13, 2015, until
	// you store data on the volume.
	//
	// If you use a delete tool that overwrites the data on your volume with random
	// data, your usage will not be reduced. This is because the random data is
	// not compressible. If you want to reduce the amount of billed storage on your
	// volume, we recommend overwriting your files with zeros to compress the data
	// to a negligible amount of actual storage.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetTargetName added in v1.16.19 

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

SetTargetName sets the TargetName 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) SetVolumeAttachmentStatus added in v1.16.19 

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

SetVolumeAttachmentStatus sets the VolumeAttachmentStatus 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChapInfo's
	// String and GoString methods.
	SecretToAuthenticateInitiator *string `min:"1" type:"string" sensitive:"true"`

	// The secret key that the target must provide to participate in mutual CHAP
	// with the initiator (e.g., Windows client).
	//
	// SecretToAuthenticateTarget is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ChapInfo's
	// String and GoString methods.
	SecretToAuthenticateTarget *string `min:"1" type:"string" sensitive:"true"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCachediSCSIVolumeInput 

type CreateCachediSCSIVolumeInput 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.
	//
	// 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

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

	// The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the
	// new cached 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html)
	// in the Amazon Elastic Compute Cloud API Reference.
	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"`

	// A list of up to 50 tags that you can assign to a cached volume. Each tag
	// is a key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers that
	// you can represent in UTF-8 format, and the following special characters:
	// + - = . _ : / @. The maximum length of a tag's key is 128 characters, and
	// the maximum length for a tag's value is 256 characters.
	Tags []*Tag `type:"list"`

	// The name of the iSCSI target used by an initiator to connect to a volume
	// and used 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 on a gateway.
	//
	// If you don't specify a value, Storage Gateway uses the value that was previously
	// used for this volume as the new target name.
	//
	// TargetName is a required field
	TargetName *string `min:"1" type:"string" required:"true"`

	// The size of the volume in bytes.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetTags added in v1.19.12 

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

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// The Amazon Resource Name (ARN) of the volume target, which 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"`
	// contains filtered or unexported fields
}

func (CreateCachediSCSIVolumeOutput) GoString added in v0.6.5 

func (s CreateCachediSCSIVolumeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateNFSFileShareInput added in v1.6.6 

type CreateNFSFileShareInput struct {

	// The Amazon Resource Name (ARN) of the storage used for audit logs.
	AuditDestinationARN *string `type:"string"`

	// Specifies the Region of the S3 bucket where the NFS file share stores files.
	//
	// This parameter is required for NFS file shares that connect to Amazon S3
	// through a VPC endpoint, a VPC access point, or an access point alias that
	// points to a VPC access point.
	BucketRegion *string `min:"1" type:"string"`

	// Specifies refresh cache information for the file share.
	CacheAttributes *CacheAttributes `type:"structure"`

	// The list of clients that are allowed to access the S3 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 S3 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 the
	// S3 File Gateway. The default value is S3_STANDARD. Optional.
	//
	// Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
	DefaultStorageClass *string `min:"5" type:"string"`

	// The name of the file share. Optional.
	//
	// FileShareName must be set if an S3 prefix name is set in LocationARN, or
	// if an access point or access point alias is used.
	FileShareName *string `min:"1" type:"string"`

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

	// A value that enables guessing of the MIME type for uploaded objects based
	// on file extensions. Set this value to true to enable MIME type guessing,
	// otherwise set to false. The default value is true.
	//
	// Valid Values: true | false
	GuessMIMETypeEnabled *bool `type:"boolean"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// A custom ARN for the backend storage used for storing data for file shares.
	// It includes a resource ARN with an optional prefix concatenation. The prefix
	// must end with a forward slash (/).
	//
	// You can specify LocationARN as a bucket ARN, access point ARN or access point
	// alias, as shown in the following examples.
	//
	// Bucket ARN:
	//
	// arn:aws:s3:::my-bucket/prefix/
	//
	// Access point ARN:
	//
	// arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
	//
	// If you specify an access point, the bucket policy must be configured to delegate
	// access control to the access point. For information, see Delegating access
	// control to access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control)
	// in the Amazon S3 User Guide.
	//
	// Access point alias:
	//
	// test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
	//
	// LocationARN is a required field
	LocationARN *string `min:"16" type:"string" required:"true"`

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

	// The notification policy of the file share. SettlingTimeInSeconds controls
	// the number of seconds to wait after the last point in time a client wrote
	// to a file before generating an ObjectUploaded notification. Because clients
	// can make many small writes to files, it's best to set this parameter for
	// as long as possible to avoid generating multiple notifications for the same
	// file in a small time period.
	//
	// SettlingTimeInSeconds has no effect on the timing of the object uploading
	// to Amazon S3, only the timing of the notification.
	//
	// The following example sets NotificationPolicy on with SettlingTimeInSeconds
	// set to 60.
	//
	// {\"Upload\": {\"SettlingTimeInSeconds\": 60}}
	//
	// The following example sets NotificationPolicy off.
	//
	// {}
	NotificationPolicy *string `min:"2" type:"string"`

	// A value that sets the access control list (ACL) permission for objects in
	// the S3 bucket that a S3 File Gateway puts objects into. The default value
	// is private.
	ObjectACL *string `type:"string" enum:"ObjectACL"`

	// A value that sets the write status of a file share. Set this value to true
	// to set the write status to read-only, otherwise set to false.
	//
	// Valid Values: true | false
	ReadOnly *bool `type:"boolean"`

	// A value that sets who pays the cost of the request and the cost associated
	// with data download from the S3 bucket. If this value is set to true, the
	// requester pays the costs; otherwise, the S3 bucket owner pays. However, the
	// S3 bucket owner always pays the cost of storing data.
	//
	// RequesterPays is a configuration for the S3 bucket that backs the file share,
	// so make sure that the configuration on the file share is the same as the
	// S3 bucket configuration.
	//
	// Valid Values: true | false
	RequesterPays *bool `type:"boolean"`

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

	// A value that maps a user to anonymous user.
	//
	// Valid values 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"`

	// A list of up to 50 tags that can be assigned to the NFS file share. Each
	// tag is a key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	Tags []*Tag `type:"list"`

	// Specifies the DNS name for the VPC endpoint that the NFS file share uses
	// to connect to Amazon S3.
	//
	// This parameter is required for NFS file shares that connect to Amazon S3
	// through a VPC endpoint, a VPC access point, or an access point alias that
	// points to a VPC access point.
	VPCEndpointDNSName *string `min:"1" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNFSFileShareInput) SetAuditDestinationARN added in v1.41.2 

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

SetAuditDestinationARN sets the AuditDestinationARN field's value.

func (*CreateNFSFileShareInput) SetBucketRegion added in v1.39.2 

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

SetBucketRegion sets the BucketRegion field's value.

func (*CreateNFSFileShareInput) SetCacheAttributes added in v1.33.3 

func (s *CreateNFSFileShareInput) SetCacheAttributes(v *CacheAttributes) *CreateNFSFileShareInput

SetCacheAttributes sets the CacheAttributes field's value.

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) SetFileShareName added in v1.33.3 

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

SetFileShareName sets the FileShareName 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) SetNotificationPolicy added in v1.35.18 

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

SetNotificationPolicy sets the NotificationPolicy 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) SetTags added in v1.17.11 

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

SetTags sets the Tags field's value.

func (*CreateNFSFileShareInput) SetVPCEndpointDNSName added in v1.39.2 

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

SetVPCEndpointDNSName sets the VPCEndpointDNSName field's value.

func (CreateNFSFileShareInput) String added in v1.6.6 

func (s CreateNFSFileShareInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSMBFileShareInput added in v1.14.16 

type CreateSMBFileShareInput struct {

	// The files and folders on this share will only be visible to users with read
	// access.
	AccessBasedEnumeration *bool `type:"boolean"`

	// A list of users or groups in the Active Directory that will be granted administrator
	// privileges on the file share. These users can do all file operations as the
	// super-user. Acceptable formats include: DOMAIN\User1, user1, @group1, and
	// @DOMAIN\group1.
	//
	// Use this option very carefully, because any user in this list can do anything
	// they like on the file share, regardless of file permissions.
	AdminUserList []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the storage used for audit logs.
	AuditDestinationARN *string `type:"string"`

	// The authentication method that users use to access the file share. The default
	// is ActiveDirectory.
	//
	// Valid Values: ActiveDirectory | GuestAccess
	Authentication *string `min:"5" type:"string"`

	// Specifies the Region of the S3 bucket where the SMB file share stores files.
	//
	// This parameter is required for SMB file shares that connect to Amazon S3
	// through a VPC endpoint, a VPC access point, or an access point alias that
	// points to a VPC access point.
	BucketRegion *string `min:"1" type:"string"`

	// Specifies refresh cache information for the file share.
	CacheAttributes *CacheAttributes `type:"structure"`

	// The case of an object name in an Amazon S3 bucket. For ClientSpecified, the
	// client determines the case sensitivity. For CaseSensitive, the gateway determines
	// the case sensitivity. The default value is ClientSpecified.
	CaseSensitivity *string `type:"string" enum:"CaseSensitivity"`

	// A unique string value that you supply that is used by S3 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 the
	// S3 File Gateway. The default value is S3_STANDARD. Optional.
	//
	// Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
	DefaultStorageClass *string `min:"5" type:"string"`

	// The name of the file share. Optional.
	//
	// FileShareName must be set if an S3 prefix name is set in LocationARN, or
	// if an access point or access point alias is used.
	FileShareName *string `min:"1" type:"string"`

	// The ARN of the S3 File Gateway on which you want to create a file share.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// A value that enables guessing of the MIME type for uploaded objects based
	// on file extensions. Set this value to true to enable MIME type guessing,
	// otherwise set to false. The default value is true.
	//
	// Valid Values: true | false
	GuessMIMETypeEnabled *bool `type:"boolean"`

	// A list of users or groups in the Active Directory that are not allowed to
	// access the file share. A group must be prefixed with the @ character. Acceptable
	// formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only
	// be set if Authentication is set to ActiveDirectory.
	InvalidUserList []*string `type:"list"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// A custom ARN for the backend storage used for storing data for file shares.
	// It includes a resource ARN with an optional prefix concatenation. The prefix
	// must end with a forward slash (/).
	//
	// You can specify LocationARN as a bucket ARN, access point ARN or access point
	// alias, as shown in the following examples.
	//
	// Bucket ARN:
	//
	// arn:aws:s3:::my-bucket/prefix/
	//
	// Access point ARN:
	//
	// arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
	//
	// If you specify an access point, the bucket policy must be configured to delegate
	// access control to the access point. For information, see Delegating access
	// control to access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control)
	// in the Amazon S3 User Guide.
	//
	// Access point alias:
	//
	// test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
	//
	// LocationARN is a required field
	LocationARN *string `min:"16" type:"string" required:"true"`

	// The notification policy of the file share. SettlingTimeInSeconds controls
	// the number of seconds to wait after the last point in time a client wrote
	// to a file before generating an ObjectUploaded notification. Because clients
	// can make many small writes to files, it's best to set this parameter for
	// as long as possible to avoid generating multiple notifications for the same
	// file in a small time period.
	//
	// SettlingTimeInSeconds has no effect on the timing of the object uploading
	// to Amazon S3, only the timing of the notification.
	//
	// The following example sets NotificationPolicy on with SettlingTimeInSeconds
	// set to 60.
	//
	// {\"Upload\": {\"SettlingTimeInSeconds\": 60}}
	//
	// The following example sets NotificationPolicy off.
	//
	// {}
	NotificationPolicy *string `min:"2" type:"string"`

	// A value that sets the access control list (ACL) permission for objects in
	// the S3 bucket that a S3 File Gateway puts objects into. The default value
	// is private.
	ObjectACL *string `type:"string" enum:"ObjectACL"`

	// Specifies whether opportunistic locking is enabled for the SMB file share.
	//
	// Enabling opportunistic locking on case-sensitive shares is not recommended
	// for workloads that involve access to files with the same name in different
	// case.
	//
	// Valid Values: true | false
	OplocksEnabled *bool `type:"boolean"`

	// A value that sets the write status of a file share. Set this value to true
	// to set the write status to read-only, otherwise set to false.
	//
	// Valid Values: true | false
	ReadOnly *bool `type:"boolean"`

	// A value that sets who pays the cost of the request and the cost associated
	// with data download from the S3 bucket. If this value is set to true, the
	// requester pays the costs; otherwise, the S3 bucket owner pays. However, the
	// S3 bucket owner always pays the cost of storing data.
	//
	// RequesterPays is a configuration for the S3 bucket that backs the file share,
	// so make sure that the configuration on the file share is the same as the
	// S3 bucket configuration.
	//
	// Valid Values: true | false
	RequesterPays *bool `type:"boolean"`

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

	// Set this value to true to enable access control list (ACL) on the SMB file
	// share. Set it to false to map file and directory permissions to the POSIX
	// permissions.
	//
	// For more information, see Using Microsoft Windows ACLs to control access
	// to an SMB file share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html)
	// in the Storage Gateway User Guide.
	//
	// Valid Values: true | false
	SMBACLEnabled *bool `type:"boolean"`

	// A list of up to 50 tags that can be assigned to the NFS file share. Each
	// tag is a key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	Tags []*Tag `type:"list"`

	// Specifies the DNS name for the VPC endpoint that the SMB file share uses
	// to connect to Amazon S3.
	//
	// This parameter is required for SMB file shares that connect to Amazon S3
	// through a VPC endpoint, a VPC access point, or an access point alias that
	// points to a VPC access point.
	VPCEndpointDNSName *string `min:"1" type:"string"`

	// A list of users or groups in the Active Directory that are allowed to access
	// the file share. A group must be prefixed with the @ character. Acceptable
	// formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only
	// be set if Authentication is set to ActiveDirectory.
	ValidUserList []*string `type:"list"`
	// contains filtered or unexported fields
}

CreateSMBFileShareInput

func (CreateSMBFileShareInput) GoString added in v1.14.16 

func (s CreateSMBFileShareInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSMBFileShareInput) SetAccessBasedEnumeration added in v1.35.18 

func (s *CreateSMBFileShareInput) SetAccessBasedEnumeration(v bool) *CreateSMBFileShareInput

SetAccessBasedEnumeration sets the AccessBasedEnumeration field's value.

func (*CreateSMBFileShareInput) SetAdminUserList added in v1.19.26 

func (s *CreateSMBFileShareInput) SetAdminUserList(v []*string) *CreateSMBFileShareInput

SetAdminUserList sets the AdminUserList field's value.

func (*CreateSMBFileShareInput) SetAuditDestinationARN added in v1.30.1 

func (s *CreateSMBFileShareInput) SetAuditDestinationARN(v string) *CreateSMBFileShareInput

SetAuditDestinationARN sets the AuditDestinationARN field's value.

func (*CreateSMBFileShareInput) SetAuthentication added in v1.14.16 

func (s *CreateSMBFileShareInput) SetAuthentication(v string) *CreateSMBFileShareInput

SetAuthentication sets the Authentication field's value.

func (*CreateSMBFileShareInput) SetBucketRegion added in v1.39.2 

func (s *CreateSMBFileShareInput) SetBucketRegion(v string) *CreateSMBFileShareInput

SetBucketRegion sets the BucketRegion field's value.

func (*CreateSMBFileShareInput) SetCacheAttributes added in v1.33.3 

func (s *CreateSMBFileShareInput) SetCacheAttributes(v *CacheAttributes) *CreateSMBFileShareInput

SetCacheAttributes sets the CacheAttributes field's value.

func (*CreateSMBFileShareInput) SetCaseSensitivity added in v1.33.3 

func (s *CreateSMBFileShareInput) SetCaseSensitivity(v string) *CreateSMBFileShareInput

SetCaseSensitivity sets the CaseSensitivity field's value.

func (*CreateSMBFileShareInput) SetClientToken added in v1.14.16 

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

SetClientToken sets the ClientToken field's value.

func (*CreateSMBFileShareInput) SetDefaultStorageClass added in v1.14.16 

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

SetDefaultStorageClass sets the DefaultStorageClass field's value.

func (*CreateSMBFileShareInput) SetFileShareName added in v1.33.3 

func (s *CreateSMBFileShareInput) SetFileShareName(v string) *CreateSMBFileShareInput

SetFileShareName sets the FileShareName field's value.

func (*CreateSMBFileShareInput) SetGatewayARN added in v1.14.16 

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

SetGatewayARN sets the GatewayARN field's value.

func (*CreateSMBFileShareInput) SetGuessMIMETypeEnabled added in v1.14.16 

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

SetGuessMIMETypeEnabled sets the GuessMIMETypeEnabled field's value.

func (*CreateSMBFileShareInput) SetInvalidUserList added in v1.14.16 

func (s *CreateSMBFileShareInput) SetInvalidUserList(v []*string) *CreateSMBFileShareInput

SetInvalidUserList sets the InvalidUserList field's value.

func (*CreateSMBFileShareInput) SetKMSEncrypted added in v1.14.16 

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

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*CreateSMBFileShareInput) SetKMSKey added in v1.14.16 

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

SetKMSKey sets the KMSKey field's value.

func (*CreateSMBFileShareInput) SetLocationARN added in v1.14.16 

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

SetLocationARN sets the LocationARN field's value.

func (*CreateSMBFileShareInput) SetNotificationPolicy added in v1.35.18 

func (s *CreateSMBFileShareInput) SetNotificationPolicy(v string) *CreateSMBFileShareInput

SetNotificationPolicy sets the NotificationPolicy field's value.

func (*CreateSMBFileShareInput) SetObjectACL added in v1.14.16 

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

SetObjectACL sets the ObjectACL field's value.

func (*CreateSMBFileShareInput) SetOplocksEnabled added in v1.39.2 

func (s *CreateSMBFileShareInput) SetOplocksEnabled(v bool) *CreateSMBFileShareInput

SetOplocksEnabled sets the OplocksEnabled field's value.

func (*CreateSMBFileShareInput) SetReadOnly added in v1.14.16 

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

SetReadOnly sets the ReadOnly field's value.

func (*CreateSMBFileShareInput) SetRequesterPays added in v1.14.16 

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

SetRequesterPays sets the RequesterPays field's value.

func (*CreateSMBFileShareInput) SetRole added in v1.14.16 

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

SetRole sets the Role field's value.

func (*CreateSMBFileShareInput) SetSMBACLEnabled added in v1.19.16 

func (s *CreateSMBFileShareInput) SetSMBACLEnabled(v bool) *CreateSMBFileShareInput

SetSMBACLEnabled sets the SMBACLEnabled field's value.

func (*CreateSMBFileShareInput) SetTags added in v1.17.11 

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

SetTags sets the Tags field's value.

func (*CreateSMBFileShareInput) SetVPCEndpointDNSName added in v1.39.2 

func (s *CreateSMBFileShareInput) SetVPCEndpointDNSName(v string) *CreateSMBFileShareInput

SetVPCEndpointDNSName sets the VPCEndpointDNSName field's value.

func (*CreateSMBFileShareInput) SetValidUserList added in v1.14.16 

func (s *CreateSMBFileShareInput) SetValidUserList(v []*string) *CreateSMBFileShareInput

SetValidUserList sets the ValidUserList field's value.

func (CreateSMBFileShareInput) String added in v1.14.16 

func (s CreateSMBFileShareInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSMBFileShareInput) Validate added in v1.14.16 

func (s *CreateSMBFileShareInput) Validate() error

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

type CreateSMBFileShareOutput added in v1.14.16 

type CreateSMBFileShareOutput struct {

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

CreateSMBFileShareOutput

func (CreateSMBFileShareOutput) GoString added in v1.14.16 

func (s CreateSMBFileShareOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSMBFileShareOutput) SetFileShareARN added in v1.14.16 

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

SetFileShareARN sets the FileShareARN field's value.

func (CreateSMBFileShareOutput) String added in v1.14.16 

func (s CreateSMBFileShareOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSnapshotFromVolumeRecoveryPointInput 

type CreateSnapshotFromVolumeRecoveryPointInput 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
	// Storage Gateway snapshot Details pane, Description field.
	//
	// SnapshotDescription is a required field
	SnapshotDescription *string `min:"1" type:"string" required:"true"`

	// A list of up to 50 tags that can be assigned to a snapshot. Each tag is a
	// key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	Tags []*Tag `type:"list"`

	// The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
	// operation to return to retrieve the TargetARN for specified VolumeARN.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSnapshotFromVolumeRecoveryPointInput) SetSnapshotDescription added in v1.5.0 

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

SetSnapshotDescription sets the SnapshotDescription field's value.

func (*CreateSnapshotFromVolumeRecoveryPointInput) SetTags added in v1.23.2 

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

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// The ID of the snapshot.
	SnapshotId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
	// operation to return to retrieve the TargetARN for specified VolumeARN.
	VolumeARN *string `min:"50" type:"string"`

	// The time the volume was created from the recovery point.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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
	// Storage Gateway snapshot Details pane, Description field.
	//
	// SnapshotDescription is a required field
	SnapshotDescription *string `min:"1" type:"string" required:"true"`

	// A list of up to 50 tags that can be assigned to a snapshot. Each tag is a
	// key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	Tags []*Tag `type:"list"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSnapshotInput) SetSnapshotDescription added in v1.5.0 

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

SetSnapshotDescription sets the SnapshotDescription field's value.

func (*CreateSnapshotInput) SetTags added in v1.19.30 

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

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStorediSCSIVolumeInput 

type CreateStorediSCSIVolumeInput struct {

	// The unique identifier for the gateway local disk that is configured as a
	// stored volume. Use ListLocalDisks (https://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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

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

	// Set to true if you want to preserve the data on the local disk. Otherwise,
	// set to false to create 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html)
	// in the Amazon Elastic Compute Cloud API Reference.
	SnapshotId *string `type:"string"`

	// A list of up to 50 tags that can be assigned to a stored volume. Each tag
	// is a key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	Tags []*Tag `type:"list"`

	// The name of the iSCSI target used by an initiator to connect to a volume
	// and used 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 on a gateway.
	//
	// If you don't specify a value, Storage Gateway uses the value that was previously
	// used for this volume as the new target name.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetKMSEncrypted added in v1.15.3 

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

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*CreateStorediSCSIVolumeInput) SetKMSKey added in v1.15.3 

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

SetKMSKey sets the KMSKey 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) SetTags added in v1.19.12 

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

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// The Amazon Resource Name (ARN) of the volume target, which 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTapePoolInput added in v1.34.8 

type CreateTapePoolInput struct {

	// The name of the new custom tape pool.
	//
	// PoolName is a required field
	PoolName *string `min:"1" type:"string" required:"true"`

	// Tape retention lock time is set in days. Tape retention lock can be enabled
	// for up to 100 years (36,500 days).
	RetentionLockTimeInDays *int64 `type:"integer"`

	// Tape retention lock can be configured in two modes. When configured in governance
	// mode, Amazon Web Services accounts with specific IAM permissions are authorized
	// to remove the tape retention lock from archived virtual tapes. When configured
	// in compliance mode, the tape retention lock cannot be removed by any user,
	// including the root Amazon Web Services account.
	RetentionLockType *string `type:"string" enum:"RetentionLockType"`

	// The storage class that is associated with the new custom pool. When you use
	// your backup application to eject the tape, the tape is archived directly
	// into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds
	// to the pool.
	//
	// StorageClass is a required field
	StorageClass *string `type:"string" required:"true" enum:"TapeStorageClass"`

	// A list of up to 50 tags that can be assigned to tape pool. Each tag is a
	// key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateTapePoolInput) GoString added in v1.34.8 

func (s CreateTapePoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTapePoolInput) SetPoolName added in v1.34.8 

func (s *CreateTapePoolInput) SetPoolName(v string) *CreateTapePoolInput

SetPoolName sets the PoolName field's value.

func (*CreateTapePoolInput) SetRetentionLockTimeInDays added in v1.34.8 

func (s *CreateTapePoolInput) SetRetentionLockTimeInDays(v int64) *CreateTapePoolInput

SetRetentionLockTimeInDays sets the RetentionLockTimeInDays field's value.

func (*CreateTapePoolInput) SetRetentionLockType added in v1.34.8 

func (s *CreateTapePoolInput) SetRetentionLockType(v string) *CreateTapePoolInput

SetRetentionLockType sets the RetentionLockType field's value.

func (*CreateTapePoolInput) SetStorageClass added in v1.34.8 

func (s *CreateTapePoolInput) SetStorageClass(v string) *CreateTapePoolInput

SetStorageClass sets the StorageClass field's value.

func (*CreateTapePoolInput) SetTags added in v1.34.8 

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

SetTags sets the Tags field's value.

func (CreateTapePoolInput) String added in v1.34.8 

func (s CreateTapePoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTapePoolInput) Validate added in v1.34.8 

func (s *CreateTapePoolInput) Validate() error

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

type CreateTapePoolOutput added in v1.34.8 

type CreateTapePoolOutput struct {

	// The unique Amazon Resource Name (ARN) that represents the custom tape pool.
	// Use the ListTapePools operation to return a list of tape pools for your account
	// and Amazon Web Services Region.
	PoolARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (CreateTapePoolOutput) GoString added in v1.34.8 

func (s CreateTapePoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTapePoolOutput) SetPoolARN added in v1.34.8 

func (s *CreateTapePoolOutput) SetPoolARN(v string) *CreateTapePoolOutput

SetPoolARN sets the PoolARN field's value.

func (CreateTapePoolOutput) String added in v1.34.8 

func (s CreateTapePoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// The ID of the pool that you want to add your tape to for archiving. The tape
	// in this pool is archived in the S3 storage class that is associated with
	// the pool. When you use your backup application to eject the tape, the tape
	// is archived directly into the storage class (S3 Glacier or S3 Deep Archive)
	// that corresponds to the pool.
	PoolId *string `min:"1" type:"string"`

	// A list of up to 50 tags that can be assigned to a virtual tape that has a
	// barcode. Each tag is a key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	Tags []*Tag `type:"list"`

	// 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:"5" 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 bytes).
	//
	// TapeSizeInBytes is a required field
	TapeSizeInBytes *int64 `type:"long" required:"true"`

	// Set to TRUE if the tape you are creating is to be configured as a write-once-read-many
	// (WORM) tape.
	Worm *bool `type:"boolean"`
	// contains filtered or unexported fields
}

CreateTapeWithBarcodeInput

func (CreateTapeWithBarcodeInput) GoString added in v1.1.4 

func (s CreateTapeWithBarcodeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetPoolId added in v1.19.3 

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

SetPoolId sets the PoolId field's value.

func (*CreateTapeWithBarcodeInput) SetTags added in v1.19.12 

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

SetTags sets the Tags 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) SetWorm added in v1.34.8 

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

SetWorm sets the Worm field's value.

func (CreateTapeWithBarcodeInput) String added in v1.1.4 

func (s CreateTapeWithBarcodeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" 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"`

	// The ID of the pool that you want to add your tape to for archiving. The tape
	// in this pool is archived in the S3 storage class that is associated with
	// the pool. When you use your backup application to eject the tape, the tape
	// is archived directly into the storage class (S3 Glacier or S3 Glacier Deep
	// Archive) that corresponds to the pool.
	PoolId *string `min:"1" type:"string"`

	// A list of up to 50 tags that can be assigned to a virtual tape. Each tag
	// is a key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	Tags []*Tag `type:"list"`

	// 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-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 bytes).
	//
	// TapeSizeInBytes is a required field
	TapeSizeInBytes *int64 `type:"long" required:"true"`

	// Set to TRUE if the tape you are creating is to be configured as a write-once-read-many
	// (WORM) tape.
	Worm *bool `type:"boolean"`
	// contains filtered or unexported fields
}

CreateTapesInput

func (CreateTapesInput) GoString added in v0.6.5 

func (s CreateTapesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetPoolId added in v1.19.3 

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

SetPoolId sets the PoolId field's value.

func (*CreateTapesInput) SetTags added in v1.19.12 

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

SetTags sets the Tags 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) SetWorm added in v1.34.8 

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

SetWorm sets the Worm field's value.

func (CreateTapesInput) String added in v0.6.5 

func (s CreateTapesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAutomaticTapeCreationPolicyInput added in v1.30.13 

type DeleteAutomaticTapeCreationPolicyInput struct {

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

func (DeleteAutomaticTapeCreationPolicyInput) GoString added in v1.30.13 

func (s DeleteAutomaticTapeCreationPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAutomaticTapeCreationPolicyInput) SetGatewayARN added in v1.30.13 

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

SetGatewayARN sets the GatewayARN field's value.

func (DeleteAutomaticTapeCreationPolicyInput) String added in v1.30.13 

func (s DeleteAutomaticTapeCreationPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAutomaticTapeCreationPolicyInput) Validate added in v1.30.13 

func (s *DeleteAutomaticTapeCreationPolicyInput) Validate() error

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

type DeleteAutomaticTapeCreationPolicyOutput added in v1.30.13 

type DeleteAutomaticTapeCreationPolicyOutput struct {

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

func (DeleteAutomaticTapeCreationPolicyOutput) GoString added in v1.30.13 

func (s DeleteAutomaticTapeCreationPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAutomaticTapeCreationPolicyOutput) SetGatewayARN added in v1.30.13 

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

SetGatewayARN sets the GatewayARN field's value.

func (DeleteAutomaticTapeCreationPolicyOutput) String added in v1.30.13 

func (s DeleteAutomaticTapeCreationPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services. Otherwise, the file share
	// is not deleted until all data is uploaded to Amazon Web Services. This process
	// aborts the data upload process, and the file share enters the FORCE_DELETING
	// status.
	//
	// Valid Values: true | false
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSnapshotScheduleInput 

type DeleteSnapshotScheduleInput struct {

	// The volume which snapshot schedule to delete.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// The volume which snapshot schedule was deleted.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTapeArchiveInput 

type DeleteTapeArchiveInput struct {

	// Set to TRUE to delete an archived tape that belongs to a custom pool with
	// tape retention lock. Only archived tapes with tape retention lock set to
	// governance can be deleted. Archived tapes with tape retention lock set to
	// compliance can't be deleted.
	BypassGovernanceRetention *bool `type:"boolean"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTapeArchiveInput) SetBypassGovernanceRetention added in v1.34.8 

func (s *DeleteTapeArchiveInput) SetBypassGovernanceRetention(v bool) *DeleteTapeArchiveInput

SetBypassGovernanceRetention sets the BypassGovernanceRetention field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTapeInput 

type DeleteTapeInput struct {

	// Set to TRUE to delete an archived tape that belongs to a custom pool with
	// tape retention lock. Only archived tapes with tape retention lock set to
	// governance can be deleted. Archived tapes with tape retention lock set to
	// compliance can't be deleted.
	BypassGovernanceRetention *bool `type:"boolean"`

	// 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTapeInput) SetBypassGovernanceRetention added in v1.34.8 

func (s *DeleteTapeInput) SetBypassGovernanceRetention(v bool) *DeleteTapeInput

SetBypassGovernanceRetention sets the BypassGovernanceRetention field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTapePoolInput added in v1.34.8 

type DeleteTapePoolInput struct {

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

func (DeleteTapePoolInput) GoString added in v1.34.8 

func (s DeleteTapePoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTapePoolInput) SetPoolARN added in v1.34.8 

func (s *DeleteTapePoolInput) SetPoolARN(v string) *DeleteTapePoolInput

SetPoolARN sets the PoolARN field's value.

func (DeleteTapePoolInput) String added in v1.34.8 

func (s DeleteTapePoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTapePoolInput) Validate added in v1.34.8 

func (s *DeleteTapePoolInput) Validate() error

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

type DeleteTapePoolOutput added in v1.34.8 

type DeleteTapePoolOutput struct {

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

func (DeleteTapePoolOutput) GoString added in v1.34.8 

func (s DeleteTapePoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTapePoolOutput) SetPoolARN added in v1.34.8 

func (s *DeleteTapePoolOutput) SetPoolARN(v string) *DeleteTapePoolOutput

SetPoolARN sets the PoolARN field's value.

func (DeleteTapePoolOutput) String added in v1.34.8 

func (s DeleteTapePoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Resource Name (ARN) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAvailabilityMonitorTestInput added in v1.25.39 

type DescribeAvailabilityMonitorTestInput struct {

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

func (DescribeAvailabilityMonitorTestInput) GoString added in v1.25.39 

func (s DescribeAvailabilityMonitorTestInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAvailabilityMonitorTestInput) SetGatewayARN added in v1.25.39 

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

SetGatewayARN sets the GatewayARN field's value.

func (DescribeAvailabilityMonitorTestInput) String added in v1.25.39 

func (s DescribeAvailabilityMonitorTestInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAvailabilityMonitorTestInput) Validate added in v1.25.39 

func (s *DescribeAvailabilityMonitorTestInput) Validate() error

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

type DescribeAvailabilityMonitorTestOutput added in v1.25.39 

type DescribeAvailabilityMonitorTestOutput struct {

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

	// The time the high availability monitoring test was started. If a test hasn't
	// been performed, the value of this field is null.
	StartTime *time.Time `type:"timestamp"`

	// The status of the high availability monitoring test. If a test hasn't been
	// performed, the value of this field is null.
	Status *string `type:"string" enum:"AvailabilityMonitorTestStatus"`
	// contains filtered or unexported fields
}

func (DescribeAvailabilityMonitorTestOutput) GoString added in v1.25.39 

func (s DescribeAvailabilityMonitorTestOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAvailabilityMonitorTestOutput) SetGatewayARN added in v1.25.39 

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

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeAvailabilityMonitorTestOutput) SetStartTime added in v1.25.39 

func (s *DescribeAvailabilityMonitorTestOutput) SetStartTime(v time.Time) *DescribeAvailabilityMonitorTestOutput

SetStartTime sets the StartTime field's value.

func (*DescribeAvailabilityMonitorTestOutput) SetStatus added in v1.25.39 

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

SetStatus sets the Status field's value.

func (DescribeAvailabilityMonitorTestOutput) String added in v1.25.39 

func (s DescribeAvailabilityMonitorTestOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

func (DescribeBandwidthRateLimitInput) GoString added in v0.6.5 

func (s DescribeBandwidthRateLimitInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBandwidthRateLimitScheduleInput added in v1.35.24 

type DescribeBandwidthRateLimitScheduleInput struct {

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

func (DescribeBandwidthRateLimitScheduleInput) GoString added in v1.35.24 

func (s DescribeBandwidthRateLimitScheduleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBandwidthRateLimitScheduleInput) SetGatewayARN added in v1.35.24 

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

SetGatewayARN sets the GatewayARN field's value.

func (DescribeBandwidthRateLimitScheduleInput) String added in v1.35.24 

func (s DescribeBandwidthRateLimitScheduleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBandwidthRateLimitScheduleInput) Validate added in v1.35.24 

func (s *DescribeBandwidthRateLimitScheduleInput) Validate() error

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

type DescribeBandwidthRateLimitScheduleOutput added in v1.35.24 

type DescribeBandwidthRateLimitScheduleOutput struct {

	// An array that contains the bandwidth rate limit intervals for a tape or volume
	// gateway.
	BandwidthRateLimitIntervals []*BandwidthRateLimitInterval `type:"list"`

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

func (DescribeBandwidthRateLimitScheduleOutput) GoString added in v1.35.24 

func (s DescribeBandwidthRateLimitScheduleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBandwidthRateLimitScheduleOutput) SetBandwidthRateLimitIntervals added in v1.35.24 

func (s *DescribeBandwidthRateLimitScheduleOutput) SetBandwidthRateLimitIntervals(v []*BandwidthRateLimitInterval) *DescribeBandwidthRateLimitScheduleOutput

SetBandwidthRateLimitIntervals sets the BandwidthRateLimitIntervals field's value.

func (*DescribeBandwidthRateLimitScheduleOutput) SetGatewayARN added in v1.35.24 

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

SetGatewayARN sets the GatewayARN field's value.

func (DescribeBandwidthRateLimitScheduleOutput) String added in v1.35.24 

func (s DescribeBandwidthRateLimitScheduleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// The amount of cache in bytes allocated to a gateway.
	CacheAllocatedInBytes *int64 `type:"long"`

	// The file share's contribution to the overall percentage of the gateway's
	// cache that has not been persisted to Amazon Web Services. The sample is taken
	// at the end of the reporting period.
	CacheDirtyPercentage *float64 `type:"double"`

	// Percent of application read operations from the file shares that are served
	// from cache. The sample is taken at the end of the reporting period.
	CacheHitPercentage *float64 `type:"double"`

	// Percent of application read operations from the file shares that are not
	// served from cache. The sample is taken at the end of the reporting period.
	CacheMissPercentage *float64 `type:"double"`

	// Percent use of the gateway's cache storage. This metric applies only to the
	// gateway-cached volume setup. The sample is taken at the end of the reporting
	// period.
	CacheUsedPercentage *float64 `type:"double"`

	// An array of strings that identify disks that are to be configured as working
	// storage. Each string has a minimum length of 1 and maximum length of 300.
	// You can get the disk IDs from the ListLocalDisks API.
	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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCachediSCSIVolumesInput 

type DescribeCachediSCSIVolumesInput struct {

	// An array of strings where each string represents the Amazon Resource Name
	// (ARN) of a cached volume. All of the specified cached volumes must be 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
}

func (DescribeCachediSCSIVolumesInput) GoString added in v0.6.5 

func (s DescribeCachediSCSIVolumesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 the following fields:

func (DescribeChapCredentialsOutput) GoString added in v0.6.5 

func (s DescribeChapCredentialsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFileSystemAssociationsInput added in v1.38.15 

type DescribeFileSystemAssociationsInput struct {

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

func (DescribeFileSystemAssociationsInput) GoString added in v1.38.15 

func (s DescribeFileSystemAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemAssociationsInput) SetFileSystemAssociationARNList added in v1.38.15 

func (s *DescribeFileSystemAssociationsInput) SetFileSystemAssociationARNList(v []*string) *DescribeFileSystemAssociationsInput

SetFileSystemAssociationARNList sets the FileSystemAssociationARNList field's value.

func (DescribeFileSystemAssociationsInput) String added in v1.38.15 

func (s DescribeFileSystemAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemAssociationsInput) Validate added in v1.38.15 

func (s *DescribeFileSystemAssociationsInput) Validate() error

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

type DescribeFileSystemAssociationsOutput added in v1.38.15 

type DescribeFileSystemAssociationsOutput struct {

	// An array containing the FileSystemAssociationInfo data type of each file
	// system association to be described.
	FileSystemAssociationInfoList []*FileSystemAssociationInfo `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeFileSystemAssociationsOutput) GoString added in v1.38.15 

func (s DescribeFileSystemAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemAssociationsOutput) SetFileSystemAssociationInfoList added in v1.38.15 

func (s *DescribeFileSystemAssociationsOutput) SetFileSystemAssociationInfoList(v []*FileSystemAssociationInfo) *DescribeFileSystemAssociationsOutput

SetFileSystemAssociationInfoList sets the FileSystemAssociationInfoList field's value.

func (DescribeFileSystemAssociationsOutput) String added in v1.38.15 

func (s DescribeFileSystemAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon CloudWatch log group that is
	// used to monitor events in the gateway. This field only only exist and returns
	// once it have been chosen and set by the SGW service, based on the OS version
	// of the gateway VM
	CloudWatchLogGroupARN *string `type:"string"`

	// Date after which this gateway will not receive software updates for new features
	// and bug fixes.
	DeprecationDate *string `min:"1" type:"string"`

	// The ID of the Amazon EC2 instance that was used to launch the gateway.
	Ec2InstanceId *string `type:"string"`

	// The Amazon Web Services Region where the Amazon EC2 instance is located.
	Ec2InstanceRegion *string `type:"string"`

	// The type of endpoint for your gateway.
	//
	// Valid Values: STANDARD | FIPS
	EndpointType *string `min:"4" type:"string"`

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

	// Specifies the size of the gateway's metadata cache.
	GatewayCapacity *string `type:"string" enum:"GatewayCapacity"`

	// 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 type of hardware or software platform on which the gateway is running.
	HostEnvironment *string `type:"string" enum:"HostEnvironment"`

	// A unique identifier for the specific instance of the host platform running
	// the gateway. This value is only available for certain host environments,
	// and its format depends on the host environment type.
	HostEnvironmentId *string `min:"1" 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. This only only exist and returns once it have been chosen and
	// set by the SGW service, based on the OS version of the gateway VM
	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"`

	// Date after which this gateway will not receive software updates for new features.
	SoftwareUpdatesEndDate *string `min:"1" type:"string"`

	// The version number of the software running on the gateway appliance.
	SoftwareVersion *string `type:"string"`

	// A list of the metadata cache sizes that the gateway can support based on
	// its current hardware specifications.
	SupportedGatewayCapacities []*string `type:"list" enum:"GatewayCapacity"`

	// A list of up to 50 tags assigned to the gateway, sorted alphabetically by
	// key name. Each tag is a key-value pair. For a gateway with more than 10 tags
	// assigned, you can view all tags using the ListTagsForResource API operation.
	Tags []*Tag `type:"list"`

	// The configuration settings for the virtual private cloud (VPC) endpoint for
	// your gateway.
	VPCEndpoint *string `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGatewayInformationOutput) SetCloudWatchLogGroupARN added in v1.23.19 

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

SetCloudWatchLogGroupARN sets the CloudWatchLogGroupARN field's value.

func (*DescribeGatewayInformationOutput) SetDeprecationDate added in v1.33.17 

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

SetDeprecationDate sets the DeprecationDate field's value.

func (*DescribeGatewayInformationOutput) SetEc2InstanceId added in v1.19.12 

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

SetEc2InstanceId sets the Ec2InstanceId field's value.

func (*DescribeGatewayInformationOutput) SetEc2InstanceRegion added in v1.19.12 

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

SetEc2InstanceRegion sets the Ec2InstanceRegion field's value.

func (*DescribeGatewayInformationOutput) SetEndpointType added in v1.32.1 

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

SetEndpointType sets the EndpointType field's value.

func (*DescribeGatewayInformationOutput) SetGatewayARN added in v1.5.0 

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

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeGatewayInformationOutput) SetGatewayCapacity added in v1.39.2 

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

SetGatewayCapacity sets the GatewayCapacity 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) SetHostEnvironment added in v1.25.39 

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

SetHostEnvironment sets the HostEnvironment field's value.

func (*DescribeGatewayInformationOutput) SetHostEnvironmentId added in v1.42.16 

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

SetHostEnvironmentId sets the HostEnvironmentId 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) SetSoftwareUpdatesEndDate added in v1.33.17 

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

SetSoftwareUpdatesEndDate sets the SoftwareUpdatesEndDate field's value.

func (*DescribeGatewayInformationOutput) SetSoftwareVersion added in v1.45.23 

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

SetSoftwareVersion sets the SoftwareVersion field's value.

func (*DescribeGatewayInformationOutput) SetSupportedGatewayCapacities added in v1.39.2 

func (s *DescribeGatewayInformationOutput) SetSupportedGatewayCapacities(v []*string) *DescribeGatewayInformationOutput

SetSupportedGatewayCapacities sets the SupportedGatewayCapacities field's value.

func (*DescribeGatewayInformationOutput) SetTags added in v1.17.11 

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

SetTags sets the Tags field's value.

func (*DescribeGatewayInformationOutput) SetVPCEndpoint added in v1.19.43 

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

SetVPCEndpoint sets the VPCEndpoint field's value.

func (DescribeGatewayInformationOutput) String added in v0.6.5 

func (s DescribeGatewayInformationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

func (DescribeMaintenanceStartTimeInput) GoString added in v0.6.5 

func (s DescribeMaintenanceStartTimeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// The day of the month component of the maintenance start time represented
	// as an ordinal number from 1 to 28, where 1 represents the first day of the
	// month and 28 represents the last day of the month.
	DayOfMonth *int64 `min:"1" type:"integer"`

	// 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 Amazon Web Services 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"`

	// A value that indicates the time zone that is set for the gateway. The start
	// time and day of week specified should be in the time zone of the gateway.
	Timezone *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

  • DescribeMaintenanceStartTimeOutput$DayOfMonth

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMaintenanceStartTimeOutput) SetDayOfMonth added in v1.19.12 

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

SetDayOfMonth sets the DayOfMonth field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSMBFileSharesInput added in v1.14.16 

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

DescribeSMBFileSharesInput

func (DescribeSMBFileSharesInput) GoString added in v1.14.16 

func (s DescribeSMBFileSharesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSMBFileSharesInput) SetFileShareARNList added in v1.14.16 

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

SetFileShareARNList sets the FileShareARNList field's value.

func (DescribeSMBFileSharesInput) String added in v1.14.16 

func (s DescribeSMBFileSharesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSMBFileSharesInput) Validate added in v1.14.16 

func (s *DescribeSMBFileSharesInput) Validate() error

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

type DescribeSMBFileSharesOutput added in v1.14.16 

type DescribeSMBFileSharesOutput struct {

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

DescribeSMBFileSharesOutput

func (DescribeSMBFileSharesOutput) GoString added in v1.14.16 

func (s DescribeSMBFileSharesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSMBFileSharesOutput) SetSMBFileShareInfoList added in v1.14.16 

func (s *DescribeSMBFileSharesOutput) SetSMBFileShareInfoList(v []*SMBFileShareInfo) *DescribeSMBFileSharesOutput

SetSMBFileShareInfoList sets the SMBFileShareInfoList field's value.

func (DescribeSMBFileSharesOutput) String added in v1.14.16 

func (s DescribeSMBFileSharesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSMBSettingsInput added in v1.14.16 

type DescribeSMBSettingsInput struct {

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

func (DescribeSMBSettingsInput) GoString added in v1.14.16 

func (s DescribeSMBSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSMBSettingsInput) SetGatewayARN added in v1.14.16 

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

SetGatewayARN sets the GatewayARN field's value.

func (DescribeSMBSettingsInput) String added in v1.14.16 

func (s DescribeSMBSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSMBSettingsInput) Validate added in v1.14.16 

func (s *DescribeSMBSettingsInput) Validate() error

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

type DescribeSMBSettingsOutput added in v1.14.16 

type DescribeSMBSettingsOutput struct {

	// Indicates the status of a gateway that is a member of the Active Directory
	// domain.
	//
	//    * ACCESS_DENIED: Indicates that the JoinDomain operation failed due to
	//    an authentication error.
	//
	//    * DETACHED: Indicates that gateway is not joined to a domain.
	//
	//    * JOINED: Indicates that the gateway has successfully joined a domain.
	//
	//    * JOINING: Indicates that a JoinDomain operation is in progress.
	//
	//    * NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network
	//    or connectivity error.
	//
	//    * TIMEOUT: Indicates that the JoinDomain operation failed because the
	//    operation didn't complete within the allotted time.
	//
	//    * UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to
	//    another type of error.
	ActiveDirectoryStatus *string `type:"string" enum:"ActiveDirectoryStatus"`

	// The name of the domain that the gateway is joined to.
	DomainName *string `min:"1" type:"string"`

	// The shares on this gateway appear when listing shares. Only supported for
	// S3 File Gateways.
	FileSharesVisible *bool `type:"boolean"`

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

	// This value is true if a password for the guest user smbguest is set, otherwise
	// false. Only supported for S3 File Gateways.
	//
	// Valid Values: true | false
	SMBGuestPasswordSet *bool `type:"boolean"`

	// A list of Active Directory users and groups that have special permissions
	// for SMB file shares on the gateway.
	SMBLocalGroups *SMBLocalGroups `type:"structure"`

	// The type of security strategy that was specified for file gateway.
	//
	//    * ClientSpecified: If you use this option, requests are established based
	//    on what is negotiated by the client. This option is recommended when you
	//    want to maximize compatibility across different clients in your environment.
	//    Only supported for S3 File Gateways.
	//
	//    * MandatorySigning: If you use this option, file gateway only allows connections
	//    from SMBv2 or SMBv3 clients that have signing enabled. This option works
	//    with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
	//
	//    * MandatoryEncryption: If you use this option, file gateway only allows
	//    connections from SMBv3 clients that have encryption enabled. This option
	//    is highly recommended for environments that handle sensitive data. This
	//    option works with SMB clients on Microsoft Windows 8, Windows Server 2012
	//    or newer.
	SMBSecurityStrategy *string `type:"string" enum:"SMBSecurityStrategy"`
	// contains filtered or unexported fields
}

func (DescribeSMBSettingsOutput) GoString added in v1.14.16 

func (s DescribeSMBSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSMBSettingsOutput) SetActiveDirectoryStatus added in v1.25.39 

func (s *DescribeSMBSettingsOutput) SetActiveDirectoryStatus(v string) *DescribeSMBSettingsOutput

SetActiveDirectoryStatus sets the ActiveDirectoryStatus field's value.

func (*DescribeSMBSettingsOutput) SetDomainName added in v1.14.16 

func (s *DescribeSMBSettingsOutput) SetDomainName(v string) *DescribeSMBSettingsOutput

SetDomainName sets the DomainName field's value.

func (*DescribeSMBSettingsOutput) SetFileSharesVisible added in v1.35.18 

func (s *DescribeSMBSettingsOutput) SetFileSharesVisible(v bool) *DescribeSMBSettingsOutput

SetFileSharesVisible sets the FileSharesVisible field's value.

func (*DescribeSMBSettingsOutput) SetGatewayARN added in v1.14.16 

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

SetGatewayARN sets the GatewayARN field's value.

func (*DescribeSMBSettingsOutput) SetSMBGuestPasswordSet added in v1.14.16 

func (s *DescribeSMBSettingsOutput) SetSMBGuestPasswordSet(v bool) *DescribeSMBSettingsOutput

SetSMBGuestPasswordSet sets the SMBGuestPasswordSet field's value.

func (*DescribeSMBSettingsOutput) SetSMBLocalGroups added in v1.41.2 

func (s *DescribeSMBSettingsOutput) SetSMBLocalGroups(v *SMBLocalGroups) *DescribeSMBSettingsOutput

SetSMBLocalGroups sets the SMBLocalGroups field's value.

func (*DescribeSMBSettingsOutput) SetSMBSecurityStrategy added in v1.19.43 

func (s *DescribeSMBSettingsOutput) SetSMBSecurityStrategy(v string) *DescribeSMBSettingsOutput

SetSMBSecurityStrategy sets the SMBSecurityStrategy field's value.

func (DescribeSMBSettingsOutput) String added in v1.14.16 

func (s DescribeSMBSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// The snapshot description.
	Description *string `min:"1" type:"string"`

	// The number of hours between snapshots.
	RecurrenceInHours *int64 `min:"1" type:"integer"`

	// 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 *int64 `type:"integer"`

	// A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically
	// by key name. Each tag is a key-value pair. For a gateway with more than 10
	// tags assigned, you can view all tags using the ListTagsForResource API operation.
	Tags []*Tag `type:"list"`

	// A value that indicates the time zone of the gateway.
	Timezone *string `min:"3" type:"string"`

	// The Amazon Resource Name (ARN) of the volume that was specified in the request.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetTags added in v1.23.2 

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

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 be 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// Describes a single unit of output from DescribeStorediSCSIVolumes. The following
	// fields are returned:
	//
	//    * ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI
	//    target.
	//
	//    * LunNumber: The logical disk number.
	//
	//    * NetworkInterfaceId: The network interface ID of the stored volume that
	//    initiator use to map the stored volume as an iSCSI target.
	//
	//    * NetworkInterfacePort: The port used to communicate with iSCSI targets.
	//
	//    * PreservedExistingData: Indicates when the stored volume was created,
	//    existing data on the underlying local disk was preserved.
	//
	//    * SourceSnapshotId: If the stored volume was created from a snapshot,
	//    this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise,
	//    this field is not included.
	//
	//    * StorediSCSIVolumes: An array of StorediSCSIVolume objects where each
	//    object contains metadata about one stored volume.
	//
	//    * TargetARN: The Amazon Resource Name (ARN) of the volume target.
	//
	//    * VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
	//
	//    * VolumeDiskId: The disk ID of the local disk that was specified in the
	//    CreateStorediSCSIVolume operation.
	//
	//    * VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
	//
	//    * VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents
	//    a collection of iSCSI attributes for one stored volume.
	//
	//    * VolumeProgress: 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.
	//
	//    * VolumeSizeInBytes: The size of the volume in bytes.
	//
	//    * VolumeStatus: One of the VolumeStatus values that indicates the state
	//    of the volume.
	//
	//    * VolumeType: One of the enumeration values describing the type of the
	//    volume. Currently, only STORED volumes are supported.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTapeArchivesInput 

type DescribeTapeArchivesInput struct {

	// Specifies that the number of virtual tapes 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
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// 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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`

	// The total number of bytes allocated in the gateway's as upload buffer.
	UploadBufferAllocatedInBytes *int64 `type:"long"`

	// The total number of bytes being used in the gateway's upload buffer.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

func (DescribeWorkingStorageInput) GoString added in v0.6.5 

func (s DescribeWorkingStorageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetachVolumeInput added in v1.16.19 

type DetachVolumeInput struct {

	// Set to true to forcibly remove the iSCSI connection of the target volume
	// and detach the volume. The default is false. If this value is set to false,
	// you must manually disconnect the iSCSI connection from the target volume.
	//
	// Valid Values: true | false
	ForceDetach *bool `type:"boolean"`

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

AttachVolumeInput

func (DetachVolumeInput) GoString added in v1.16.19 

func (s DetachVolumeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachVolumeInput) SetForceDetach added in v1.16.19 

func (s *DetachVolumeInput) SetForceDetach(v bool) *DetachVolumeInput

SetForceDetach sets the ForceDetach field's value.

func (*DetachVolumeInput) SetVolumeARN added in v1.16.19 

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

SetVolumeARN sets the VolumeARN field's value.

func (DetachVolumeInput) String added in v1.16.19 

func (s DetachVolumeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachVolumeInput) Validate added in v1.16.19 

func (s *DetachVolumeInput) Validate() error

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

type DetachVolumeOutput added in v1.16.19 

type DetachVolumeOutput struct {

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

AttachVolumeOutput

func (DetachVolumeOutput) GoString added in v1.16.19 

func (s DetachVolumeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachVolumeOutput) SetVolumeARN added in v1.16.19 

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

SetVolumeARN sets the VolumeARN field's value.

func (DetachVolumeOutput) String added in v1.16.19 

func (s DetachVolumeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateFileSystemInput added in v1.38.15 

type DisassociateFileSystemInput struct {

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

	// If this value is set to true, the operation disassociates an Amazon FSx file
	// system immediately. It ends all data uploads to the file system, and the
	// file system association enters the FORCE_DELETING status. If this value is
	// set to false, the Amazon FSx file system does not disassociate until all
	// data is uploaded.
	ForceDelete *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DisassociateFileSystemInput) GoString added in v1.38.15 

func (s DisassociateFileSystemInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateFileSystemInput) SetFileSystemAssociationARN added in v1.38.15 

func (s *DisassociateFileSystemInput) SetFileSystemAssociationARN(v string) *DisassociateFileSystemInput

SetFileSystemAssociationARN sets the FileSystemAssociationARN field's value.

func (*DisassociateFileSystemInput) SetForceDelete added in v1.38.15 

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

SetForceDelete sets the ForceDelete field's value.

func (DisassociateFileSystemInput) String added in v1.38.15 

func (s DisassociateFileSystemInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateFileSystemInput) Validate added in v1.38.15 

func (s *DisassociateFileSystemInput) Validate() error

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

type DisassociateFileSystemOutput added in v1.38.15 

type DisassociateFileSystemOutput struct {

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

func (DisassociateFileSystemOutput) GoString added in v1.38.15 

func (s DisassociateFileSystemOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateFileSystemOutput) SetFileSystemAssociationARN added in v1.38.15 

func (s *DisassociateFileSystemOutput) SetFileSystemAssociationARN(v string) *DisassociateFileSystemOutput

SetFileSystemAssociationARN sets the FileSystemAssociationARN field's value.

func (DisassociateFileSystemOutput) String added in v1.38.15 

func (s DisassociateFileSystemOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Disk 

type Disk struct {

	// The iSCSI qualified name (IQN) that is defined for a disk. This field is
	// not included in the response if the local disk is not defined as an iSCSI
	// target. The format of this field is targetIqn::LUNNumber::region-volumeId.
	DiskAllocationResource *string `type:"string"`

	// One of the DiskAllocationType enumeration values that identifies how a local
	// disk is used.
	//
	// Valid Values: UPLOAD_BUFFER | CACHE_STORAGE
	DiskAllocationType *string `min:"3" type:"string"`

	// A list of values that represents attributes of a local disk.
	DiskAttributeList []*string `type:"list"`

	// The unique device ID or other distinguishing data that identifies a local
	// disk.
	DiskId *string `min:"1" type:"string"`

	// The device node of a local disk as assigned by the virtualization environment.
	DiskNode *string `type:"string"`

	// The path of a local disk in the gateway virtual machine (VM).
	DiskPath *string `type:"string"`

	// The local disk size in bytes.
	DiskSizeInBytes *int64 `type:"long"`

	// A value that represents the status of a local disk.
	DiskStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a gateway's local disk.

func (Disk) GoString added in v0.6.5 

func (s Disk) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetDiskAttributeList added in v1.15.89 

func (s *Disk) SetDiskAttributeList(v []*string) *Disk

SetDiskAttributeList sets the DiskAttributeList 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointNetworkConfiguration added in v1.39.2 

type EndpointNetworkConfiguration struct {

	// A list of gateway IP addresses on which the associated Amazon FSx file system
	// is available.
	//
	// If multiple file systems are associated with this gateway, this field is
	// required.
	IpAddresses []*string `type:"list"`
	// contains filtered or unexported fields
}

Specifies network configuration information for the gateway associated with the Amazon FSx file system.

func (EndpointNetworkConfiguration) GoString added in v1.39.2 

func (s EndpointNetworkConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointNetworkConfiguration) SetIpAddresses added in v1.39.2 

func (s *EndpointNetworkConfiguration) SetIpAddresses(v []*string) *EndpointNetworkConfiguration

SetIpAddresses sets the IpAddresses field's value.

func (EndpointNetworkConfiguration) String added in v1.39.2 

func (s EndpointNetworkConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.
	//
	// Valid Values: CREATING | UPDATING | AVAILABLE | DELETING
	FileShareStatus *string `min:"3" type:"string"`

	// The type of the file share.
	FileShareType *string `type:"string" enum:"FileShareType"`

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

Describes a file share. Only supported S3 File Gateway.

func (FileShareInfo) GoString added in v1.6.6 

func (s FileShareInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetFileShareType added in v1.14.16 

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

SetFileShareType sets the FileShareType 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemAssociationInfo added in v1.38.15 

type FileSystemAssociationInfo struct {

	// The Amazon Resource Name (ARN) of the storage used for the audit logs.
	AuditDestinationARN *string `type:"string"`

	// The refresh cache information for the file share or FSx file systems.
	CacheAttributes *CacheAttributes `type:"structure"`

	// Specifies network configuration information for the gateway associated with
	// the Amazon FSx file system.
	//
	// If multiple file systems are associated with this gateway, this parameter's
	// IpAddresses field is required.
	EndpointNetworkConfiguration *EndpointNetworkConfiguration `type:"structure"`

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

	// The status of the file system association. Valid Values: AVAILABLE | CREATING
	// | DELETING | FORCE_DELETING | UPDATING | ERROR
	FileSystemAssociationStatus *string `min:"3" type:"string"`

	// An array containing the FileSystemAssociationStatusDetail data type, which
	// provides detailed information on file system association status.
	FileSystemAssociationStatusDetails []*FileSystemAssociationStatusDetail `type:"list"`

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

	// The ARN of the backend Amazon FSx file system used for storing file data.
	// For information, see FileSystem (https://docs.aws.amazon.com/fsx/latest/APIReference/API_FileSystem.html)
	// in the Amazon FSx API Reference.
	LocationARN *string `min:"8" type:"string"`

	// A list of up to 50 tags assigned to the SMB file share, sorted alphabetically
	// by key name. Each tag is a key-value pair.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.

func (FileSystemAssociationInfo) GoString added in v1.38.15 

func (s FileSystemAssociationInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemAssociationInfo) SetAuditDestinationARN added in v1.38.15 

func (s *FileSystemAssociationInfo) SetAuditDestinationARN(v string) *FileSystemAssociationInfo

SetAuditDestinationARN sets the AuditDestinationARN field's value.

func (*FileSystemAssociationInfo) SetCacheAttributes added in v1.38.15 

func (s *FileSystemAssociationInfo) SetCacheAttributes(v *CacheAttributes) *FileSystemAssociationInfo

SetCacheAttributes sets the CacheAttributes field's value.

func (*FileSystemAssociationInfo) SetEndpointNetworkConfiguration added in v1.39.2 

func (s *FileSystemAssociationInfo) SetEndpointNetworkConfiguration(v *EndpointNetworkConfiguration) *FileSystemAssociationInfo

SetEndpointNetworkConfiguration sets the EndpointNetworkConfiguration field's value.

func (*FileSystemAssociationInfo) SetFileSystemAssociationARN added in v1.38.15 

func (s *FileSystemAssociationInfo) SetFileSystemAssociationARN(v string) *FileSystemAssociationInfo

SetFileSystemAssociationARN sets the FileSystemAssociationARN field's value.

func (*FileSystemAssociationInfo) SetFileSystemAssociationStatus added in v1.38.15 

func (s *FileSystemAssociationInfo) SetFileSystemAssociationStatus(v string) *FileSystemAssociationInfo

SetFileSystemAssociationStatus sets the FileSystemAssociationStatus field's value.

func (*FileSystemAssociationInfo) SetFileSystemAssociationStatusDetails added in v1.41.2 

func (s *FileSystemAssociationInfo) SetFileSystemAssociationStatusDetails(v []*FileSystemAssociationStatusDetail) *FileSystemAssociationInfo

SetFileSystemAssociationStatusDetails sets the FileSystemAssociationStatusDetails field's value.

func (*FileSystemAssociationInfo) SetGatewayARN added in v1.38.15 

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

SetGatewayARN sets the GatewayARN field's value.

func (*FileSystemAssociationInfo) SetLocationARN added in v1.38.15 

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

SetLocationARN sets the LocationARN field's value.

func (*FileSystemAssociationInfo) SetTags added in v1.38.15 

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

SetTags sets the Tags field's value.

func (FileSystemAssociationInfo) String added in v1.38.15 

func (s FileSystemAssociationInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemAssociationStatusDetail added in v1.41.2 

type FileSystemAssociationStatusDetail struct {

	// The error code for a given file system association status.
	ErrorCode *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information on file system association status.

func (FileSystemAssociationStatusDetail) GoString added in v1.41.2 

func (s FileSystemAssociationStatusDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemAssociationStatusDetail) SetErrorCode added in v1.41.2 

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

SetErrorCode sets the ErrorCode field's value.

func (FileSystemAssociationStatusDetail) String added in v1.41.2 

func (s FileSystemAssociationStatusDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemAssociationSummary added in v1.38.15 

type FileSystemAssociationSummary struct {

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

	// The ID of the file system association.
	FileSystemAssociationId *string `min:"10" type:"string"`

	// The status of the file share. Valid Values: AVAILABLE | CREATING | DELETING
	// | FORCE_DELETING | UPDATING | ERROR
	FileSystemAssociationStatus *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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

Gets the summary returned by ListFileSystemAssociation, which is a summary of a created file system association.

func (FileSystemAssociationSummary) GoString added in v1.38.15 

func (s FileSystemAssociationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemAssociationSummary) SetFileSystemAssociationARN added in v1.38.15 

func (s *FileSystemAssociationSummary) SetFileSystemAssociationARN(v string) *FileSystemAssociationSummary

SetFileSystemAssociationARN sets the FileSystemAssociationARN field's value.

func (*FileSystemAssociationSummary) SetFileSystemAssociationId added in v1.38.15 

func (s *FileSystemAssociationSummary) SetFileSystemAssociationId(v string) *FileSystemAssociationSummary

SetFileSystemAssociationId sets the FileSystemAssociationId field's value.

func (*FileSystemAssociationSummary) SetFileSystemAssociationStatus added in v1.38.15 

func (s *FileSystemAssociationSummary) SetFileSystemAssociationStatus(v string) *FileSystemAssociationSummary

SetFileSystemAssociationStatus sets the FileSystemAssociationStatus field's value.

func (*FileSystemAssociationSummary) SetGatewayARN added in v1.38.15 

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

SetGatewayARN sets the GatewayARN field's value.

func (FileSystemAssociationSummary) String added in v1.38.15 

func (s FileSystemAssociationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GatewayInfo 

type GatewayInfo struct {

	// Date after which this gateway will not receive software updates for new features
	// and bug fixes.
	DeprecationDate *string `min:"1" type:"string"`

	// The ID of the Amazon EC2 instance that was used to launch the gateway.
	Ec2InstanceId *string `type:"string"`

	// The Amazon Web Services Region where the Amazon EC2 instance is located.
	Ec2InstanceRegion *string `type:"string"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and Amazon Web Services 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 | ACTIVE
	GatewayOperationalState *string `min:"2" type:"string"`

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

	// The type of hardware or software platform on which the gateway is running.
	HostEnvironment *string `type:"string" enum:"HostEnvironment"`

	// A unique identifier for the specific instance of the host platform running
	// the gateway. This value is only available for certain host environments,
	// and its format depends on the host environment type.
	HostEnvironmentId *string `min:"1" type:"string"`

	// The version number of the software running on the gateway appliance.
	SoftwareVersion *string `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GatewayInfo) SetDeprecationDate added in v1.50.3 

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

SetDeprecationDate sets the DeprecationDate field's value.

func (*GatewayInfo) SetEc2InstanceId added in v1.19.12 

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

SetEc2InstanceId sets the Ec2InstanceId field's value.

func (*GatewayInfo) SetEc2InstanceRegion added in v1.19.12 

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

SetEc2InstanceRegion sets the Ec2InstanceRegion field's value.

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) SetHostEnvironment added in v1.42.16 

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

SetHostEnvironment sets the HostEnvironment field's value.

func (*GatewayInfo) SetHostEnvironmentId added in v1.42.16 

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

SetHostEnvironmentId sets the HostEnvironmentId field's value.

func (*GatewayInfo) SetSoftwareVersion added in v1.50.3 

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

SetSoftwareVersion sets the SoftwareVersion field's value.

func (GatewayInfo) String added in v0.6.5 

func (s GatewayInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerError added in v1.28.0 

type InternalServerError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A StorageGatewayError that provides more information about the cause of the
	// error.
	Error_ *Error `locationName:"error" type:"structure"`

	// A human-readable message describing the error that occurred.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InternalServerError) Code added in v1.28.0 

func (s *InternalServerError) Code() string

Code returns the exception type name.

func (*InternalServerError) Error added in v1.28.0 

func (s *InternalServerError) Error() string

func (InternalServerError) GoString added in v1.28.0 

func (s InternalServerError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerError) Message added in v1.28.0 

func (s *InternalServerError) Message() string

Message returns the exception's message.

func (*InternalServerError) OrigErr added in v1.28.0 

func (s *InternalServerError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerError) RequestID added in v1.28.0 

func (s *InternalServerError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerError) StatusCode added in v1.28.0 

func (s *InternalServerError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerError) String added in v1.28.0 

func (s InternalServerError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidGatewayRequestException added in v1.28.0 

type InvalidGatewayRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A StorageGatewayError that provides more detail about the cause of the error.
	Error_ *Error `locationName:"error" type:"structure"`

	// A human-readable message describing the error that occurred.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidGatewayRequestException) Code added in v1.28.0 

func (s *InvalidGatewayRequestException) Code() string

Code returns the exception type name.

func (*InvalidGatewayRequestException) Error added in v1.28.0 

func (s *InvalidGatewayRequestException) Error() string

func (InvalidGatewayRequestException) GoString added in v1.28.0 

func (s InvalidGatewayRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidGatewayRequestException) Message added in v1.28.0 

func (s *InvalidGatewayRequestException) Message() string

Message returns the exception's message.

func (*InvalidGatewayRequestException) OrigErr added in v1.28.0 

func (s *InvalidGatewayRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidGatewayRequestException) RequestID added in v1.28.0 

func (s *InvalidGatewayRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidGatewayRequestException) StatusCode added in v1.28.0 

func (s *InvalidGatewayRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidGatewayRequestException) String added in v1.28.0 

func (s InvalidGatewayRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JoinDomainInput added in v1.14.16 

type JoinDomainInput struct {

	// List of IPv4 addresses, NetBIOS names, or host names of your domain server.
	// If you need to specify the port number include it after the colon (“:”).
	// For example, mydc.mydomain.com:389.
	DomainControllers []*string `type:"list"`

	// The name of the domain that you want the gateway to join.
	//
	// DomainName is a required field
	DomainName *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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The organizational unit (OU) is a container in an Active Directory that can
	// hold users, groups, computers, and other OUs and this parameter specifies
	// the OU that the gateway will join within the AD domain.
	OrganizationalUnit *string `min:"1" type:"string"`

	// Sets the password of the user who has permission to add the gateway to the
	// Active Directory domain.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by JoinDomainInput's
	// String and GoString methods.
	//
	// Password is a required field
	Password *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Specifies the time in seconds, in which the JoinDomain operation must complete.
	// The default is 20 seconds.
	TimeoutInSeconds *int64 `type:"integer"`

	// Sets the user name of user who has permission to add the gateway to the Active
	// Directory domain. The domain user account should be enabled to join computers
	// to the domain. For example, you can use the domain administrator account
	// or an account with delegated permissions to join computers to the domain.
	//
	// UserName is a required field
	UserName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

JoinDomainInput

func (JoinDomainInput) GoString added in v1.14.16 

func (s JoinDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JoinDomainInput) SetDomainControllers added in v1.16.19 

func (s *JoinDomainInput) SetDomainControllers(v []*string) *JoinDomainInput

SetDomainControllers sets the DomainControllers field's value.

func (*JoinDomainInput) SetDomainName added in v1.14.16 

func (s *JoinDomainInput) SetDomainName(v string) *JoinDomainInput

SetDomainName sets the DomainName field's value.

func (*JoinDomainInput) SetGatewayARN added in v1.14.16 

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

SetGatewayARN sets the GatewayARN field's value.

func (*JoinDomainInput) SetOrganizationalUnit added in v1.16.19 

func (s *JoinDomainInput) SetOrganizationalUnit(v string) *JoinDomainInput

SetOrganizationalUnit sets the OrganizationalUnit field's value.

func (*JoinDomainInput) SetPassword added in v1.14.16 

func (s *JoinDomainInput) SetPassword(v string) *JoinDomainInput

SetPassword sets the Password field's value.

func (*JoinDomainInput) SetTimeoutInSeconds added in v1.25.39 

func (s *JoinDomainInput) SetTimeoutInSeconds(v int64) *JoinDomainInput

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (*JoinDomainInput) SetUserName added in v1.14.16 

func (s *JoinDomainInput) SetUserName(v string) *JoinDomainInput

SetUserName sets the UserName field's value.

func (JoinDomainInput) String added in v1.14.16 

func (s JoinDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JoinDomainInput) Validate added in v1.14.16 

func (s *JoinDomainInput) Validate() error

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

type JoinDomainOutput added in v1.14.16 

type JoinDomainOutput struct {

	// Indicates the status of the gateway as a member of the Active Directory domain.
	//
	//    * ACCESS_DENIED: Indicates that the JoinDomain operation failed due to
	//    an authentication error.
	//
	//    * DETACHED: Indicates that gateway is not joined to a domain.
	//
	//    * JOINED: Indicates that the gateway has successfully joined a domain.
	//
	//    * JOINING: Indicates that a JoinDomain operation is in progress.
	//
	//    * NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network
	//    or connectivity error.
	//
	//    * TIMEOUT: Indicates that the JoinDomain operation failed because the
	//    operation didn't complete within the allotted time.
	//
	//    * UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to
	//    another type of error.
	ActiveDirectoryStatus *string `type:"string" enum:"ActiveDirectoryStatus"`

	// The unique Amazon Resource Name (ARN) of the gateway that joined the domain.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

JoinDomainOutput

func (JoinDomainOutput) GoString added in v1.14.16 

func (s JoinDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JoinDomainOutput) SetActiveDirectoryStatus added in v1.25.39 

func (s *JoinDomainOutput) SetActiveDirectoryStatus(v string) *JoinDomainOutput

SetActiveDirectoryStatus sets the ActiveDirectoryStatus field's value.

func (*JoinDomainOutput) SetGatewayARN added in v1.14.16 

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

SetGatewayARN sets the GatewayARN field's value.

func (JoinDomainOutput) String added in v1.14.16 

func (s JoinDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAutomaticTapeCreationPoliciesInput added in v1.30.13 

type ListAutomaticTapeCreationPoliciesInput struct {

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

func (ListAutomaticTapeCreationPoliciesInput) GoString added in v1.30.13 

func (s ListAutomaticTapeCreationPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAutomaticTapeCreationPoliciesInput) SetGatewayARN added in v1.30.13 

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

SetGatewayARN sets the GatewayARN field's value.

func (ListAutomaticTapeCreationPoliciesInput) String added in v1.30.13 

func (s ListAutomaticTapeCreationPoliciesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAutomaticTapeCreationPoliciesInput) Validate added in v1.30.13 

func (s *ListAutomaticTapeCreationPoliciesInput) Validate() error

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

type ListAutomaticTapeCreationPoliciesOutput added in v1.30.13 

type ListAutomaticTapeCreationPoliciesOutput struct {

	// Gets a listing of information about the gateway's automatic tape creation
	// policies, including the automatic tape creation rules and the gateway that
	// is using the policies.
	AutomaticTapeCreationPolicyInfos []*AutomaticTapeCreationPolicyInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListAutomaticTapeCreationPoliciesOutput) GoString added in v1.30.13 

func (s ListAutomaticTapeCreationPoliciesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAutomaticTapeCreationPoliciesOutput) SetAutomaticTapeCreationPolicyInfos added in v1.30.13 

func (s *ListAutomaticTapeCreationPoliciesOutput) SetAutomaticTapeCreationPolicyInfos(v []*AutomaticTapeCreationPolicyInfo) *ListAutomaticTapeCreationPoliciesOutput

SetAutomaticTapeCreationPolicyInfos sets the AutomaticTapeCreationPolicyInfos field's value.

func (ListAutomaticTapeCreationPoliciesOutput) String added in v1.30.13 

func (s ListAutomaticTapeCreationPoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFileSystemAssociationsInput added in v1.38.15 

type ListFileSystemAssociationsInput struct {

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

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

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

func (ListFileSystemAssociationsInput) GoString added in v1.38.15 

func (s ListFileSystemAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFileSystemAssociationsInput) SetGatewayARN added in v1.38.15 

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

SetGatewayARN sets the GatewayARN field's value.

func (*ListFileSystemAssociationsInput) SetLimit added in v1.38.15 

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

SetLimit sets the Limit field's value.

func (*ListFileSystemAssociationsInput) SetMarker added in v1.38.15 

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

SetMarker sets the Marker field's value.

func (ListFileSystemAssociationsInput) String added in v1.38.15 

func (s ListFileSystemAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFileSystemAssociationsInput) Validate added in v1.38.15 

func (s *ListFileSystemAssociationsInput) Validate() error

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

type ListFileSystemAssociationsOutput added in v1.38.15 

type ListFileSystemAssociationsOutput struct {

	// An array of information about the Amazon FSx gateway's file system associations.
	FileSystemAssociationSummaryList []*FileSystemAssociationSummary `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 system associations to return.
	// In a subsequent request, use NextMarker as the value for Marker to retrieve
	// the next set of file system associations.
	NextMarker *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFileSystemAssociationsOutput) GoString added in v1.38.15 

func (s ListFileSystemAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFileSystemAssociationsOutput) SetFileSystemAssociationSummaryList added in v1.38.15 

func (s *ListFileSystemAssociationsOutput) SetFileSystemAssociationSummaryList(v []*FileSystemAssociationSummary) *ListFileSystemAssociationsOutput

SetFileSystemAssociationSummaryList sets the FileSystemAssociationSummaryList field's value.

func (*ListFileSystemAssociationsOutput) SetMarker added in v1.38.15 

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

SetMarker sets the Marker field's value.

func (*ListFileSystemAssociationsOutput) SetNextMarker added in v1.38.15 

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

SetNextMarker sets the NextMarker field's value.

func (ListFileSystemAssociationsOutput) String added in v1.38.15 

func (s ListFileSystemAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// An array of GatewayInfo objects.
	Gateways []*GatewayInfo `type:"list"`

	// Use the marker in your next request to fetch the next set of gateways in
	// the list. If there are no more gateways to list, this field does not appear
	// in the response.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

func (ListLocalDisksInput) GoString added in v0.6.5 

func (s ListLocalDisksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

	// A JSON object containing the following fields:
	//
	//    * ListLocalDisksOutput$Disks
	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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTapePoolsInput added in v1.34.8 

type ListTapePoolsInput struct {

	// An optional number limit for the tape pools 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 tape pools.
	Marker *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of each of the custom tape pools you want
	// to list. If you don't specify a custom tape pool ARN, the response lists
	// all custom tape pools.
	PoolARNs []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListTapePoolsInput) GoString added in v1.34.8 

func (s ListTapePoolsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTapePoolsInput) SetLimit added in v1.34.8 

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

SetLimit sets the Limit field's value.

func (*ListTapePoolsInput) SetMarker added in v1.34.8 

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

SetMarker sets the Marker field's value.

func (*ListTapePoolsInput) SetPoolARNs added in v1.34.8 

func (s *ListTapePoolsInput) SetPoolARNs(v []*string) *ListTapePoolsInput

SetPoolARNs sets the PoolARNs field's value.

func (ListTapePoolsInput) String added in v1.34.8 

func (s ListTapePoolsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTapePoolsInput) Validate added in v1.34.8 

func (s *ListTapePoolsInput) Validate() error

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

type ListTapePoolsOutput added in v1.34.8 

type ListTapePoolsOutput struct {

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

	// An array of PoolInfo objects, where each object describes a single custom
	// tape pool. If there are no custom tape pools, the PoolInfos is an empty array.
	PoolInfos []*PoolInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListTapePoolsOutput) GoString added in v1.34.8 

func (s ListTapePoolsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTapePoolsOutput) SetMarker added in v1.34.8 

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

SetMarker sets the Marker field's value.

func (*ListTapePoolsOutput) SetPoolInfos added in v1.34.8 

func (s *ListTapePoolsOutput) SetPoolInfos(v []*PoolInfo) *ListTapePoolsOutput

SetPoolInfos sets the PoolInfos field's value.

func (ListTapePoolsOutput) String added in v1.34.8 

func (s ListTapePoolsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 a single tape.
	// If there are no 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`

	// An array of VolumeRecoveryPointInfo objects.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`

	// Use the marker in your next request to continue pagination of iSCSI volumes.
	// If there are no more volumes to list, this field does not appear in the response
	// body.
	Marker *string `min:"1" type:"string"`

	// An array of VolumeInfo objects, where each object describes an iSCSI volume.
	// If no volumes are defined for the gateway, then VolumeInfos is an empty array
	// "[]".
	VolumeInfos []*VolumeInfo `type:"list"`
	// contains filtered or unexported fields
}

A JSON object containing the following fields:

  • ListVolumesOutput$Marker

  • ListVolumesOutput$VolumeInfos

func (ListVolumesOutput) GoString added in v0.6.5 

func (s ListVolumesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Network File System (NFS) 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 for S3 File Gateways.

func (NFSFileShareDefaults) GoString added in v1.6.6 

func (s NFSFileShareDefaults) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Resource Name (ARN) of the storage used for audit logs.
	AuditDestinationARN *string `type:"string"`

	// Specifies the Region of the S3 bucket where the NFS file share stores files.
	//
	// This parameter is required for NFS file shares that connect to Amazon S3
	// through a VPC endpoint, a VPC access point, or an access point alias that
	// points to a VPC access point.
	BucketRegion *string `min:"1" type:"string"`

	// Refresh cache information for the file share.
	CacheAttributes *CacheAttributes `type:"structure"`

	// The list of clients that are allowed to access the S3 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 the
	// S3 File Gateway. The default value is S3_STANDARD. Optional.
	//
	// Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
	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 name of the file share. Optional.
	//
	// FileShareName must be set if an S3 prefix name is set in LocationARN, or
	// if an access point or access point alias is used.
	FileShareName *string `min:"1" type:"string"`

	// The status of the file share.
	//
	// Valid Values: CREATING | UPDATING | AVAILABLE | 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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`

	// A value that enables guessing of the MIME type for uploaded objects based
	// on file extensions. Set this value to true to enable MIME type guessing,
	// otherwise set to false. The default value is true.
	//
	// Valid Values: true | false
	GuessMIMETypeEnabled *bool `type:"boolean"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// A custom ARN for the backend storage used for storing data for file shares.
	// It includes a resource ARN with an optional prefix concatenation. The prefix
	// must end with a forward slash (/).
	//
	// You can specify LocationARN as a bucket ARN, access point ARN or access point
	// alias, as shown in the following examples.
	//
	// Bucket ARN:
	//
	// arn:aws:s3:::my-bucket/prefix/
	//
	// Access point ARN:
	//
	// arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
	//
	// If you specify an access point, the bucket policy must be configured to delegate
	// access control to the access point. For information, see Delegating access
	// control to access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control)
	// in the Amazon S3 User Guide.
	//
	// Access point alias:
	//
	// test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
	LocationARN *string `min:"16" type:"string"`

	// Describes Network File System (NFS) 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 for S3 File
	// Gateways.
	NFSFileShareDefaults *NFSFileShareDefaults `type:"structure"`

	// The notification policy of the file share. SettlingTimeInSeconds controls
	// the number of seconds to wait after the last point in time a client wrote
	// to a file before generating an ObjectUploaded notification. Because clients
	// can make many small writes to files, it's best to set this parameter for
	// as long as possible to avoid generating multiple notifications for the same
	// file in a small time period.
	//
	// SettlingTimeInSeconds has no effect on the timing of the object uploading
	// to Amazon S3, only the timing of the notification.
	//
	// The following example sets NotificationPolicy on with SettlingTimeInSeconds
	// set to 60.
	//
	// {\"Upload\": {\"SettlingTimeInSeconds\": 60}}
	//
	// The following example sets NotificationPolicy off.
	//
	// {}
	NotificationPolicy *string `min:"2" type:"string"`

	// A value that sets the access control list (ACL) permission for objects in
	// the S3 bucket that an S3 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"`

	// A value that sets the write status of a file share. Set this value to true
	// to set the write status to read-only, otherwise set to false.
	//
	// Valid Values: true | false
	ReadOnly *bool `type:"boolean"`

	// A value that sets who pays the cost of the request and the cost associated
	// with data download from the S3 bucket. If this value is set to true, the
	// requester pays the costs; otherwise, the S3 bucket owner pays. However, the
	// S3 bucket owner always pays the cost of storing data.
	//
	// RequesterPays is a configuration for the S3 bucket that backs the file share,
	// so make sure that the configuration on the file share is the same as the
	// S3 bucket configuration.
	//
	// Valid Values: true | false
	RequesterPays *bool `type:"boolean"`

	// The ARN of the IAM role that an S3 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"`

	// A list of up to 50 tags assigned to the NFS file share, sorted alphabetically
	// by key name. Each tag is a key-value pair. For a gateway with more than 10
	// tags assigned, you can view all tags using the ListTagsForResource API operation.
	Tags []*Tag `type:"list"`

	// Specifies the DNS name for the VPC endpoint that the NFS file share uses
	// to connect to Amazon S3.
	//
	// This parameter is required for NFS file shares that connect to Amazon S3
	// through a VPC endpoint, a VPC access point, or an access point alias that
	// points to a VPC access point.
	VPCEndpointDNSName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (NFSFileShareInfo) GoString added in v1.6.6 

func (s NFSFileShareInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NFSFileShareInfo) SetAuditDestinationARN added in v1.41.2 

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

SetAuditDestinationARN sets the AuditDestinationARN field's value.

func (*NFSFileShareInfo) SetBucketRegion added in v1.39.2 

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

SetBucketRegion sets the BucketRegion field's value.

func (*NFSFileShareInfo) SetCacheAttributes added in v1.33.3 

func (s *NFSFileShareInfo) SetCacheAttributes(v *CacheAttributes) *NFSFileShareInfo

SetCacheAttributes sets the CacheAttributes field's value.

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) SetFileShareName added in v1.33.3 

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

SetFileShareName sets the FileShareName 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) SetNotificationPolicy added in v1.35.18 

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

SetNotificationPolicy sets the NotificationPolicy 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) SetTags added in v1.17.11 

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

SetTags sets the Tags field's value.

func (*NFSFileShareInfo) SetVPCEndpointDNSName added in v1.39.2 

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

SetVPCEndpointDNSName sets the VPCEndpointDNSName field's value.

func (NFSFileShareInfo) String added in v1.6.6 

func (s NFSFileShareInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PoolInfo added in v1.34.8 

type PoolInfo struct {

	// The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools
	// operation to return a list of custom tape pools for your account and Amazon
	// Web Services Region.
	PoolARN *string `min:"50" type:"string"`

	// The name of the custom tape pool. PoolName can use all ASCII characters,
	// except '/' and '\'.
	PoolName *string `min:"1" type:"string"`

	// Status of the custom tape pool. Pool can be ACTIVE or DELETED.
	PoolStatus *string `type:"string" enum:"PoolStatus"`

	// Tape retention lock time is set in days. Tape retention lock can be enabled
	// for up to 100 years (36,500 days).
	RetentionLockTimeInDays *int64 `type:"integer"`

	// Tape retention lock type, which can be configured in two modes. When configured
	// in governance mode, Amazon Web Services accounts with specific IAM permissions
	// are authorized to remove the tape retention lock from archived virtual tapes.
	// When configured in compliance mode, the tape retention lock cannot be removed
	// by any user, including the root Amazon Web Services account.
	RetentionLockType *string `type:"string" enum:"RetentionLockType"`

	// The storage class that is associated with the custom pool. When you use your
	// backup application to eject the tape, the tape is archived directly into
	// the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds
	// to the pool.
	StorageClass *string `type:"string" enum:"TapeStorageClass"`
	// contains filtered or unexported fields
}

Describes a custom tape pool.

func (PoolInfo) GoString added in v1.34.8 

func (s PoolInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PoolInfo) SetPoolARN added in v1.34.8 

func (s *PoolInfo) SetPoolARN(v string) *PoolInfo

SetPoolARN sets the PoolARN field's value.

func (*PoolInfo) SetPoolName added in v1.34.8 

func (s *PoolInfo) SetPoolName(v string) *PoolInfo

SetPoolName sets the PoolName field's value.

func (*PoolInfo) SetPoolStatus added in v1.34.8 

func (s *PoolInfo) SetPoolStatus(v string) *PoolInfo

SetPoolStatus sets the PoolStatus field's value.

func (*PoolInfo) SetRetentionLockTimeInDays added in v1.34.8 

func (s *PoolInfo) SetRetentionLockTimeInDays(v int64) *PoolInfo

SetRetentionLockTimeInDays sets the RetentionLockTimeInDays field's value.

func (*PoolInfo) SetRetentionLockType added in v1.34.8 

func (s *PoolInfo) SetRetentionLockType(v string) *PoolInfo

SetRetentionLockType sets the RetentionLockType field's value.

func (*PoolInfo) SetStorageClass added in v1.34.8 

func (s *PoolInfo) SetStorageClass(v string) *PoolInfo

SetStorageClass sets the StorageClass field's value.

func (PoolInfo) String added in v1.34.8 

func (s PoolInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RefreshCacheInput added in v1.8.5 

type RefreshCacheInput struct {

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

	// A comma-separated list of the paths of folders to refresh in the cache. The
	// default is ["/"]. The default refreshes objects and folders at the root of
	// the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that
	// the file share has access to is refreshed.
	FolderList []*string `min:"1" type:"list"`

	// A value that specifies whether to recursively refresh folders in the cache.
	// The refresh includes folders that were in the cache the last time the gateway
	// listed the folder's contents. If this value set to true, each folder that
	// is listed in FolderList is recursively updated. Otherwise, subfolders listed
	// in FolderList are not refreshed. Only objects that are in folders listed
	// directly under FolderList are found and used for the update. The default
	// is true.
	//
	// Valid Values: true | false
	Recursive *bool `type:"boolean"`
	// contains filtered or unexported fields
}

RefreshCacheInput

func (RefreshCacheInput) GoString added in v1.8.5 

func (s RefreshCacheInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshCacheInput) SetFileShareARN added in v1.8.5 

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

SetFileShareARN sets the FileShareARN field's value.

func (*RefreshCacheInput) SetFolderList added in v1.15.48 

func (s *RefreshCacheInput) SetFolderList(v []*string) *RefreshCacheInput

SetFolderList sets the FolderList field's value.

func (*RefreshCacheInput) SetRecursive added in v1.15.48 

func (s *RefreshCacheInput) SetRecursive(v bool) *RefreshCacheInput

SetRecursive sets the Recursive field's value.

func (RefreshCacheInput) String added in v1.8.5 

func (s RefreshCacheInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

RefreshCacheOutput

func (RefreshCacheOutput) GoString added in v1.8.5 

func (s RefreshCacheOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RefreshCacheOutput) SetFileShareARN added in v1.8.5 

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

SetFileShareARN sets the FileShareARN field's value.

func (*RefreshCacheOutput) SetNotificationId added in v1.15.48 

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

SetNotificationId sets the NotificationId field's value.

func (RefreshCacheOutput) String added in v1.8.5 

func (s RefreshCacheOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SMBFileShareInfo added in v1.14.16 

type SMBFileShareInfo struct {

	// Indicates whether AccessBasedEnumeration is enabled.
	AccessBasedEnumeration *bool `type:"boolean"`

	// A list of users or groups in the Active Directory that have administrator
	// rights to the file share. A group must be prefixed with the @ character.
	// Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1.
	// Can only be set if Authentication is set to ActiveDirectory.
	AdminUserList []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the storage used for audit logs.
	AuditDestinationARN *string `type:"string"`

	// The authentication method of the file share. The default is ActiveDirectory.
	//
	// Valid Values: ActiveDirectory | GuestAccess
	Authentication *string `min:"5" type:"string"`

	// Specifies the Region of the S3 bucket where the SMB file share stores files.
	//
	// This parameter is required for SMB file shares that connect to Amazon S3
	// through a VPC endpoint, a VPC access point, or an access point alias that
	// points to a VPC access point.
	BucketRegion *string `min:"1" type:"string"`

	// Refresh cache information for the file share.
	CacheAttributes *CacheAttributes `type:"structure"`

	// The case of an object name in an Amazon S3 bucket. For ClientSpecified, the
	// client determines the case sensitivity. For CaseSensitive, the gateway determines
	// the case sensitivity. The default value is ClientSpecified.
	CaseSensitivity *string `type:"string" enum:"CaseSensitivity"`

	// The default storage class for objects put into an Amazon S3 bucket by the
	// S3 File Gateway. The default value is S3_STANDARD. Optional.
	//
	// Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
	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 name of the file share. Optional.
	//
	// FileShareName must be set if an S3 prefix name is set in LocationARN, or
	// if an access point or access point alias is used.
	FileShareName *string `min:"1" type:"string"`

	// The status of the file share.
	//
	// Valid Values: CREATING | UPDATING | AVAILABLE | 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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`

	// A value that enables guessing of the MIME type for uploaded objects based
	// on file extensions. Set this value to true to enable MIME type guessing,
	// otherwise set to false. The default value is true.
	//
	// Valid Values: true | false
	GuessMIMETypeEnabled *bool `type:"boolean"`

	// A list of users or groups in the Active Directory that are not allowed to
	// access the file share. A group must be prefixed with the @ character. Acceptable
	// formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only
	// be set if Authentication is set to ActiveDirectory.
	InvalidUserList []*string `type:"list"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// A custom ARN for the backend storage used for storing data for file shares.
	// It includes a resource ARN with an optional prefix concatenation. The prefix
	// must end with a forward slash (/).
	//
	// You can specify LocationARN as a bucket ARN, access point ARN or access point
	// alias, as shown in the following examples.
	//
	// Bucket ARN:
	//
	// arn:aws:s3:::my-bucket/prefix/
	//
	// Access point ARN:
	//
	// arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
	//
	// If you specify an access point, the bucket policy must be configured to delegate
	// access control to the access point. For information, see Delegating access
	// control to access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control)
	// in the Amazon S3 User Guide.
	//
	// Access point alias:
	//
	// test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
	LocationARN *string `min:"16" type:"string"`

	// The notification policy of the file share. SettlingTimeInSeconds controls
	// the number of seconds to wait after the last point in time a client wrote
	// to a file before generating an ObjectUploaded notification. Because clients
	// can make many small writes to files, it's best to set this parameter for
	// as long as possible to avoid generating multiple notifications for the same
	// file in a small time period.
	//
	// SettlingTimeInSeconds has no effect on the timing of the object uploading
	// to Amazon S3, only the timing of the notification.
	//
	// The following example sets NotificationPolicy on with SettlingTimeInSeconds
	// set to 60.
	//
	// {\"Upload\": {\"SettlingTimeInSeconds\": 60}}
	//
	// The following example sets NotificationPolicy off.
	//
	// {}
	NotificationPolicy *string `min:"2" type:"string"`

	// A value that sets the access control list (ACL) permission for objects in
	// the S3 bucket that an S3 File Gateway puts objects into. The default value
	// is private.
	ObjectACL *string `type:"string" enum:"ObjectACL"`

	// Specifies whether opportunistic locking is enabled for the SMB file share.
	//
	// Enabling opportunistic locking on case-sensitive shares is not recommended
	// for workloads that involve access to files with the same name in different
	// case.
	//
	// Valid Values: true | false
	OplocksEnabled *bool `type:"boolean"`

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

	// A value that sets the write status of a file share. Set this value to true
	// to set the write status to read-only, otherwise set to false.
	//
	// Valid Values: true | false
	ReadOnly *bool `type:"boolean"`

	// A value that sets who pays the cost of the request and the cost associated
	// with data download from the S3 bucket. If this value is set to true, the
	// requester pays the costs; otherwise, the S3 bucket owner pays. However, the
	// S3 bucket owner always pays the cost of storing data.
	//
	// RequesterPays is a configuration for the S3 bucket that backs the file share,
	// so make sure that the configuration on the file share is the same as the
	// S3 bucket configuration.
	//
	// Valid Values: true | false
	RequesterPays *bool `type:"boolean"`

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

	// If this value is set to true, it indicates that access control list (ACL)
	// is enabled on the SMB file share. If it is set to false, it indicates that
	// file and directory permissions are mapped to the POSIX permission.
	//
	// For more information, see Using Microsoft Windows ACLs to control access
	// to an SMB file share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html)
	// in the Storage Gateway User Guide.
	SMBACLEnabled *bool `type:"boolean"`

	// A list of up to 50 tags assigned to the SMB file share, sorted alphabetically
	// by key name. Each tag is a key-value pair. For a gateway with more than 10
	// tags assigned, you can view all tags using the ListTagsForResource API operation.
	Tags []*Tag `type:"list"`

	// Specifies the DNS name for the VPC endpoint that the SMB file share uses
	// to connect to Amazon S3.
	//
	// This parameter is required for SMB file shares that connect to Amazon S3
	// through a VPC endpoint, a VPC access point, or an access point alias that
	// points to a VPC access point.
	VPCEndpointDNSName *string `min:"1" type:"string"`

	// A list of users or groups in the Active Directory that are allowed to access
	// the file share. A group must be prefixed with the @ character. Acceptable
	// formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only
	// be set if Authentication is set to ActiveDirectory.
	ValidUserList []*string `type:"list"`
	// contains filtered or unexported fields
}

The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.

func (SMBFileShareInfo) GoString added in v1.14.16 

func (s SMBFileShareInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SMBFileShareInfo) SetAccessBasedEnumeration added in v1.35.18 

func (s *SMBFileShareInfo) SetAccessBasedEnumeration(v bool) *SMBFileShareInfo

SetAccessBasedEnumeration sets the AccessBasedEnumeration field's value.

func (*SMBFileShareInfo) SetAdminUserList added in v1.19.26 

func (s *SMBFileShareInfo) SetAdminUserList(v []*string) *SMBFileShareInfo

SetAdminUserList sets the AdminUserList field's value.

func (*SMBFileShareInfo) SetAuditDestinationARN added in v1.30.1 

func (s *SMBFileShareInfo) SetAuditDestinationARN(v string) *SMBFileShareInfo

SetAuditDestinationARN sets the AuditDestinationARN field's value.

func (*SMBFileShareInfo) SetAuthentication added in v1.14.16 

func (s *SMBFileShareInfo) SetAuthentication(v string) *SMBFileShareInfo

SetAuthentication sets the Authentication field's value.

func (*SMBFileShareInfo) SetBucketRegion added in v1.39.2 

func (s *SMBFileShareInfo) SetBucketRegion(v string) *SMBFileShareInfo

SetBucketRegion sets the BucketRegion field's value.

func (*SMBFileShareInfo) SetCacheAttributes added in v1.33.3 

func (s *SMBFileShareInfo) SetCacheAttributes(v *CacheAttributes) *SMBFileShareInfo

SetCacheAttributes sets the CacheAttributes field's value.

func (*SMBFileShareInfo) SetCaseSensitivity added in v1.33.3 

func (s *SMBFileShareInfo) SetCaseSensitivity(v string) *SMBFileShareInfo

SetCaseSensitivity sets the CaseSensitivity field's value.

func (*SMBFileShareInfo) SetDefaultStorageClass added in v1.14.16 

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

SetDefaultStorageClass sets the DefaultStorageClass field's value.

func (*SMBFileShareInfo) SetFileShareARN added in v1.14.16 

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

SetFileShareARN sets the FileShareARN field's value.

func (*SMBFileShareInfo) SetFileShareId added in v1.14.16 

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

SetFileShareId sets the FileShareId field's value.

func (*SMBFileShareInfo) SetFileShareName added in v1.33.3 

func (s *SMBFileShareInfo) SetFileShareName(v string) *SMBFileShareInfo

SetFileShareName sets the FileShareName field's value.

func (*SMBFileShareInfo) SetFileShareStatus added in v1.14.16 

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

SetFileShareStatus sets the FileShareStatus field's value.

func (*SMBFileShareInfo) SetGatewayARN added in v1.14.16 

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

SetGatewayARN sets the GatewayARN field's value.

func (*SMBFileShareInfo) SetGuessMIMETypeEnabled added in v1.14.16 

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

SetGuessMIMETypeEnabled sets the GuessMIMETypeEnabled field's value.

func (*SMBFileShareInfo) SetInvalidUserList added in v1.14.16 

func (s *SMBFileShareInfo) SetInvalidUserList(v []*string) *SMBFileShareInfo

SetInvalidUserList sets the InvalidUserList field's value.

func (*SMBFileShareInfo) SetKMSEncrypted added in v1.14.16 

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

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*SMBFileShareInfo) SetKMSKey added in v1.14.16 

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

SetKMSKey sets the KMSKey field's value.

func (*SMBFileShareInfo) SetLocationARN added in v1.14.16 

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

SetLocationARN sets the LocationARN field's value.

func (*SMBFileShareInfo) SetNotificationPolicy added in v1.35.18 

func (s *SMBFileShareInfo) SetNotificationPolicy(v string) *SMBFileShareInfo

SetNotificationPolicy sets the NotificationPolicy field's value.

func (*SMBFileShareInfo) SetObjectACL added in v1.14.16 

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

SetObjectACL sets the ObjectACL field's value.

func (*SMBFileShareInfo) SetOplocksEnabled added in v1.39.2 

func (s *SMBFileShareInfo) SetOplocksEnabled(v bool) *SMBFileShareInfo

SetOplocksEnabled sets the OplocksEnabled field's value.

func (*SMBFileShareInfo) SetPath added in v1.14.16 

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

SetPath sets the Path field's value.

func (*SMBFileShareInfo) SetReadOnly added in v1.14.16 

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

SetReadOnly sets the ReadOnly field's value.

func (*SMBFileShareInfo) SetRequesterPays added in v1.14.16 

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

SetRequesterPays sets the RequesterPays field's value.

func (*SMBFileShareInfo) SetRole added in v1.14.16 

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

SetRole sets the Role field's value.

func (*SMBFileShareInfo) SetSMBACLEnabled added in v1.19.16 

func (s *SMBFileShareInfo) SetSMBACLEnabled(v bool) *SMBFileShareInfo

SetSMBACLEnabled sets the SMBACLEnabled field's value.

func (*SMBFileShareInfo) SetTags added in v1.17.11 

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

SetTags sets the Tags field's value.

func (*SMBFileShareInfo) SetVPCEndpointDNSName added in v1.39.2 

func (s *SMBFileShareInfo) SetVPCEndpointDNSName(v string) *SMBFileShareInfo

SetVPCEndpointDNSName sets the VPCEndpointDNSName field's value.

func (*SMBFileShareInfo) SetValidUserList added in v1.14.16 

func (s *SMBFileShareInfo) SetValidUserList(v []*string) *SMBFileShareInfo

SetValidUserList sets the ValidUserList field's value.

func (SMBFileShareInfo) String added in v1.14.16 

func (s SMBFileShareInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SMBLocalGroups added in v1.41.2 

type SMBLocalGroups struct {

	// A list of Active Directory users and groups that have local Gateway Admin
	// permissions. Acceptable formats include: DOMAIN\User1, user1, DOMAIN\group1,
	// and group1.
	//
	// Gateway Admins can use the Shared Folders Microsoft Management Console snap-in
	// to force-close files that are open and locked.
	GatewayAdmins []*string `type:"list"`
	// contains filtered or unexported fields
}

A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

func (SMBLocalGroups) GoString added in v1.41.2 

func (s SMBLocalGroups) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SMBLocalGroups) SetGatewayAdmins added in v1.41.2 

func (s *SMBLocalGroups) SetGatewayAdmins(v []*string) *SMBLocalGroups

SetGatewayAdmins sets the GatewayAdmins field's value.

func (SMBLocalGroups) String added in v1.41.2 

func (s SMBLocalGroups) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableError added in v1.28.0 

type ServiceUnavailableError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A StorageGatewayError that provides more information about the cause of the
	// error.
	Error_ *Error `locationName:"error" type:"structure"`

	// A human-readable message describing the error that occurred.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.

func (*ServiceUnavailableError) Code added in v1.28.0 

func (s *ServiceUnavailableError) Code() string

Code returns the exception type name.

func (*ServiceUnavailableError) Error added in v1.28.0 

func (s *ServiceUnavailableError) Error() string

func (ServiceUnavailableError) GoString added in v1.28.0 

func (s ServiceUnavailableError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableError) Message added in v1.28.0 

func (s *ServiceUnavailableError) Message() string

Message returns the exception's message.

func (*ServiceUnavailableError) OrigErr added in v1.28.0 

func (s *ServiceUnavailableError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableError) RequestID added in v1.28.0 

func (s *ServiceUnavailableError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableError) StatusCode added in v1.28.0 

func (s *ServiceUnavailableError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableError) String added in v1.28.0 

func (s ServiceUnavailableError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SetLocalConsolePasswordInput's
	// String and GoString methods.
	//
	// LocalConsolePassword is a required field
	LocalConsolePassword *string `min:"6" type:"string" required:"true" sensitive:"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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SetSMBGuestPasswordInput added in v1.14.16 

type SetSMBGuestPasswordInput struct {

	// The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share
	// is associated with.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`

	// The password that you want to set for your SMB server.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SetSMBGuestPasswordInput's
	// String and GoString methods.
	//
	// Password is a required field
	Password *string `min:"6" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

SetSMBGuestPasswordInput

func (SetSMBGuestPasswordInput) GoString added in v1.14.16 

func (s SetSMBGuestPasswordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetSMBGuestPasswordInput) SetGatewayARN added in v1.14.16 

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

SetGatewayARN sets the GatewayARN field's value.

func (*SetSMBGuestPasswordInput) SetPassword added in v1.14.16 

func (s *SetSMBGuestPasswordInput) SetPassword(v string) *SetSMBGuestPasswordInput

SetPassword sets the Password field's value.

func (SetSMBGuestPasswordInput) String added in v1.14.16 

func (s SetSMBGuestPasswordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetSMBGuestPasswordInput) Validate added in v1.14.16 

func (s *SetSMBGuestPasswordInput) Validate() error

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

type SetSMBGuestPasswordOutput added in v1.14.16 

type SetSMBGuestPasswordOutput struct {

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

func (SetSMBGuestPasswordOutput) GoString added in v1.14.16 

func (s SetSMBGuestPasswordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetSMBGuestPasswordOutput) SetGatewayARN added in v1.14.16 

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

SetGatewayARN sets the GatewayARN field's value.

func (SetSMBGuestPasswordOutput) String added in v1.14.16 

func (s SetSMBGuestPasswordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.

func (ShutdownGatewayInput) GoString added in v0.6.5 

func (s ShutdownGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartAvailabilityMonitorTestInput added in v1.25.39 

type StartAvailabilityMonitorTestInput struct {

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

func (StartAvailabilityMonitorTestInput) GoString added in v1.25.39 

func (s StartAvailabilityMonitorTestInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAvailabilityMonitorTestInput) SetGatewayARN added in v1.25.39 

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

SetGatewayARN sets the GatewayARN field's value.

func (StartAvailabilityMonitorTestInput) String added in v1.25.39 

func (s StartAvailabilityMonitorTestInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAvailabilityMonitorTestInput) Validate added in v1.25.39 

func (s *StartAvailabilityMonitorTestInput) Validate() error

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

type StartAvailabilityMonitorTestOutput added in v1.25.39 

type StartAvailabilityMonitorTestOutput struct {

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

func (StartAvailabilityMonitorTestOutput) GoString added in v1.25.39 

func (s StartAvailabilityMonitorTestOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAvailabilityMonitorTestOutput) SetGatewayARN added in v1.25.39 

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

SetGatewayARN sets the GatewayARN field's value.

func (StartAvailabilityMonitorTestOutput) String added in v1.25.39 

func (s StartAvailabilityMonitorTestOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.

func (StartGatewayInput) GoString added in v0.6.5 

func (s StartGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.

func (StartGatewayOutput) GoString added in v0.6.5 

func (s StartGatewayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

mySession := session.Must(session.NewSession())

// 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 Amazon Web Services Region that 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 Types:

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

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

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

See 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 How Storage Gateway works (architecture) (https://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 Types:

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

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

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

See 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 Storage Gateway resources:

  • Storage gateways of all types

  • Storage volumes

  • Virtual tapes

  • NFS and SMB file shares

  • File System associations

You can create a maximum of 50 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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) AssignTapePool added in v1.19.39 

func (c *StorageGateway) AssignTapePool(input *AssignTapePoolInput) (*AssignTapePoolOutput, error)

AssignTapePool API operation for AWS Storage Gateway.

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

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 AssignTapePool for usage and error information.

Returned Error Types:

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

  • 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/AssignTapePool

func (*StorageGateway) AssignTapePoolRequest added in v1.19.39 

func (c *StorageGateway) AssignTapePoolRequest(input *AssignTapePoolInput) (req *request.Request, output *AssignTapePoolOutput)

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

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

See AssignTapePool for more information on using the AssignTapePool 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 AssignTapePoolRequest method.
req, resp := client.AssignTapePoolRequest(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/AssignTapePool

func (*StorageGateway) AssignTapePoolWithContext added in v1.19.39 

func (c *StorageGateway) AssignTapePoolWithContext(ctx aws.Context, input *AssignTapePoolInput, opts ...request.Option) (*AssignTapePoolOutput, error)

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

See AssignTapePool 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) AssociateFileSystem added in v1.38.15 

func (c *StorageGateway) AssociateFileSystem(input *AssociateFileSystemInput) (*AssociateFileSystemOutput, error)

AssociateFileSystem API operation for AWS Storage Gateway.

Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx 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 AssociateFileSystem for usage and error information.

Returned Error Types:

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

  • 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/AssociateFileSystem

func (*StorageGateway) AssociateFileSystemRequest added in v1.38.15 

func (c *StorageGateway) AssociateFileSystemRequest(input *AssociateFileSystemInput) (req *request.Request, output *AssociateFileSystemOutput)

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

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

See AssociateFileSystem for more information on using the AssociateFileSystem 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 AssociateFileSystemRequest method.
req, resp := client.AssociateFileSystemRequest(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/AssociateFileSystem

func (*StorageGateway) AssociateFileSystemWithContext added in v1.38.15 

func (c *StorageGateway) AssociateFileSystemWithContext(ctx aws.Context, input *AssociateFileSystemInput, opts ...request.Option) (*AssociateFileSystemOutput, error)

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

See AssociateFileSystem 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) AttachVolume added in v1.16.19 

func (c *StorageGateway) AttachVolume(input *AttachVolumeInput) (*AttachVolumeOutput, error)

AttachVolume API operation for AWS Storage Gateway.

Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

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 AttachVolume for usage and error information.

Returned Error Types:

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

  • 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/AttachVolume

func (*StorageGateway) AttachVolumeRequest added in v1.16.19 

func (c *StorageGateway) AttachVolumeRequest(input *AttachVolumeInput) (req *request.Request, output *AttachVolumeOutput)

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

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

See AttachVolume for more information on using the AttachVolume 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 AttachVolumeRequest method.
req, resp := client.AttachVolumeRequest(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/AttachVolume

func (*StorageGateway) AttachVolumeWithContext added in v1.16.19 

func (c *StorageGateway) AttachVolumeWithContext(ctx aws.Context, input *AttachVolumeInput, opts ...request.Option) (*AttachVolumeOutput, error)

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

See AttachVolume 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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 Network File System (NFS) file share on an existing S3 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 an NFS interface. This operation is only supported for S3 File Gateways.

S3 File gateway requires Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the Identity and Access Management User Guide.

S3 File Gateways do 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 Types:

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

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

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

See 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) CreateSMBFileShare added in v1.14.16 

func (c *StorageGateway) CreateSMBFileShare(input *CreateSMBFileShareInput) (*CreateSMBFileShareOutput, error)

CreateSMBFileShare API operation for AWS Storage Gateway.

Creates a Server Message Block (SMB) file share on an existing S3 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 an SMB interface. This operation is only supported for S3 File Gateways.

S3 File Gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the Identity and Access Management User Guide.

File gateways don't 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 CreateSMBFileShare for usage and error information.

Returned Error Types:

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

  • 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/CreateSMBFileShare

func (*StorageGateway) CreateSMBFileShareRequest added in v1.14.16 

func (c *StorageGateway) CreateSMBFileShareRequest(input *CreateSMBFileShareInput) (req *request.Request, output *CreateSMBFileShareOutput)

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

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

See CreateSMBFileShare for more information on using the CreateSMBFileShare 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 CreateSMBFileShareRequest method.
req, resp := client.CreateSMBFileShareRequest(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/CreateSMBFileShare

func (*StorageGateway) CreateSMBFileShareWithContext added in v1.14.16 

func (c *StorageGateway) CreateSMBFileShareWithContext(ctx aws.Context, input *CreateSMBFileShareInput, opts ...request.Option) (*CreateSMBFileShareOutput, error)

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

See CreateSMBFileShare 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.

Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also 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 an ad hoc snapshot. For more information, see Editing a snapshot schedule (https://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 Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the Storage Gateway console. In response, 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) or DeleteSnapshot (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) in the Amazon Elastic Compute Cloud API Reference.

Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome (https://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 Types:

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

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

  • 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 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, see DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) or DeleteSnapshot (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) in the 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 Types:

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

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

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

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

See 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 successfully.

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

See 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 Types:

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

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

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

See 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) CreateTapePool added in v1.34.8 

func (c *StorageGateway) CreateTapePool(input *CreateTapePoolInput) (*CreateTapePoolOutput, error)

CreateTapePool API operation for AWS Storage Gateway.

Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.

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 CreateTapePool for usage and error information.

Returned Error Types:

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

  • 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/CreateTapePool

func (*StorageGateway) CreateTapePoolRequest added in v1.34.8 

func (c *StorageGateway) CreateTapePoolRequest(input *CreateTapePoolInput) (req *request.Request, output *CreateTapePoolOutput)

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

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

See CreateTapePool for more information on using the CreateTapePool 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 CreateTapePoolRequest method.
req, resp := client.CreateTapePoolRequest(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/CreateTapePool

func (*StorageGateway) CreateTapePoolWithContext added in v1.34.8 

func (c *StorageGateway) CreateTapePoolWithContext(ctx aws.Context, input *CreateTapePoolInput, opts ...request.Option) (*CreateTapePoolOutput, error)

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

See CreateTapePool 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 cannot 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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) DeleteAutomaticTapeCreationPolicy added in v1.30.13 

func (c *StorageGateway) DeleteAutomaticTapeCreationPolicy(input *DeleteAutomaticTapeCreationPolicyInput) (*DeleteAutomaticTapeCreationPolicyOutput, error)

DeleteAutomaticTapeCreationPolicy API operation for AWS Storage Gateway.

Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

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 DeleteAutomaticTapeCreationPolicy for usage and error information.

Returned Error Types:

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

  • 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/DeleteAutomaticTapeCreationPolicy

func (*StorageGateway) DeleteAutomaticTapeCreationPolicyRequest added in v1.30.13 

func (c *StorageGateway) DeleteAutomaticTapeCreationPolicyRequest(input *DeleteAutomaticTapeCreationPolicyInput) (req *request.Request, output *DeleteAutomaticTapeCreationPolicyOutput)

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

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

See DeleteAutomaticTapeCreationPolicy for more information on using the DeleteAutomaticTapeCreationPolicy 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 DeleteAutomaticTapeCreationPolicyRequest method.
req, resp := client.DeleteAutomaticTapeCreationPolicyRequest(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/DeleteAutomaticTapeCreationPolicy

func (*StorageGateway) DeleteAutomaticTapeCreationPolicyWithContext added in v1.30.13 

func (c *StorageGateway) DeleteAutomaticTapeCreationPolicyWithContext(ctx aws.Context, input *DeleteAutomaticTapeCreationPolicyInput, opts ...request.Option) (*DeleteAutomaticTapeCreationPolicyOutput, error)

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

See DeleteAutomaticTapeCreationPolicy 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. This operation is supported only for the stored volume, cached 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 DeleteBandwidthRateLimit for usage and error information.

Returned Error Types:

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

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

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

See 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. This operation is supported in 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 DeleteChapCredentials for usage and error information.

Returned Error Types:

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

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

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

See 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 an S3 File Gateway. This operation is only supported for S3 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 DeleteFileShare for usage and error information.

Returned Error Types:

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

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

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

See 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 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 Types:

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

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

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

See 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 Backing up your volumes (https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html). In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) in the 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 Types:

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

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

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

See 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 Types:

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

  • 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 Types:

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

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

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

See 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) DeleteTapePool added in v1.34.8 

func (c *StorageGateway) DeleteTapePool(input *DeleteTapePoolInput) (*DeleteTapePoolOutput, error)

DeleteTapePool API operation for AWS Storage Gateway.

Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.

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 DeleteTapePool for usage and error information.

Returned Error Types:

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

  • 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/DeleteTapePool

func (*StorageGateway) DeleteTapePoolRequest added in v1.34.8 

func (c *StorageGateway) DeleteTapePoolRequest(input *DeleteTapePoolInput) (req *request.Request, output *DeleteTapePoolOutput)

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

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

See DeleteTapePool for more information on using the DeleteTapePool 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 DeleteTapePoolRequest method.
req, resp := client.DeleteTapePoolRequest(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/DeleteTapePool

func (*StorageGateway) DeleteTapePoolWithContext added in v1.34.8 

func (c *StorageGateway) DeleteTapePoolWithContext(ctx aws.Context, input *DeleteTapePoolInput, opts ...request.Option) (*DeleteTapePoolOutput, error)

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

See DeleteTapePool 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 successfully.

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

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

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

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

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

See 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) DescribeAvailabilityMonitorTest added in v1.25.39 

func (c *StorageGateway) DescribeAvailabilityMonitorTest(input *DescribeAvailabilityMonitorTestInput) (*DescribeAvailabilityMonitorTestOutput, error)

DescribeAvailabilityMonitorTest API operation for AWS Storage Gateway.

Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.

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 DescribeAvailabilityMonitorTest for usage and error information.

Returned Error Types:

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

  • 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/DescribeAvailabilityMonitorTest

func (*StorageGateway) DescribeAvailabilityMonitorTestRequest added in v1.25.39 

func (c *StorageGateway) DescribeAvailabilityMonitorTestRequest(input *DescribeAvailabilityMonitorTestInput) (req *request.Request, output *DescribeAvailabilityMonitorTestOutput)

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

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

See DescribeAvailabilityMonitorTest for more information on using the DescribeAvailabilityMonitorTest 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 DescribeAvailabilityMonitorTestRequest method.
req, resp := client.DescribeAvailabilityMonitorTestRequest(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/DescribeAvailabilityMonitorTest

func (*StorageGateway) DescribeAvailabilityMonitorTestWithContext added in v1.25.39 

func (c *StorageGateway) DescribeAvailabilityMonitorTestWithContext(ctx aws.Context, input *DescribeAvailabilityMonitorTestInput, opts ...request.Option) (*DescribeAvailabilityMonitorTestOutput, error)

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

See DescribeAvailabilityMonitorTest 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 is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.

This operation 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 Types:

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

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

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

See 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) DescribeBandwidthRateLimitSchedule added in v1.35.24 

func (c *StorageGateway) DescribeBandwidthRateLimitSchedule(input *DescribeBandwidthRateLimitScheduleInput) (*DescribeBandwidthRateLimitScheduleOutput, error)

DescribeBandwidthRateLimitSchedule API operation for AWS Storage Gateway.

Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.

This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading

If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. 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 DescribeBandwidthRateLimitSchedule for usage and error information.

Returned Error Types:

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

  • 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/DescribeBandwidthRateLimitSchedule

func (*StorageGateway) DescribeBandwidthRateLimitScheduleRequest added in v1.35.24 

func (c *StorageGateway) DescribeBandwidthRateLimitScheduleRequest(input *DescribeBandwidthRateLimitScheduleInput) (req *request.Request, output *DescribeBandwidthRateLimitScheduleOutput)

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

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

See DescribeBandwidthRateLimitSchedule for more information on using the DescribeBandwidthRateLimitSchedule 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 DescribeBandwidthRateLimitScheduleRequest method.
req, resp := client.DescribeBandwidthRateLimitScheduleRequest(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/DescribeBandwidthRateLimitSchedule

func (*StorageGateway) DescribeBandwidthRateLimitScheduleWithContext added in v1.35.24 

func (c *StorageGateway) DescribeBandwidthRateLimitScheduleWithContext(ctx aws.Context, input *DescribeBandwidthRateLimitScheduleInput, opts ...request.Option) (*DescribeBandwidthRateLimitScheduleOutput, error)

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

See DescribeBandwidthRateLimitSchedule 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) 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 Types:

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

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

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

See 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, 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 Types:

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

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

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

See 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. This operation is supported in the 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 DescribeChapCredentials for usage and error information.

Returned Error Types:

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

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

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

See 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) DescribeFileSystemAssociations added in v1.38.15 

func (c *StorageGateway) DescribeFileSystemAssociations(input *DescribeFileSystemAssociationsInput) (*DescribeFileSystemAssociationsOutput, error)

DescribeFileSystemAssociations API operation for AWS Storage Gateway.

Gets the file system association information. This operation is only supported for FSx 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 DescribeFileSystemAssociations for usage and error information.

Returned Error Types:

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

  • 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/DescribeFileSystemAssociations

func (*StorageGateway) DescribeFileSystemAssociationsRequest added in v1.38.15 

func (c *StorageGateway) DescribeFileSystemAssociationsRequest(input *DescribeFileSystemAssociationsInput) (req *request.Request, output *DescribeFileSystemAssociationsOutput)

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

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

See DescribeFileSystemAssociations for more information on using the DescribeFileSystemAssociations 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 DescribeFileSystemAssociationsRequest method.
req, resp := client.DescribeFileSystemAssociationsRequest(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/DescribeFileSystemAssociations

func (*StorageGateway) DescribeFileSystemAssociationsWithContext added in v1.38.15 

func (c *StorageGateway) DescribeFileSystemAssociationsWithContext(ctx aws.Context, input *DescribeFileSystemAssociationsInput, opts ...request.Option) (*DescribeFileSystemAssociationsOutput, error)

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

See DescribeFileSystemAssociations 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, time zone, status, and software version. 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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 Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 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 DescribeNFSFileShares for usage and error information.

Returned Error Types:

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

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

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

See 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) DescribeSMBFileShares added in v1.14.16 

func (c *StorageGateway) DescribeSMBFileShares(input *DescribeSMBFileSharesInput) (*DescribeSMBFileSharesOutput, error)

DescribeSMBFileShares API operation for AWS Storage Gateway.

Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 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 DescribeSMBFileShares for usage and error information.

Returned Error Types:

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

  • 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/DescribeSMBFileShares

func (*StorageGateway) DescribeSMBFileSharesRequest added in v1.14.16 

func (c *StorageGateway) DescribeSMBFileSharesRequest(input *DescribeSMBFileSharesInput) (req *request.Request, output *DescribeSMBFileSharesOutput)

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

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

See DescribeSMBFileShares for more information on using the DescribeSMBFileShares 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 DescribeSMBFileSharesRequest method.
req, resp := client.DescribeSMBFileSharesRequest(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/DescribeSMBFileShares

func (*StorageGateway) DescribeSMBFileSharesWithContext added in v1.14.16 

func (c *StorageGateway) DescribeSMBFileSharesWithContext(ctx aws.Context, input *DescribeSMBFileSharesInput, opts ...request.Option) (*DescribeSMBFileSharesOutput, error)

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

See DescribeSMBFileShares 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) DescribeSMBSettings added in v1.14.16 

func (c *StorageGateway) DescribeSMBSettings(input *DescribeSMBSettingsInput) (*DescribeSMBSettingsOutput, error)

DescribeSMBSettings API operation for AWS Storage Gateway.

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for 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 DescribeSMBSettings for usage and error information.

Returned Error Types:

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

  • 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/DescribeSMBSettings

func (*StorageGateway) DescribeSMBSettingsRequest added in v1.14.16 

func (c *StorageGateway) DescribeSMBSettingsRequest(input *DescribeSMBSettingsInput) (req *request.Request, output *DescribeSMBSettingsOutput)

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

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

See DescribeSMBSettings for more information on using the DescribeSMBSettings 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 DescribeSMBSettingsRequest method.
req, resp := client.DescribeSMBSettingsRequest(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/DescribeSMBSettings

func (*StorageGateway) DescribeSMBSettingsWithContext added in v1.14.16 

func (c *StorageGateway) DescribeSMBSettingsWithContext(ctx aws.Context, input *DescribeSMBSettingsInput, opts ...request.Option) (*DescribeSMBSettingsOutput, error)

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

See DescribeSMBSettings 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 Types:

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

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

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

See 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, 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 Types:

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

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

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

See 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, 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 Types:

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

  • 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 *storagegateway.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 successfully.

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

See 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 Types:

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

  • 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 *storagegateway.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 successfully.

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

See 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 virtual tapes that correspond to the specified Amazon Resource Names (ARNs). If TapeARN is not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type.

The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit field 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 field. You can use this Marker value in your subsequent request to retrieve the next set of tapes.

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

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

  • 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 *storagegateway.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 successfully.

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

See 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 Types:

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

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

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

See 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, 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 Types:

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

  • 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 *storagegateway.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 successfully.

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

See 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 Types:

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

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

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

See 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) DetachVolume added in v1.16.19 

func (c *StorageGateway) DetachVolume(input *DetachVolumeInput) (*DetachVolumeOutput, error)

DetachVolume API operation for AWS Storage Gateway.

Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the 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 DetachVolume for usage and error information.

Returned Error Types:

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

  • 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/DetachVolume

func (*StorageGateway) DetachVolumeRequest added in v1.16.19 

func (c *StorageGateway) DetachVolumeRequest(input *DetachVolumeInput) (req *request.Request, output *DetachVolumeOutput)

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

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

See DetachVolume for more information on using the DetachVolume 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 DetachVolumeRequest method.
req, resp := client.DetachVolumeRequest(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/DetachVolume

func (*StorageGateway) DetachVolumeWithContext added in v1.16.19 

func (c *StorageGateway) DetachVolumeWithContext(ctx aws.Context, input *DetachVolumeInput, opts ...request.Option) (*DetachVolumeOutput, error)

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

See DetachVolume 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.

After 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 Types:

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

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

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

See 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) DisassociateFileSystem added in v1.38.15 

func (c *StorageGateway) DisassociateFileSystem(input *DisassociateFileSystemInput) (*DisassociateFileSystemOutput, error)

DisassociateFileSystem API operation for AWS Storage Gateway.

Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx 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 DisassociateFileSystem for usage and error information.

Returned Error Types:

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

  • 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/DisassociateFileSystem

func (*StorageGateway) DisassociateFileSystemRequest added in v1.38.15 

func (c *StorageGateway) DisassociateFileSystemRequest(input *DisassociateFileSystemInput) (req *request.Request, output *DisassociateFileSystemOutput)

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

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

See DisassociateFileSystem for more information on using the DisassociateFileSystem 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 DisassociateFileSystemRequest method.
req, resp := client.DisassociateFileSystemRequest(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/DisassociateFileSystem

func (*StorageGateway) DisassociateFileSystemWithContext added in v1.38.15 

func (c *StorageGateway) DisassociateFileSystemWithContext(ctx aws.Context, input *DisassociateFileSystemInput, opts ...request.Option) (*DisassociateFileSystemOutput, error)

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

See DisassociateFileSystem 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) JoinDomain added in v1.14.16 

func (c *StorageGateway) JoinDomain(input *JoinDomainInput) (*JoinDomainOutput, error)

JoinDomain API operation for AWS Storage Gateway.

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.

To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.

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 JoinDomain for usage and error information.

Returned Error Types:

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

  • 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/JoinDomain

func (*StorageGateway) JoinDomainRequest added in v1.14.16 

func (c *StorageGateway) JoinDomainRequest(input *JoinDomainInput) (req *request.Request, output *JoinDomainOutput)

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

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

See JoinDomain for more information on using the JoinDomain 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 JoinDomainRequest method.
req, resp := client.JoinDomainRequest(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/JoinDomain

func (*StorageGateway) JoinDomainWithContext added in v1.14.16 

func (c *StorageGateway) JoinDomainWithContext(ctx aws.Context, input *JoinDomainInput, opts ...request.Option) (*JoinDomainOutput, error)

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

See JoinDomain 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) ListAutomaticTapeCreationPolicies added in v1.30.13 

func (c *StorageGateway) ListAutomaticTapeCreationPolicies(input *ListAutomaticTapeCreationPoliciesInput) (*ListAutomaticTapeCreationPoliciesOutput, error)

ListAutomaticTapeCreationPolicies API operation for AWS Storage Gateway.

Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.

This operation is only supported for tape 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 ListAutomaticTapeCreationPolicies for usage and error information.

Returned Error Types:

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

  • 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/ListAutomaticTapeCreationPolicies

func (*StorageGateway) ListAutomaticTapeCreationPoliciesRequest added in v1.30.13 

func (c *StorageGateway) ListAutomaticTapeCreationPoliciesRequest(input *ListAutomaticTapeCreationPoliciesInput) (req *request.Request, output *ListAutomaticTapeCreationPoliciesOutput)

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

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

See ListAutomaticTapeCreationPolicies for more information on using the ListAutomaticTapeCreationPolicies 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 ListAutomaticTapeCreationPoliciesRequest method.
req, resp := client.ListAutomaticTapeCreationPoliciesRequest(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/ListAutomaticTapeCreationPolicies

func (*StorageGateway) ListAutomaticTapeCreationPoliciesWithContext added in v1.30.13 

func (c *StorageGateway) ListAutomaticTapeCreationPoliciesWithContext(ctx aws.Context, input *ListAutomaticTapeCreationPoliciesInput, opts ...request.Option) (*ListAutomaticTapeCreationPoliciesOutput, error)

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

See ListAutomaticTapeCreationPolicies 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 S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 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 ListFileShares for usage and error information.

Returned Error Types:

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

  • 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) ListFileSharesPages added in v1.19.16 

func (c *StorageGateway) ListFileSharesPages(input *ListFileSharesInput, fn func(*ListFileSharesOutput, bool) bool) error

ListFileSharesPages iterates over the pages of a ListFileShares operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFileShares 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 ListFileShares operation.
pageNum := 0
err := client.ListFileSharesPages(params,
    func(page *storagegateway.ListFileSharesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) ListFileSharesPagesWithContext added in v1.19.16 

func (c *StorageGateway) ListFileSharesPagesWithContext(ctx aws.Context, input *ListFileSharesInput, fn func(*ListFileSharesOutput, bool) bool, opts ...request.Option) error

ListFileSharesPagesWithContext same as ListFileSharesPages 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) 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 successfully.

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

See 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) ListFileSystemAssociations added in v1.38.15 

func (c *StorageGateway) ListFileSystemAssociations(input *ListFileSystemAssociationsInput) (*ListFileSystemAssociationsOutput, error)

ListFileSystemAssociations API operation for AWS Storage Gateway.

Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx 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 ListFileSystemAssociations for usage and error information.

Returned Error Types:

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

  • 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/ListFileSystemAssociations

func (*StorageGateway) ListFileSystemAssociationsPages added in v1.38.15 

func (c *StorageGateway) ListFileSystemAssociationsPages(input *ListFileSystemAssociationsInput, fn func(*ListFileSystemAssociationsOutput, bool) bool) error

ListFileSystemAssociationsPages iterates over the pages of a ListFileSystemAssociations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFileSystemAssociations 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 ListFileSystemAssociations operation.
pageNum := 0
err := client.ListFileSystemAssociationsPages(params,
    func(page *storagegateway.ListFileSystemAssociationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) ListFileSystemAssociationsPagesWithContext added in v1.38.15 

func (c *StorageGateway) ListFileSystemAssociationsPagesWithContext(ctx aws.Context, input *ListFileSystemAssociationsInput, fn func(*ListFileSystemAssociationsOutput, bool) bool, opts ...request.Option) error

ListFileSystemAssociationsPagesWithContext same as ListFileSystemAssociationsPages 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) ListFileSystemAssociationsRequest added in v1.38.15 

func (c *StorageGateway) ListFileSystemAssociationsRequest(input *ListFileSystemAssociationsInput) (req *request.Request, output *ListFileSystemAssociationsOutput)

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

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

See ListFileSystemAssociations for more information on using the ListFileSystemAssociations 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 ListFileSystemAssociationsRequest method.
req, resp := client.ListFileSystemAssociationsRequest(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/ListFileSystemAssociations

func (*StorageGateway) ListFileSystemAssociationsWithContext added in v1.38.15 

func (c *StorageGateway) ListFileSystemAssociationsWithContext(ctx aws.Context, input *ListFileSystemAssociationsInput, opts ...request.Option) (*ListFileSystemAssociationsOutput, error)

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

See ListFileSystemAssociations 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 Amazon Web Services account in an Amazon Web Services 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 Types:

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

  • 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 *storagegateway.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 successfully.

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

See 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 Types:

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

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

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

See 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 supported in storage gateways of all 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 ListTagsForResource for usage and error information.

Returned Error Types:

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

  • 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) ListTagsForResourcePages added in v1.19.16 

func (c *StorageGateway) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource 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 ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *storagegateway.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) ListTagsForResourcePagesWithContext added in v1.19.16 

func (c *StorageGateway) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages 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) 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 successfully.

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

See 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) ListTapePools added in v1.34.8 

func (c *StorageGateway) ListTapePools(input *ListTapePoolsInput) (*ListTapePoolsOutput, error)

ListTapePools API operation for AWS Storage Gateway.

Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.

This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools 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 tape pools.

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 ListTapePools for usage and error information.

Returned Error Types:

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

  • 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/ListTapePools

func (*StorageGateway) ListTapePoolsPages added in v1.35.24 

func (c *StorageGateway) ListTapePoolsPages(input *ListTapePoolsInput, fn func(*ListTapePoolsOutput, bool) bool) error

ListTapePoolsPages iterates over the pages of a ListTapePools operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTapePools 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 ListTapePools operation.
pageNum := 0
err := client.ListTapePoolsPages(params,
    func(page *storagegateway.ListTapePoolsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) ListTapePoolsPagesWithContext added in v1.35.24 

func (c *StorageGateway) ListTapePoolsPagesWithContext(ctx aws.Context, input *ListTapePoolsInput, fn func(*ListTapePoolsOutput, bool) bool, opts ...request.Option) error

ListTapePoolsPagesWithContext same as ListTapePoolsPages 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) ListTapePoolsRequest added in v1.34.8 

func (c *StorageGateway) ListTapePoolsRequest(input *ListTapePoolsInput) (req *request.Request, output *ListTapePoolsOutput)

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

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

See ListTapePools for more information on using the ListTapePools 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 ListTapePoolsRequest method.
req, resp := client.ListTapePoolsRequest(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/ListTapePools

func (*StorageGateway) ListTapePoolsWithContext added in v1.34.8 

func (c *StorageGateway) ListTapePoolsWithContext(ctx aws.Context, input *ListTapePoolsInput, opts ...request.Option) (*ListTapePoolsOutput, error)

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

See ListTapePools 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 Types:

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

  • 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) ListTapesPages added in v1.19.16 

func (c *StorageGateway) ListTapesPages(input *ListTapesInput, fn func(*ListTapesOutput, bool) bool) error

ListTapesPages iterates over the pages of a ListTapes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTapes 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 ListTapes operation.
pageNum := 0
err := client.ListTapesPages(params,
    func(page *storagegateway.ListTapesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*StorageGateway) ListTapesPagesWithContext added in v1.19.16 

func (c *StorageGateway) ListTapesPagesWithContext(ctx aws.Context, input *ListTapesInput, fn func(*ListTapesOutput, bool) bool, opts ...request.Option) error

ListTapesPagesWithContext same as ListTapesPages 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) 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 successfully.

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

See 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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 Types:

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

  • 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 *storagegateway.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 successfully.

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

See 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 file share have been uploaded to Amazon S3.

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 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 Lambda function. This operation is only supported for S3 File Gateways.

For more information, see Getting file upload notification (https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) in the Amazon S3 File Gateway User Guide.

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

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

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

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

See 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 cached inventory of objects 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 does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.

You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations (https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) in the Amazon S3 File Gateway User Guide. This operation is Only supported for S3 File Gateways.

When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes.

Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations (https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) in the Amazon S3 File Gateway User Guide.

  • Wait at least 60 seconds between consecutive RefreshCache API requests.

  • If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.

The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.

For more information, see Getting notified about file operations (https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) in the Amazon S3 File Gateway User Guide.

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

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

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

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

See 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 supported in storage gateways of all 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 Types:

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

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

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

See 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 an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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) SetSMBGuestPassword added in v1.14.16 

func (c *StorageGateway) SetSMBGuestPassword(input *SetSMBGuestPasswordInput) (*SetSMBGuestPasswordOutput, error)

SetSMBGuestPassword API operation for AWS Storage Gateway.

Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess. This operation only supported for S3 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 SetSMBGuestPassword for usage and error information.

Returned Error Types:

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

  • 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/SetSMBGuestPassword

func (*StorageGateway) SetSMBGuestPasswordRequest added in v1.14.16 

func (c *StorageGateway) SetSMBGuestPasswordRequest(input *SetSMBGuestPasswordInput) (req *request.Request, output *SetSMBGuestPasswordOutput)

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

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

See SetSMBGuestPassword for more information on using the SetSMBGuestPassword 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 SetSMBGuestPasswordRequest method.
req, resp := client.SetSMBGuestPasswordRequest(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/SetSMBGuestPassword

func (*StorageGateway) SetSMBGuestPasswordWithContext added in v1.14.16 

func (c *StorageGateway) SetSMBGuestPasswordWithContext(ctx aws.Context, input *SetSMBGuestPasswordInput, opts ...request.Option) (*SetSMBGuestPasswordOutput, error)

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

See SetSMBGuestPassword 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 Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

This API action cannot be used to shut down S3 File Gateway or FSx File Gateway.

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

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

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

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

See 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) StartAvailabilityMonitorTest added in v1.25.39 

func (c *StorageGateway) StartAvailabilityMonitorTest(input *StartAvailabilityMonitorTestInput) (*StartAvailabilityMonitorTestOutput, error)

StartAvailabilityMonitorTest API operation for AWS Storage Gateway.

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

Starting this test will cause your gateway to go offline for a brief period.

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 StartAvailabilityMonitorTest for usage and error information.

Returned Error Types:

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

  • 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/StartAvailabilityMonitorTest

func (*StorageGateway) StartAvailabilityMonitorTestRequest added in v1.25.39 

func (c *StorageGateway) StartAvailabilityMonitorTestRequest(input *StartAvailabilityMonitorTestInput) (req *request.Request, output *StartAvailabilityMonitorTestOutput)

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

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

See StartAvailabilityMonitorTest for more information on using the StartAvailabilityMonitorTest 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 StartAvailabilityMonitorTestRequest method.
req, resp := client.StartAvailabilityMonitorTestRequest(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/StartAvailabilityMonitorTest

func (*StorageGateway) StartAvailabilityMonitorTestWithContext added in v1.25.39 

func (c *StorageGateway) StartAvailabilityMonitorTestWithContext(ctx aws.Context, input *StartAvailabilityMonitorTestInput, opts ...request.Option) (*StartAvailabilityMonitorTestOutput, error)

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

See StartAvailabilityMonitorTest 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 Types:

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

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

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

See 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) UpdateAutomaticTapeCreationPolicy added in v1.30.13 

func (c *StorageGateway) UpdateAutomaticTapeCreationPolicy(input *UpdateAutomaticTapeCreationPolicyInput) (*UpdateAutomaticTapeCreationPolicyOutput, error)

UpdateAutomaticTapeCreationPolicy API operation for AWS Storage Gateway.

Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.

By default, there is no automatic tape creation policy.

A gateway can have only one automatic tape creation policy.

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 UpdateAutomaticTapeCreationPolicy for usage and error information.

Returned Error Types:

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

  • 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/UpdateAutomaticTapeCreationPolicy

func (*StorageGateway) UpdateAutomaticTapeCreationPolicyRequest added in v1.30.13 

func (c *StorageGateway) UpdateAutomaticTapeCreationPolicyRequest(input *UpdateAutomaticTapeCreationPolicyInput) (req *request.Request, output *UpdateAutomaticTapeCreationPolicyOutput)

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

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

See UpdateAutomaticTapeCreationPolicy for more information on using the UpdateAutomaticTapeCreationPolicy 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 UpdateAutomaticTapeCreationPolicyRequest method.
req, resp := client.UpdateAutomaticTapeCreationPolicyRequest(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/UpdateAutomaticTapeCreationPolicy

func (*StorageGateway) UpdateAutomaticTapeCreationPolicyWithContext added in v1.30.13 

func (c *StorageGateway) UpdateAutomaticTapeCreationPolicyWithContext(ctx aws.Context, input *UpdateAutomaticTapeCreationPolicyInput, opts ...request.Option) (*UpdateAutomaticTapeCreationPolicyOutput, error)

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

See UpdateAutomaticTapeCreationPolicy 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. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule.

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

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

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

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

See 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) UpdateBandwidthRateLimitSchedule added in v1.35.24 

func (c *StorageGateway) UpdateBandwidthRateLimitSchedule(input *UpdateBandwidthRateLimitScheduleInput) (*UpdateBandwidthRateLimitScheduleOutput, error)

UpdateBandwidthRateLimitSchedule API operation for AWS Storage Gateway.

Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.

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 UpdateBandwidthRateLimitSchedule for usage and error information.

Returned Error Types:

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

  • 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/UpdateBandwidthRateLimitSchedule

func (*StorageGateway) UpdateBandwidthRateLimitScheduleRequest added in v1.35.24 

func (c *StorageGateway) UpdateBandwidthRateLimitScheduleRequest(input *UpdateBandwidthRateLimitScheduleInput) (req *request.Request, output *UpdateBandwidthRateLimitScheduleOutput)

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

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

See UpdateBandwidthRateLimitSchedule for more information on using the UpdateBandwidthRateLimitSchedule 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 UpdateBandwidthRateLimitScheduleRequest method.
req, resp := client.UpdateBandwidthRateLimitScheduleRequest(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/UpdateBandwidthRateLimitSchedule

func (*StorageGateway) UpdateBandwidthRateLimitScheduleWithContext added in v1.35.24 

func (c *StorageGateway) UpdateBandwidthRateLimitScheduleWithContext(ctx aws.Context, input *UpdateBandwidthRateLimitScheduleInput, opts ...request.Option) (*UpdateBandwidthRateLimitScheduleOutput, error)

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

See UpdateBandwidthRateLimitSchedule 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) 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. This operation is supported in the volume and tape gateway types.

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

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

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

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

See 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) UpdateFileSystemAssociation added in v1.38.15 

func (c *StorageGateway) UpdateFileSystemAssociation(input *UpdateFileSystemAssociationInput) (*UpdateFileSystemAssociationOutput, error)

UpdateFileSystemAssociation API operation for AWS Storage Gateway.

Updates a file system association. This operation is only supported in the FSx 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 UpdateFileSystemAssociation for usage and error information.

Returned Error Types:

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

  • 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/UpdateFileSystemAssociation

func (*StorageGateway) UpdateFileSystemAssociationRequest added in v1.38.15 

func (c *StorageGateway) UpdateFileSystemAssociationRequest(input *UpdateFileSystemAssociationInput) (req *request.Request, output *UpdateFileSystemAssociationOutput)

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

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

See UpdateFileSystemAssociation for more information on using the UpdateFileSystemAssociation 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 UpdateFileSystemAssociationRequest method.
req, resp := client.UpdateFileSystemAssociationRequest(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/UpdateFileSystemAssociation

func (*StorageGateway) UpdateFileSystemAssociationWithContext added in v1.38.15 

func (c *StorageGateway) UpdateFileSystemAssociationWithContext(ctx aws.Context, input *UpdateFileSystemAssociationInput, opts ...request.Option) (*UpdateFileSystemAssociationOutput, error)

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

See UpdateFileSystemAssociation 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 Types:

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

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

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

See 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 (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings) and Customizing your Linux iSCSI settings (https://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 Types:

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

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

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

See 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 Types:

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

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

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

See 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 Network File System (NFS) file share. This operation is only supported in S3 File Gateways.

To leave a file share field unchanged, set the corresponding input field to null.

Updates the following file share settings:

  • 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

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

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

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

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

See 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) UpdateSMBFileShare added in v1.14.16 

func (c *StorageGateway) UpdateSMBFileShare(input *UpdateSMBFileShareInput) (*UpdateSMBFileShareOutput, error)

UpdateSMBFileShare API operation for AWS Storage Gateway.

Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.

To leave a file share field unchanged, set the corresponding input field to null.

File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the Identity and Access Management User Guide.

File gateways don't 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 UpdateSMBFileShare for usage and error information.

Returned Error Types:

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

  • 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/UpdateSMBFileShare

func (*StorageGateway) UpdateSMBFileShareRequest added in v1.14.16 

func (c *StorageGateway) UpdateSMBFileShareRequest(input *UpdateSMBFileShareInput) (req *request.Request, output *UpdateSMBFileShareOutput)

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

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

See UpdateSMBFileShare for more information on using the UpdateSMBFileShare 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 UpdateSMBFileShareRequest method.
req, resp := client.UpdateSMBFileShareRequest(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/UpdateSMBFileShare

func (*StorageGateway) UpdateSMBFileShareVisibility added in v1.35.18 

func (c *StorageGateway) UpdateSMBFileShareVisibility(input *UpdateSMBFileShareVisibilityInput) (*UpdateSMBFileShareVisibilityOutput, error)

UpdateSMBFileShareVisibility API operation for AWS Storage Gateway.

Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 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 UpdateSMBFileShareVisibility for usage and error information.

Returned Error Types:

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

  • 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/UpdateSMBFileShareVisibility

func (*StorageGateway) UpdateSMBFileShareVisibilityRequest added in v1.35.18 

func (c *StorageGateway) UpdateSMBFileShareVisibilityRequest(input *UpdateSMBFileShareVisibilityInput) (req *request.Request, output *UpdateSMBFileShareVisibilityOutput)

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

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

See UpdateSMBFileShareVisibility for more information on using the UpdateSMBFileShareVisibility 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 UpdateSMBFileShareVisibilityRequest method.
req, resp := client.UpdateSMBFileShareVisibilityRequest(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/UpdateSMBFileShareVisibility

func (*StorageGateway) UpdateSMBFileShareVisibilityWithContext added in v1.35.18 

func (c *StorageGateway) UpdateSMBFileShareVisibilityWithContext(ctx aws.Context, input *UpdateSMBFileShareVisibilityInput, opts ...request.Option) (*UpdateSMBFileShareVisibilityOutput, error)

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

See UpdateSMBFileShareVisibility 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) UpdateSMBFileShareWithContext added in v1.14.16 

func (c *StorageGateway) UpdateSMBFileShareWithContext(ctx aws.Context, input *UpdateSMBFileShareInput, opts ...request.Option) (*UpdateSMBFileShareOutput, error)

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

See UpdateSMBFileShare 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) UpdateSMBLocalGroups added in v1.41.2 

func (c *StorageGateway) UpdateSMBLocalGroups(input *UpdateSMBLocalGroupsInput) (*UpdateSMBLocalGroupsOutput, error)

UpdateSMBLocalGroups API operation for AWS Storage Gateway.

Updates the list of Active Directory users and groups that have special permissions for SMB file shares on 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 UpdateSMBLocalGroups for usage and error information.

Returned Error Types:

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

  • 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/UpdateSMBLocalGroups

func (*StorageGateway) UpdateSMBLocalGroupsRequest added in v1.41.2 

func (c *StorageGateway) UpdateSMBLocalGroupsRequest(input *UpdateSMBLocalGroupsInput) (req *request.Request, output *UpdateSMBLocalGroupsOutput)

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

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

See UpdateSMBLocalGroups for more information on using the UpdateSMBLocalGroups 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 UpdateSMBLocalGroupsRequest method.
req, resp := client.UpdateSMBLocalGroupsRequest(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/UpdateSMBLocalGroups

func (*StorageGateway) UpdateSMBLocalGroupsWithContext added in v1.41.2 

func (c *StorageGateway) UpdateSMBLocalGroupsWithContext(ctx aws.Context, input *UpdateSMBLocalGroupsInput, opts ...request.Option) (*UpdateSMBLocalGroupsOutput, error)

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

See UpdateSMBLocalGroups 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) UpdateSMBSecurityStrategy added in v1.19.43 

func (c *StorageGateway) UpdateSMBSecurityStrategy(input *UpdateSMBSecurityStrategyInput) (*UpdateSMBSecurityStrategyOutput, error)

UpdateSMBSecurityStrategy API operation for AWS Storage Gateway.

Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.

This API is called Security level in the User Guide.

A higher security level can affect performance of 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 UpdateSMBSecurityStrategy for usage and error information.

Returned Error Types:

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

  • 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/UpdateSMBSecurityStrategy

func (*StorageGateway) UpdateSMBSecurityStrategyRequest added in v1.19.43 

func (c *StorageGateway) UpdateSMBSecurityStrategyRequest(input *UpdateSMBSecurityStrategyInput) (req *request.Request, output *UpdateSMBSecurityStrategyOutput)

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

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

See UpdateSMBSecurityStrategy for more information on using the UpdateSMBSecurityStrategy 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 UpdateSMBSecurityStrategyRequest method.
req, resp := client.UpdateSMBSecurityStrategyRequest(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/UpdateSMBSecurityStrategy

func (*StorageGateway) UpdateSMBSecurityStrategyWithContext added in v1.19.43 

func (c *StorageGateway) UpdateSMBSecurityStrategyWithContext(ctx aws.Context, input *UpdateSMBSecurityStrategyInput, opts ...request.Option) (*UpdateSMBSecurityStrategyOutput, error)

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

See UpdateSMBSecurityStrategy 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 Types:

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

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

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

See 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 Types:

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

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

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

See 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 timestamp.
	CreatedDate *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// 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 name of the iSCSI target used by an initiator to connect to a volume
	// and used 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 on a gateway.
	//
	// If you don't specify a value, Storage Gateway uses the value that was previously
	// used for this volume as the new target name.
	TargetName *string `min:"1" type:"string"`

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

	// A value that indicates whether a storage volume is attached to, detached
	// from, or is in the process of detaching from a gateway. For more information,
	// see Moving your volumes to a different gateway (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume).
	VolumeAttachmentStatus *string `min:"3" 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 calculated
	// based on the number of blocks that are touched, instead of the actual amount
	// of data written. This value can be useful for sequential write patterns but
	// less accurate for random write patterns. VolumeUsedInBytes is different from
	// the compressed size of the volume, which is the value that is used to calculate
	// your bill.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorediSCSIVolume) SetCreatedDate added in v1.6.6 

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

SetCreatedDate sets the CreatedDate field's value.

func (*StorediSCSIVolume) SetKMSKey added in v1.15.3 

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

SetKMSKey sets the KMSKey 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) SetTargetName added in v1.16.19 

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

SetTargetName sets the TargetName 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) SetVolumeAttachmentStatus added in v1.16.19 

func (s *StorediSCSIVolume) SetVolumeAttachmentStatus(v string) *StorediSCSIVolume

SetVolumeAttachmentStatus sets the VolumeAttachmentStatus 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v0.9.5 

type Tag struct {

	// Tag key. The key can't start with aws:.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Value of the tag key.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

func (Tag) GoString added in v0.9.5 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// The date that the tape enters a custom tape pool.
	PoolEntryDate *time.Time `type:"timestamp"`

	// The ID of the pool that contains tapes that will be archived. The tapes in
	// this pool are archived in the S3 storage class that is associated with the
	// pool. When you use your backup application to eject the tape, the tape is
	// archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive)
	// that corresponds to the pool.
	PoolId *string `min:"1" 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 date that the tape is first archived with tape retention lock enabled.
	RetentionStartDate *time.Time `type:"timestamp"`

	// 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:"5" type:"string"`

	// The date the virtual tape was created.
	TapeCreatedDate *time.Time `type:"timestamp"`

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

	// If the tape is archived as write-once-read-many (WORM), this value is true.
	Worm *bool `type:"boolean"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tape) SetKMSKey added in v1.14.4 

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

SetKMSKey sets the KMSKey field's value.

func (*Tape) SetPoolEntryDate added in v1.34.8 

func (s *Tape) SetPoolEntryDate(v time.Time) *Tape

SetPoolEntryDate sets the PoolEntryDate field's value.

func (*Tape) SetPoolId added in v1.19.3 

func (s *Tape) SetPoolId(v string) *Tape

SetPoolId sets the PoolId 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) SetRetentionStartDate added in v1.34.8 

func (s *Tape) SetRetentionStartDate(v time.Time) *Tape

SetRetentionStartDate sets the RetentionStartDate 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) SetWorm added in v1.34.8 

func (s *Tape) SetWorm(v bool) *Tape

SetWorm sets the Worm field's value.

func (Tape) String added in v0.6.5 

func (s Tape) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TapeArchive 

type TapeArchive struct {

	// The time that the archiving of the virtual tape was completed.
	//
	// The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'
	// format.
	CompletionTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// The time that the tape entered the custom tape pool.
	//
	// The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'
	// format.
	PoolEntryDate *time.Time `type:"timestamp"`

	// The ID of the pool that was used to archive the tape. The tapes in this pool
	// are archived in the S3 storage class that is associated with the pool.
	PoolId *string `min:"1" type:"string"`

	// If the archived tape is subject to tape retention lock, the date that the
	// archived tape started being retained.
	RetentionStartDate *time.Time `type:"timestamp"`

	// 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:"5" type:"string"`

	// The date the virtual tape was created.
	TapeCreatedDate *time.Time `type:"timestamp"`

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

	// Set to true if the archived tape is stored as write-once-read-many (WORM).
	Worm *bool `type:"boolean"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetPoolEntryDate added in v1.34.8 

func (s *TapeArchive) SetPoolEntryDate(v time.Time) *TapeArchive

SetPoolEntryDate sets the PoolEntryDate field's value.

func (*TapeArchive) SetPoolId added in v1.19.3 

func (s *TapeArchive) SetPoolId(v string) *TapeArchive

SetPoolId sets the PoolId field's value.

func (*TapeArchive) SetRetentionStartDate added in v1.34.8 

func (s *TapeArchive) SetRetentionStartDate(v time.Time) *TapeArchive

SetRetentionStartDate sets the RetentionStartDate 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) SetWorm added in v1.34.8 

func (s *TapeArchive) SetWorm(v bool) *TapeArchive

SetWorm sets the Worm field's value.

func (TapeArchive) String added in v0.6.5 

func (s TapeArchive) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`

	// The date that the tape entered the custom tape pool with tape retention lock
	// enabled.
	PoolEntryDate *time.Time `type:"timestamp"`

	// The ID of the pool that you want to add your tape to for archiving. The tape
	// in this pool is archived in the S3 storage class that is associated with
	// the pool. When you use your backup application to eject the tape, the tape
	// is archived directly into the storage class (S3 Glacier or S3 Glacier Deep
	// Archive) that corresponds to the pool.
	PoolId *string `min:"1" type:"string"`

	// The date that the tape became subject to tape retention lock.
	RetentionStartDate *time.Time `type:"timestamp"`

	// 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:"5" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TapeInfo) SetGatewayARN added in v1.5.0 

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

SetGatewayARN sets the GatewayARN field's value.

func (*TapeInfo) SetPoolEntryDate added in v1.34.8 

func (s *TapeInfo) SetPoolEntryDate(v time.Time) *TapeInfo

SetPoolEntryDate sets the PoolEntryDate field's value.

func (*TapeInfo) SetPoolId added in v1.19.3 

func (s *TapeInfo) SetPoolId(v string) *TapeInfo

SetPoolId sets the PoolId field's value.

func (*TapeInfo) SetRetentionStartDate added in v1.34.8 

func (s *TapeInfo) SetRetentionStartDate(v time.Time) *TapeInfo

SetRetentionStartDate sets the RetentionStartDate 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The size, in bytes, of the virtual tapes to recover.
	TapeSizeInBytes *int64 `type:"long"`

	// The status of the virtual tapes.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAutomaticTapeCreationPolicyInput added in v1.30.13 

type UpdateAutomaticTapeCreationPolicyInput struct {

	// An automatic tape creation policy consists of a list of automatic tape creation
	// rules. The rules determine when and how to automatically create new tapes.
	//
	// AutomaticTapeCreationRules is a required field
	AutomaticTapeCreationRules []*AutomaticTapeCreationRule `min:"1" 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAutomaticTapeCreationPolicyInput) GoString added in v1.30.13 

func (s UpdateAutomaticTapeCreationPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAutomaticTapeCreationPolicyInput) SetAutomaticTapeCreationRules added in v1.30.13 

func (s *UpdateAutomaticTapeCreationPolicyInput) SetAutomaticTapeCreationRules(v []*AutomaticTapeCreationRule) *UpdateAutomaticTapeCreationPolicyInput

SetAutomaticTapeCreationRules sets the AutomaticTapeCreationRules field's value.

func (*UpdateAutomaticTapeCreationPolicyInput) SetGatewayARN added in v1.30.13 

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

SetGatewayARN sets the GatewayARN field's value.

func (UpdateAutomaticTapeCreationPolicyInput) String added in v1.30.13 

func (s UpdateAutomaticTapeCreationPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAutomaticTapeCreationPolicyInput) Validate added in v1.30.13 

func (s *UpdateAutomaticTapeCreationPolicyInput) Validate() error

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

type UpdateAutomaticTapeCreationPolicyOutput added in v1.30.13 

type UpdateAutomaticTapeCreationPolicyOutput struct {

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

func (UpdateAutomaticTapeCreationPolicyOutput) GoString added in v1.30.13 

func (s UpdateAutomaticTapeCreationPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAutomaticTapeCreationPolicyOutput) SetGatewayARN added in v1.30.13 

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

SetGatewayARN sets the GatewayARN field's value.

func (UpdateAutomaticTapeCreationPolicyOutput) String added in v1.30.13 

func (s UpdateAutomaticTapeCreationPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateBandwidthRateLimitScheduleInput added in v1.35.24 

type UpdateBandwidthRateLimitScheduleInput struct {

	// An array containing bandwidth rate limit schedule intervals for a gateway.
	// When no bandwidth rate limit intervals have been scheduled, the array is
	// empty.
	//
	// BandwidthRateLimitIntervals is a required field
	BandwidthRateLimitIntervals []*BandwidthRateLimitInterval `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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateBandwidthRateLimitScheduleInput) GoString added in v1.35.24 

func (s UpdateBandwidthRateLimitScheduleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBandwidthRateLimitScheduleInput) SetBandwidthRateLimitIntervals added in v1.35.24 

func (s *UpdateBandwidthRateLimitScheduleInput) SetBandwidthRateLimitIntervals(v []*BandwidthRateLimitInterval) *UpdateBandwidthRateLimitScheduleInput

SetBandwidthRateLimitIntervals sets the BandwidthRateLimitIntervals field's value.

func (*UpdateBandwidthRateLimitScheduleInput) SetGatewayARN added in v1.35.24 

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

SetGatewayARN sets the GatewayARN field's value.

func (UpdateBandwidthRateLimitScheduleInput) String added in v1.35.24 

func (s UpdateBandwidthRateLimitScheduleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBandwidthRateLimitScheduleInput) Validate added in v1.35.24 

func (s *UpdateBandwidthRateLimitScheduleInput) Validate() error

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

type UpdateBandwidthRateLimitScheduleOutput added in v1.35.24 

type UpdateBandwidthRateLimitScheduleOutput struct {

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

func (UpdateBandwidthRateLimitScheduleOutput) GoString added in v1.35.24 

func (s UpdateBandwidthRateLimitScheduleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBandwidthRateLimitScheduleOutput) SetGatewayARN added in v1.35.24 

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

SetGatewayARN sets the GatewayARN field's value.

func (UpdateBandwidthRateLimitScheduleOutput) String added in v1.35.24 

func (s UpdateBandwidthRateLimitScheduleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateChapCredentialsInput's
	// String and GoString methods.
	//
	// SecretToAuthenticateInitiator is a required field
	SecretToAuthenticateInitiator *string `min:"1" type:"string" required:"true" sensitive:"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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateChapCredentialsInput's
	// String and GoString methods.
	SecretToAuthenticateTarget *string `min:"1" type:"string" sensitive:"true"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFileSystemAssociationInput added in v1.38.15 

type UpdateFileSystemAssociationInput struct {

	// The Amazon Resource Name (ARN) of the storage used for the audit logs.
	AuditDestinationARN *string `type:"string"`

	// The refresh cache information for the file share or FSx file systems.
	CacheAttributes *CacheAttributes `type:"structure"`

	// The Amazon Resource Name (ARN) of the file system association that you want
	// to update.
	//
	// FileSystemAssociationARN is a required field
	FileSystemAssociationARN *string `min:"50" type:"string" required:"true"`

	// The password of the user credential.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateFileSystemAssociationInput's
	// String and GoString methods.
	Password *string `min:"1" type:"string" sensitive:"true"`

	// The user name of the user credential that has permission to access the root
	// share D$ of the Amazon FSx file system. The user account must belong to the
	// Amazon FSx delegated admin user group.
	UserName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFileSystemAssociationInput) GoString added in v1.38.15 

func (s UpdateFileSystemAssociationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemAssociationInput) SetAuditDestinationARN added in v1.38.15 

func (s *UpdateFileSystemAssociationInput) SetAuditDestinationARN(v string) *UpdateFileSystemAssociationInput

SetAuditDestinationARN sets the AuditDestinationARN field's value.

func (*UpdateFileSystemAssociationInput) SetCacheAttributes added in v1.38.15 

func (s *UpdateFileSystemAssociationInput) SetCacheAttributes(v *CacheAttributes) *UpdateFileSystemAssociationInput

SetCacheAttributes sets the CacheAttributes field's value.

func (*UpdateFileSystemAssociationInput) SetFileSystemAssociationARN added in v1.38.15 

func (s *UpdateFileSystemAssociationInput) SetFileSystemAssociationARN(v string) *UpdateFileSystemAssociationInput

SetFileSystemAssociationARN sets the FileSystemAssociationARN field's value.

func (*UpdateFileSystemAssociationInput) SetPassword added in v1.38.15 

func (s *UpdateFileSystemAssociationInput) SetPassword(v string) *UpdateFileSystemAssociationInput

SetPassword sets the Password field's value.

func (*UpdateFileSystemAssociationInput) SetUserName added in v1.38.15 

func (s *UpdateFileSystemAssociationInput) SetUserName(v string) *UpdateFileSystemAssociationInput

SetUserName sets the UserName field's value.

func (UpdateFileSystemAssociationInput) String added in v1.38.15 

func (s UpdateFileSystemAssociationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemAssociationInput) Validate added in v1.38.15 

func (s *UpdateFileSystemAssociationInput) Validate() error

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

type UpdateFileSystemAssociationOutput added in v1.38.15 

type UpdateFileSystemAssociationOutput struct {

	// The ARN of the updated file system association.
	FileSystemAssociationARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFileSystemAssociationOutput) GoString added in v1.38.15 

func (s UpdateFileSystemAssociationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemAssociationOutput) SetFileSystemAssociationARN added in v1.38.15 

func (s *UpdateFileSystemAssociationOutput) SetFileSystemAssociationARN(v string) *UpdateFileSystemAssociationOutput

SetFileSystemAssociationARN sets the FileSystemAssociationARN field's value.

func (UpdateFileSystemAssociationOutput) String added in v1.38.15 

func (s UpdateFileSystemAssociationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGatewayInformationInput 

type UpdateGatewayInformationInput struct {

	// The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you
	// want to use to monitor and log events in the gateway.
	//
	// For more information, see What is Amazon CloudWatch Logs? (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html)
	CloudWatchLogGroupARN *string `type:"string"`

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

	// Specifies the size of the gateway's metadata cache.
	GatewayCapacity *string `type:"string" enum:"GatewayCapacity"`

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

	// A value that indicates the time zone of the gateway.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewayInformationInput) SetCloudWatchLogGroupARN added in v1.23.19 

func (s *UpdateGatewayInformationInput) SetCloudWatchLogGroupARN(v string) *UpdateGatewayInformationInput

SetCloudWatchLogGroupARN sets the CloudWatchLogGroupARN field's value.

func (*UpdateGatewayInformationInput) SetGatewayARN added in v1.5.0 

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

SetGatewayARN sets the GatewayARN field's value.

func (*UpdateGatewayInformationInput) SetGatewayCapacity added in v1.39.2 

func (s *UpdateGatewayInformationInput) SetGatewayCapacity(v string) *UpdateGatewayInformationInput

SetGatewayCapacity sets the GatewayCapacity 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`

	// The name you configured for your gateway.
	GatewayName *string `type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services Region.
	//
	// GatewayARN is a required field
	GatewayARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.

func (UpdateGatewaySoftwareNowInput) GoString added in v0.6.5 

func (s UpdateGatewaySoftwareNowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.

func (UpdateGatewaySoftwareNowOutput) GoString added in v0.6.5 

func (s UpdateGatewaySoftwareNowOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateMaintenanceStartTimeInput 

type UpdateMaintenanceStartTimeInput struct {

	// The day of the month component of the maintenance start time represented
	// as an ordinal number from 1 to 28, where 1 represents the first day of the
	// month and 28 represents the last day of the month.
	DayOfMonth *int64 `min:"1" type:"integer"`

	// The day of the week component of the maintenance start time week represented
	// as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
	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 Amazon Web Services 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$DayOfMonth

  • UpdateMaintenanceStartTimeInput$DayOfWeek

  • UpdateMaintenanceStartTimeInput$HourOfDay

  • UpdateMaintenanceStartTimeInput$MinuteOfHour

func (UpdateMaintenanceStartTimeInput) GoString added in v0.6.5 

func (s UpdateMaintenanceStartTimeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMaintenanceStartTimeInput) SetDayOfMonth added in v1.19.12 

func (s *UpdateMaintenanceStartTimeInput) SetDayOfMonth(v int64) *UpdateMaintenanceStartTimeInput

SetDayOfMonth sets the DayOfMonth field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Web Services Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A JSON object containing the Amazon Resource Name (ARN) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateNFSFileShareInput added in v1.6.6 

type UpdateNFSFileShareInput struct {

	// The Amazon Resource Name (ARN) of the storage used for audit logs.
	AuditDestinationARN *string `type:"string"`

	// Specifies refresh cache information for the file share.
	CacheAttributes *CacheAttributes `type:"structure"`

	// The list of clients that are allowed to access the S3 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 the
	// S3 File Gateway. The default value is S3_STANDARD. Optional.
	//
	// Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
	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"`

	// The name of the file share. Optional.
	//
	// FileShareName must be set if an S3 prefix name is set in LocationARN, or
	// if an access point or access point alias is used.
	FileShareName *string `min:"1" type:"string"`

	// A value that enables guessing of the MIME type for uploaded objects based
	// on file extensions. Set this value to true to enable MIME type guessing,
	// otherwise set to false. The default value is true.
	//
	// Valid Values: true | false
	GuessMIMETypeEnabled *bool `type:"boolean"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// The default values for the file share. Optional.
	NFSFileShareDefaults *NFSFileShareDefaults `type:"structure"`

	// The notification policy of the file share. SettlingTimeInSeconds controls
	// the number of seconds to wait after the last point in time a client wrote
	// to a file before generating an ObjectUploaded notification. Because clients
	// can make many small writes to files, it's best to set this parameter for
	// as long as possible to avoid generating multiple notifications for the same
	// file in a small time period.
	//
	// SettlingTimeInSeconds has no effect on the timing of the object uploading
	// to Amazon S3, only the timing of the notification.
	//
	// The following example sets NotificationPolicy on with SettlingTimeInSeconds
	// set to 60.
	//
	// {\"Upload\": {\"SettlingTimeInSeconds\": 60}}
	//
	// The following example sets NotificationPolicy off.
	//
	// {}
	NotificationPolicy *string `min:"2" type:"string"`

	// A value that sets the access control list (ACL) permission for objects in
	// the S3 bucket that a S3 File Gateway puts objects into. The default value
	// is private.
	ObjectACL *string `type:"string" enum:"ObjectACL"`

	// A value that sets the write status of a file share. Set this value to true
	// to set the write status to read-only, otherwise set to false.
	//
	// Valid Values: true | false
	ReadOnly *bool `type:"boolean"`

	// A value that sets who pays the cost of the request and the cost associated
	// with data download from the S3 bucket. If this value is set to true, the
	// requester pays the costs; otherwise, the S3 bucket owner pays. However, the
	// S3 bucket owner always pays the cost of storing data.
	//
	// RequesterPays is a configuration for the S3 bucket that backs the file share,
	// so make sure that the configuration on the file share is the same as the
	// S3 bucket configuration.
	//
	// Valid Values: true | false
	RequesterPays *bool `type:"boolean"`

	// The user mapped to anonymous user.
	//
	// Valid values 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNFSFileShareInput) SetAuditDestinationARN added in v1.41.2 

func (s *UpdateNFSFileShareInput) SetAuditDestinationARN(v string) *UpdateNFSFileShareInput

SetAuditDestinationARN sets the AuditDestinationARN field's value.

func (*UpdateNFSFileShareInput) SetCacheAttributes added in v1.33.3 

func (s *UpdateNFSFileShareInput) SetCacheAttributes(v *CacheAttributes) *UpdateNFSFileShareInput

SetCacheAttributes sets the CacheAttributes field's value.

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) SetFileShareName added in v1.33.3 

func (s *UpdateNFSFileShareInput) SetFileShareName(v string) *UpdateNFSFileShareInput

SetFileShareName sets the FileShareName 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) SetNotificationPolicy added in v1.35.18 

func (s *UpdateNFSFileShareInput) SetNotificationPolicy(v string) *UpdateNFSFileShareInput

SetNotificationPolicy sets the NotificationPolicy 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSMBFileShareInput added in v1.14.16 

type UpdateSMBFileShareInput struct {

	// The files and folders on this share will only be visible to users with read
	// access.
	AccessBasedEnumeration *bool `type:"boolean"`

	// A list of users or groups in the Active Directory that have administrator
	// rights to the file share. A group must be prefixed with the @ character.
	// Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1.
	// Can only be set if Authentication is set to ActiveDirectory.
	AdminUserList []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the storage used for audit logs.
	AuditDestinationARN *string `type:"string"`

	// Specifies refresh cache information for the file share.
	CacheAttributes *CacheAttributes `type:"structure"`

	// The case of an object name in an Amazon S3 bucket. For ClientSpecified, the
	// client determines the case sensitivity. For CaseSensitive, the gateway determines
	// the case sensitivity. The default value is ClientSpecified.
	CaseSensitivity *string `type:"string" enum:"CaseSensitivity"`

	// The default storage class for objects put into an Amazon S3 bucket by the
	// S3 File Gateway. The default value is S3_STANDARD. Optional.
	//
	// Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
	DefaultStorageClass *string `min:"5" type:"string"`

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

	// The name of the file share. Optional.
	//
	// FileShareName must be set if an S3 prefix name is set in LocationARN, or
	// if an access point or access point alias is used.
	FileShareName *string `min:"1" type:"string"`

	// A value that enables guessing of the MIME type for uploaded objects based
	// on file extensions. Set this value to true to enable MIME type guessing,
	// otherwise set to false. The default value is true.
	//
	// Valid Values: true | false
	GuessMIMETypeEnabled *bool `type:"boolean"`

	// A list of users or groups in the Active Directory that are not allowed to
	// access the file share. A group must be prefixed with the @ character. Acceptable
	// formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only
	// be set if Authentication is set to ActiveDirectory.
	InvalidUserList []*string `type:"list"`

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

	// The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
	// for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
	// CMKs. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"7" type:"string"`

	// The notification policy of the file share. SettlingTimeInSeconds controls
	// the number of seconds to wait after the last point in time a client wrote
	// to a file before generating an ObjectUploaded notification. Because clients
	// can make many small writes to files, it's best to set this parameter for
	// as long as possible to avoid generating multiple notifications for the same
	// file in a small time period.
	//
	// SettlingTimeInSeconds has no effect on the timing of the object uploading
	// to Amazon S3, only the timing of the notification.
	//
	// The following example sets NotificationPolicy on with SettlingTimeInSeconds
	// set to 60.
	//
	// {\"Upload\": {\"SettlingTimeInSeconds\": 60}}
	//
	// The following example sets NotificationPolicy off.
	//
	// {}
	NotificationPolicy *string `min:"2" type:"string"`

	// A value that sets the access control list (ACL) permission for objects in
	// the S3 bucket that a S3 File Gateway puts objects into. The default value
	// is private.
	ObjectACL *string `type:"string" enum:"ObjectACL"`

	// Specifies whether opportunistic locking is enabled for the SMB file share.
	//
	// Enabling opportunistic locking on case-sensitive shares is not recommended
	// for workloads that involve access to files with the same name in different
	// case.
	//
	// Valid Values: true | false
	OplocksEnabled *bool `type:"boolean"`

	// A value that sets the write status of a file share. Set this value to true
	// to set write status to read-only, otherwise set to false.
	//
	// Valid Values: true | false
	ReadOnly *bool `type:"boolean"`

	// A value that sets who pays the cost of the request and the cost associated
	// with data download from the S3 bucket. If this value is set to true, the
	// requester pays the costs; otherwise, the S3 bucket owner pays. However, the
	// S3 bucket owner always pays the cost of storing data.
	//
	// RequesterPays is a configuration for the S3 bucket that backs the file share,
	// so make sure that the configuration on the file share is the same as the
	// S3 bucket configuration.
	//
	// Valid Values: true | false
	RequesterPays *bool `type:"boolean"`

	// Set this value to true to enable access control list (ACL) on the SMB file
	// share. Set it to false to map file and directory permissions to the POSIX
	// permissions.
	//
	// For more information, see Using Microsoft Windows ACLs to control access
	// to an SMB file share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html)
	// in the Storage Gateway User Guide.
	//
	// Valid Values: true | false
	SMBACLEnabled *bool `type:"boolean"`

	// A list of users or groups in the Active Directory that are allowed to access
	// the file share. A group must be prefixed with the @ character. Acceptable
	// formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only
	// be set if Authentication is set to ActiveDirectory.
	ValidUserList []*string `type:"list"`
	// contains filtered or unexported fields
}

UpdateSMBFileShareInput

func (UpdateSMBFileShareInput) GoString added in v1.14.16 

func (s UpdateSMBFileShareInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBFileShareInput) SetAccessBasedEnumeration added in v1.35.18 

func (s *UpdateSMBFileShareInput) SetAccessBasedEnumeration(v bool) *UpdateSMBFileShareInput

SetAccessBasedEnumeration sets the AccessBasedEnumeration field's value.

func (*UpdateSMBFileShareInput) SetAdminUserList added in v1.19.26 

func (s *UpdateSMBFileShareInput) SetAdminUserList(v []*string) *UpdateSMBFileShareInput

SetAdminUserList sets the AdminUserList field's value.

func (*UpdateSMBFileShareInput) SetAuditDestinationARN added in v1.30.1 

func (s *UpdateSMBFileShareInput) SetAuditDestinationARN(v string) *UpdateSMBFileShareInput

SetAuditDestinationARN sets the AuditDestinationARN field's value.

func (*UpdateSMBFileShareInput) SetCacheAttributes added in v1.33.3 

func (s *UpdateSMBFileShareInput) SetCacheAttributes(v *CacheAttributes) *UpdateSMBFileShareInput

SetCacheAttributes sets the CacheAttributes field's value.

func (*UpdateSMBFileShareInput) SetCaseSensitivity added in v1.33.3 

func (s *UpdateSMBFileShareInput) SetCaseSensitivity(v string) *UpdateSMBFileShareInput

SetCaseSensitivity sets the CaseSensitivity field's value.

func (*UpdateSMBFileShareInput) SetDefaultStorageClass added in v1.14.16 

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

SetDefaultStorageClass sets the DefaultStorageClass field's value.

func (*UpdateSMBFileShareInput) SetFileShareARN added in v1.14.16 

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

SetFileShareARN sets the FileShareARN field's value.

func (*UpdateSMBFileShareInput) SetFileShareName added in v1.33.3 

func (s *UpdateSMBFileShareInput) SetFileShareName(v string) *UpdateSMBFileShareInput

SetFileShareName sets the FileShareName field's value.

func (*UpdateSMBFileShareInput) SetGuessMIMETypeEnabled added in v1.14.16 

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

SetGuessMIMETypeEnabled sets the GuessMIMETypeEnabled field's value.

func (*UpdateSMBFileShareInput) SetInvalidUserList added in v1.14.16 

func (s *UpdateSMBFileShareInput) SetInvalidUserList(v []*string) *UpdateSMBFileShareInput

SetInvalidUserList sets the InvalidUserList field's value.

func (*UpdateSMBFileShareInput) SetKMSEncrypted added in v1.14.16 

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

SetKMSEncrypted sets the KMSEncrypted field's value.

func (*UpdateSMBFileShareInput) SetKMSKey added in v1.14.16 

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

SetKMSKey sets the KMSKey field's value.

func (*UpdateSMBFileShareInput) SetNotificationPolicy added in v1.35.18 

func (s *UpdateSMBFileShareInput) SetNotificationPolicy(v string) *UpdateSMBFileShareInput

SetNotificationPolicy sets the NotificationPolicy field's value.

func (*UpdateSMBFileShareInput) SetObjectACL added in v1.14.16 

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

SetObjectACL sets the ObjectACL field's value.

func (*UpdateSMBFileShareInput) SetOplocksEnabled added in v1.39.2 

func (s *UpdateSMBFileShareInput) SetOplocksEnabled(v bool) *UpdateSMBFileShareInput

SetOplocksEnabled sets the OplocksEnabled field's value.

func (*UpdateSMBFileShareInput) SetReadOnly added in v1.14.16 

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

SetReadOnly sets the ReadOnly field's value.

func (*UpdateSMBFileShareInput) SetRequesterPays added in v1.14.16 

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

SetRequesterPays sets the RequesterPays field's value.

func (*UpdateSMBFileShareInput) SetSMBACLEnabled added in v1.19.16 

func (s *UpdateSMBFileShareInput) SetSMBACLEnabled(v bool) *UpdateSMBFileShareInput

SetSMBACLEnabled sets the SMBACLEnabled field's value.

func (*UpdateSMBFileShareInput) SetValidUserList added in v1.14.16 

func (s *UpdateSMBFileShareInput) SetValidUserList(v []*string) *UpdateSMBFileShareInput

SetValidUserList sets the ValidUserList field's value.

func (UpdateSMBFileShareInput) String added in v1.14.16 

func (s UpdateSMBFileShareInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBFileShareInput) Validate added in v1.14.16 

func (s *UpdateSMBFileShareInput) Validate() error

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

type UpdateSMBFileShareOutput added in v1.14.16 

type UpdateSMBFileShareOutput struct {

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

UpdateSMBFileShareOutput

func (UpdateSMBFileShareOutput) GoString added in v1.14.16 

func (s UpdateSMBFileShareOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBFileShareOutput) SetFileShareARN added in v1.14.16 

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

SetFileShareARN sets the FileShareARN field's value.

func (UpdateSMBFileShareOutput) String added in v1.14.16 

func (s UpdateSMBFileShareOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSMBFileShareVisibilityInput added in v1.35.18 

type UpdateSMBFileShareVisibilityInput struct {

	// The shares on this gateway appear when listing shares.
	//
	// FileSharesVisible is a required field
	FileSharesVisible *bool `type:"boolean" required:"true"`

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

func (UpdateSMBFileShareVisibilityInput) GoString added in v1.35.18 

func (s UpdateSMBFileShareVisibilityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBFileShareVisibilityInput) SetFileSharesVisible added in v1.35.18 

func (s *UpdateSMBFileShareVisibilityInput) SetFileSharesVisible(v bool) *UpdateSMBFileShareVisibilityInput

SetFileSharesVisible sets the FileSharesVisible field's value.

func (*UpdateSMBFileShareVisibilityInput) SetGatewayARN added in v1.35.18 

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

SetGatewayARN sets the GatewayARN field's value.

func (UpdateSMBFileShareVisibilityInput) String added in v1.35.18 

func (s UpdateSMBFileShareVisibilityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBFileShareVisibilityInput) Validate added in v1.35.18 

func (s *UpdateSMBFileShareVisibilityInput) Validate() error

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

type UpdateSMBFileShareVisibilityOutput added in v1.35.18 

type UpdateSMBFileShareVisibilityOutput struct {

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

func (UpdateSMBFileShareVisibilityOutput) GoString added in v1.35.18 

func (s UpdateSMBFileShareVisibilityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBFileShareVisibilityOutput) SetGatewayARN added in v1.35.18 

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

SetGatewayARN sets the GatewayARN field's value.

func (UpdateSMBFileShareVisibilityOutput) String added in v1.35.18 

func (s UpdateSMBFileShareVisibilityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSMBLocalGroupsInput added in v1.41.2 

type UpdateSMBLocalGroupsInput struct {

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

	// A list of Active Directory users and groups that you want to grant special
	// permissions for SMB file shares on the gateway.
	//
	// SMBLocalGroups is a required field
	SMBLocalGroups *SMBLocalGroups `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSMBLocalGroupsInput) GoString added in v1.41.2 

func (s UpdateSMBLocalGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBLocalGroupsInput) SetGatewayARN added in v1.41.2 

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

SetGatewayARN sets the GatewayARN field's value.

func (*UpdateSMBLocalGroupsInput) SetSMBLocalGroups added in v1.41.2 

func (s *UpdateSMBLocalGroupsInput) SetSMBLocalGroups(v *SMBLocalGroups) *UpdateSMBLocalGroupsInput

SetSMBLocalGroups sets the SMBLocalGroups field's value.

func (UpdateSMBLocalGroupsInput) String added in v1.41.2 

func (s UpdateSMBLocalGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBLocalGroupsInput) Validate added in v1.41.2 

func (s *UpdateSMBLocalGroupsInput) Validate() error

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

type UpdateSMBLocalGroupsOutput added in v1.41.2 

type UpdateSMBLocalGroupsOutput struct {

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

func (UpdateSMBLocalGroupsOutput) GoString added in v1.41.2 

func (s UpdateSMBLocalGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBLocalGroupsOutput) SetGatewayARN added in v1.41.2 

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

SetGatewayARN sets the GatewayARN field's value.

func (UpdateSMBLocalGroupsOutput) String added in v1.41.2 

func (s UpdateSMBLocalGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSMBSecurityStrategyInput added in v1.19.43 

type UpdateSMBSecurityStrategyInput struct {

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

	// Specifies the type of security strategy.
	//
	// ClientSpecified: if you use this option, requests are established based on
	// what is negotiated by the client. This option is recommended when you want
	// to maximize compatibility across different clients in your environment. Supported
	// only in S3 File Gateway.
	//
	// MandatorySigning: if you use this option, file gateway only allows connections
	// from SMBv2 or SMBv3 clients that have signing enabled. This option works
	// with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
	//
	// MandatoryEncryption: if you use this option, file gateway only allows connections
	// from SMBv3 clients that have encryption enabled. This option is highly recommended
	// for environments that handle sensitive data. This option works with SMB clients
	// on Microsoft Windows 8, Windows Server 2012 or newer.
	//
	// SMBSecurityStrategy is a required field
	SMBSecurityStrategy *string `type:"string" required:"true" enum:"SMBSecurityStrategy"`
	// contains filtered or unexported fields
}

func (UpdateSMBSecurityStrategyInput) GoString added in v1.19.43 

func (s UpdateSMBSecurityStrategyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBSecurityStrategyInput) SetGatewayARN added in v1.19.43 

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

SetGatewayARN sets the GatewayARN field's value.

func (*UpdateSMBSecurityStrategyInput) SetSMBSecurityStrategy added in v1.19.43 

func (s *UpdateSMBSecurityStrategyInput) SetSMBSecurityStrategy(v string) *UpdateSMBSecurityStrategyInput

SetSMBSecurityStrategy sets the SMBSecurityStrategy field's value.

func (UpdateSMBSecurityStrategyInput) String added in v1.19.43 

func (s UpdateSMBSecurityStrategyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBSecurityStrategyInput) Validate added in v1.19.43 

func (s *UpdateSMBSecurityStrategyInput) Validate() error

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

type UpdateSMBSecurityStrategyOutput added in v1.19.43 

type UpdateSMBSecurityStrategyOutput struct {

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

func (UpdateSMBSecurityStrategyOutput) GoString added in v1.19.43 

func (s UpdateSMBSecurityStrategyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSMBSecurityStrategyOutput) SetGatewayARN added in v1.19.43 

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

SetGatewayARN sets the GatewayARN field's value.

func (UpdateSMBSecurityStrategyOutput) String added in v1.19.43 

func (s UpdateSMBSecurityStrategyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// A list of up to 50 tags that can be assigned to a snapshot. Each tag is a
	// key-value pair.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @. The
	// maximum length of a tag's key is 128 characters, and the maximum length for
	// a tag's value is 256.
	Tags []*Tag `type:"list"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetTags added in v1.19.30 

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

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

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

A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.

func (UpdateSnapshotScheduleOutput) GoString added in v0.6.5 

func (s UpdateSnapshotScheduleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateVTLDeviceTypeInput 

type UpdateVTLDeviceTypeInput struct {

	// The type of medium changer you want to select.
	//
	// Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// Specifies the model number of device that the VTL device emulates.
	VTLDeviceProductIdentifier *string `type:"string"`

	// Specifies the type of device that the VTL device emulates.
	VTLDeviceType *string `type:"string"`

	// Specifies the vendor of the device that the VTL device object emulates.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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 Amazon Web Services 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"`

	// One of the VolumeStatus values that indicates the state of the storage volume.
	VolumeAttachmentStatus *string `min:"3" 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"`

	// One of the VolumeType enumeration values describing the type of the volume.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetVolumeAttachmentStatus added in v1.16.19 

func (s *VolumeInfo) SetVolumeAttachmentStatus(v string) *VolumeInfo

SetVolumeAttachmentStatus sets the VolumeAttachmentStatus 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VolumeRecoveryPointInfo 

type VolumeRecoveryPointInfo struct {

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

	// The time the recovery point was taken.
	VolumeRecoveryPointTime *string `type:"string"`

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

	// 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.
	VolumeUsageInBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

Describes a storage volume recovery point object.

func (VolumeRecoveryPointInfo) GoString added in v0.6.5 

func (s VolumeRecoveryPointInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.