StorageGateway module#
Index > StorageGateway
Auto-generated documentation for StorageGateway type annotations stubs module mypy-boto3-storagegateway.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and StorageGateway
.
From PyPI with pip#
Install boto3-stubs
for StorageGateway
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[storagegateway]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[storagegateway]'
# standalone installation
python -m pip install mypy-boto3-storagegateway
How to uninstall#
python -m pip uninstall -y mypy-boto3-storagegateway
Usage#
Code samples can be found in Examples.
StorageGatewayClient#
Type annotations and code completion for boto3.client("storagegateway")
as StorageGatewayClient
boto3 documentation
# StorageGatewayClient usage example
from boto3.session import Session
from mypy_boto3_storagegateway.client import StorageGatewayClient
def get_client() -> StorageGatewayClient:
return Session().client("storagegateway")
Paginators#
Type annotations and code completion for paginators
from boto3.client("storagegateway").get_paginator("...")
.
# DescribeTapeArchivesPaginator usage example
from boto3.session import Session
from mypy_boto3_storagegateway.paginator import DescribeTapeArchivesPaginator
def get_describe_tape_archives_paginator() -> DescribeTapeArchivesPaginator:
return Session().client("storagegateway").get_paginator("describe_tape_archives"))
- DescribeTapeArchivesPaginator
- DescribeTapeRecoveryPointsPaginator
- DescribeTapesPaginator
- DescribeVTLDevicesPaginator
- ListFileSharesPaginator
- ListFileSystemAssociationsPaginator
- ListGatewaysPaginator
- ListTagsForResourcePaginator
- ListTapePoolsPaginator
- ListTapesPaginator
- ListVolumesPaginator
Literals#
Type annotations for literals used in methods and schemas.
# ActiveDirectoryStatusType usage example
from mypy_boto3_storagegateway.literals import ActiveDirectoryStatusType
def get_value() -> ActiveDirectoryStatusType:
return "ACCESS_DENIED"
- ActiveDirectoryStatusType
- AvailabilityMonitorTestStatusType
- CaseSensitivityType
- DescribeTapeArchivesPaginatorName
- DescribeTapeRecoveryPointsPaginatorName
- DescribeTapesPaginatorName
- DescribeVTLDevicesPaginatorName
- FileShareTypeType
- GatewayCapacityType
- HostEnvironmentType
- ListFileSharesPaginatorName
- ListFileSystemAssociationsPaginatorName
- ListGatewaysPaginatorName
- ListTagsForResourcePaginatorName
- ListTapePoolsPaginatorName
- ListTapesPaginatorName
- ListVolumesPaginatorName
- ObjectACLType
- PoolStatusType
- RetentionLockTypeType
- SMBSecurityStrategyType
- TapeStorageClassType
- StorageGatewayServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# TagTypeDef usage example
from mypy_boto3_storagegateway.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
- TagTypeDef
- ActivateGatewayOutputTypeDef
- AddCacheInputRequestTypeDef
- AddCacheOutputTypeDef
- AddTagsToResourceOutputTypeDef
- AddUploadBufferInputRequestTypeDef
- AddUploadBufferOutputTypeDef
- AddWorkingStorageInputRequestTypeDef
- AddWorkingStorageOutputTypeDef
- AssignTapePoolInputRequestTypeDef
- AssignTapePoolOutputTypeDef
- CacheAttributesTypeDef
- EndpointNetworkConfigurationTypeDef
- AssociateFileSystemOutputTypeDef
- AttachVolumeInputRequestTypeDef
- AttachVolumeOutputTypeDef
- AutomaticTapeCreationRuleTypeDef
- BandwidthRateLimitIntervalTypeDef
- VolumeiSCSIAttributesTypeDef
- CancelArchivalInputRequestTypeDef
- CancelArchivalOutputTypeDef
- CancelRetrievalInputRequestTypeDef
- CancelRetrievalOutputTypeDef
- ChapInfoTypeDef
- CreateCachediSCSIVolumeOutputTypeDef
- NFSFileShareDefaultsTypeDef
- CreateNFSFileShareOutputTypeDef
- CreateSMBFileShareOutputTypeDef
- CreateSnapshotFromVolumeRecoveryPointOutputTypeDef
- CreateSnapshotOutputTypeDef
- CreateStorediSCSIVolumeOutputTypeDef
- CreateTapePoolOutputTypeDef
- CreateTapeWithBarcodeOutputTypeDef
- CreateTapesOutputTypeDef
- DeleteAutomaticTapeCreationPolicyInputRequestTypeDef
- DeleteAutomaticTapeCreationPolicyOutputTypeDef
- DeleteBandwidthRateLimitInputRequestTypeDef
- DeleteBandwidthRateLimitOutputTypeDef
- DeleteChapCredentialsInputRequestTypeDef
- DeleteChapCredentialsOutputTypeDef
- DeleteFileShareInputRequestTypeDef
- DeleteFileShareOutputTypeDef
- DeleteGatewayInputRequestTypeDef
- DeleteGatewayOutputTypeDef
- DeleteSnapshotScheduleInputRequestTypeDef
- DeleteSnapshotScheduleOutputTypeDef
- DeleteTapeArchiveInputRequestTypeDef
- DeleteTapeArchiveOutputTypeDef
- DeleteTapeInputRequestTypeDef
- DeleteTapeOutputTypeDef
- DeleteTapePoolInputRequestTypeDef
- DeleteTapePoolOutputTypeDef
- DeleteVolumeInputRequestTypeDef
- DeleteVolumeOutputTypeDef
- DescribeAvailabilityMonitorTestInputRequestTypeDef
- DescribeAvailabilityMonitorTestOutputTypeDef
- DescribeBandwidthRateLimitInputRequestTypeDef
- DescribeBandwidthRateLimitOutputTypeDef
- DescribeBandwidthRateLimitScheduleInputRequestTypeDef
- DescribeCacheInputRequestTypeDef
- DescribeCacheOutputTypeDef
- DescribeCachediSCSIVolumesInputRequestTypeDef
- DescribeChapCredentialsInputRequestTypeDef
- DescribeFileSystemAssociationsInputRequestTypeDef
- DescribeGatewayInformationInputRequestTypeDef
- NetworkInterfaceTypeDef
- DescribeMaintenanceStartTimeInputRequestTypeDef
- DescribeMaintenanceStartTimeOutputTypeDef
- DescribeNFSFileSharesInputRequestTypeDef
- DescribeSMBFileSharesInputRequestTypeDef
- DescribeSMBSettingsInputRequestTypeDef
- SMBLocalGroupsTypeDef
- DescribeSnapshotScheduleInputRequestTypeDef
- DescribeStorediSCSIVolumesInputRequestTypeDef
- DescribeTapeArchivesInputDescribeTapeArchivesPaginateTypeDef
- DescribeTapeArchivesInputRequestTypeDef
- TapeArchiveTypeDef
- DescribeTapeRecoveryPointsInputDescribeTapeRecoveryPointsPaginateTypeDef
- DescribeTapeRecoveryPointsInputRequestTypeDef
- TapeRecoveryPointInfoTypeDef
- DescribeTapesInputDescribeTapesPaginateTypeDef
- DescribeTapesInputRequestTypeDef
- TapeTypeDef
- DescribeUploadBufferInputRequestTypeDef
- DescribeUploadBufferOutputTypeDef
- DescribeVTLDevicesInputDescribeVTLDevicesPaginateTypeDef
- DescribeVTLDevicesInputRequestTypeDef
- DescribeWorkingStorageInputRequestTypeDef
- DescribeWorkingStorageOutputTypeDef
- DetachVolumeInputRequestTypeDef
- DetachVolumeOutputTypeDef
- DeviceiSCSIAttributesTypeDef
- DisableGatewayInputRequestTypeDef
- DisableGatewayOutputTypeDef
- DisassociateFileSystemInputRequestTypeDef
- DisassociateFileSystemOutputTypeDef
- DiskTypeDef
- FileShareInfoTypeDef
- FileSystemAssociationStatusDetailTypeDef
- FileSystemAssociationSummaryTypeDef
- GatewayInfoTypeDef
- JoinDomainInputRequestTypeDef
- JoinDomainOutputTypeDef
- ListAutomaticTapeCreationPoliciesInputRequestTypeDef
- ListFileSharesInputListFileSharesPaginateTypeDef
- ListFileSharesInputRequestTypeDef
- ListFileSystemAssociationsInputListFileSystemAssociationsPaginateTypeDef
- ListFileSystemAssociationsInputRequestTypeDef
- ListGatewaysInputListGatewaysPaginateTypeDef
- ListGatewaysInputRequestTypeDef
- ListLocalDisksInputRequestTypeDef
- ListTagsForResourceInputListTagsForResourcePaginateTypeDef
- ListTagsForResourceInputRequestTypeDef
- ListTapePoolsInputListTapePoolsPaginateTypeDef
- ListTapePoolsInputRequestTypeDef
- PoolInfoTypeDef
- ListTapesInputListTapesPaginateTypeDef
- ListTapesInputRequestTypeDef
- TapeInfoTypeDef
- ListVolumeInitiatorsInputRequestTypeDef
- ListVolumeInitiatorsOutputTypeDef
- ListVolumeRecoveryPointsInputRequestTypeDef
- VolumeRecoveryPointInfoTypeDef
- ListVolumesInputListVolumesPaginateTypeDef
- ListVolumesInputRequestTypeDef
- VolumeInfoTypeDef
- NotifyWhenUploadedInputRequestTypeDef
- NotifyWhenUploadedOutputTypeDef
- PaginatorConfigTypeDef
- RefreshCacheInputRequestTypeDef
- RefreshCacheOutputTypeDef
- RemoveTagsFromResourceInputRequestTypeDef
- RemoveTagsFromResourceOutputTypeDef
- ResetCacheInputRequestTypeDef
- ResetCacheOutputTypeDef
- ResponseMetadataTypeDef
- RetrieveTapeArchiveInputRequestTypeDef
- RetrieveTapeArchiveOutputTypeDef
- RetrieveTapeRecoveryPointInputRequestTypeDef
- RetrieveTapeRecoveryPointOutputTypeDef
- SetLocalConsolePasswordInputRequestTypeDef
- SetLocalConsolePasswordOutputTypeDef
- SetSMBGuestPasswordInputRequestTypeDef
- SetSMBGuestPasswordOutputTypeDef
- ShutdownGatewayInputRequestTypeDef
- ShutdownGatewayOutputTypeDef
- StartAvailabilityMonitorTestInputRequestTypeDef
- StartAvailabilityMonitorTestOutputTypeDef
- StartGatewayInputRequestTypeDef
- StartGatewayOutputTypeDef
- UpdateAutomaticTapeCreationPolicyOutputTypeDef
- UpdateBandwidthRateLimitInputRequestTypeDef
- UpdateBandwidthRateLimitOutputTypeDef
- UpdateBandwidthRateLimitScheduleOutputTypeDef
- UpdateChapCredentialsInputRequestTypeDef
- UpdateChapCredentialsOutputTypeDef
- UpdateFileSystemAssociationOutputTypeDef
- UpdateGatewayInformationInputRequestTypeDef
- UpdateGatewayInformationOutputTypeDef
- UpdateGatewaySoftwareNowInputRequestTypeDef
- UpdateGatewaySoftwareNowOutputTypeDef
- UpdateMaintenanceStartTimeInputRequestTypeDef
- UpdateMaintenanceStartTimeOutputTypeDef
- UpdateNFSFileShareOutputTypeDef
- UpdateSMBFileShareOutputTypeDef
- UpdateSMBFileShareVisibilityInputRequestTypeDef
- UpdateSMBFileShareVisibilityOutputTypeDef
- UpdateSMBLocalGroupsOutputTypeDef
- UpdateSMBSecurityStrategyInputRequestTypeDef
- UpdateSMBSecurityStrategyOutputTypeDef
- UpdateSnapshotScheduleOutputTypeDef
- UpdateVTLDeviceTypeInputRequestTypeDef
- UpdateVTLDeviceTypeOutputTypeDef
- ActivateGatewayInputRequestTypeDef
- AddTagsToResourceInputRequestTypeDef
- CreateCachediSCSIVolumeInputRequestTypeDef
- CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef
- CreateSnapshotInputRequestTypeDef
- CreateStorediSCSIVolumeInputRequestTypeDef
- CreateTapePoolInputRequestTypeDef
- CreateTapeWithBarcodeInputRequestTypeDef
- CreateTapesInputRequestTypeDef
- DescribeSnapshotScheduleOutputTypeDef
- ListTagsForResourceOutputTypeDef
- UpdateSnapshotScheduleInputRequestTypeDef
- CreateSMBFileShareInputRequestTypeDef
- SMBFileShareInfoTypeDef
- UpdateFileSystemAssociationInputRequestTypeDef
- UpdateSMBFileShareInputRequestTypeDef
- AssociateFileSystemInputRequestTypeDef
- AutomaticTapeCreationPolicyInfoTypeDef
- UpdateAutomaticTapeCreationPolicyInputRequestTypeDef
- DescribeBandwidthRateLimitScheduleOutputTypeDef
- UpdateBandwidthRateLimitScheduleInputRequestTypeDef
- CachediSCSIVolumeTypeDef
- StorediSCSIVolumeTypeDef
- DescribeChapCredentialsOutputTypeDef
- CreateNFSFileShareInputRequestTypeDef
- NFSFileShareInfoTypeDef
- UpdateNFSFileShareInputRequestTypeDef
- DescribeGatewayInformationOutputTypeDef
- DescribeSMBSettingsOutputTypeDef
- UpdateSMBLocalGroupsInputRequestTypeDef
- DescribeTapeArchivesOutputTypeDef
- DescribeTapeRecoveryPointsOutputTypeDef
- DescribeTapesOutputTypeDef
- VTLDeviceTypeDef
- ListLocalDisksOutputTypeDef
- ListFileSharesOutputTypeDef
- FileSystemAssociationInfoTypeDef
- ListFileSystemAssociationsOutputTypeDef
- ListGatewaysOutputTypeDef
- ListTapePoolsOutputTypeDef
- ListTapesOutputTypeDef
- ListVolumeRecoveryPointsOutputTypeDef
- ListVolumesOutputTypeDef
- DescribeSMBFileSharesOutputTypeDef
- ListAutomaticTapeCreationPoliciesOutputTypeDef
- DescribeCachediSCSIVolumesOutputTypeDef
- DescribeStorediSCSIVolumesOutputTypeDef
- DescribeNFSFileSharesOutputTypeDef
- DescribeVTLDevicesOutputTypeDef
- DescribeFileSystemAssociationsOutputTypeDef