# Packages
Package storagegatewayiface provides an interface to enable mocking the AWS Storage Gateway service client for testing your code.
# Functions
ActiveDirectoryStatus_Values returns all elements of the ActiveDirectoryStatus enum.
AutomaticUpdatePolicy_Values returns all elements of the AutomaticUpdatePolicy enum.
AvailabilityMonitorTestStatus_Values returns all elements of the AvailabilityMonitorTestStatus enum.
CaseSensitivity_Values returns all elements of the CaseSensitivity enum.
ErrorCode_Values returns all elements of the ErrorCode enum.
FileShareType_Values returns all elements of the FileShareType enum.
GatewayCapacity_Values returns all elements of the GatewayCapacity enum.
HostEnvironment_Values returns all elements of the HostEnvironment enum.
New creates a new instance of the StorageGateway client with a session.
ObjectACL_Values returns all elements of the ObjectACL enum.
PoolStatus_Values returns all elements of the PoolStatus enum.
RetentionLockType_Values returns all elements of the RetentionLockType enum.
SMBSecurityStrategy_Values returns all elements of the SMBSecurityStrategy enum.
TapeStorageClass_Values returns all elements of the TapeStorageClass enum.
# Constants
ActiveDirectoryStatusAccessDenied is a ActiveDirectoryStatus enum value.
ActiveDirectoryStatusDetached is a ActiveDirectoryStatus enum value.
ActiveDirectoryStatusJoined is a ActiveDirectoryStatus enum value.
ActiveDirectoryStatusJoining is a ActiveDirectoryStatus enum value.
ActiveDirectoryStatusNetworkError is a ActiveDirectoryStatus enum value.
ActiveDirectoryStatusTimeout is a ActiveDirectoryStatus enum value.
ActiveDirectoryStatusUnknownError is a ActiveDirectoryStatus enum value.
AutomaticUpdatePolicyAllVersions is a AutomaticUpdatePolicy enum value.
AutomaticUpdatePolicyEmergencyVersionsOnly is a AutomaticUpdatePolicy enum value.
AvailabilityMonitorTestStatusComplete is a AvailabilityMonitorTestStatus enum value.
AvailabilityMonitorTestStatusFailed is a AvailabilityMonitorTestStatus enum value.
AvailabilityMonitorTestStatusPending is a AvailabilityMonitorTestStatus enum value.
CaseSensitivityCaseSensitive is a CaseSensitivity enum value.
CaseSensitivityClientSpecified is a CaseSensitivity enum value.
ID to lookup a service endpoint with.
ErrCodeInternalServerError for service response error code "InternalServerError".
ErrCodeInvalidGatewayRequestException for service response error code "InvalidGatewayRequestException".
ErrCodeServiceUnavailableError for service response error code "ServiceUnavailableError".
ErrorCodeActivationKeyExpired is a ErrorCode enum value.
ErrorCodeActivationKeyInvalid is a ErrorCode enum value.
ErrorCodeActivationKeyNotFound is a ErrorCode enum value.
ErrorCodeAuthenticationFailure is a ErrorCode enum value.
ErrorCodeBandwidthThrottleScheduleNotFound is a ErrorCode enum value.
ErrorCodeBlocked is a ErrorCode enum value.
ErrorCodeCannotExportSnapshot is a ErrorCode enum value.
ErrorCodeChapCredentialNotFound is a ErrorCode enum value.
ErrorCodeDiskAlreadyAllocated is a ErrorCode enum value.
ErrorCodeDiskDoesNotExist is a ErrorCode enum value.
ErrorCodeDiskSizeGreaterThanVolumeMaxSize is a ErrorCode enum value.
ErrorCodeDiskSizeLessThanVolumeSize is a ErrorCode enum value.
ErrorCodeDiskSizeNotGigAligned is a ErrorCode enum value.
ErrorCodeDuplicateCertificateInfo is a ErrorCode enum value.
ErrorCodeDuplicateSchedule is a ErrorCode enum value.
ErrorCodeEndpointNotFound is a ErrorCode enum value.
ErrorCodeGatewayInternalError is a ErrorCode enum value.
ErrorCodeGatewayNotConnected is a ErrorCode enum value.
ErrorCodeGatewayNotFound is a ErrorCode enum value.
ErrorCodeGatewayProxyNetworkConnectionBusy is a ErrorCode enum value.
ErrorCodeIamnotSupported is a ErrorCode enum value.
ErrorCodeInitiatorInvalid is a ErrorCode enum value.
ErrorCodeInitiatorNotFound is a ErrorCode enum value.
ErrorCodeInternalError is a ErrorCode enum value.
ErrorCodeInvalidEndpoint is a ErrorCode enum value.
ErrorCodeInvalidGateway is a ErrorCode enum value.
ErrorCodeInvalidParameters is a ErrorCode enum value.
ErrorCodeInvalidSchedule is a ErrorCode enum value.
ErrorCodeJoinDomainInProgress is a ErrorCode enum value.
ErrorCodeLocalStorageLimitExceeded is a ErrorCode enum value.
ErrorCodeLunAlreadyAllocated is a ErrorCode enum value.
ErrorCodeLunInvalid is a ErrorCode enum value.
ErrorCodeMaximumContentLengthExceeded is a ErrorCode enum value.
ErrorCodeMaximumTapeCartridgeCountExceeded is a ErrorCode enum value.
ErrorCodeMaximumVolumeCountExceeded is a ErrorCode enum value.
ErrorCodeNetworkConfigurationChanged is a ErrorCode enum value.
ErrorCodeNoDisksAvailable is a ErrorCode enum value.
ErrorCodeNotImplemented is a ErrorCode enum value.
ErrorCodeNotSupported is a ErrorCode enum value.
ErrorCodeOperationAborted is a ErrorCode enum value.
ErrorCodeOutdatedGateway is a ErrorCode enum value.
ErrorCodeParametersNotImplemented is a ErrorCode enum value.
ErrorCodeRegionInvalid is a ErrorCode enum value.
ErrorCodeRequestTimeout is a ErrorCode enum value.
ErrorCodeServiceUnavailable is a ErrorCode enum value.
ErrorCodeSnapshotDeleted is a ErrorCode enum value.
ErrorCodeSnapshotIdInvalid is a ErrorCode enum value.
ErrorCodeSnapshotInProgress is a ErrorCode enum value.
ErrorCodeSnapshotNotFound is a ErrorCode enum value.
ErrorCodeSnapshotScheduleNotFound is a ErrorCode enum value.
ErrorCodeStagingAreaFull is a ErrorCode enum value.
ErrorCodeStorageFailure is a ErrorCode enum value.
ErrorCodeTapeCartridgeNotFound is a ErrorCode enum value.
ErrorCodeTargetAlreadyExists is a ErrorCode enum value.
ErrorCodeTargetInvalid is a ErrorCode enum value.
ErrorCodeTargetNotFound is a ErrorCode enum value.
ErrorCodeUnauthorizedOperation is a ErrorCode enum value.
ErrorCodeVolumeAlreadyExists is a ErrorCode enum value.
ErrorCodeVolumeIdInvalid is a ErrorCode enum value.
ErrorCodeVolumeInUse is a ErrorCode enum value.
ErrorCodeVolumeNotFound is a ErrorCode enum value.
ErrorCodeVolumeNotReady is a ErrorCode enum value.
FileShareTypeNfs is a FileShareType enum value.
FileShareTypeSmb is a FileShareType enum value.
GatewayCapacityLarge is a GatewayCapacity enum value.
GatewayCapacityMedium is a GatewayCapacity enum value.
GatewayCapacitySmall is a GatewayCapacity enum value.
HostEnvironmentEc2 is a HostEnvironment enum value.
HostEnvironmentHyperV is a HostEnvironment enum value.
HostEnvironmentKvm is a HostEnvironment enum value.
HostEnvironmentOther is a HostEnvironment enum value.
HostEnvironmentSnowball is a HostEnvironment enum value.
HostEnvironmentVmware is a HostEnvironment enum value.
ObjectACLAuthenticatedRead is a ObjectACL enum value.
ObjectACLAwsExecRead is a ObjectACL enum value.
ObjectACLBucketOwnerFullControl is a ObjectACL enum value.
ObjectACLBucketOwnerRead is a ObjectACL enum value.
ObjectACLPrivate is a ObjectACL enum value.
ObjectACLPublicRead is a ObjectACL enum value.
ObjectACLPublicReadWrite is a ObjectACL enum value.
PoolStatusActive is a PoolStatus enum value.
PoolStatusDeleted is a PoolStatus enum value.
RetentionLockTypeCompliance is a RetentionLockType enum value.
RetentionLockTypeGovernance is a RetentionLockType enum value.
RetentionLockTypeNone is a RetentionLockType enum value.
ServiceID is a unique identifier of a specific service.
Name of service.
SMBSecurityStrategyClientSpecified is a SMBSecurityStrategy enum value.
SMBSecurityStrategyMandatoryEncryption is a SMBSecurityStrategy enum value.
SMBSecurityStrategyMandatoryEncryptionNoAes128 is a SMBSecurityStrategy enum value.
SMBSecurityStrategyMandatorySigning is a SMBSecurityStrategy enum value.
TapeStorageClassDeepArchive is a TapeStorageClass enum value.
TapeStorageClassGlacier is a TapeStorageClass enum value.
# Structs
A JSON object containing one or more of the following fields:
- ActivateGatewayInput$ActivationKey
- ActivateGatewayInput$GatewayName
- ActivateGatewayInput$GatewayRegion
- ActivateGatewayInput$GatewayTimezone
- ActivateGatewayInput$GatewayType
- ActivateGatewayInput$MediumChangerType
- ActivateGatewayInput$TapeDriveType.
Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway.
AddTagsToResourceInput.
AddTagsToResourceOutput.
A JSON object containing one or more of the following fields:
- AddWorkingStorageInput$DiskIds.
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.
Describes a bandwidth rate limit interval for a gateway.
The refresh cache information for the file share or FSx file systems.
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:
- CreateSnapshotInput$SnapshotDescription
- CreateSnapshotInput$VolumeARN.
A JSON object containing the following fields:.
A JSON object containing one or more of the following fields:
- CreateStorediSCSIVolumeInput$DiskId
- CreateStorediSCSIVolumeInput$NetworkInterfaceId
- CreateStorediSCSIVolumeInput$PreserveExistingData
- CreateStorediSCSIVolumeInput$SnapshotId
- CreateStorediSCSIVolumeInput$TargetName.
A JSON object containing the following fields:.
CreateTapesInput.
CreateTapeOutput.
CreateTapeWithBarcodeInput.
CreateTapeOutput.
A JSON object containing the following fields:
- DeleteBandwidthRateLimitInput$BandwidthType.
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:
- DeleteChapCredentialsInput$InitiatorName
- DeleteChapCredentialsInput$TargetARN.
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.
A JSON object containing the following fields:
- DescribeMaintenanceStartTimeOutput$SoftwareUpdatePreferences
- DescribeMaintenanceStartTimeOutput$DayOfMonth
- DescribeMaintenanceStartTimeOutput$DayOfWeek
- DescribeMaintenanceStartTimeOutput$HourOfDay
- DescribeMaintenanceStartTimeOutput$MinuteOfHour
- DescribeMaintenanceStartTimeOutput$Timezone.
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.
Specifies network configuration information for the gateway associated with the Amazon FSx file system.
Provides additional information about an error that was returned by the service.
Describes a file share.
Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.
Detailed information on file system association status.
Gets the summary returned by ListFileSystemAssociation, which is a summary of a created file system association.
Describes a gateway object.
An internal server error has occurred during the request.
An exception occurred because an invalid gateway request was issued to the service.
JoinDomainInput.
JoinDomainOutput.
ListFileShareInput.
ListFileShareOutput.
A JSON object containing zero or more of the following fields:
- ListGatewaysInput$Limit
- ListGatewaysInput$Marker.
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:
- ListTapesInput$Limit
- ListTapesInput$Marker
- ListTapesInput$TapeARNs.
A JSON object containing the following fields:
- ListTapesOutput$Marker
- ListTapesOutput$VolumeInfos.
ListVolumeInitiatorsInput.
ListVolumeInitiatorsOutput.
A JSON object that contains one or more of the following fields:
- ListVolumesInput$Limit
- ListVolumesInput$Marker.
A JSON object containing the following fields:
- ListVolumesOutput$Marker
- ListVolumesOutput$VolumeInfos.
Describes a gateway's network interface.
Describes Network File System (NFS) file share default values.
The Unix file permissions and ownership information assigned, by default, to native S3 objects when an S3 File Gateway discovers them in S3 buckets.
Describes a custom tape pool.
RefreshCacheInput.
RefreshCacheOutput.
RemoveTagsFromResourceInput.
RemoveTagsFromResourceOutput.
RetrieveTapeArchiveInput.
RetrieveTapeArchiveOutput.
RetrieveTapeRecoveryPointInput.
RetrieveTapeRecoveryPointOutput.
An internal server error has occurred because the service is unavailable.
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.
The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets.
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
A set of variables indicating the software update preferences for the gateway.
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.
StorageGateway provides the API operation methods for making requests to AWS Storage Gateway.
Describes an iSCSI stored volume.
A key-value pair that helps you manage, filter, and search for your resource.
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:
- UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec
- UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec.
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:
- UpdateChapCredentialsInput$InitiatorName
- UpdateChapCredentialsInput$SecretToAuthenticateInitiator
- UpdateChapCredentialsInput$SecretToAuthenticateTarget
- UpdateChapCredentialsInput$TargetARN.
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:
- UpdateMaintenanceStartTimeInput$SoftwareUpdatePreferences
- UpdateMaintenanceStartTimeInput$DayOfMonth
- UpdateMaintenanceStartTimeInput$DayOfWeek
- UpdateMaintenanceStartTimeInput$HourOfDay
- UpdateMaintenanceStartTimeInput$MinuteOfHour.
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:
- UpdateSnapshotScheduleInput$Description
- UpdateSnapshotScheduleInput$RecurrenceInHours
- UpdateSnapshotScheduleInput$StartAt
- UpdateSnapshotScheduleInput$VolumeARN.
A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.
UpdateVTLDeviceTypeOutput.
Describes a storage volume object.
Lists iSCSI information about a volume.
Describes a storage volume recovery point object.
Represents a device object associated with a tape gateway.