Crate rusoto_storagegateway
source · [−]Expand description
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 required request headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway.
-
Signing requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
-
Error responses: Provides reference information about AWS Storage Gateway errors.
-
Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
-
AWS Storage Gateway endpoints and quotas: Provides a list of each AWS Region and the endpoints available for use with AWS Storage Gateway.
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.
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.
If you’re using the service, you’re probably looking for StorageGatewayClient and StorageGateway.
Structs
A JSON object containing one or more of the following 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.
AddTagsToResourceInput
AddTagsToResourceOutput
A JSON object containing one or more of the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.
AttachVolumeInput
AttachVolumeOutput
Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically.
Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
The refresh cache information for the file share.
Describes an iSCSI cached volume.
CancelArchivalInput
CancelArchivalOutput
CancelRetrievalInput
CancelRetrievalOutput
Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
CreateNFSFileShareInput
CreateNFSFileShareOutput
CreateSMBFileShareInput
CreateSMBFileShareOutput
A JSON object containing one or more of the following fields:
A JSON object containing the following fields:
A JSON object containing one or more of the following fields:
A JSON object containing the following fields:
CreateTapeWithBarcodeInput
CreateTapeOutput
CreateTapesInput
CreateTapeOutput
A JSON object containing the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.
A JSON object containing one or more of the following fields:
A JSON object containing the following fields:
DeleteFileShareInput
DeleteFileShareOutput
A JSON object containing the ID of the gateway to delete.
A JSON object containing the ID of the deleted gateway.
DeleteTapeArchiveInput
DeleteTapeArchiveOutput
DeleteTapeInput
DeleteTapeOutput
A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted.
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
A JSON object containing the following fields:
A JSON object containing the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
A JSON object containing the following fields:
A JSON object containing the ID of the gateway.
A JSON object containing the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
DescribeNFSFileSharesInput
DescribeNFSFileSharesOutput
DescribeSMBFileSharesInput
DescribeSMBFileSharesOutput
A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
DescribeTapeArchivesInput
DescribeTapeArchivesOutput
DescribeTapeRecoveryPointsInput
DescribeTapeRecoveryPointsOutput
DescribeTapesInput
DescribeTapesOutput
DescribeVTLDevicesInput
DescribeVTLDevicesOutput
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
A JSON object containing the following fields:
AttachVolumeInput
AttachVolumeOutput
Lists iSCSI information about a VTL device.
DisableGatewayInput
DisableGatewayOutput
Represents a gateway's local disk.
Describes a file share.
Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.
Gets the summary returned by ListFileSystemAssociation, which is a summary of a created file system association.
Describes a gateway object.
JoinDomainInput
JoinDomainOutput
ListFileShareInput
ListFileShareOutput
A JSON object containing zero or more of the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
ListTagsForResourceInput
ListTagsForResourceOutput
A JSON object that contains one or more of the following fields:
A JSON object containing the following fields:
ListVolumeInitiatorsInput
ListVolumeInitiatorsOutput
A JSON object that contains one or more of the following fields:
A JSON object containing the following 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.
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.
Describes a gateway's network interface.
Describes a custom tape pool.
RefreshCacheInput
RefreshCacheOutput
RemoveTagsFromResourceInput
RemoveTagsFromResourceOutput
RetrieveTapeArchiveInput
RetrieveTapeArchiveOutput
RetrieveTapeRecoveryPointInput
RetrieveTapeRecoveryPointOutput
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.
SetLocalConsolePasswordInput
SetSMBGuestPasswordInput
A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.
A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.
A client for the AWS Storage Gateway API.
Provides additional information about an error that was returned by the service. See the errorCode and errorDetails members for more information about the error.
Describes an iSCSI stored volume.
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: + - = . _ : /.
Describes a virtual tape object.
Represents a virtual tape that is archived in the virtual tape shelf (VTS).
Describes a virtual tape.
Describes a recovery point.
A JSON object containing one or more of the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.
A JSON object containing one or more of the following fields:
A JSON object containing the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
A JSON object containing the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.
UpdateNFSFileShareInput
UpdateNFSFileShareOutput
UpdateSMBFileShareInput
UpdateSMBFileShareOutput
A JSON object containing one or more of the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.
UpdateVTLDeviceTypeOutput
Represents a device object associated with a tape gateway.
Describes a storage volume object.
Describes a storage volume recovery point object.
Lists iSCSI information about a volume.
Enums
Errors returned by ActivateGateway
Errors returned by AddCache
Errors returned by AddTagsToResource
Errors returned by AddUploadBuffer
Errors returned by AddWorkingStorage
Errors returned by AssignTapePool
Errors returned by AssociateFileSystem
Errors returned by AttachVolume
Errors returned by CancelArchival
Errors returned by CancelRetrieval
Errors returned by CreateCachediSCSIVolume
Errors returned by CreateNFSFileShare
Errors returned by CreateSMBFileShare
Errors returned by CreateSnapshot
Errors returned by CreateSnapshotFromVolumeRecoveryPoint
Errors returned by CreateStorediSCSIVolume
Errors returned by CreateTapePool
Errors returned by CreateTapeWithBarcode
Errors returned by CreateTapes
Errors returned by DeleteAutomaticTapeCreationPolicy
Errors returned by DeleteBandwidthRateLimit
Errors returned by DeleteChapCredentials
Errors returned by DeleteFileShare
Errors returned by DeleteGateway
Errors returned by DeleteSnapshotSchedule
Errors returned by DeleteTapeArchive
Errors returned by DeleteTape
Errors returned by DeleteTapePool
Errors returned by DeleteVolume
Errors returned by DescribeAvailabilityMonitorTest
Errors returned by DescribeBandwidthRateLimit
Errors returned by DescribeBandwidthRateLimitSchedule
Errors returned by DescribeCache
Errors returned by DescribeCachediSCSIVolumes
Errors returned by DescribeChapCredentials
Errors returned by DescribeFileSystemAssociations
Errors returned by DescribeGatewayInformation
Errors returned by DescribeMaintenanceStartTime
Errors returned by DescribeNFSFileShares
Errors returned by DescribeSMBFileShares
Errors returned by DescribeSMBSettings
Errors returned by DescribeSnapshotSchedule
Errors returned by DescribeStorediSCSIVolumes
Errors returned by DescribeTapeArchives
Errors returned by DescribeTapeRecoveryPoints
Errors returned by DescribeTapes
Errors returned by DescribeUploadBuffer
Errors returned by DescribeVTLDevices
Errors returned by DescribeWorkingStorage
Errors returned by DetachVolume
Errors returned by DisableGateway
Errors returned by DisassociateFileSystem
Errors returned by JoinDomain
Errors returned by ListAutomaticTapeCreationPolicies
Errors returned by ListFileShares
Errors returned by ListFileSystemAssociations
Errors returned by ListGateways
Errors returned by ListLocalDisks
Errors returned by ListTagsForResource
Errors returned by ListTapePools
Errors returned by ListTapes
Errors returned by ListVolumeInitiators
Errors returned by ListVolumeRecoveryPoints
Errors returned by ListVolumes
Errors returned by NotifyWhenUploaded
Errors returned by RefreshCache
Errors returned by RemoveTagsFromResource
Errors returned by ResetCache
Errors returned by RetrieveTapeArchive
Errors returned by RetrieveTapeRecoveryPoint
Errors returned by SetLocalConsolePassword
Errors returned by SetSMBGuestPassword
Errors returned by ShutdownGateway
Errors returned by StartAvailabilityMonitorTest
Errors returned by StartGateway
Errors returned by UpdateAutomaticTapeCreationPolicy
Errors returned by UpdateBandwidthRateLimit
Errors returned by UpdateBandwidthRateLimitSchedule
Errors returned by UpdateChapCredentials
Errors returned by UpdateFileSystemAssociation
Errors returned by UpdateGatewayInformation
Errors returned by UpdateGatewaySoftwareNow
Errors returned by UpdateMaintenanceStartTime
Errors returned by UpdateNFSFileShare
Errors returned by UpdateSMBFileShare
Errors returned by UpdateSMBFileShareVisibility
Errors returned by UpdateSMBSecurityStrategy
Errors returned by UpdateSnapshotSchedule
Errors returned by UpdateVTLDeviceType
Traits
Trait representing the capabilities of the AWS Storage Gateway API. AWS Storage Gateway clients implement this trait.