storagegateway

package
v0.15.0 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2019 License: Apache-2.0 Imports: 7 Imported by: 30

Documentation

Overview

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

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

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

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

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

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:

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

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

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

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

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

Using the Client

To use 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 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 (
	ServiceName = "AWS Storage Gateway" // Service's name
	ServiceID   = "StorageGateway"      // Service's identifier
	EndpointsID = "storagegateway"      // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateGatewayInput

type ActivateGatewayInput struct {

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

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

	// A value that indicates the AWS Region where you want to store your data.
	// The gateway AWS Region specified must be the same AWS Region as the AWS Region
	// in your Host header in the request. For more information about available
	// AWS Regions and endpoints for AWS Storage Gateway, see Regions and Endpoints
	// (https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region) in the
	// Amazon Web Services Glossary.
	//
	// Valid Values: See AWS Storage Gateway Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region)
	// in the AWS 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", "FILE_S3"
	GatewayType *string `min:"2" type:"string"`

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

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

  • ActivateGatewayInput$MediumChangerType

func (ActivateGatewayInput) String

func (s ActivateGatewayInput) String() string

String returns the string representation

func (*ActivateGatewayInput) Validate

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

AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and AWS 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) String

func (s ActivateGatewayOutput) String() string

String returns the string representation

type ActivateGatewayRequest

type ActivateGatewayRequest struct {
	*aws.Request
	Input *ActivateGatewayInput
	Copy  func(*ActivateGatewayInput) ActivateGatewayRequest
}

ActivateGatewayRequest is the request type for the ActivateGateway API operation.

func (ActivateGatewayRequest) Send

Send marshals and sends the ActivateGateway API request.

type ActivateGatewayResponse added in v0.9.0

type ActivateGatewayResponse struct {
	*ActivateGatewayOutput
	// contains filtered or unexported fields
}

ActivateGatewayResponse is the response type for the ActivateGateway API operation.

func (*ActivateGatewayResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ActivateGateway request.

type AddCacheInput

type AddCacheInput struct {

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

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

func (AddCacheInput) String

func (s AddCacheInput) String() string

String returns the string representation

func (*AddCacheInput) Validate

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

func (AddCacheOutput) String

func (s AddCacheOutput) String() string

String returns the string representation

type AddCacheRequest

type AddCacheRequest struct {
	*aws.Request
	Input *AddCacheInput
	Copy  func(*AddCacheInput) AddCacheRequest
}

AddCacheRequest is the request type for the AddCache API operation.

func (AddCacheRequest) Send

Send marshals and sends the AddCache API request.

type AddCacheResponse added in v0.9.0

type AddCacheResponse struct {
	*AddCacheOutput
	// contains filtered or unexported fields
}

AddCacheResponse is the response type for the AddCache API operation.

func (*AddCacheResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the AddCache request.

type AddTagsToResourceInput

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) String

func (s AddTagsToResourceInput) String() string

String returns the string representation

func (*AddTagsToResourceInput) Validate

func (s *AddTagsToResourceInput) Validate() error

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

type AddTagsToResourceOutput

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) String

func (s AddTagsToResourceOutput) String() string

String returns the string representation

type AddTagsToResourceRequest

type AddTagsToResourceRequest struct {
	*aws.Request
	Input *AddTagsToResourceInput
	Copy  func(*AddTagsToResourceInput) AddTagsToResourceRequest
}

AddTagsToResourceRequest is the request type for the AddTagsToResource API operation.

func (AddTagsToResourceRequest) Send

Send marshals and sends the AddTagsToResource API request.

type AddTagsToResourceResponse added in v0.9.0

type AddTagsToResourceResponse struct {
	*AddTagsToResourceOutput
	// contains filtered or unexported fields
}

AddTagsToResourceResponse is the response type for the AddTagsToResource API operation.

func (*AddTagsToResourceResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the AddTagsToResource request.

type AddUploadBufferInput

type AddUploadBufferInput struct {

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

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

func (AddUploadBufferInput) String

func (s AddUploadBufferInput) String() string

String returns the string representation

func (*AddUploadBufferInput) Validate

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

func (AddUploadBufferOutput) String

func (s AddUploadBufferOutput) String() string

String returns the string representation

type AddUploadBufferRequest

type AddUploadBufferRequest struct {
	*aws.Request
	Input *AddUploadBufferInput
	Copy  func(*AddUploadBufferInput) AddUploadBufferRequest
}

AddUploadBufferRequest is the request type for the AddUploadBuffer API operation.

func (AddUploadBufferRequest) Send

Send marshals and sends the AddUploadBuffer API request.

type AddUploadBufferResponse added in v0.9.0

type AddUploadBufferResponse struct {
	*AddUploadBufferOutput
	// contains filtered or unexported fields
}

AddUploadBufferResponse is the response type for the AddUploadBuffer API operation.

func (*AddUploadBufferResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the AddUploadBuffer request.

type AddWorkingStorageInput

type AddWorkingStorageInput struct {

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

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and AWS 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) String

func (s AddWorkingStorageInput) String() string

String returns the string representation

func (*AddWorkingStorageInput) Validate

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

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

func (AddWorkingStorageOutput) String

func (s AddWorkingStorageOutput) String() string

String returns the string representation

type AddWorkingStorageRequest

type AddWorkingStorageRequest struct {
	*aws.Request
	Input *AddWorkingStorageInput
	Copy  func(*AddWorkingStorageInput) AddWorkingStorageRequest
}

AddWorkingStorageRequest is the request type for the AddWorkingStorage API operation.

func (AddWorkingStorageRequest) Send

Send marshals and sends the AddWorkingStorage API request.

type AddWorkingStorageResponse added in v0.9.0

type AddWorkingStorageResponse struct {
	*AddWorkingStorageOutput
	// contains filtered or unexported fields
}

AddWorkingStorageResponse is the response type for the AddWorkingStorage API operation.

func (*AddWorkingStorageResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the AddWorkingStorage request.

type AssignTapePoolInput added in v0.9.0

type AssignTapePoolInput struct {

	// 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 (Glacier or Deep Archive) that
	// corresponds to the pool.
	//
	// Valid values: "GLACIER", "DEEP_ARCHIVE"
	//
	// 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) String added in v0.9.0

func (s AssignTapePoolInput) String() string

String returns the string representation

func (*AssignTapePoolInput) Validate added in v0.9.0

func (s *AssignTapePoolInput) Validate() error

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

type AssignTapePoolOutput added in v0.9.0

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

func (s AssignTapePoolOutput) String() string

String returns the string representation

type AssignTapePoolRequest added in v0.9.0

type AssignTapePoolRequest struct {
	*aws.Request
	Input *AssignTapePoolInput
	Copy  func(*AssignTapePoolInput) AssignTapePoolRequest
}

AssignTapePoolRequest is the request type for the AssignTapePool API operation.

func (AssignTapePoolRequest) Send added in v0.9.0

Send marshals and sends the AssignTapePool API request.

type AssignTapePoolResponse added in v0.9.0

type AssignTapePoolResponse struct {
	*AssignTapePoolOutput
	// contains filtered or unexported fields
}

AssignTapePoolResponse is the response type for the AssignTapePool API operation.

func (*AssignTapePoolResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the AssignTapePool request.

type AttachVolumeInput added in v0.8.0

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) String added in v0.8.0

func (s AttachVolumeInput) String() string

String returns the string representation

func (*AttachVolumeInput) Validate added in v0.8.0

func (s *AttachVolumeInput) Validate() error

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

type AttachVolumeOutput added in v0.8.0

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) String added in v0.8.0

func (s AttachVolumeOutput) String() string

String returns the string representation

type AttachVolumeRequest added in v0.8.0

type AttachVolumeRequest struct {
	*aws.Request
	Input *AttachVolumeInput
	Copy  func(*AttachVolumeInput) AttachVolumeRequest
}

AttachVolumeRequest is the request type for the AttachVolume API operation.

func (AttachVolumeRequest) Send added in v0.8.0

Send marshals and sends the AttachVolume API request.

type AttachVolumeResponse added in v0.9.0

type AttachVolumeResponse struct {
	*AttachVolumeOutput
	// contains filtered or unexported fields
}

AttachVolumeResponse is the response type for the AttachVolume API operation.

func (*AttachVolumeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the AttachVolume request.

type CachediSCSIVolume

type CachediSCSIVolume struct {

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

	// The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server
	// side encryption. 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.
	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) String

func (s CachediSCSIVolume) String() string

String returns the string representation

type CancelArchivalInput

type CancelArchivalInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and AWS 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) String

func (s CancelArchivalInput) String() string

String returns the string representation

func (*CancelArchivalInput) Validate

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) String

func (s CancelArchivalOutput) String() string

String returns the string representation

type CancelArchivalRequest

type CancelArchivalRequest struct {
	*aws.Request
	Input *CancelArchivalInput
	Copy  func(*CancelArchivalInput) CancelArchivalRequest
}

CancelArchivalRequest is the request type for the CancelArchival API operation.

func (CancelArchivalRequest) Send

Send marshals and sends the CancelArchival API request.

type CancelArchivalResponse added in v0.9.0

type CancelArchivalResponse struct {
	*CancelArchivalOutput
	// contains filtered or unexported fields
}

CancelArchivalResponse is the response type for the CancelArchival API operation.

func (*CancelArchivalResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the CancelArchival request.

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 AWS 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) String

func (s CancelRetrievalInput) String() string

String returns the string representation

func (*CancelRetrievalInput) Validate

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) String

func (s CancelRetrievalOutput) String() string

String returns the string representation

type CancelRetrievalRequest

type CancelRetrievalRequest struct {
	*aws.Request
	Input *CancelRetrievalInput
	Copy  func(*CancelRetrievalInput) CancelRetrievalRequest
}

CancelRetrievalRequest is the request type for the CancelRetrieval API operation.

func (CancelRetrievalRequest) Send

Send marshals and sends the CancelRetrieval API request.

type CancelRetrievalResponse added in v0.9.0

type CancelRetrievalResponse struct {
	*CancelRetrievalOutput
	// contains filtered or unexported fields
}

CancelRetrievalResponse is the response type for the CancelRetrieval API operation.

func (*CancelRetrievalResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the CancelRetrieval request.

type ChapInfo

type ChapInfo struct {

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

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

	// The secret key that the target must provide to participate in mutual CHAP
	// with the initiator (e.g. Windows client).
	SecretToAuthenticateTarget *string `min:"1" type:"string" 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) String

func (s ChapInfo) String() string

String returns the string representation

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

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

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

func New

func New(config aws.Config) *Client

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

Example:

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

func (*Client) ActivateGatewayRequest added in v0.9.0

func (c *Client) ActivateGatewayRequest(input *ActivateGatewayInput) ActivateGatewayRequest

ActivateGatewayRequest returns a request value for making 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 AWS 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.ActivateGatewayRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) AddCacheRequest added in v0.9.0

func (c *Client) AddCacheRequest(input *AddCacheInput) AddCacheRequest

AddCacheRequest returns a request value for making API operation for AWS Storage Gateway.

Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts (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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

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

	req := svc.AddCacheRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) AddTagsToResourceRequest added in v0.9.0

func (c *Client) AddTagsToResourceRequest(input *AddTagsToResourceInput) AddTagsToResourceRequest

AddTagsToResourceRequest returns a request value for making API operation for AWS Storage Gateway.

Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:

  • Storage gateways of all types

  • Storage volumes

  • Virtual tapes

  • NFS and SMB file shares

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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
			},
		},
	}

	req := svc.AddTagsToResourceRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) AddUploadBufferRequest added in v0.9.0

func (c *Client) AddUploadBufferRequest(input *AddUploadBufferInput) AddUploadBufferRequest

AddUploadBufferRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

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

	req := svc.AddUploadBufferRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) AddWorkingStorageRequest added in v0.9.0

func (c *Client) AddWorkingStorageRequest(input *AddWorkingStorageInput) AddWorkingStorageRequest

AddWorkingStorageRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

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

	req := svc.AddWorkingStorageRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) AssignTapePoolRequest added in v0.9.0

func (c *Client) AssignTapePoolRequest(input *AssignTapePoolInput) AssignTapePoolRequest

AssignTapePoolRequest returns a request value for making 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 (Glacier or Deep Archive) that corresponds to the pool.

Valid values: "GLACIER", "DEEP_ARCHIVE"

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssignTapePool

func (*Client) AttachVolumeRequest added in v0.9.0

func (c *Client) AttachVolumeRequest(input *AttachVolumeInput) AttachVolumeRequest

AttachVolumeRequest returns a request value for making 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.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AttachVolume

func (*Client) CancelArchivalRequest added in v0.9.0

func (c *Client) CancelArchivalRequest(input *CancelArchivalInput) CancelArchivalRequest

CancelArchivalRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.CancelArchivalRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) CancelRetrievalRequest added in v0.9.0

func (c *Client) CancelRetrievalRequest(input *CancelRetrievalInput) CancelRetrievalRequest

CancelRetrievalRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.CancelRetrievalRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) CreateCachediSCSIVolumeRequest added in v0.9.0

func (c *Client) CreateCachediSCSIVolumeRequest(input *CreateCachediSCSIVolumeInput) CreateCachediSCSIVolumeRequest

CreateCachediSCSIVolumeRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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),
	}

	req := svc.CreateCachediSCSIVolumeRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) CreateNFSFileShareRequest added in v0.9.0

func (c *Client) CreateNFSFileShareRequest(input *CreateNFSFileShareInput) CreateNFSFileShareRequest

CreateNFSFileShareRequest returns a request value for making API operation for AWS Storage Gateway.

Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways.

File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateway does not support creating hard or symbolic links on a file share.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateNFSFileShare

func (*Client) CreateSMBFileShareRequest added in v0.9.0

func (c *Client) CreateSMBFileShareRequest(input *CreateSMBFileShareInput) CreateSMBFileShareRequest

CreateSMBFileShareRequest returns a request value for making API operation for AWS Storage Gateway.

Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways.

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the AWS Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateSMBFileShare

func (*Client) CreateSnapshotFromVolumeRecoveryPointRequest added in v0.9.0

func (c *Client) CreateSnapshotFromVolumeRecoveryPointRequest(input *CreateSnapshotFromVolumeRecoveryPointInput) CreateSnapshotFromVolumeRecoveryPointRequest

CreateSnapshotFromVolumeRecoveryPointRequest returns a request value for making API operation for AWS Storage Gateway.

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.CreateSnapshotFromVolumeRecoveryPointRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) CreateSnapshotRequest added in v0.9.0

func (c *Client) CreateSnapshotRequest(input *CreateSnapshotInput) CreateSnapshotRequest

CreateSnapshotRequest returns a request value for making API operation for AWS Storage Gateway.

Initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule (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 AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html).

Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome (https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html) page.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.CreateSnapshotRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) CreateStorediSCSIVolumeRequest added in v0.9.0

func (c *Client) CreateStorediSCSIVolumeRequest(input *CreateStorediSCSIVolumeInput) CreateStorediSCSIVolumeRequest

CreateStorediSCSIVolumeRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.CreateStorediSCSIVolumeRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) CreateTapeWithBarcodeRequest added in v0.9.0

func (c *Client) CreateTapeWithBarcodeRequest(input *CreateTapeWithBarcodeInput) CreateTapeWithBarcodeRequest

CreateTapeWithBarcodeRequest returns a request value for making API operation for AWS Storage Gateway.

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.CreateTapeWithBarcodeInput{
		GatewayARN:      aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		TapeBarcode:     aws.String("TEST12345"),
		TapeSizeInBytes: aws.Int64(107374182400),
	}

	req := svc.CreateTapeWithBarcodeRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) CreateTapesRequest added in v0.9.0

func (c *Client) CreateTapesRequest(input *CreateTapesInput) CreateTapesRequest

CreateTapesRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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),
	}

	req := svc.CreateTapesRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DeleteBandwidthRateLimitRequest added in v0.9.0

func (c *Client) DeleteBandwidthRateLimitRequest(input *DeleteBandwidthRateLimitInput) DeleteBandwidthRateLimitRequest

DeleteBandwidthRateLimitRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DeleteBandwidthRateLimitInput{
		BandwidthType: aws.String("All"),
		GatewayARN:    aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DeleteBandwidthRateLimitRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DeleteChapCredentialsRequest added in v0.9.0

func (c *Client) DeleteChapCredentialsRequest(input *DeleteChapCredentialsInput) DeleteChapCredentialsRequest

DeleteChapCredentialsRequest returns a request value for making API operation for AWS Storage Gateway.

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.DeleteChapCredentialsRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DeleteFileShareRequest added in v0.9.0

func (c *Client) DeleteFileShareRequest(input *DeleteFileShareInput) DeleteFileShareRequest

DeleteFileShareRequest returns a request value for making API operation for AWS Storage Gateway.

Deletes a file share from a file gateway. This operation is only supported for file gateways.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteFileShare

func (*Client) DeleteGatewayRequest added in v0.9.0

func (c *Client) DeleteGatewayRequest(input *DeleteGatewayInput) DeleteGatewayRequest

DeleteGatewayRequest returns a request value for making API operation for AWS Storage Gateway.

Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page (http://aws.amazon.com/storagegateway).

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DeleteGatewayInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DeleteGatewayRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DeleteSnapshotScheduleRequest added in v0.9.0

func (c *Client) DeleteSnapshotScheduleRequest(input *DeleteSnapshotScheduleInput) DeleteSnapshotScheduleRequest

DeleteSnapshotScheduleRequest returns a request value for making API operation for AWS Storage Gateway.

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots (https://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html). In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.

To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DeleteSnapshotScheduleInput{
		VolumeARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
	}

	req := svc.DeleteSnapshotScheduleRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DeleteTapeArchiveRequest added in v0.9.0

func (c *Client) DeleteTapeArchiveRequest(input *DeleteTapeArchiveInput) DeleteTapeArchiveRequest

DeleteTapeArchiveRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DeleteTapeArchiveInput{
		TapeARN: aws.String("arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"),
	}

	req := svc.DeleteTapeArchiveRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DeleteTapeRequest added in v0.9.0

func (c *Client) DeleteTapeRequest(input *DeleteTapeInput) DeleteTapeRequest

DeleteTapeRequest returns a request value for making API operation for AWS Storage Gateway.

Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.DeleteTapeRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DeleteVolumeRequest added in v0.9.0

func (c *Client) DeleteVolumeRequest(input *DeleteVolumeInput) DeleteVolumeRequest

DeleteVolumeRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DeleteVolumeInput{
		VolumeARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
	}

	req := svc.DeleteVolumeRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeBandwidthRateLimitRequest added in v0.9.0

func (c *Client) DescribeBandwidthRateLimitRequest(input *DescribeBandwidthRateLimitInput) DescribeBandwidthRateLimitRequest

DescribeBandwidthRateLimitRequest returns a request value for making API operation for AWS Storage Gateway.

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeBandwidthRateLimitInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DescribeBandwidthRateLimitRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeCacheRequest added in v0.9.0

func (c *Client) DescribeCacheRequest(input *DescribeCacheInput) DescribeCacheRequest

DescribeCacheRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeCacheInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DescribeCacheRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeCachediSCSIVolumesRequest added in v0.9.0

func (c *Client) DescribeCachediSCSIVolumesRequest(input *DescribeCachediSCSIVolumesInput) DescribeCachediSCSIVolumesRequest

DescribeCachediSCSIVolumesRequest returns a request value for making API operation for AWS Storage Gateway.

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeCachediSCSIVolumesInput{
		VolumeARNs: []string{
			"arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
		},
	}

	req := svc.DescribeCachediSCSIVolumesRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeChapCredentialsRequest added in v0.9.0

func (c *Client) DescribeChapCredentialsRequest(input *DescribeChapCredentialsInput) DescribeChapCredentialsRequest

DescribeChapCredentialsRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeChapCredentialsInput{
		TargetARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"),
	}

	req := svc.DescribeChapCredentialsRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeGatewayInformationRequest added in v0.9.0

func (c *Client) DescribeGatewayInformationRequest(input *DescribeGatewayInformationInput) DescribeGatewayInformationRequest

DescribeGatewayInformationRequest returns a request value for making API operation for AWS Storage Gateway.

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeGatewayInformationInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DescribeGatewayInformationRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeMaintenanceStartTimeRequest added in v0.9.0

func (c *Client) DescribeMaintenanceStartTimeRequest(input *DescribeMaintenanceStartTimeInput) DescribeMaintenanceStartTimeRequest

DescribeMaintenanceStartTimeRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeMaintenanceStartTimeInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DescribeMaintenanceStartTimeRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeNFSFileSharesRequest added in v0.9.0

func (c *Client) DescribeNFSFileSharesRequest(input *DescribeNFSFileSharesInput) DescribeNFSFileSharesRequest

DescribeNFSFileSharesRequest returns a request value for making API operation for AWS Storage Gateway.

Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares

func (*Client) DescribeSMBFileSharesRequest added in v0.9.0

func (c *Client) DescribeSMBFileSharesRequest(input *DescribeSMBFileSharesInput) DescribeSMBFileSharesRequest

DescribeSMBFileSharesRequest returns a request value for making API operation for AWS Storage Gateway.

Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBFileShares

func (*Client) DescribeSMBSettingsRequest added in v0.9.0

func (c *Client) DescribeSMBSettingsRequest(input *DescribeSMBSettingsInput) DescribeSMBSettingsRequest

DescribeSMBSettingsRequest returns a request value for making 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.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettings

func (*Client) DescribeSnapshotScheduleRequest added in v0.9.0

func (c *Client) DescribeSnapshotScheduleRequest(input *DescribeSnapshotScheduleInput) DescribeSnapshotScheduleRequest

DescribeSnapshotScheduleRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeSnapshotScheduleInput{
		VolumeARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"),
	}

	req := svc.DescribeSnapshotScheduleRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeStorediSCSIVolumesRequest added in v0.9.0

func (c *Client) DescribeStorediSCSIVolumesRequest(input *DescribeStorediSCSIVolumesInput) DescribeStorediSCSIVolumesRequest

DescribeStorediSCSIVolumesRequest returns a request value for making API operation for AWS Storage Gateway.

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeStorediSCSIVolumesInput{
		VolumeARNs: []string{
			"arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
		},
	}

	req := svc.DescribeStorediSCSIVolumesRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeTapeArchivesRequest added in v0.9.0

func (c *Client) DescribeTapeArchivesRequest(input *DescribeTapeArchivesInput) DescribeTapeArchivesRequest

DescribeTapeArchivesRequest returns a request value for making API operation for AWS Storage Gateway.

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeTapeArchivesInput{
		Limit:  aws.Int64(123),
		Marker: aws.String("1"),
		TapeARNs: []string{
			"arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD",
			"arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4",
		},
	}

	req := svc.DescribeTapeArchivesRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeTapeRecoveryPointsRequest added in v0.9.0

func (c *Client) DescribeTapeRecoveryPointsRequest(input *DescribeTapeRecoveryPointsInput) DescribeTapeRecoveryPointsRequest

DescribeTapeRecoveryPointsRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeTapeRecoveryPointsInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		Limit:      aws.Int64(1),
		Marker:     aws.String("1"),
	}

	req := svc.DescribeTapeRecoveryPointsRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeTapesRequest added in v0.9.0

func (c *Client) DescribeTapesRequest(input *DescribeTapesInput) DescribeTapesRequest

DescribeTapesRequest returns a request value for making API operation for AWS Storage Gateway.

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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{
			"arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1",
			"arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0",
		},
	}

	req := svc.DescribeTapesRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeUploadBufferRequest added in v0.9.0

func (c *Client) DescribeUploadBufferRequest(input *DescribeUploadBufferInput) DescribeUploadBufferRequest

DescribeUploadBufferRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeUploadBufferInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DescribeUploadBufferRequest(input)
	result, err := req.Send(context.Background())
	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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeUploadBufferInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DescribeUploadBufferRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeVTLDevicesRequest added in v0.9.0

func (c *Client) DescribeVTLDevicesRequest(input *DescribeVTLDevicesInput) DescribeVTLDevicesRequest

DescribeVTLDevicesRequest returns a request value for making API operation for AWS Storage Gateway.

Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.

This operation is only supported in the tape gateway type.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeVTLDevicesInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		Limit:      aws.Int64(123),
		Marker:     aws.String("1"),
	}

	req := svc.DescribeVTLDevicesRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DescribeWorkingStorageRequest added in v0.9.0

func (c *Client) DescribeWorkingStorageRequest(input *DescribeWorkingStorageInput) DescribeWorkingStorageRequest

DescribeWorkingStorageRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DescribeWorkingStorageInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DescribeWorkingStorageRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) DetachVolumeRequest added in v0.9.0

func (c *Client) DetachVolumeRequest(input *DetachVolumeInput) DetachVolumeRequest

DetachVolumeRequest returns a request value for making 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.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DetachVolume

func (*Client) DisableGatewayRequest added in v0.9.0

func (c *Client) DisableGatewayRequest(input *DisableGatewayInput) DisableGatewayRequest

DisableGatewayRequest returns a request value for making API operation for AWS Storage Gateway.

Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

Once a gateway is disabled it cannot be enabled.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.DisableGatewayInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.DisableGatewayRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) JoinDomainRequest added in v0.9.0

func (c *Client) JoinDomainRequest(input *JoinDomainInput) JoinDomainRequest

JoinDomainRequest returns a request value for making 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.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/JoinDomain

func (*Client) ListFileSharesRequest added in v0.9.0

func (c *Client) ListFileSharesRequest(input *ListFileSharesInput) ListFileSharesRequest

ListFileSharesRequest returns a request value for making API operation for AWS Storage Gateway.

Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListFileShares

func (*Client) ListGatewaysRequest added in v0.9.0

func (c *Client) ListGatewaysRequest(input *ListGatewaysInput) ListGatewaysRequest

ListGatewaysRequest returns a request value for making API operation for AWS Storage Gateway.

Lists gateways owned by an AWS account in an AWS 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.ListGatewaysInput{
		Limit:  aws.Int64(2),
		Marker: aws.String("1"),
	}

	req := svc.ListGatewaysRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) ListLocalDisksRequest added in v0.9.0

func (c *Client) ListLocalDisksRequest(input *ListLocalDisksInput) ListLocalDisksRequest

ListLocalDisksRequest returns a request value for making 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).

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.ListLocalDisksInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.ListLocalDisksRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) ListTagsForResourceRequest added in v0.9.0

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS Storage Gateway.

Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.ListTagsForResourceInput{
		Limit:       aws.Int64(1),
		Marker:      aws.String("1"),
		ResourceARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"),
	}

	req := svc.ListTagsForResourceRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) ListTapesRequest added in v0.9.0

func (c *Client) ListTapesRequest(input *ListTapesInput) ListTapesRequest

ListTapesRequest returns a request value for making 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.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapes

func (*Client) ListVolumeInitiatorsRequest added in v0.9.0

func (c *Client) ListVolumeInitiatorsRequest(input *ListVolumeInitiatorsInput) ListVolumeInitiatorsRequest

ListVolumeInitiatorsRequest returns a request value for making 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.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListVolumeInitiators

func (*Client) ListVolumeRecoveryPointsRequest added in v0.9.0

func (c *Client) ListVolumeRecoveryPointsRequest(input *ListVolumeRecoveryPointsInput) ListVolumeRecoveryPointsRequest

ListVolumeRecoveryPointsRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.ListVolumeRecoveryPointsInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.ListVolumeRecoveryPointsRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) ListVolumesRequest added in v0.9.0

func (c *Client) ListVolumesRequest(input *ListVolumesInput) ListVolumesRequest

ListVolumesRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.ListVolumesInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
		Limit:      aws.Int64(2),
		Marker:     aws.String("1"),
	}

	req := svc.ListVolumesRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) NotifyWhenUploadedRequest added in v0.9.0

func (c *Client) NotifyWhenUploadedRequest(input *NotifyWhenUploadedInput) NotifyWhenUploadedRequest

NotifyWhenUploadedRequest returns a request value for making 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.

AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways.

For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/NotifyWhenUploaded

func (*Client) RefreshCacheRequest added in v0.9.0

func (c *Client) RefreshCacheRequest(input *RefreshCacheInput) RefreshCacheRequest

RefreshCacheRequest returns a request value for making API operation for AWS Storage Gateway.

Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. 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/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification).

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 an CloudWatch event when your RefreshCache operation completes.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RefreshCache

func (*Client) RemoveTagsFromResourceRequest added in v0.9.0

func (c *Client) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) RemoveTagsFromResourceRequest

RemoveTagsFromResourceRequest returns a request value for making API operation for AWS Storage Gateway.

Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.RemoveTagsFromResourceInput{
		ResourceARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"),
		TagKeys: []string{
			"Dev Gatgeway Region",
			"East Coast",
		},
	}

	req := svc.RemoveTagsFromResourceRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) ResetCacheRequest added in v0.9.0

func (c *Client) ResetCacheRequest(input *ResetCacheInput) ResetCacheRequest

ResetCacheRequest returns a request value for making API operation for AWS Storage Gateway.

Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.ResetCacheInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C"),
	}

	req := svc.ResetCacheRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) RetrieveTapeArchiveRequest added in v0.9.0

func (c *Client) RetrieveTapeArchiveRequest(input *RetrieveTapeArchiveInput) RetrieveTapeArchiveRequest

RetrieveTapeArchiveRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.RetrieveTapeArchiveRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) RetrieveTapeRecoveryPointRequest added in v0.9.0

func (c *Client) RetrieveTapeRecoveryPointRequest(input *RetrieveTapeRecoveryPointInput) RetrieveTapeRecoveryPointRequest

RetrieveTapeRecoveryPointRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.RetrieveTapeRecoveryPointRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) SetLocalConsolePasswordRequest added in v0.9.0

func (c *Client) SetLocalConsolePasswordRequest(input *SetLocalConsolePasswordInput) SetLocalConsolePasswordRequest

SetLocalConsolePasswordRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.SetLocalConsolePasswordInput{
		GatewayARN:           aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
		LocalConsolePassword: aws.String("PassWordMustBeAtLeast6Chars."),
	}

	req := svc.SetLocalConsolePasswordRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) SetSMBGuestPasswordRequest added in v0.9.0

func (c *Client) SetSMBGuestPasswordRequest(input *SetSMBGuestPasswordInput) SetSMBGuestPasswordRequest

SetSMBGuestPasswordRequest returns a request value for making 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.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SetSMBGuestPassword

func (*Client) ShutdownGatewayRequest added in v0.9.0

func (c *Client) ShutdownGatewayRequest(input *ShutdownGatewayInput) ShutdownGatewayRequest

ShutdownGatewayRequest returns a request value for making API operation for AWS Storage Gateway.

Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.ShutdownGatewayInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
	}

	req := svc.ShutdownGatewayRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) StartGatewayRequest added in v0.9.0

func (c *Client) StartGatewayRequest(input *StartGatewayInput) StartGatewayRequest

StartGatewayRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.StartGatewayInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"),
	}

	req := svc.StartGatewayRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) UpdateBandwidthRateLimitRequest added in v0.9.0

func (c *Client) UpdateBandwidthRateLimitRequest(input *UpdateBandwidthRateLimitInput) UpdateBandwidthRateLimitRequest

UpdateBandwidthRateLimitRequest returns a request value for making API operation for AWS Storage Gateway.

Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.UpdateBandwidthRateLimitInput{
		AverageDownloadRateLimitInBitsPerSec: aws.Int64(102400),
		AverageUploadRateLimitInBitsPerSec:   aws.Int64(51200),
		GatewayARN:                           aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.UpdateBandwidthRateLimitRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) UpdateChapCredentialsRequest added in v0.9.0

func (c *Client) UpdateChapCredentialsRequest(input *UpdateChapCredentialsInput) UpdateChapCredentialsRequest

UpdateChapCredentialsRequest returns a request value for making API operation for AWS Storage Gateway.

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.UpdateChapCredentialsRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) UpdateGatewayInformationRequest added in v0.9.0

func (c *Client) UpdateGatewayInformationRequest(input *UpdateGatewayInformationInput) UpdateGatewayInformationRequest

UpdateGatewayInformationRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.UpdateGatewayInformationRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) UpdateGatewaySoftwareNowRequest added in v0.9.0

func (c *Client) UpdateGatewaySoftwareNowRequest(input *UpdateGatewaySoftwareNowInput) UpdateGatewaySoftwareNowRequest

UpdateGatewaySoftwareNowRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	input := &storagegateway.UpdateGatewaySoftwareNowInput{
		GatewayARN: aws.String("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"),
	}

	req := svc.UpdateGatewaySoftwareNowRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) UpdateMaintenanceStartTimeRequest added in v0.9.0

func (c *Client) UpdateMaintenanceStartTimeRequest(input *UpdateMaintenanceStartTimeInput) UpdateMaintenanceStartTimeRequest

UpdateMaintenanceStartTimeRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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),
	}

	req := svc.UpdateMaintenanceStartTimeRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) UpdateNFSFileShareRequest added in v0.9.0

func (c *Client) UpdateNFSFileShareRequest(input *UpdateNFSFileShareInput) UpdateNFSFileShareRequest

UpdateNFSFileShareRequest returns a request value for making API operation for AWS Storage Gateway.

Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.

To leave a file share field unchanged, set the corresponding input field to null.

Updates the following file share setting:

  • Default storage class for your S3 bucket

  • Metadata defaults for your S3 bucket

  • Allowed NFS clients for your file share

  • Squash settings

  • Write status of your file share

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateNFSFileShare

func (*Client) UpdateSMBFileShareRequest added in v0.9.0

func (c *Client) UpdateSMBFileShareRequest(input *UpdateSMBFileShareInput) UpdateSMBFileShareRequest

UpdateSMBFileShareRequest returns a request value for making API operation for AWS Storage Gateway.

Updates a Server Message Block (SMB) file share.

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the AWS Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBFileShare

func (*Client) UpdateSMBSecurityStrategyRequest added in v0.10.0

func (c *Client) UpdateSMBSecurityStrategyRequest(input *UpdateSMBSecurityStrategyInput) UpdateSMBSecurityStrategyRequest

UpdateSMBSecurityStrategyRequest returns a request value for making 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.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBSecurityStrategy

func (*Client) UpdateSnapshotScheduleRequest added in v0.9.0

func (c *Client) UpdateSnapshotScheduleRequest(input *UpdateSnapshotScheduleInput) UpdateSnapshotScheduleRequest

UpdateSnapshotScheduleRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.UpdateSnapshotScheduleRequest(input)
	result, err := req.Send(context.Background())
	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 (*Client) UpdateVTLDeviceTypeRequest added in v0.9.0

func (c *Client) UpdateVTLDeviceTypeRequest(input *UpdateVTLDeviceTypeInput) UpdateVTLDeviceTypeRequest

UpdateVTLDeviceTypeRequest returns a request value for making 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.

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

Please also see 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 (
	"context"
	"fmt"

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

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

	svc := storagegateway.New(cfg)
	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"),
	}

	req := svc.UpdateVTLDeviceTypeRequest(input)
	result, err := req.Send(context.Background())
	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:

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

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

	// The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server
	// side encryption. 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) String

String returns the string representation

func (*CreateCachediSCSIVolumeInput) Validate

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) String

String returns the string representation

type CreateCachediSCSIVolumeRequest

type CreateCachediSCSIVolumeRequest struct {
	*aws.Request
	Input *CreateCachediSCSIVolumeInput
	Copy  func(*CreateCachediSCSIVolumeInput) CreateCachediSCSIVolumeRequest
}

CreateCachediSCSIVolumeRequest is the request type for the CreateCachediSCSIVolume API operation.

func (CreateCachediSCSIVolumeRequest) Send

Send marshals and sends the CreateCachediSCSIVolume API request.

type CreateCachediSCSIVolumeResponse added in v0.9.0

type CreateCachediSCSIVolumeResponse struct {
	*CreateCachediSCSIVolumeOutput
	// contains filtered or unexported fields
}

CreateCachediSCSIVolumeResponse is the response type for the CreateCachediSCSIVolume API operation.

func (*CreateCachediSCSIVolumeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the CreateCachediSCSIVolume request.

type CreateNFSFileShareInput

type CreateNFSFileShareInput struct {

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

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

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

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

	// 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,
	// and otherwise to false. The default value is true.
	GuessMIMETypeEnabled *bool `type:"boolean"`

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

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

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

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

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

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

	// 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.
	RequesterPays *bool `type:"boolean"`

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

	// A value that maps a user to anonymous user. Valid options are the following:
	//
	//    * RootSquash - Only root is mapped to anonymous user.
	//
	//    * NoSquash - No one is mapped to anonymous user
	//
	//    * AllSquash - Everyone is mapped to anonymous user.
	Squash *string `min:"5" type:"string"`

	// 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"`
	// contains filtered or unexported fields
}

CreateNFSFileShareInput

func (CreateNFSFileShareInput) String

func (s CreateNFSFileShareInput) String() string

String returns the string representation

func (*CreateNFSFileShareInput) Validate

func (s *CreateNFSFileShareInput) Validate() error

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

type CreateNFSFileShareOutput

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) String

func (s CreateNFSFileShareOutput) String() string

String returns the string representation

type CreateNFSFileShareRequest

type CreateNFSFileShareRequest struct {
	*aws.Request
	Input *CreateNFSFileShareInput
	Copy  func(*CreateNFSFileShareInput) CreateNFSFileShareRequest
}

CreateNFSFileShareRequest is the request type for the CreateNFSFileShare API operation.

func (CreateNFSFileShareRequest) Send

Send marshals and sends the CreateNFSFileShare API request.

type CreateNFSFileShareResponse added in v0.9.0

type CreateNFSFileShareResponse struct {
	*CreateNFSFileShareOutput
	// contains filtered or unexported fields
}

CreateNFSFileShareResponse is the response type for the CreateNFSFileShare API operation.

func (*CreateNFSFileShareResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the CreateNFSFileShare request.

type CreateSMBFileShareInput added in v0.5.0

type CreateSMBFileShareInput struct {

	// A list of users 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.
	//
	// 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 authentication method that users use to access the file share.
	//
	// Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
	Authentication *string `min:"5" type:"string"`

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

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

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

	// 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,
	// and otherwise to false. The default value is true.
	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. For
	// example @group1. Can only be set if Authentication is set to ActiveDirectory.
	InvalidUserList []string `type:"list"`

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

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

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

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

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

	// 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.
	RequesterPays *bool `type:"boolean"`

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

	// Set this value to "true to enable ACL (access control list) on the SMB file
	// share. Set it to "false" to map file and directory permissions to the POSIX
	// permissions.
	//
	// For more information, see 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 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"`

	// 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. For example
	// @group1. Can only be set if Authentication is set to ActiveDirectory.
	ValidUserList []string `type:"list"`
	// contains filtered or unexported fields
}

CreateSMBFileShareInput

func (CreateSMBFileShareInput) String added in v0.5.0

func (s CreateSMBFileShareInput) String() string

String returns the string representation

func (*CreateSMBFileShareInput) Validate added in v0.5.0

func (s *CreateSMBFileShareInput) Validate() error

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

type CreateSMBFileShareOutput added in v0.5.0

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) String added in v0.5.0

func (s CreateSMBFileShareOutput) String() string

String returns the string representation

type CreateSMBFileShareRequest added in v0.5.0

type CreateSMBFileShareRequest struct {
	*aws.Request
	Input *CreateSMBFileShareInput
	Copy  func(*CreateSMBFileShareInput) CreateSMBFileShareRequest
}

CreateSMBFileShareRequest is the request type for the CreateSMBFileShare API operation.

func (CreateSMBFileShareRequest) Send added in v0.5.0

Send marshals and sends the CreateSMBFileShare API request.

type CreateSMBFileShareResponse added in v0.9.0

type CreateSMBFileShareResponse struct {
	*CreateSMBFileShareOutput
	// contains filtered or unexported fields
}

CreateSMBFileShareResponse is the response type for the CreateSMBFileShare API operation.

func (*CreateSMBFileShareResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the CreateSMBFileShare request.

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
	// AWS 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) String

String returns the string representation

func (*CreateSnapshotFromVolumeRecoveryPointInput) Validate

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) String

String returns the string representation

type CreateSnapshotFromVolumeRecoveryPointRequest

CreateSnapshotFromVolumeRecoveryPointRequest is the request type for the CreateSnapshotFromVolumeRecoveryPoint API operation.

func (CreateSnapshotFromVolumeRecoveryPointRequest) Send

Send marshals and sends the CreateSnapshotFromVolumeRecoveryPoint API request.

type CreateSnapshotFromVolumeRecoveryPointResponse added in v0.9.0

type CreateSnapshotFromVolumeRecoveryPointResponse struct {
	*CreateSnapshotFromVolumeRecoveryPointOutput
	// contains filtered or unexported fields
}

CreateSnapshotFromVolumeRecoveryPointResponse is the response type for the CreateSnapshotFromVolumeRecoveryPoint API operation.

func (*CreateSnapshotFromVolumeRecoveryPointResponse) SDKResponseMetdata added in v0.9.0

SDKResponseMetdata returns the response metadata for the CreateSnapshotFromVolumeRecoveryPoint request.

type CreateSnapshotInput

type CreateSnapshotInput struct {

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

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

func (s CreateSnapshotInput) String() string

String returns the string representation

func (*CreateSnapshotInput) Validate

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) String

func (s CreateSnapshotOutput) String() string

String returns the string representation

type CreateSnapshotRequest

type CreateSnapshotRequest struct {
	*aws.Request
	Input *CreateSnapshotInput
	Copy  func(*CreateSnapshotInput) CreateSnapshotRequest
}

CreateSnapshotRequest is the request type for the CreateSnapshot API operation.

func (CreateSnapshotRequest) Send

Send marshals and sends the CreateSnapshot API request.

type CreateSnapshotResponse added in v0.9.0

type CreateSnapshotResponse struct {
	*CreateSnapshotOutput
	// contains filtered or unexported fields
}

CreateSnapshotResponse is the response type for the CreateSnapshot API operation.

func (*CreateSnapshotResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the CreateSnapshot request.

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

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

	// The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side
	// encryption. This value can only be set when KMSEncrypted is true. Optional.
	KMSKey *string `min:"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"`

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

	// The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the
	// new stored volume. Specify this field if you want to create the iSCSI storage
	// volume from a snapshot otherwise do not include this field. To list snapshots
	// for your account use DescribeSnapshots (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) String

String returns the string representation

func (*CreateStorediSCSIVolumeInput) Validate

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) String

String returns the string representation

type CreateStorediSCSIVolumeRequest

type CreateStorediSCSIVolumeRequest struct {
	*aws.Request
	Input *CreateStorediSCSIVolumeInput
	Copy  func(*CreateStorediSCSIVolumeInput) CreateStorediSCSIVolumeRequest
}

CreateStorediSCSIVolumeRequest is the request type for the CreateStorediSCSIVolume API operation.

func (CreateStorediSCSIVolumeRequest) Send

Send marshals and sends the CreateStorediSCSIVolume API request.

type CreateStorediSCSIVolumeResponse added in v0.9.0

type CreateStorediSCSIVolumeResponse struct {
	*CreateStorediSCSIVolumeOutput
	// contains filtered or unexported fields
}

CreateStorediSCSIVolumeResponse is the response type for the CreateStorediSCSIVolume API operation.

func (*CreateStorediSCSIVolumeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the CreateStorediSCSIVolume request.

type CreateTapeWithBarcodeInput

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

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

	// The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server
	// side encryption. 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 (Glacier or Deep Archive) that
	// corresponds to the pool.
	//
	// Valid values: "GLACIER", "DEEP_ARCHIVE"
	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:"7" type:"string" required:"true"`

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

CreateTapeWithBarcodeInput

func (CreateTapeWithBarcodeInput) String

String returns the string representation

func (*CreateTapeWithBarcodeInput) Validate

func (s *CreateTapeWithBarcodeInput) Validate() error

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

type CreateTapeWithBarcodeOutput

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) String

String returns the string representation

type CreateTapeWithBarcodeRequest

type CreateTapeWithBarcodeRequest struct {
	*aws.Request
	Input *CreateTapeWithBarcodeInput
	Copy  func(*CreateTapeWithBarcodeInput) CreateTapeWithBarcodeRequest
}

CreateTapeWithBarcodeRequest is the request type for the CreateTapeWithBarcode API operation.

func (CreateTapeWithBarcodeRequest) Send

Send marshals and sends the CreateTapeWithBarcode API request.

type CreateTapeWithBarcodeResponse added in v0.9.0

type CreateTapeWithBarcodeResponse struct {
	*CreateTapeWithBarcodeOutput
	// contains filtered or unexported fields
}

CreateTapeWithBarcodeResponse is the response type for the CreateTapeWithBarcode API operation.

func (*CreateTapeWithBarcodeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the CreateTapeWithBarcode request.

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

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

	// The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server
	// side encryption. 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 (Glacier or Deep Archive) that
	// corresponds to the pool.
	//
	// Valid values: "GLACIER", "DEEP_ARCHIVE"
	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 to 4 characters in length and must be one of the uppercase
	// letters from A to Z.
	//
	// TapeBarcodePrefix is a required field
	TapeBarcodePrefix *string `min:"1" type:"string" required:"true"`

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

CreateTapesInput

func (CreateTapesInput) String

func (s CreateTapesInput) String() string

String returns the string representation

func (*CreateTapesInput) Validate

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) String

func (s CreateTapesOutput) String() string

String returns the string representation

type CreateTapesRequest

type CreateTapesRequest struct {
	*aws.Request
	Input *CreateTapesInput
	Copy  func(*CreateTapesInput) CreateTapesRequest
}

CreateTapesRequest is the request type for the CreateTapes API operation.

func (CreateTapesRequest) Send

Send marshals and sends the CreateTapes API request.

type CreateTapesResponse added in v0.9.0

type CreateTapesResponse struct {
	*CreateTapesOutput
	// contains filtered or unexported fields
}

CreateTapesResponse is the response type for the CreateTapes API operation.

func (*CreateTapesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the CreateTapes request.

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 AWS 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) String

String returns the string representation

func (*DeleteBandwidthRateLimitInput) Validate

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

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

func (DeleteBandwidthRateLimitOutput) String

String returns the string representation

type DeleteBandwidthRateLimitRequest

type DeleteBandwidthRateLimitRequest struct {
	*aws.Request
	Input *DeleteBandwidthRateLimitInput
	Copy  func(*DeleteBandwidthRateLimitInput) DeleteBandwidthRateLimitRequest
}

DeleteBandwidthRateLimitRequest is the request type for the DeleteBandwidthRateLimit API operation.

func (DeleteBandwidthRateLimitRequest) Send

Send marshals and sends the DeleteBandwidthRateLimit API request.

type DeleteBandwidthRateLimitResponse added in v0.9.0

type DeleteBandwidthRateLimitResponse struct {
	*DeleteBandwidthRateLimitOutput
	// contains filtered or unexported fields
}

DeleteBandwidthRateLimitResponse is the response type for the DeleteBandwidthRateLimit API operation.

func (*DeleteBandwidthRateLimitResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DeleteBandwidthRateLimit request.

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) String

String returns the string representation

func (*DeleteChapCredentialsInput) Validate

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) String

String returns the string representation

type DeleteChapCredentialsRequest

type DeleteChapCredentialsRequest struct {
	*aws.Request
	Input *DeleteChapCredentialsInput
	Copy  func(*DeleteChapCredentialsInput) DeleteChapCredentialsRequest
}

DeleteChapCredentialsRequest is the request type for the DeleteChapCredentials API operation.

func (DeleteChapCredentialsRequest) Send

Send marshals and sends the DeleteChapCredentials API request.

type DeleteChapCredentialsResponse added in v0.9.0

type DeleteChapCredentialsResponse struct {
	*DeleteChapCredentialsOutput
	// contains filtered or unexported fields
}

DeleteChapCredentialsResponse is the response type for the DeleteChapCredentials API operation.

func (*DeleteChapCredentialsResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DeleteChapCredentials request.

type DeleteFileShareInput

type DeleteFileShareInput struct {

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

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

DeleteFileShareInput

func (DeleteFileShareInput) String

func (s DeleteFileShareInput) String() string

String returns the string representation

func (*DeleteFileShareInput) Validate

func (s *DeleteFileShareInput) Validate() error

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

type DeleteFileShareOutput

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) String

func (s DeleteFileShareOutput) String() string

String returns the string representation

type DeleteFileShareRequest

type DeleteFileShareRequest struct {
	*aws.Request
	Input *DeleteFileShareInput
	Copy  func(*DeleteFileShareInput) DeleteFileShareRequest
}

DeleteFileShareRequest is the request type for the DeleteFileShare API operation.

func (DeleteFileShareRequest) Send

Send marshals and sends the DeleteFileShare API request.

type DeleteFileShareResponse added in v0.9.0

type DeleteFileShareResponse struct {
	*DeleteFileShareOutput
	// contains filtered or unexported fields
}

DeleteFileShareResponse is the response type for the DeleteFileShare API operation.

func (*DeleteFileShareResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DeleteFileShare request.

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 AWS 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) String

func (s DeleteGatewayInput) String() string

String returns the string representation

func (*DeleteGatewayInput) Validate

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

A JSON object containing the ID of the deleted gateway.

func (DeleteGatewayOutput) String

func (s DeleteGatewayOutput) String() string

String returns the string representation

type DeleteGatewayRequest

type DeleteGatewayRequest struct {
	*aws.Request
	Input *DeleteGatewayInput
	Copy  func(*DeleteGatewayInput) DeleteGatewayRequest
}

DeleteGatewayRequest is the request type for the DeleteGateway API operation.

func (DeleteGatewayRequest) Send

Send marshals and sends the DeleteGateway API request.

type DeleteGatewayResponse added in v0.9.0

type DeleteGatewayResponse struct {
	*DeleteGatewayOutput
	// contains filtered or unexported fields
}

DeleteGatewayResponse is the response type for the DeleteGateway API operation.

func (*DeleteGatewayResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DeleteGateway request.

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) String

String returns the string representation

func (*DeleteSnapshotScheduleInput) Validate

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) String

String returns the string representation

type DeleteSnapshotScheduleRequest

type DeleteSnapshotScheduleRequest struct {
	*aws.Request
	Input *DeleteSnapshotScheduleInput
	Copy  func(*DeleteSnapshotScheduleInput) DeleteSnapshotScheduleRequest
}

DeleteSnapshotScheduleRequest is the request type for the DeleteSnapshotSchedule API operation.

func (DeleteSnapshotScheduleRequest) Send

Send marshals and sends the DeleteSnapshotSchedule API request.

type DeleteSnapshotScheduleResponse added in v0.9.0

type DeleteSnapshotScheduleResponse struct {
	*DeleteSnapshotScheduleOutput
	// contains filtered or unexported fields
}

DeleteSnapshotScheduleResponse is the response type for the DeleteSnapshotSchedule API operation.

func (*DeleteSnapshotScheduleResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DeleteSnapshotSchedule request.

type DeleteTapeArchiveInput

type DeleteTapeArchiveInput struct {

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

DeleteTapeArchiveInput

func (DeleteTapeArchiveInput) String

func (s DeleteTapeArchiveInput) String() string

String returns the string representation

func (*DeleteTapeArchiveInput) Validate

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) String

func (s DeleteTapeArchiveOutput) String() string

String returns the string representation

type DeleteTapeArchiveRequest

type DeleteTapeArchiveRequest struct {
	*aws.Request
	Input *DeleteTapeArchiveInput
	Copy  func(*DeleteTapeArchiveInput) DeleteTapeArchiveRequest
}

DeleteTapeArchiveRequest is the request type for the DeleteTapeArchive API operation.

func (DeleteTapeArchiveRequest) Send

Send marshals and sends the DeleteTapeArchive API request.

type DeleteTapeArchiveResponse added in v0.9.0

type DeleteTapeArchiveResponse struct {
	*DeleteTapeArchiveOutput
	// contains filtered or unexported fields
}

DeleteTapeArchiveResponse is the response type for the DeleteTapeArchive API operation.

func (*DeleteTapeArchiveResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DeleteTapeArchive request.

type DeleteTapeInput

type DeleteTapeInput struct {

	// The unique Amazon Resource Name (ARN) of the gateway that the virtual tape
	// to delete is associated with. Use the ListGateways operation to return a
	// list of gateways for your account and AWS 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) String

func (s DeleteTapeInput) String() string

String returns the string representation

func (*DeleteTapeInput) Validate

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) String

func (s DeleteTapeOutput) String() string

String returns the string representation

type DeleteTapeRequest

type DeleteTapeRequest struct {
	*aws.Request
	Input *DeleteTapeInput
	Copy  func(*DeleteTapeInput) DeleteTapeRequest
}

DeleteTapeRequest is the request type for the DeleteTape API operation.

func (DeleteTapeRequest) Send

Send marshals and sends the DeleteTape API request.

type DeleteTapeResponse added in v0.9.0

type DeleteTapeResponse struct {
	*DeleteTapeOutput
	// contains filtered or unexported fields
}

DeleteTapeResponse is the response type for the DeleteTape API operation.

func (*DeleteTapeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DeleteTape request.

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) String

func (s DeleteVolumeInput) String() string

String returns the string representation

func (*DeleteVolumeInput) Validate

func (s *DeleteVolumeInput) Validate() error

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

type DeleteVolumeOutput

type DeleteVolumeOutput struct {

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

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

func (DeleteVolumeOutput) String

func (s DeleteVolumeOutput) String() string

String returns the string representation

type DeleteVolumeRequest

type DeleteVolumeRequest struct {
	*aws.Request
	Input *DeleteVolumeInput
	Copy  func(*DeleteVolumeInput) DeleteVolumeRequest
}

DeleteVolumeRequest is the request type for the DeleteVolume API operation.

func (DeleteVolumeRequest) Send

Send marshals and sends the DeleteVolume API request.

type DeleteVolumeResponse added in v0.9.0

type DeleteVolumeResponse struct {
	*DeleteVolumeOutput
	// contains filtered or unexported fields
}

DeleteVolumeResponse is the response type for the DeleteVolume API operation.

func (*DeleteVolumeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DeleteVolume request.

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

A JSON object containing the of the gateway.

func (DescribeBandwidthRateLimitInput) String

String returns the string representation

func (*DescribeBandwidthRateLimitInput) Validate

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

A JSON object containing the following fields:

func (DescribeBandwidthRateLimitOutput) String

String returns the string representation

type DescribeBandwidthRateLimitRequest

type DescribeBandwidthRateLimitRequest struct {
	*aws.Request
	Input *DescribeBandwidthRateLimitInput
	Copy  func(*DescribeBandwidthRateLimitInput) DescribeBandwidthRateLimitRequest
}

DescribeBandwidthRateLimitRequest is the request type for the DescribeBandwidthRateLimit API operation.

func (DescribeBandwidthRateLimitRequest) Send

Send marshals and sends the DescribeBandwidthRateLimit API request.

type DescribeBandwidthRateLimitResponse added in v0.9.0

type DescribeBandwidthRateLimitResponse struct {
	*DescribeBandwidthRateLimitOutput
	// contains filtered or unexported fields
}

DescribeBandwidthRateLimitResponse is the response type for the DescribeBandwidthRateLimit API operation.

func (*DescribeBandwidthRateLimitResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeBandwidthRateLimit request.

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

func (DescribeCacheInput) String

func (s DescribeCacheInput) String() string

String returns the string representation

func (*DescribeCacheInput) Validate

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 the 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 AWS. 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 have 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 AWS Region.
	GatewayARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeCacheOutput) String

func (s DescribeCacheOutput) String() string

String returns the string representation

type DescribeCacheRequest

type DescribeCacheRequest struct {
	*aws.Request
	Input *DescribeCacheInput
	Copy  func(*DescribeCacheInput) DescribeCacheRequest
}

DescribeCacheRequest is the request type for the DescribeCache API operation.

func (DescribeCacheRequest) Send

Send marshals and sends the DescribeCache API request.

type DescribeCacheResponse added in v0.9.0

type DescribeCacheResponse struct {
	*DescribeCacheOutput
	// contains filtered or unexported fields
}

DescribeCacheResponse is the response type for the DescribeCache API operation.

func (*DescribeCacheResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeCache request.

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 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) String

String returns the string representation

func (*DescribeCachediSCSIVolumesInput) Validate

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) String

String returns the string representation

type DescribeCachediSCSIVolumesRequest

type DescribeCachediSCSIVolumesRequest struct {
	*aws.Request
	Input *DescribeCachediSCSIVolumesInput
	Copy  func(*DescribeCachediSCSIVolumesInput) DescribeCachediSCSIVolumesRequest
}

DescribeCachediSCSIVolumesRequest is the request type for the DescribeCachediSCSIVolumes API operation.

func (DescribeCachediSCSIVolumesRequest) Send

Send marshals and sends the DescribeCachediSCSIVolumes API request.

type DescribeCachediSCSIVolumesResponse added in v0.9.0

type DescribeCachediSCSIVolumesResponse struct {
	*DescribeCachediSCSIVolumesOutput
	// contains filtered or unexported fields
}

DescribeCachediSCSIVolumesResponse is the response type for the DescribeCachediSCSIVolumes API operation.

func (*DescribeCachediSCSIVolumesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeCachediSCSIVolumes request.

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) String

String returns the string representation

func (*DescribeChapCredentialsInput) Validate

func (s *DescribeChapCredentialsInput) Validate() error

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

type DescribeChapCredentialsOutput

type DescribeChapCredentialsOutput struct {

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

A JSON object containing a .

func (DescribeChapCredentialsOutput) String

String returns the string representation

type DescribeChapCredentialsRequest

type DescribeChapCredentialsRequest struct {
	*aws.Request
	Input *DescribeChapCredentialsInput
	Copy  func(*DescribeChapCredentialsInput) DescribeChapCredentialsRequest
}

DescribeChapCredentialsRequest is the request type for the DescribeChapCredentials API operation.

func (DescribeChapCredentialsRequest) Send

Send marshals and sends the DescribeChapCredentials API request.

type DescribeChapCredentialsResponse added in v0.9.0

type DescribeChapCredentialsResponse struct {
	*DescribeChapCredentialsOutput
	// contains filtered or unexported fields
}

DescribeChapCredentialsResponse is the response type for the DescribeChapCredentials API operation.

func (*DescribeChapCredentialsResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeChapCredentials request.

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 AWS 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) String

String returns the string representation

func (*DescribeGatewayInformationInput) Validate

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 was
	// used to monitor and log events in the gateway.
	CloudWatchLogGroupARN *string `type:"string"`

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

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

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

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

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

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

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

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

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

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

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

String returns the string representation

type DescribeGatewayInformationRequest

type DescribeGatewayInformationRequest struct {
	*aws.Request
	Input *DescribeGatewayInformationInput
	Copy  func(*DescribeGatewayInformationInput) DescribeGatewayInformationRequest
}

DescribeGatewayInformationRequest is the request type for the DescribeGatewayInformation API operation.

func (DescribeGatewayInformationRequest) Send

Send marshals and sends the DescribeGatewayInformation API request.

type DescribeGatewayInformationResponse added in v0.9.0

type DescribeGatewayInformationResponse struct {
	*DescribeGatewayInformationOutput
	// contains filtered or unexported fields
}

DescribeGatewayInformationResponse is the response type for the DescribeGatewayInformation API operation.

func (*DescribeGatewayInformationResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeGatewayInformation request.

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

A JSON object containing the of the gateway.

func (DescribeMaintenanceStartTimeInput) String

String returns the string representation

func (*DescribeMaintenanceStartTimeInput) Validate

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.
	//
	// This value is only available for tape and volume gateways.
	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 AWS 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) String

String returns the string representation

type DescribeMaintenanceStartTimeRequest

type DescribeMaintenanceStartTimeRequest struct {
	*aws.Request
	Input *DescribeMaintenanceStartTimeInput
	Copy  func(*DescribeMaintenanceStartTimeInput) DescribeMaintenanceStartTimeRequest
}

DescribeMaintenanceStartTimeRequest is the request type for the DescribeMaintenanceStartTime API operation.

func (DescribeMaintenanceStartTimeRequest) Send

Send marshals and sends the DescribeMaintenanceStartTime API request.

type DescribeMaintenanceStartTimeResponse added in v0.9.0

type DescribeMaintenanceStartTimeResponse struct {
	*DescribeMaintenanceStartTimeOutput
	// contains filtered or unexported fields
}

DescribeMaintenanceStartTimeResponse is the response type for the DescribeMaintenanceStartTime API operation.

func (*DescribeMaintenanceStartTimeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeMaintenanceStartTime request.

type DescribeNFSFileSharesInput

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) String

String returns the string representation

func (*DescribeNFSFileSharesInput) Validate

func (s *DescribeNFSFileSharesInput) Validate() error

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

type DescribeNFSFileSharesOutput

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) String

String returns the string representation

type DescribeNFSFileSharesRequest

type DescribeNFSFileSharesRequest struct {
	*aws.Request
	Input *DescribeNFSFileSharesInput
	Copy  func(*DescribeNFSFileSharesInput) DescribeNFSFileSharesRequest
}

DescribeNFSFileSharesRequest is the request type for the DescribeNFSFileShares API operation.

func (DescribeNFSFileSharesRequest) Send

Send marshals and sends the DescribeNFSFileShares API request.

type DescribeNFSFileSharesResponse added in v0.9.0

type DescribeNFSFileSharesResponse struct {
	*DescribeNFSFileSharesOutput
	// contains filtered or unexported fields
}

DescribeNFSFileSharesResponse is the response type for the DescribeNFSFileShares API operation.

func (*DescribeNFSFileSharesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeNFSFileShares request.

type DescribeSMBFileSharesInput added in v0.5.0

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) String added in v0.5.0

String returns the string representation

func (*DescribeSMBFileSharesInput) Validate added in v0.5.0

func (s *DescribeSMBFileSharesInput) Validate() error

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

type DescribeSMBFileSharesOutput added in v0.5.0

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) String added in v0.5.0

String returns the string representation

type DescribeSMBFileSharesRequest added in v0.5.0

type DescribeSMBFileSharesRequest struct {
	*aws.Request
	Input *DescribeSMBFileSharesInput
	Copy  func(*DescribeSMBFileSharesInput) DescribeSMBFileSharesRequest
}

DescribeSMBFileSharesRequest is the request type for the DescribeSMBFileShares API operation.

func (DescribeSMBFileSharesRequest) Send added in v0.5.0

Send marshals and sends the DescribeSMBFileShares API request.

type DescribeSMBFileSharesResponse added in v0.9.0

type DescribeSMBFileSharesResponse struct {
	*DescribeSMBFileSharesOutput
	// contains filtered or unexported fields
}

DescribeSMBFileSharesResponse is the response type for the DescribeSMBFileShares API operation.

func (*DescribeSMBFileSharesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeSMBFileShares request.

type DescribeSMBSettingsInput added in v0.5.0

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

func (DescribeSMBSettingsInput) String added in v0.5.0

func (s DescribeSMBSettingsInput) String() string

String returns the string representation

func (*DescribeSMBSettingsInput) Validate added in v0.5.0

func (s *DescribeSMBSettingsInput) Validate() error

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

type DescribeSMBSettingsOutput added in v0.5.0

type DescribeSMBSettingsOutput struct {

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

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

	// This value is true if a password for the guest user “smbguest” is set,
	// and otherwise false.
	SMBGuestPasswordSet *bool `type:"boolean"`

	// 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.
	//
	// 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 SMBSecurityStrategy `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (DescribeSMBSettingsOutput) String added in v0.5.0

func (s DescribeSMBSettingsOutput) String() string

String returns the string representation

type DescribeSMBSettingsRequest added in v0.5.0

type DescribeSMBSettingsRequest struct {
	*aws.Request
	Input *DescribeSMBSettingsInput
	Copy  func(*DescribeSMBSettingsInput) DescribeSMBSettingsRequest
}

DescribeSMBSettingsRequest is the request type for the DescribeSMBSettings API operation.

func (DescribeSMBSettingsRequest) Send added in v0.5.0

Send marshals and sends the DescribeSMBSettings API request.

type DescribeSMBSettingsResponse added in v0.9.0

type DescribeSMBSettingsResponse struct {
	*DescribeSMBSettingsOutput
	// contains filtered or unexported fields
}

DescribeSMBSettingsResponse is the response type for the DescribeSMBSettings API operation.

func (*DescribeSMBSettingsResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeSMBSettings request.

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) String

String returns the string representation

func (*DescribeSnapshotScheduleInput) Validate

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) String

String returns the string representation

type DescribeSnapshotScheduleRequest

type DescribeSnapshotScheduleRequest struct {
	*aws.Request
	Input *DescribeSnapshotScheduleInput
	Copy  func(*DescribeSnapshotScheduleInput) DescribeSnapshotScheduleRequest
}

DescribeSnapshotScheduleRequest is the request type for the DescribeSnapshotSchedule API operation.

func (DescribeSnapshotScheduleRequest) Send

Send marshals and sends the DescribeSnapshotSchedule API request.

type DescribeSnapshotScheduleResponse added in v0.9.0

type DescribeSnapshotScheduleResponse struct {
	*DescribeSnapshotScheduleOutput
	// contains filtered or unexported fields
}

DescribeSnapshotScheduleResponse is the response type for the DescribeSnapshotSchedule API operation.

func (*DescribeSnapshotScheduleResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeSnapshotSchedule request.

type DescribeStorediSCSIVolumesInput

type DescribeStorediSCSIVolumesInput struct {

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

A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

func (DescribeStorediSCSIVolumesInput) String

String returns the string representation

func (*DescribeStorediSCSIVolumesInput) Validate

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 if 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, on STORED volumes are supported.
	StorediSCSIVolumes []StorediSCSIVolume `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeStorediSCSIVolumesOutput) String

String returns the string representation

type DescribeStorediSCSIVolumesRequest

type DescribeStorediSCSIVolumesRequest struct {
	*aws.Request
	Input *DescribeStorediSCSIVolumesInput
	Copy  func(*DescribeStorediSCSIVolumesInput) DescribeStorediSCSIVolumesRequest
}

DescribeStorediSCSIVolumesRequest is the request type for the DescribeStorediSCSIVolumes API operation.

func (DescribeStorediSCSIVolumesRequest) Send

Send marshals and sends the DescribeStorediSCSIVolumes API request.

type DescribeStorediSCSIVolumesResponse added in v0.9.0

type DescribeStorediSCSIVolumesResponse struct {
	*DescribeStorediSCSIVolumesOutput
	// contains filtered or unexported fields
}

DescribeStorediSCSIVolumesResponse is the response type for the DescribeStorediSCSIVolumes API operation.

func (*DescribeStorediSCSIVolumesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeStorediSCSIVolumes request.

type DescribeTapeArchivesInput

type DescribeTapeArchivesInput struct {

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

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

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

DescribeTapeArchivesInput

func (DescribeTapeArchivesInput) String

func (s DescribeTapeArchivesInput) String() string

String returns the string representation

func (*DescribeTapeArchivesInput) Validate

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) String

String returns the string representation

type DescribeTapeArchivesPaginator added in v0.9.0

type DescribeTapeArchivesPaginator struct {
	aws.Pager
}

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

func NewDescribeTapeArchivesPaginator added in v0.9.0

func NewDescribeTapeArchivesPaginator(req DescribeTapeArchivesRequest) DescribeTapeArchivesPaginator

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

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

// Example iterating over pages.
req := client.DescribeTapeArchivesRequest(input)
p := storagegateway.NewDescribeTapeArchivesRequestPaginator(req)

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

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

func (*DescribeTapeArchivesPaginator) CurrentPage added in v0.9.0

type DescribeTapeArchivesRequest

type DescribeTapeArchivesRequest struct {
	*aws.Request
	Input *DescribeTapeArchivesInput
	Copy  func(*DescribeTapeArchivesInput) DescribeTapeArchivesRequest
}

DescribeTapeArchivesRequest is the request type for the DescribeTapeArchives API operation.

func (DescribeTapeArchivesRequest) Send

Send marshals and sends the DescribeTapeArchives API request.

type DescribeTapeArchivesResponse added in v0.9.0

type DescribeTapeArchivesResponse struct {
	*DescribeTapeArchivesOutput
	// contains filtered or unexported fields
}

DescribeTapeArchivesResponse is the response type for the DescribeTapeArchives API operation.

func (*DescribeTapeArchivesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeTapeArchives request.

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 AWS 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) String

String returns the string representation

func (*DescribeTapeRecoveryPointsInput) Validate

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 AWS 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) String

String returns the string representation

type DescribeTapeRecoveryPointsPaginator added in v0.9.0

type DescribeTapeRecoveryPointsPaginator struct {
	aws.Pager
}

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

func NewDescribeTapeRecoveryPointsPaginator added in v0.9.0

func NewDescribeTapeRecoveryPointsPaginator(req DescribeTapeRecoveryPointsRequest) DescribeTapeRecoveryPointsPaginator

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

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

// Example iterating over pages.
req := client.DescribeTapeRecoveryPointsRequest(input)
p := storagegateway.NewDescribeTapeRecoveryPointsRequestPaginator(req)

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

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

func (*DescribeTapeRecoveryPointsPaginator) CurrentPage added in v0.9.0

type DescribeTapeRecoveryPointsRequest

type DescribeTapeRecoveryPointsRequest struct {
	*aws.Request
	Input *DescribeTapeRecoveryPointsInput
	Copy  func(*DescribeTapeRecoveryPointsInput) DescribeTapeRecoveryPointsRequest
}

DescribeTapeRecoveryPointsRequest is the request type for the DescribeTapeRecoveryPoints API operation.

func (DescribeTapeRecoveryPointsRequest) Send

Send marshals and sends the DescribeTapeRecoveryPoints API request.

type DescribeTapeRecoveryPointsResponse added in v0.9.0

type DescribeTapeRecoveryPointsResponse struct {
	*DescribeTapeRecoveryPointsOutput
	// contains filtered or unexported fields
}

DescribeTapeRecoveryPointsResponse is the response type for the DescribeTapeRecoveryPoints API operation.

func (*DescribeTapeRecoveryPointsResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeTapeRecoveryPoints request.

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 AWS 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) String

func (s DescribeTapesInput) String() string

String returns the string representation

func (*DescribeTapesInput) Validate

func (s *DescribeTapesInput) Validate() error

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

type DescribeTapesOutput

type DescribeTapesOutput struct {

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

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

DescribeTapesOutput

func (DescribeTapesOutput) String

func (s DescribeTapesOutput) String() string

String returns the string representation

type DescribeTapesPaginator added in v0.9.0

type DescribeTapesPaginator struct {
	aws.Pager
}

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

func NewDescribeTapesPaginator added in v0.9.0

func NewDescribeTapesPaginator(req DescribeTapesRequest) DescribeTapesPaginator

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

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

// Example iterating over pages.
req := client.DescribeTapesRequest(input)
p := storagegateway.NewDescribeTapesRequestPaginator(req)

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

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

func (*DescribeTapesPaginator) CurrentPage added in v0.9.0

func (p *DescribeTapesPaginator) CurrentPage() *DescribeTapesOutput

type DescribeTapesRequest

type DescribeTapesRequest struct {
	*aws.Request
	Input *DescribeTapesInput
	Copy  func(*DescribeTapesInput) DescribeTapesRequest
}

DescribeTapesRequest is the request type for the DescribeTapes API operation.

func (DescribeTapesRequest) Send

Send marshals and sends the DescribeTapes API request.

type DescribeTapesResponse added in v0.9.0

type DescribeTapesResponse struct {
	*DescribeTapesOutput
	// contains filtered or unexported fields
}

DescribeTapesResponse is the response type for the DescribeTapes API operation.

func (*DescribeTapesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeTapes request.

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

func (DescribeUploadBufferInput) String

func (s DescribeUploadBufferInput) String() string

String returns the string representation

func (*DescribeUploadBufferInput) Validate

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 AWS 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) String

String returns the string representation

type DescribeUploadBufferRequest

type DescribeUploadBufferRequest struct {
	*aws.Request
	Input *DescribeUploadBufferInput
	Copy  func(*DescribeUploadBufferInput) DescribeUploadBufferRequest
}

DescribeUploadBufferRequest is the request type for the DescribeUploadBuffer API operation.

func (DescribeUploadBufferRequest) Send

Send marshals and sends the DescribeUploadBuffer API request.

type DescribeUploadBufferResponse added in v0.9.0

type DescribeUploadBufferResponse struct {
	*DescribeUploadBufferOutput
	// contains filtered or unexported fields
}

DescribeUploadBufferResponse is the response type for the DescribeUploadBuffer API operation.

func (*DescribeUploadBufferResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeUploadBuffer request.

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 AWS 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) String

func (s DescribeVTLDevicesInput) String() string

String returns the string representation

func (*DescribeVTLDevicesInput) Validate

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 AWS 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) String

func (s DescribeVTLDevicesOutput) String() string

String returns the string representation

type DescribeVTLDevicesPaginator added in v0.9.0

type DescribeVTLDevicesPaginator struct {
	aws.Pager
}

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

func NewDescribeVTLDevicesPaginator added in v0.9.0

func NewDescribeVTLDevicesPaginator(req DescribeVTLDevicesRequest) DescribeVTLDevicesPaginator

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

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

// Example iterating over pages.
req := client.DescribeVTLDevicesRequest(input)
p := storagegateway.NewDescribeVTLDevicesRequestPaginator(req)

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

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

func (*DescribeVTLDevicesPaginator) CurrentPage added in v0.9.0

type DescribeVTLDevicesRequest

type DescribeVTLDevicesRequest struct {
	*aws.Request
	Input *DescribeVTLDevicesInput
	Copy  func(*DescribeVTLDevicesInput) DescribeVTLDevicesRequest
}

DescribeVTLDevicesRequest is the request type for the DescribeVTLDevices API operation.

func (DescribeVTLDevicesRequest) Send

Send marshals and sends the DescribeVTLDevices API request.

type DescribeVTLDevicesResponse added in v0.9.0

type DescribeVTLDevicesResponse struct {
	*DescribeVTLDevicesOutput
	// contains filtered or unexported fields
}

DescribeVTLDevicesResponse is the response type for the DescribeVTLDevices API operation.

func (*DescribeVTLDevicesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeVTLDevices request.

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

A JSON object containing the of the gateway.

func (DescribeWorkingStorageInput) String

String returns the string representation

func (*DescribeWorkingStorageInput) Validate

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 AWS 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) String

String returns the string representation

type DescribeWorkingStorageRequest

type DescribeWorkingStorageRequest struct {
	*aws.Request
	Input *DescribeWorkingStorageInput
	Copy  func(*DescribeWorkingStorageInput) DescribeWorkingStorageRequest
}

DescribeWorkingStorageRequest is the request type for the DescribeWorkingStorage API operation.

func (DescribeWorkingStorageRequest) Send

Send marshals and sends the DescribeWorkingStorage API request.

type DescribeWorkingStorageResponse added in v0.9.0

type DescribeWorkingStorageResponse struct {
	*DescribeWorkingStorageOutput
	// contains filtered or unexported fields
}

DescribeWorkingStorageResponse is the response type for the DescribeWorkingStorage API operation.

func (*DescribeWorkingStorageResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DescribeWorkingStorage request.

type DetachVolumeInput added in v0.8.0

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.
	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) String added in v0.8.0

func (s DetachVolumeInput) String() string

String returns the string representation

func (*DetachVolumeInput) Validate added in v0.8.0

func (s *DetachVolumeInput) Validate() error

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

type DetachVolumeOutput added in v0.8.0

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) String added in v0.8.0

func (s DetachVolumeOutput) String() string

String returns the string representation

type DetachVolumeRequest added in v0.8.0

type DetachVolumeRequest struct {
	*aws.Request
	Input *DetachVolumeInput
	Copy  func(*DetachVolumeInput) DetachVolumeRequest
}

DetachVolumeRequest is the request type for the DetachVolume API operation.

func (DetachVolumeRequest) Send added in v0.8.0

Send marshals and sends the DetachVolume API request.

type DetachVolumeResponse added in v0.9.0

type DetachVolumeResponse struct {
	*DetachVolumeOutput
	// contains filtered or unexported fields
}

DetachVolumeResponse is the response type for the DetachVolume API operation.

func (*DetachVolumeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DetachVolume request.

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) String

func (s DeviceiSCSIAttributes) String() string

String returns the string representation

type DisableGatewayInput

type DisableGatewayInput struct {

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

DisableGatewayInput

func (DisableGatewayInput) String

func (s DisableGatewayInput) String() string

String returns the string representation

func (*DisableGatewayInput) Validate

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) String

func (s DisableGatewayOutput) String() string

String returns the string representation

type DisableGatewayRequest

type DisableGatewayRequest struct {
	*aws.Request
	Input *DisableGatewayInput
	Copy  func(*DisableGatewayInput) DisableGatewayRequest
}

DisableGatewayRequest is the request type for the DisableGateway API operation.

func (DisableGatewayRequest) Send

Send marshals and sends the DisableGateway API request.

type DisableGatewayResponse added in v0.9.0

type DisableGatewayResponse struct {
	*DisableGatewayOutput
	// contains filtered or unexported fields
}

DisableGatewayResponse is the response type for the DisableGateway API operation.

func (*DisableGatewayResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the DisableGateway request.

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) String

func (s Disk) String() string

String returns the string representation

type ErrorCode

type ErrorCode string
const (
	ErrorCodeActivationKeyExpired              ErrorCode = "ActivationKeyExpired"
	ErrorCodeActivationKeyInvalid              ErrorCode = "ActivationKeyInvalid"
	ErrorCodeActivationKeyNotFound             ErrorCode = "ActivationKeyNotFound"
	ErrorCodeGatewayInternalError              ErrorCode = "GatewayInternalError"
	ErrorCodeGatewayNotConnected               ErrorCode = "GatewayNotConnected"
	ErrorCodeGatewayNotFound                   ErrorCode = "GatewayNotFound"
	ErrorCodeGatewayProxyNetworkConnectionBusy ErrorCode = "GatewayProxyNetworkConnectionBusy"
	ErrorCodeAuthenticationFailure             ErrorCode = "AuthenticationFailure"
	ErrorCodeBandwidthThrottleScheduleNotFound ErrorCode = "BandwidthThrottleScheduleNotFound"
	ErrorCodeBlocked                           ErrorCode = "Blocked"
	ErrorCodeCannotExportSnapshot              ErrorCode = "CannotExportSnapshot"
	ErrorCodeChapCredentialNotFound            ErrorCode = "ChapCredentialNotFound"
	ErrorCodeDiskAlreadyAllocated              ErrorCode = "DiskAlreadyAllocated"
	ErrorCodeDiskDoesNotExist                  ErrorCode = "DiskDoesNotExist"
	ErrorCodeDiskSizeGreaterThanVolumeMaxSize  ErrorCode = "DiskSizeGreaterThanVolumeMaxSize"
	ErrorCodeDiskSizeLessThanVolumeSize        ErrorCode = "DiskSizeLessThanVolumeSize"
	ErrorCodeDiskSizeNotGigAligned             ErrorCode = "DiskSizeNotGigAligned"
	ErrorCodeDuplicateCertificateInfo          ErrorCode = "DuplicateCertificateInfo"
	ErrorCodeDuplicateSchedule                 ErrorCode = "DuplicateSchedule"
	ErrorCodeEndpointNotFound                  ErrorCode = "EndpointNotFound"
	ErrorCodeIamnotSupported                   ErrorCode = "IAMNotSupported"
	ErrorCodeInitiatorInvalid                  ErrorCode = "InitiatorInvalid"
	ErrorCodeInitiatorNotFound                 ErrorCode = "InitiatorNotFound"
	ErrorCodeInternalError                     ErrorCode = "InternalError"
	ErrorCodeInvalidGateway                    ErrorCode = "InvalidGateway"
	ErrorCodeInvalidEndpoint                   ErrorCode = "InvalidEndpoint"
	ErrorCodeInvalidParameters                 ErrorCode = "InvalidParameters"
	ErrorCodeInvalidSchedule                   ErrorCode = "InvalidSchedule"
	ErrorCodeLocalStorageLimitExceeded         ErrorCode = "LocalStorageLimitExceeded"
	ErrorCodeLunAlreadyAllocated               ErrorCode = "LunAlreadyAllocated "
	ErrorCodeLunInvalid                        ErrorCode = "LunInvalid"
	ErrorCodeMaximumContentLengthExceeded      ErrorCode = "MaximumContentLengthExceeded"
	ErrorCodeMaximumTapeCartridgeCountExceeded ErrorCode = "MaximumTapeCartridgeCountExceeded"
	ErrorCodeMaximumVolumeCountExceeded        ErrorCode = "MaximumVolumeCountExceeded"
	ErrorCodeNetworkConfigurationChanged       ErrorCode = "NetworkConfigurationChanged"
	ErrorCodeNoDisksAvailable                  ErrorCode = "NoDisksAvailable"
	ErrorCodeNotImplemented                    ErrorCode = "NotImplemented"
	ErrorCodeNotSupported                      ErrorCode = "NotSupported"
	ErrorCodeOperationAborted                  ErrorCode = "OperationAborted"
	ErrorCodeOutdatedGateway                   ErrorCode = "OutdatedGateway"
	ErrorCodeParametersNotImplemented          ErrorCode = "ParametersNotImplemented"
	ErrorCodeRegionInvalid                     ErrorCode = "RegionInvalid"
	ErrorCodeRequestTimeout                    ErrorCode = "RequestTimeout"
	ErrorCodeServiceUnavailable                ErrorCode = "ServiceUnavailable"
	ErrorCodeSnapshotDeleted                   ErrorCode = "SnapshotDeleted"
	ErrorCodeSnapshotIdInvalid                 ErrorCode = "SnapshotIdInvalid"
	ErrorCodeSnapshotInProgress                ErrorCode = "SnapshotInProgress"
	ErrorCodeSnapshotNotFound                  ErrorCode = "SnapshotNotFound"
	ErrorCodeSnapshotScheduleNotFound          ErrorCode = "SnapshotScheduleNotFound"
	ErrorCodeStagingAreaFull                   ErrorCode = "StagingAreaFull"
	ErrorCodeStorageFailure                    ErrorCode = "StorageFailure"
	ErrorCodeTapeCartridgeNotFound             ErrorCode = "TapeCartridgeNotFound"
	ErrorCodeTargetAlreadyExists               ErrorCode = "TargetAlreadyExists"
	ErrorCodeTargetInvalid                     ErrorCode = "TargetInvalid"
	ErrorCodeTargetNotFound                    ErrorCode = "TargetNotFound"
	ErrorCodeUnauthorizedOperation             ErrorCode = "UnauthorizedOperation"
	ErrorCodeVolumeAlreadyExists               ErrorCode = "VolumeAlreadyExists"
	ErrorCodeVolumeIdInvalid                   ErrorCode = "VolumeIdInvalid"
	ErrorCodeVolumeInUse                       ErrorCode = "VolumeInUse"
	ErrorCodeVolumeNotFound                    ErrorCode = "VolumeNotFound"
	ErrorCodeVolumeNotReady                    ErrorCode = "VolumeNotReady"
)

Enum values for ErrorCode

func (ErrorCode) MarshalValue added in v0.3.0

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

func (ErrorCode) MarshalValueBuf added in v0.3.0

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

type FileShareInfo

type FileShareInfo struct {

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

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

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

	// The type of the file share.
	FileShareType FileShareType `type:"string" enum:"true"`

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

Describes a file share.

func (FileShareInfo) String

func (s FileShareInfo) String() string

String returns the string representation

type FileShareType added in v0.5.0

type FileShareType string

The type of the file share.

const (
	FileShareTypeNfs FileShareType = "NFS"
	FileShareTypeSmb FileShareType = "SMB"
)

Enum values for FileShareType

func (FileShareType) MarshalValue added in v0.5.0

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

func (FileShareType) MarshalValueBuf added in v0.5.0

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

type GatewayInfo

type GatewayInfo struct {

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

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

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

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

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

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

Describes a gateway object.

func (GatewayInfo) String

func (s GatewayInfo) String() string

String returns the string representation

type JoinDomainInput added in v0.5.0

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 AWS 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 required field
	Password *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Sets the user name of user who has permission to add the gateway to the Active
	// Directory domain.
	//
	// UserName is a required field
	UserName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

JoinDomainInput

func (JoinDomainInput) String added in v0.5.0

func (s JoinDomainInput) String() string

String returns the string representation

func (*JoinDomainInput) Validate added in v0.5.0

func (s *JoinDomainInput) Validate() error

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

type JoinDomainOutput added in v0.5.0

type JoinDomainOutput struct {

	// 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) String added in v0.5.0

func (s JoinDomainOutput) String() string

String returns the string representation

type JoinDomainRequest added in v0.5.0

type JoinDomainRequest struct {
	*aws.Request
	Input *JoinDomainInput
	Copy  func(*JoinDomainInput) JoinDomainRequest
}

JoinDomainRequest is the request type for the JoinDomain API operation.

func (JoinDomainRequest) Send added in v0.5.0

Send marshals and sends the JoinDomain API request.

type JoinDomainResponse added in v0.9.0

type JoinDomainResponse struct {
	*JoinDomainOutput
	// contains filtered or unexported fields
}

JoinDomainResponse is the response type for the JoinDomain API operation.

func (*JoinDomainResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the JoinDomain request.

type ListFileSharesInput

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) String

func (s ListFileSharesInput) String() string

String returns the string representation

func (*ListFileSharesInput) Validate

func (s *ListFileSharesInput) Validate() error

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

type ListFileSharesOutput

type ListFileSharesOutput struct {

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

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

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

ListFileShareOutput

func (ListFileSharesOutput) String

func (s ListFileSharesOutput) String() string

String returns the string representation

type ListFileSharesPaginator added in v0.9.0

type ListFileSharesPaginator struct {
	aws.Pager
}

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

func NewListFileSharesPaginator added in v0.9.0

func NewListFileSharesPaginator(req ListFileSharesRequest) ListFileSharesPaginator

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

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

// Example iterating over pages.
req := client.ListFileSharesRequest(input)
p := storagegateway.NewListFileSharesRequestPaginator(req)

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

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

func (*ListFileSharesPaginator) CurrentPage added in v0.9.0

type ListFileSharesRequest

type ListFileSharesRequest struct {
	*aws.Request
	Input *ListFileSharesInput
	Copy  func(*ListFileSharesInput) ListFileSharesRequest
}

ListFileSharesRequest is the request type for the ListFileShares API operation.

func (ListFileSharesRequest) Send

Send marshals and sends the ListFileShares API request.

type ListFileSharesResponse added in v0.9.0

type ListFileSharesResponse struct {
	*ListFileSharesOutput
	// contains filtered or unexported fields
}

ListFileSharesResponse is the response type for the ListFileShares API operation.

func (*ListFileSharesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ListFileShares request.

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) String

func (s ListGatewaysInput) String() string

String returns the string representation

func (*ListGatewaysInput) Validate

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) String

func (s ListGatewaysOutput) String() string

String returns the string representation

type ListGatewaysPaginator added in v0.9.0

type ListGatewaysPaginator struct {
	aws.Pager
}

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

func NewListGatewaysPaginator added in v0.9.0

func NewListGatewaysPaginator(req ListGatewaysRequest) ListGatewaysPaginator

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

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

// Example iterating over pages.
req := client.ListGatewaysRequest(input)
p := storagegateway.NewListGatewaysRequestPaginator(req)

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

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

func (*ListGatewaysPaginator) CurrentPage added in v0.9.0

func (p *ListGatewaysPaginator) CurrentPage() *ListGatewaysOutput

type ListGatewaysRequest

type ListGatewaysRequest struct {
	*aws.Request
	Input *ListGatewaysInput
	Copy  func(*ListGatewaysInput) ListGatewaysRequest
}

ListGatewaysRequest is the request type for the ListGateways API operation.

func (ListGatewaysRequest) Send

Send marshals and sends the ListGateways API request.

type ListGatewaysResponse added in v0.9.0

type ListGatewaysResponse struct {
	*ListGatewaysOutput
	// contains filtered or unexported fields
}

ListGatewaysResponse is the response type for the ListGateways API operation.

func (*ListGatewaysResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ListGateways request.

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

A JSON object containing the of the gateway.

func (ListLocalDisksInput) String

func (s ListLocalDisksInput) String() string

String returns the string representation

func (*ListLocalDisksInput) Validate

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

func (ListLocalDisksOutput) String

func (s ListLocalDisksOutput) String() string

String returns the string representation

type ListLocalDisksRequest

type ListLocalDisksRequest struct {
	*aws.Request
	Input *ListLocalDisksInput
	Copy  func(*ListLocalDisksInput) ListLocalDisksRequest
}

ListLocalDisksRequest is the request type for the ListLocalDisks API operation.

func (ListLocalDisksRequest) Send

Send marshals and sends the ListLocalDisks API request.

type ListLocalDisksResponse added in v0.9.0

type ListLocalDisksResponse struct {
	*ListLocalDisksOutput
	// contains filtered or unexported fields
}

ListLocalDisksResponse is the response type for the ListLocalDisks API operation.

func (*ListLocalDisksResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ListLocalDisks request.

type ListTagsForResourceInput

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) String

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

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

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

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

ListTagsForResourceOutput

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourcePaginator added in v0.9.0

type ListTagsForResourcePaginator struct {
	aws.Pager
}

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

func NewListTagsForResourcePaginator added in v0.9.0

func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator

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

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

// Example iterating over pages.
req := client.ListTagsForResourceRequest(input)
p := storagegateway.NewListTagsForResourceRequestPaginator(req)

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

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

func (*ListTagsForResourcePaginator) CurrentPage added in v0.9.0

type ListTagsForResourceRequest

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ListTapesInput

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) String

func (s ListTapesInput) String() string

String returns the string representation

func (*ListTapesInput) Validate

func (s *ListTapesInput) Validate() error

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

type ListTapesOutput

type ListTapesOutput struct {

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

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

A JSON object containing the following fields:

  • ListTapesOutput$Marker

  • ListTapesOutput$VolumeInfos

func (ListTapesOutput) String

func (s ListTapesOutput) String() string

String returns the string representation

type ListTapesPaginator added in v0.9.0

type ListTapesPaginator struct {
	aws.Pager
}

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

func NewListTapesPaginator added in v0.9.0

func NewListTapesPaginator(req ListTapesRequest) ListTapesPaginator

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

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

// Example iterating over pages.
req := client.ListTapesRequest(input)
p := storagegateway.NewListTapesRequestPaginator(req)

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

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

func (*ListTapesPaginator) CurrentPage added in v0.9.0

func (p *ListTapesPaginator) CurrentPage() *ListTapesOutput

type ListTapesRequest

type ListTapesRequest struct {
	*aws.Request
	Input *ListTapesInput
	Copy  func(*ListTapesInput) ListTapesRequest
}

ListTapesRequest is the request type for the ListTapes API operation.

func (ListTapesRequest) Send

Send marshals and sends the ListTapes API request.

type ListTapesResponse added in v0.9.0

type ListTapesResponse struct {
	*ListTapesOutput
	// contains filtered or unexported fields
}

ListTapesResponse is the response type for the ListTapes API operation.

func (*ListTapesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ListTapes request.

type ListVolumeInitiatorsInput

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) String

func (s ListVolumeInitiatorsInput) String() string

String returns the string representation

func (*ListVolumeInitiatorsInput) Validate

func (s *ListVolumeInitiatorsInput) Validate() error

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

type ListVolumeInitiatorsOutput

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) String

String returns the string representation

type ListVolumeInitiatorsRequest

type ListVolumeInitiatorsRequest struct {
	*aws.Request
	Input *ListVolumeInitiatorsInput
	Copy  func(*ListVolumeInitiatorsInput) ListVolumeInitiatorsRequest
}

ListVolumeInitiatorsRequest is the request type for the ListVolumeInitiators API operation.

func (ListVolumeInitiatorsRequest) Send

Send marshals and sends the ListVolumeInitiators API request.

type ListVolumeInitiatorsResponse added in v0.9.0

type ListVolumeInitiatorsResponse struct {
	*ListVolumeInitiatorsOutput
	// contains filtered or unexported fields
}

ListVolumeInitiatorsResponse is the response type for the ListVolumeInitiators API operation.

func (*ListVolumeInitiatorsResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ListVolumeInitiators request.

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

func (ListVolumeRecoveryPointsInput) String

String returns the string representation

func (*ListVolumeRecoveryPointsInput) Validate

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 AWS Region.
	GatewayARN *string `min:"50" type:"string"`

	// An array of VolumeRecoveryPointInfo objects.
	VolumeRecoveryPointInfos []VolumeRecoveryPointInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListVolumeRecoveryPointsOutput) String

String returns the string representation

type ListVolumeRecoveryPointsRequest

type ListVolumeRecoveryPointsRequest struct {
	*aws.Request
	Input *ListVolumeRecoveryPointsInput
	Copy  func(*ListVolumeRecoveryPointsInput) ListVolumeRecoveryPointsRequest
}

ListVolumeRecoveryPointsRequest is the request type for the ListVolumeRecoveryPoints API operation.

func (ListVolumeRecoveryPointsRequest) Send

Send marshals and sends the ListVolumeRecoveryPoints API request.

type ListVolumeRecoveryPointsResponse added in v0.9.0

type ListVolumeRecoveryPointsResponse struct {
	*ListVolumeRecoveryPointsOutput
	// contains filtered or unexported fields
}

ListVolumeRecoveryPointsResponse is the response type for the ListVolumeRecoveryPoints API operation.

func (*ListVolumeRecoveryPointsResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ListVolumeRecoveryPoints request.

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 AWS 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) String

func (s ListVolumesInput) String() string

String returns the string representation

func (*ListVolumesInput) Validate

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 AWS 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) String

func (s ListVolumesOutput) String() string

String returns the string representation

type ListVolumesPaginator added in v0.9.0

type ListVolumesPaginator struct {
	aws.Pager
}

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

func NewListVolumesPaginator added in v0.9.0

func NewListVolumesPaginator(req ListVolumesRequest) ListVolumesPaginator

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

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

// Example iterating over pages.
req := client.ListVolumesRequest(input)
p := storagegateway.NewListVolumesRequestPaginator(req)

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

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

func (*ListVolumesPaginator) CurrentPage added in v0.9.0

func (p *ListVolumesPaginator) CurrentPage() *ListVolumesOutput

type ListVolumesRequest

type ListVolumesRequest struct {
	*aws.Request
	Input *ListVolumesInput
	Copy  func(*ListVolumesInput) ListVolumesRequest
}

ListVolumesRequest is the request type for the ListVolumes API operation.

func (ListVolumesRequest) Send

Send marshals and sends the ListVolumes API request.

type ListVolumesResponse added in v0.9.0

type ListVolumesResponse struct {
	*ListVolumesOutput
	// contains filtered or unexported fields
}

ListVolumesResponse is the response type for the ListVolumes API operation.

func (*ListVolumesResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ListVolumes request.

type NFSFileShareDefaults

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 file gateways.

func (NFSFileShareDefaults) String

func (s NFSFileShareDefaults) String() string

String returns the string representation

func (*NFSFileShareDefaults) Validate

func (s *NFSFileShareDefaults) Validate() error

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

type NFSFileShareInfo

type NFSFileShareInfo struct {

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

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

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

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

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

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and AWS 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,
	// and otherwise to false. The default value is true.
	GuessMIMETypeEnabled *bool `type:"boolean"`

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

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

	// The ARN of the backend storage used for storing file data.
	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 file
	// gateways.
	NFSFileShareDefaults *NFSFileShareDefaults `type:"structure"`

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

	// 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. This value is true if
	// the write status is read-only, and otherwise 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.
	RequesterPays *bool `type:"boolean"`

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

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

	// 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"`
	// contains filtered or unexported fields
}

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

func (NFSFileShareInfo) String

func (s NFSFileShareInfo) String() string

String returns the string representation

type NetworkInterface

type NetworkInterface struct {

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

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

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

Describes a gateway's network interface.

func (NetworkInterface) String

func (s NetworkInterface) String() string

String returns the string representation

type NotifyWhenUploadedInput added in v0.2.0

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) String added in v0.2.0

func (s NotifyWhenUploadedInput) String() string

String returns the string representation

func (*NotifyWhenUploadedInput) Validate added in v0.2.0

func (s *NotifyWhenUploadedInput) Validate() error

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

type NotifyWhenUploadedOutput added in v0.2.0

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) String added in v0.2.0

func (s NotifyWhenUploadedOutput) String() string

String returns the string representation

type NotifyWhenUploadedRequest added in v0.2.0

type NotifyWhenUploadedRequest struct {
	*aws.Request
	Input *NotifyWhenUploadedInput
	Copy  func(*NotifyWhenUploadedInput) NotifyWhenUploadedRequest
}

NotifyWhenUploadedRequest is the request type for the NotifyWhenUploaded API operation.

func (NotifyWhenUploadedRequest) Send added in v0.2.0

Send marshals and sends the NotifyWhenUploaded API request.

type NotifyWhenUploadedResponse added in v0.9.0

type NotifyWhenUploadedResponse struct {
	*NotifyWhenUploadedOutput
	// contains filtered or unexported fields
}

NotifyWhenUploadedResponse is the response type for the NotifyWhenUploaded API operation.

func (*NotifyWhenUploadedResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the NotifyWhenUploaded request.

type ObjectACL added in v0.3.0

type ObjectACL string

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

const (
	ObjectACLPrivate                ObjectACL = "private"
	ObjectACLPublicRead             ObjectACL = "public-read"
	ObjectACLPublicReadWrite        ObjectACL = "public-read-write"
	ObjectACLAuthenticatedRead      ObjectACL = "authenticated-read"
	ObjectACLBucketOwnerRead        ObjectACL = "bucket-owner-read"
	ObjectACLBucketOwnerFullControl ObjectACL = "bucket-owner-full-control"
	ObjectACLAwsExecRead            ObjectACL = "aws-exec-read"
)

Enum values for ObjectACL

func (ObjectACL) MarshalValue added in v0.3.0

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

func (ObjectACL) MarshalValueBuf added in v0.3.0

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

type RefreshCacheInput

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".
	Recursive *bool `type:"boolean"`
	// contains filtered or unexported fields
}

RefreshCacheInput

func (RefreshCacheInput) String

func (s RefreshCacheInput) String() string

String returns the string representation

func (*RefreshCacheInput) Validate

func (s *RefreshCacheInput) Validate() error

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

type RefreshCacheOutput

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) String

func (s RefreshCacheOutput) String() string

String returns the string representation

type RefreshCacheRequest

type RefreshCacheRequest struct {
	*aws.Request
	Input *RefreshCacheInput
	Copy  func(*RefreshCacheInput) RefreshCacheRequest
}

RefreshCacheRequest is the request type for the RefreshCache API operation.

func (RefreshCacheRequest) Send

Send marshals and sends the RefreshCache API request.

type RefreshCacheResponse added in v0.9.0

type RefreshCacheResponse struct {
	*RefreshCacheOutput
	// contains filtered or unexported fields
}

RefreshCacheResponse is the response type for the RefreshCache API operation.

func (*RefreshCacheResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the RefreshCache request.

type RemoveTagsFromResourceInput

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) String

String returns the string representation

func (*RemoveTagsFromResourceInput) Validate

func (s *RemoveTagsFromResourceInput) Validate() error

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

type RemoveTagsFromResourceOutput

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) String

String returns the string representation

type RemoveTagsFromResourceRequest

type RemoveTagsFromResourceRequest struct {
	*aws.Request
	Input *RemoveTagsFromResourceInput
	Copy  func(*RemoveTagsFromResourceInput) RemoveTagsFromResourceRequest
}

RemoveTagsFromResourceRequest is the request type for the RemoveTagsFromResource API operation.

func (RemoveTagsFromResourceRequest) Send

Send marshals and sends the RemoveTagsFromResource API request.

type RemoveTagsFromResourceResponse added in v0.9.0

type RemoveTagsFromResourceResponse struct {
	*RemoveTagsFromResourceOutput
	// contains filtered or unexported fields
}

RemoveTagsFromResourceResponse is the response type for the RemoveTagsFromResource API operation.

func (*RemoveTagsFromResourceResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the RemoveTagsFromResource request.

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

func (ResetCacheInput) String

func (s ResetCacheInput) String() string

String returns the string representation

func (*ResetCacheInput) Validate

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

func (ResetCacheOutput) String

func (s ResetCacheOutput) String() string

String returns the string representation

type ResetCacheRequest

type ResetCacheRequest struct {
	*aws.Request
	Input *ResetCacheInput
	Copy  func(*ResetCacheInput) ResetCacheRequest
}

ResetCacheRequest is the request type for the ResetCache API operation.

func (ResetCacheRequest) Send

Send marshals and sends the ResetCache API request.

type ResetCacheResponse added in v0.9.0

type ResetCacheResponse struct {
	*ResetCacheOutput
	// contains filtered or unexported fields
}

ResetCacheResponse is the response type for the ResetCache API operation.

func (*ResetCacheResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ResetCache request.

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 AWS 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) String

func (s RetrieveTapeArchiveInput) String() string

String returns the string representation

func (*RetrieveTapeArchiveInput) Validate

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) String

func (s RetrieveTapeArchiveOutput) String() string

String returns the string representation

type RetrieveTapeArchiveRequest

type RetrieveTapeArchiveRequest struct {
	*aws.Request
	Input *RetrieveTapeArchiveInput
	Copy  func(*RetrieveTapeArchiveInput) RetrieveTapeArchiveRequest
}

RetrieveTapeArchiveRequest is the request type for the RetrieveTapeArchive API operation.

func (RetrieveTapeArchiveRequest) Send

Send marshals and sends the RetrieveTapeArchive API request.

type RetrieveTapeArchiveResponse added in v0.9.0

type RetrieveTapeArchiveResponse struct {
	*RetrieveTapeArchiveOutput
	// contains filtered or unexported fields
}

RetrieveTapeArchiveResponse is the response type for the RetrieveTapeArchive API operation.

func (*RetrieveTapeArchiveResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the RetrieveTapeArchive request.

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 AWS 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) String

String returns the string representation

func (*RetrieveTapeRecoveryPointInput) Validate

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) String

String returns the string representation

type RetrieveTapeRecoveryPointRequest

type RetrieveTapeRecoveryPointRequest struct {
	*aws.Request
	Input *RetrieveTapeRecoveryPointInput
	Copy  func(*RetrieveTapeRecoveryPointInput) RetrieveTapeRecoveryPointRequest
}

RetrieveTapeRecoveryPointRequest is the request type for the RetrieveTapeRecoveryPoint API operation.

func (RetrieveTapeRecoveryPointRequest) Send

Send marshals and sends the RetrieveTapeRecoveryPoint API request.

type RetrieveTapeRecoveryPointResponse added in v0.9.0

type RetrieveTapeRecoveryPointResponse struct {
	*RetrieveTapeRecoveryPointOutput
	// contains filtered or unexported fields
}

RetrieveTapeRecoveryPointResponse is the response type for the RetrieveTapeRecoveryPoint API operation.

func (*RetrieveTapeRecoveryPointResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the RetrieveTapeRecoveryPoint request.

type SMBFileShareInfo added in v0.5.0

type SMBFileShareInfo struct {

	// 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.
	// For example @group1. Can only be set if Authentication is set to ActiveDirectory.
	AdminUserList []string `type:"list"`

	// The authentication method of the file share.
	//
	// Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
	Authentication *string `min:"5" type:"string"`

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

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

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

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

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and AWS 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,
	// and otherwise to false. The default value is true.
	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. For
	// example @group1. Can only be set if Authentication is set to ActiveDirectory.
	InvalidUserList []string `type:"list"`

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

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

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

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

	// 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. This value is true if
	// the write status is read-only, and otherwise 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.
	RequesterPays *bool `type:"boolean"`

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

	// If this value is set to "true", indicates that ACL (access control list)
	// 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 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"`

	// 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. For example
	// @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 file gateway discovers them in S3 buckets. This operation is only supported for file gateways.

func (SMBFileShareInfo) String added in v0.5.0

func (s SMBFileShareInfo) String() string

String returns the string representation

type SMBSecurityStrategy added in v0.10.0

type SMBSecurityStrategy string
const (
	SMBSecurityStrategyClientSpecified     SMBSecurityStrategy = "ClientSpecified"
	SMBSecurityStrategyMandatorySigning    SMBSecurityStrategy = "MandatorySigning"
	SMBSecurityStrategyMandatoryEncryption SMBSecurityStrategy = "MandatoryEncryption"
)

Enum values for SMBSecurityStrategy

func (SMBSecurityStrategy) MarshalValue added in v0.10.0

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

func (SMBSecurityStrategy) MarshalValueBuf added in v0.10.0

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

type SetLocalConsolePasswordInput

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

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

SetLocalConsolePasswordInput

func (SetLocalConsolePasswordInput) String

String returns the string representation

func (*SetLocalConsolePasswordInput) Validate

func (s *SetLocalConsolePasswordInput) Validate() error

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

type SetLocalConsolePasswordOutput

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

func (SetLocalConsolePasswordOutput) String

String returns the string representation

type SetLocalConsolePasswordRequest

type SetLocalConsolePasswordRequest struct {
	*aws.Request
	Input *SetLocalConsolePasswordInput
	Copy  func(*SetLocalConsolePasswordInput) SetLocalConsolePasswordRequest
}

SetLocalConsolePasswordRequest is the request type for the SetLocalConsolePassword API operation.

func (SetLocalConsolePasswordRequest) Send

Send marshals and sends the SetLocalConsolePassword API request.

type SetLocalConsolePasswordResponse added in v0.9.0

type SetLocalConsolePasswordResponse struct {
	*SetLocalConsolePasswordOutput
	// contains filtered or unexported fields
}

SetLocalConsolePasswordResponse is the response type for the SetLocalConsolePassword API operation.

func (*SetLocalConsolePasswordResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the SetLocalConsolePassword request.

type SetSMBGuestPasswordInput added in v0.5.0

type SetSMBGuestPasswordInput struct {

	// The Amazon Resource Name (ARN) of the 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 required field
	Password *string `min:"6" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

SetSMBGuestPasswordInput

func (SetSMBGuestPasswordInput) String added in v0.5.0

func (s SetSMBGuestPasswordInput) String() string

String returns the string representation

func (*SetSMBGuestPasswordInput) Validate added in v0.5.0

func (s *SetSMBGuestPasswordInput) Validate() error

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

type SetSMBGuestPasswordOutput added in v0.5.0

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

func (SetSMBGuestPasswordOutput) String added in v0.5.0

func (s SetSMBGuestPasswordOutput) String() string

String returns the string representation

type SetSMBGuestPasswordRequest added in v0.5.0

type SetSMBGuestPasswordRequest struct {
	*aws.Request
	Input *SetSMBGuestPasswordInput
	Copy  func(*SetSMBGuestPasswordInput) SetSMBGuestPasswordRequest
}

SetSMBGuestPasswordRequest is the request type for the SetSMBGuestPassword API operation.

func (SetSMBGuestPasswordRequest) Send added in v0.5.0

Send marshals and sends the SetSMBGuestPassword API request.

type SetSMBGuestPasswordResponse added in v0.9.0

type SetSMBGuestPasswordResponse struct {
	*SetSMBGuestPasswordOutput
	// contains filtered or unexported fields
}

SetSMBGuestPasswordResponse is the response type for the SetSMBGuestPassword API operation.

func (*SetSMBGuestPasswordResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the SetSMBGuestPassword request.

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

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

func (ShutdownGatewayInput) String

func (s ShutdownGatewayInput) String() string

String returns the string representation

func (*ShutdownGatewayInput) Validate

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

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

func (ShutdownGatewayOutput) String

func (s ShutdownGatewayOutput) String() string

String returns the string representation

type ShutdownGatewayRequest

type ShutdownGatewayRequest struct {
	*aws.Request
	Input *ShutdownGatewayInput
	Copy  func(*ShutdownGatewayInput) ShutdownGatewayRequest
}

ShutdownGatewayRequest is the request type for the ShutdownGateway API operation.

func (ShutdownGatewayRequest) Send

Send marshals and sends the ShutdownGateway API request.

type ShutdownGatewayResponse added in v0.9.0

type ShutdownGatewayResponse struct {
	*ShutdownGatewayOutput
	// contains filtered or unexported fields
}

ShutdownGatewayResponse is the response type for the ShutdownGateway API operation.

func (*ShutdownGatewayResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the ShutdownGateway request.

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

A JSON object containing the of the gateway to start.

func (StartGatewayInput) String

func (s StartGatewayInput) String() string

String returns the string representation

func (*StartGatewayInput) Validate

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

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

func (StartGatewayOutput) String

func (s StartGatewayOutput) String() string

String returns the string representation

type StartGatewayRequest

type StartGatewayRequest struct {
	*aws.Request
	Input *StartGatewayInput
	Copy  func(*StartGatewayInput) StartGatewayRequest
}

StartGatewayRequest is the request type for the StartGateway API operation.

func (StartGatewayRequest) Send

Send marshals and sends the StartGateway API request.

type StartGatewayResponse added in v0.9.0

type StartGatewayResponse struct {
	*StartGatewayOutput
	// contains filtered or unexported fields
}

StartGatewayResponse is the response type for the StartGateway API operation.

func (*StartGatewayResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the StartGateway request.

type StorageGatewayError added in v0.9.0

type StorageGatewayError struct {

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

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

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

func (StorageGatewayError) String added in v0.9.0

func (s StorageGatewayError) String() string

String returns the string representation

type StorediSCSIVolume

type StorediSCSIVolume struct {

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

	// The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server
	// side encryption. 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) String

func (s StorediSCSIVolume) String() string

String returns the string representation

type Tag

type Tag struct {

	// Tag key (String). 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) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

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

type Tape

type Tape struct {

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

	// 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 (Glacier or Deep Archive) that corresponds
	// to the pool.
	//
	// Valid values: "GLACIER", "DEEP_ARCHIVE"
	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 Amazon Resource Name (ARN) of the virtual tape.
	TapeARN *string `min:"50" type:"string"`

	// The barcode that identifies a specific virtual tape.
	TapeBarcode *string `min:"7" type:"string"`

	// The date the virtual tape was created.
	TapeCreatedDate *time.Time `type:"timestamp"`

	// The size, in bytes, of the virtual tape capacity.
	TapeSizeInBytes *int64 `type:"long"`

	// The current state of the virtual tape.
	TapeStatus *string `type:"string"`

	// The size, in bytes, of data stored on the virtual tape.
	//
	// This value is not available for tapes created prior to May 13, 2015.
	TapeUsedInBytes *int64 `type:"long"`

	// The virtual tape library (VTL) device that the virtual tape is associated
	// with.
	VTLDevice *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

Describes a virtual tape object.

func (Tape) String

func (s Tape) String() string

String returns the string representation

type TapeArchive

type TapeArchive struct {

	// The time that the archiving of the virtual tape was completed.
	//
	// The default time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'
	// format.
	CompletionTime *time.Time `type:"timestamp"`

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

	// 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.
	//
	// Valid values: "GLACIER", "DEEP_ARCHIVE"
	PoolId *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the tape gateway that the virtual tape
	// is being retrieved to.
	//
	// The virtual tape is retrieved from the virtual tape shelf (VTS).
	RetrievedTo *string `min:"50" type:"string"`

	// The Amazon Resource Name (ARN) of an archived virtual tape.
	TapeARN *string `min:"50" type:"string"`

	// The barcode that identifies the archived virtual tape.
	TapeBarcode *string `min:"7" type:"string"`

	// The date the virtual tape was created.
	TapeCreatedDate *time.Time `type:"timestamp"`

	// The size, in bytes, of the archived virtual tape.
	TapeSizeInBytes *int64 `type:"long"`

	// The current state of the archived virtual tape.
	TapeStatus *string `type:"string"`

	// The size, in bytes, of data stored on the virtual tape.
	//
	// This value is not available for tapes created prior to May 13, 2015.
	TapeUsedInBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

Represents a virtual tape that is archived in the virtual tape shelf (VTS).

func (TapeArchive) String

func (s TapeArchive) String() string

String returns the string representation

type TapeInfo

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 AWS Region.
	GatewayARN *string `min:"50" 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 (Glacier or Deep Archive) that
	// corresponds to the pool.
	//
	// Valid values: "GLACIER", "DEEP_ARCHIVE"
	PoolId *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of a virtual tape.
	TapeARN *string `min:"50" type:"string"`

	// The barcode that identifies a specific virtual tape.
	TapeBarcode *string `min:"7" type:"string"`

	// The size, in bytes, of a virtual tape.
	TapeSizeInBytes *int64 `type:"long"`

	// The status of the tape.
	TapeStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a virtual tape.

func (TapeInfo) String

func (s TapeInfo) String() string

String returns the string representation

type TapeRecoveryPointInfo

type TapeRecoveryPointInfo struct {

	// The Amazon Resource Name (ARN) of the virtual tape.
	TapeARN *string `min:"50" type:"string"`

	// The time when the point-in-time view of the virtual tape was replicated for
	// later recovery.
	//
	// The default time stamp format of the tape recovery point time is in the ISO8601
	// extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
	TapeRecoveryPointTime *time.Time `type:"timestamp"`

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

func (s TapeRecoveryPointInfo) String() string

String returns the string representation

type UpdateBandwidthRateLimitInput

type UpdateBandwidthRateLimitInput struct {

	// The average download bandwidth rate limit in bits per second.
	AverageDownloadRateLimitInBitsPerSec *int64 `min:"102400" type:"long"`

	// The average upload bandwidth rate limit in bits per second.
	AverageUploadRateLimitInBitsPerSec *int64 `min:"51200" type:"long"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and AWS 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) String

String returns the string representation

func (*UpdateBandwidthRateLimitInput) Validate

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

A JSON object containing the of the gateway whose throttle information was updated.

func (UpdateBandwidthRateLimitOutput) String

String returns the string representation

type UpdateBandwidthRateLimitRequest

type UpdateBandwidthRateLimitRequest struct {
	*aws.Request
	Input *UpdateBandwidthRateLimitInput
	Copy  func(*UpdateBandwidthRateLimitInput) UpdateBandwidthRateLimitRequest
}

UpdateBandwidthRateLimitRequest is the request type for the UpdateBandwidthRateLimit API operation.

func (UpdateBandwidthRateLimitRequest) Send

Send marshals and sends the UpdateBandwidthRateLimit API request.

type UpdateBandwidthRateLimitResponse added in v0.9.0

type UpdateBandwidthRateLimitResponse struct {
	*UpdateBandwidthRateLimitOutput
	// contains filtered or unexported fields
}

UpdateBandwidthRateLimitResponse is the response type for the UpdateBandwidthRateLimit API operation.

func (*UpdateBandwidthRateLimitResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the UpdateBandwidthRateLimit request.

type UpdateChapCredentialsInput

type UpdateChapCredentialsInput struct {

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

	// The secret key that the initiator (for example, the Windows client) must
	// provide to participate in mutual CHAP with the target.
	//
	// The secret key must be between 12 and 16 bytes when encoded in UTF-8.
	//
	// SecretToAuthenticateInitiator is a required field
	SecretToAuthenticateInitiator *string `min:"1" type:"string" required:"true" 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 *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) String

String returns the string representation

func (*UpdateChapCredentialsInput) Validate

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) String

String returns the string representation

type UpdateChapCredentialsRequest

type UpdateChapCredentialsRequest struct {
	*aws.Request
	Input *UpdateChapCredentialsInput
	Copy  func(*UpdateChapCredentialsInput) UpdateChapCredentialsRequest
}

UpdateChapCredentialsRequest is the request type for the UpdateChapCredentials API operation.

func (UpdateChapCredentialsRequest) Send

Send marshals and sends the UpdateChapCredentials API request.

type UpdateChapCredentialsResponse added in v0.9.0

type UpdateChapCredentialsResponse struct {
	*UpdateChapCredentialsOutput
	// contains filtered or unexported fields
}

UpdateChapCredentialsResponse is the response type for the UpdateChapCredentials API operation.

func (*UpdateChapCredentialsResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the UpdateChapCredentials request.

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

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

	// A value that indicates the time zone of the gateway.
	GatewayTimezone *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateGatewayInformationInput) String

String returns the string representation

func (*UpdateGatewayInformationInput) Validate

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 AWS 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 ARN of the gateway that was updated.

func (UpdateGatewayInformationOutput) String

String returns the string representation

type UpdateGatewayInformationRequest

type UpdateGatewayInformationRequest struct {
	*aws.Request
	Input *UpdateGatewayInformationInput
	Copy  func(*UpdateGatewayInformationInput) UpdateGatewayInformationRequest
}

UpdateGatewayInformationRequest is the request type for the UpdateGatewayInformation API operation.

func (UpdateGatewayInformationRequest) Send

Send marshals and sends the UpdateGatewayInformation API request.

type UpdateGatewayInformationResponse added in v0.9.0

type UpdateGatewayInformationResponse struct {
	*UpdateGatewayInformationOutput
	// contains filtered or unexported fields
}

UpdateGatewayInformationResponse is the response type for the UpdateGatewayInformation API operation.

func (*UpdateGatewayInformationResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the UpdateGatewayInformation request.

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

A JSON object containing the of the gateway to update.

func (UpdateGatewaySoftwareNowInput) String

String returns the string representation

func (*UpdateGatewaySoftwareNowInput) Validate

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

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

func (UpdateGatewaySoftwareNowOutput) String

String returns the string representation

type UpdateGatewaySoftwareNowRequest

type UpdateGatewaySoftwareNowRequest struct {
	*aws.Request
	Input *UpdateGatewaySoftwareNowInput
	Copy  func(*UpdateGatewaySoftwareNowInput) UpdateGatewaySoftwareNowRequest
}

UpdateGatewaySoftwareNowRequest is the request type for the UpdateGatewaySoftwareNow API operation.

func (UpdateGatewaySoftwareNowRequest) Send

Send marshals and sends the UpdateGatewaySoftwareNow API request.

type UpdateGatewaySoftwareNowResponse added in v0.9.0

type UpdateGatewaySoftwareNowResponse struct {
	*UpdateGatewaySoftwareNowOutput
	// contains filtered or unexported fields
}

UpdateGatewaySoftwareNowResponse is the response type for the UpdateGatewaySoftwareNow API operation.

func (*UpdateGatewaySoftwareNowResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the UpdateGatewaySoftwareNow request.

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.
	//
	// This value is only available for tape and volume gateways.
	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 AWS 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) String

String returns the string representation

func (*UpdateMaintenanceStartTimeInput) Validate

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

A JSON object containing the of the gateway whose maintenance start time is updated.

func (UpdateMaintenanceStartTimeOutput) String

String returns the string representation

type UpdateMaintenanceStartTimeRequest

type UpdateMaintenanceStartTimeRequest struct {
	*aws.Request
	Input *UpdateMaintenanceStartTimeInput
	Copy  func(*UpdateMaintenanceStartTimeInput) UpdateMaintenanceStartTimeRequest
}

UpdateMaintenanceStartTimeRequest is the request type for the UpdateMaintenanceStartTime API operation.

func (UpdateMaintenanceStartTimeRequest) Send

Send marshals and sends the UpdateMaintenanceStartTime API request.

type UpdateMaintenanceStartTimeResponse added in v0.9.0

type UpdateMaintenanceStartTimeResponse struct {
	*UpdateMaintenanceStartTimeOutput
	// contains filtered or unexported fields
}

UpdateMaintenanceStartTimeResponse is the response type for the UpdateMaintenanceStartTime API operation.

func (*UpdateMaintenanceStartTimeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the UpdateMaintenanceStartTime request.

type UpdateNFSFileShareInput

type UpdateNFSFileShareInput struct {

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

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

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

	// 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,
	// and otherwise to false. The default value is true.
	GuessMIMETypeEnabled *bool `type:"boolean"`

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

	// The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server
	// side encryption. 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"`

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

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

	// 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.
	RequesterPays *bool `type:"boolean"`

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

UpdateNFSFileShareInput

func (UpdateNFSFileShareInput) String

func (s UpdateNFSFileShareInput) String() string

String returns the string representation

func (*UpdateNFSFileShareInput) Validate

func (s *UpdateNFSFileShareInput) Validate() error

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

type UpdateNFSFileShareOutput

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) String

func (s UpdateNFSFileShareOutput) String() string

String returns the string representation

type UpdateNFSFileShareRequest

type UpdateNFSFileShareRequest struct {
	*aws.Request
	Input *UpdateNFSFileShareInput
	Copy  func(*UpdateNFSFileShareInput) UpdateNFSFileShareRequest
}

UpdateNFSFileShareRequest is the request type for the UpdateNFSFileShare API operation.

func (UpdateNFSFileShareRequest) Send

Send marshals and sends the UpdateNFSFileShare API request.

type UpdateNFSFileShareResponse added in v0.9.0

type UpdateNFSFileShareResponse struct {
	*UpdateNFSFileShareOutput
	// contains filtered or unexported fields
}

UpdateNFSFileShareResponse is the response type for the UpdateNFSFileShare API operation.

func (*UpdateNFSFileShareResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the UpdateNFSFileShare request.

type UpdateSMBFileShareInput added in v0.5.0

type UpdateSMBFileShareInput struct {

	// A list of users in the Active Directory that have administrator rights to
	// the file share. A group must be prefixed with the @ character. For example
	// @group1. Can only be set if Authentication is set to ActiveDirectory.
	AdminUserList []string `type:"list"`

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

	// The Amazon Resource Name (ARN) of the SMB file share that you want to update.
	//
	// FileShareARN is a required field
	FileShareARN *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,
	// and otherwise to false. The default value is true.
	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. For
	// example @group1. Can only be set if Authentication is set to ActiveDirectory.
	InvalidUserList []string `type:"list"`

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

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

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

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

	// 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.
	RequesterPays *bool `type:"boolean"`

	// Set this value to "true to enable ACL (access control list) on the SMB file
	// share. Set it to "false" to map file and directory permissions to the POSIX
	// permissions.
	//
	// For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin
	// the Storage Gateway User Guide.
	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. For example
	// @group1. Can only be set if Authentication is set to ActiveDirectory.
	ValidUserList []string `type:"list"`
	// contains filtered or unexported fields
}

UpdateSMBFileShareInput

func (UpdateSMBFileShareInput) String added in v0.5.0

func (s UpdateSMBFileShareInput) String() string

String returns the string representation

func (*UpdateSMBFileShareInput) Validate added in v0.5.0

func (s *UpdateSMBFileShareInput) Validate() error

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

type UpdateSMBFileShareOutput added in v0.5.0

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) String added in v0.5.0

func (s UpdateSMBFileShareOutput) String() string

String returns the string representation

type UpdateSMBFileShareRequest added in v0.5.0

type UpdateSMBFileShareRequest struct {
	*aws.Request
	Input *UpdateSMBFileShareInput
	Copy  func(*UpdateSMBFileShareInput) UpdateSMBFileShareRequest
}

UpdateSMBFileShareRequest is the request type for the UpdateSMBFileShare API operation.

func (UpdateSMBFileShareRequest) Send added in v0.5.0

Send marshals and sends the UpdateSMBFileShare API request.

type UpdateSMBFileShareResponse added in v0.9.0

type UpdateSMBFileShareResponse struct {
	*UpdateSMBFileShareOutput
	// contains filtered or unexported fields
}

UpdateSMBFileShareResponse is the response type for the UpdateSMBFileShare API operation.

func (*UpdateSMBFileShareResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the UpdateSMBFileShare request.

type UpdateSMBSecurityStrategyInput added in v0.10.0

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 AWS 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.
	//
	// 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 SMBSecurityStrategy `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateSMBSecurityStrategyInput) String added in v0.10.0

String returns the string representation

func (*UpdateSMBSecurityStrategyInput) Validate added in v0.10.0

func (s *UpdateSMBSecurityStrategyInput) Validate() error

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

type UpdateSMBSecurityStrategyOutput added in v0.10.0

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

func (UpdateSMBSecurityStrategyOutput) String added in v0.10.0

String returns the string representation

type UpdateSMBSecurityStrategyRequest added in v0.10.0

type UpdateSMBSecurityStrategyRequest struct {
	*aws.Request
	Input *UpdateSMBSecurityStrategyInput
	Copy  func(*UpdateSMBSecurityStrategyInput) UpdateSMBSecurityStrategyRequest
}

UpdateSMBSecurityStrategyRequest is the request type for the UpdateSMBSecurityStrategy API operation.

func (UpdateSMBSecurityStrategyRequest) Send added in v0.10.0

Send marshals and sends the UpdateSMBSecurityStrategy API request.

type UpdateSMBSecurityStrategyResponse added in v0.10.0

type UpdateSMBSecurityStrategyResponse struct {
	*UpdateSMBSecurityStrategyOutput
	// contains filtered or unexported fields
}

UpdateSMBSecurityStrategyResponse is the response type for the UpdateSMBSecurityStrategy API operation.

func (*UpdateSMBSecurityStrategyResponse) SDKResponseMetdata added in v0.10.0

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

SDKResponseMetdata returns the response metadata for the UpdateSMBSecurityStrategy request.

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) String

String returns the string representation

func (*UpdateSnapshotScheduleInput) Validate

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 of the updated storage volume.

func (UpdateSnapshotScheduleOutput) String

String returns the string representation

type UpdateSnapshotScheduleRequest

type UpdateSnapshotScheduleRequest struct {
	*aws.Request
	Input *UpdateSnapshotScheduleInput
	Copy  func(*UpdateSnapshotScheduleInput) UpdateSnapshotScheduleRequest
}

UpdateSnapshotScheduleRequest is the request type for the UpdateSnapshotSchedule API operation.

func (UpdateSnapshotScheduleRequest) Send

Send marshals and sends the UpdateSnapshotSchedule API request.

type UpdateSnapshotScheduleResponse added in v0.9.0

type UpdateSnapshotScheduleResponse struct {
	*UpdateSnapshotScheduleOutput
	// contains filtered or unexported fields
}

UpdateSnapshotScheduleResponse is the response type for the UpdateSnapshotSchedule API operation.

func (*UpdateSnapshotScheduleResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the UpdateSnapshotSchedule request.

type UpdateVTLDeviceTypeInput

type UpdateVTLDeviceTypeInput struct {

	// The type of medium changer you want to select.
	//
	// Valid Values: "STK-L700", "AWS-Gateway-VTL"
	//
	// DeviceType is a required field
	DeviceType *string `min:"2" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the medium changer you want to select.
	//
	// VTLDeviceARN is a required field
	VTLDeviceARN *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVTLDeviceTypeInput) String

func (s UpdateVTLDeviceTypeInput) String() string

String returns the string representation

func (*UpdateVTLDeviceTypeInput) Validate

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) String

func (s UpdateVTLDeviceTypeOutput) String() string

String returns the string representation

type UpdateVTLDeviceTypeRequest

type UpdateVTLDeviceTypeRequest struct {
	*aws.Request
	Input *UpdateVTLDeviceTypeInput
	Copy  func(*UpdateVTLDeviceTypeInput) UpdateVTLDeviceTypeRequest
}

UpdateVTLDeviceTypeRequest is the request type for the UpdateVTLDeviceType API operation.

func (UpdateVTLDeviceTypeRequest) Send

Send marshals and sends the UpdateVTLDeviceType API request.

type UpdateVTLDeviceTypeResponse added in v0.9.0

type UpdateVTLDeviceTypeResponse struct {
	*UpdateVTLDeviceTypeOutput
	// contains filtered or unexported fields
}

UpdateVTLDeviceTypeResponse is the response type for the UpdateVTLDeviceType API operation.

func (*UpdateVTLDeviceTypeResponse) SDKResponseMetdata added in v0.9.0

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

SDKResponseMetdata returns the response metadata for the UpdateVTLDeviceType request.

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) String

func (s VTLDevice) String() string

String returns the string representation

type VolumeInfo

type VolumeInfo struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and AWS 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) String

func (s VolumeInfo) String() string

String returns the string representation

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) String

func (s VolumeRecoveryPointInfo) String() string

String returns the string representation

type VolumeiSCSIAttributes

type VolumeiSCSIAttributes struct {

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

	// The logical disk number.
	LunNumber *int64 `min:"1" type:"integer"`

	// The network interface identifier.
	NetworkInterfaceId *string `type:"string"`

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

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

Lists iSCSI information about a volume.

func (VolumeiSCSIAttributes) String

func (s VolumeiSCSIAttributes) String() string

String returns the string representation

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