Typed dictionaries
Index > StorageGateway > Typed dictionaries
Auto-generated documentation for StorageGateway type annotations stubs module mypy-boto3-storagegateway.
TagTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AddCacheInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import AddCacheInputRequestTypeDef
def get_value() -> AddCacheInputRequestTypeDef:
return {
"GatewayARN": ...,
"DiskIds": ...,
}
AddUploadBufferInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import AddUploadBufferInputRequestTypeDef
def get_value() -> AddUploadBufferInputRequestTypeDef:
return {
"GatewayARN": ...,
"DiskIds": ...,
}
Definition
class AddUploadBufferInputRequestTypeDef(TypedDict):
GatewayARN: str,
DiskIds: Sequence[str],
AddWorkingStorageInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import AddWorkingStorageInputRequestTypeDef
def get_value() -> AddWorkingStorageInputRequestTypeDef:
return {
"GatewayARN": ...,
"DiskIds": ...,
}
Definition
class AddWorkingStorageInputRequestTypeDef(TypedDict):
GatewayARN: str,
DiskIds: Sequence[str],
AssignTapePoolInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import AssignTapePoolInputRequestTypeDef
def get_value() -> AssignTapePoolInputRequestTypeDef:
return {
"TapeARN": ...,
"PoolId": ...,
}
Definition
class AssignTapePoolInputRequestTypeDef(TypedDict):
TapeARN: str,
PoolId: str,
BypassGovernanceRetention: NotRequired[bool],
CacheAttributesTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import CacheAttributesTypeDef
def get_value() -> CacheAttributesTypeDef:
return {
"CacheStaleTimeoutInSeconds": ...,
}
EndpointNetworkConfigurationTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import EndpointNetworkConfigurationTypeDef
def get_value() -> EndpointNetworkConfigurationTypeDef:
return {
"IpAddresses": ...,
}
Definition
class EndpointNetworkConfigurationTypeDef(TypedDict):
IpAddresses: NotRequired[Sequence[str]],
AttachVolumeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import AttachVolumeInputRequestTypeDef
def get_value() -> AttachVolumeInputRequestTypeDef:
return {
"GatewayARN": ...,
"VolumeARN": ...,
"NetworkInterfaceId": ...,
}
Definition
class AttachVolumeInputRequestTypeDef(TypedDict):
GatewayARN: str,
VolumeARN: str,
NetworkInterfaceId: str,
TargetName: NotRequired[str],
DiskId: NotRequired[str],
AutomaticTapeCreationRuleTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import AutomaticTapeCreationRuleTypeDef
def get_value() -> AutomaticTapeCreationRuleTypeDef:
return {
"TapeBarcodePrefix": ...,
"PoolId": ...,
"TapeSizeInBytes": ...,
"MinimumNumTapes": ...,
}
Definition
class AutomaticTapeCreationRuleTypeDef(TypedDict):
TapeBarcodePrefix: str,
PoolId: str,
TapeSizeInBytes: int,
MinimumNumTapes: int,
Worm: NotRequired[bool],
BandwidthRateLimitIntervalTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import BandwidthRateLimitIntervalTypeDef
def get_value() -> BandwidthRateLimitIntervalTypeDef:
return {
"StartHourOfDay": ...,
"StartMinuteOfHour": ...,
"EndHourOfDay": ...,
"EndMinuteOfHour": ...,
"DaysOfWeek": ...,
}
Definition
class BandwidthRateLimitIntervalTypeDef(TypedDict):
StartHourOfDay: int,
StartMinuteOfHour: int,
EndHourOfDay: int,
EndMinuteOfHour: int,
DaysOfWeek: List[int],
AverageUploadRateLimitInBitsPerSec: NotRequired[int],
AverageDownloadRateLimitInBitsPerSec: NotRequired[int],
VolumeiSCSIAttributesTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import VolumeiSCSIAttributesTypeDef
def get_value() -> VolumeiSCSIAttributesTypeDef:
return {
"TargetARN": ...,
}
Definition
class VolumeiSCSIAttributesTypeDef(TypedDict):
TargetARN: NotRequired[str],
NetworkInterfaceId: NotRequired[str],
NetworkInterfacePort: NotRequired[int],
LunNumber: NotRequired[int],
ChapEnabled: NotRequired[bool],
CancelArchivalInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import CancelArchivalInputRequestTypeDef
def get_value() -> CancelArchivalInputRequestTypeDef:
return {
"GatewayARN": ...,
"TapeARN": ...,
}
CancelRetrievalInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import CancelRetrievalInputRequestTypeDef
def get_value() -> CancelRetrievalInputRequestTypeDef:
return {
"GatewayARN": ...,
"TapeARN": ...,
}
ChapInfoTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ChapInfoTypeDef
def get_value() -> ChapInfoTypeDef:
return {
"TargetARN": ...,
}
Definition
class ChapInfoTypeDef(TypedDict):
TargetARN: NotRequired[str],
SecretToAuthenticateInitiator: NotRequired[str],
InitiatorName: NotRequired[str],
SecretToAuthenticateTarget: NotRequired[str],
NFSFileShareDefaultsTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import NFSFileShareDefaultsTypeDef
def get_value() -> NFSFileShareDefaultsTypeDef:
return {
"FileMode": ...,
}
Definition
class NFSFileShareDefaultsTypeDef(TypedDict):
FileMode: NotRequired[str],
DirectoryMode: NotRequired[str],
GroupId: NotRequired[int],
OwnerId: NotRequired[int],
DeleteAutomaticTapeCreationPolicyInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteAutomaticTapeCreationPolicyInputRequestTypeDef
def get_value() -> DeleteAutomaticTapeCreationPolicyInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DeleteBandwidthRateLimitInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteBandwidthRateLimitInputRequestTypeDef
def get_value() -> DeleteBandwidthRateLimitInputRequestTypeDef:
return {
"GatewayARN": ...,
"BandwidthType": ...,
}
Definition
class DeleteBandwidthRateLimitInputRequestTypeDef(TypedDict):
GatewayARN: str,
BandwidthType: str,
DeleteChapCredentialsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteChapCredentialsInputRequestTypeDef
def get_value() -> DeleteChapCredentialsInputRequestTypeDef:
return {
"TargetARN": ...,
"InitiatorName": ...,
}
Definition
class DeleteChapCredentialsInputRequestTypeDef(TypedDict):
TargetARN: str,
InitiatorName: str,
DeleteFileShareInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteFileShareInputRequestTypeDef
def get_value() -> DeleteFileShareInputRequestTypeDef:
return {
"FileShareARN": ...,
}
Definition
class DeleteFileShareInputRequestTypeDef(TypedDict):
FileShareARN: str,
ForceDelete: NotRequired[bool],
DeleteGatewayInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteGatewayInputRequestTypeDef
def get_value() -> DeleteGatewayInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DeleteSnapshotScheduleInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteSnapshotScheduleInputRequestTypeDef
def get_value() -> DeleteSnapshotScheduleInputRequestTypeDef:
return {
"VolumeARN": ...,
}
DeleteTapeArchiveInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteTapeArchiveInputRequestTypeDef
def get_value() -> DeleteTapeArchiveInputRequestTypeDef:
return {
"TapeARN": ...,
}
Definition
class DeleteTapeArchiveInputRequestTypeDef(TypedDict):
TapeARN: str,
BypassGovernanceRetention: NotRequired[bool],
DeleteTapeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteTapeInputRequestTypeDef
def get_value() -> DeleteTapeInputRequestTypeDef:
return {
"GatewayARN": ...,
"TapeARN": ...,
}
Definition
class DeleteTapeInputRequestTypeDef(TypedDict):
GatewayARN: str,
TapeARN: str,
BypassGovernanceRetention: NotRequired[bool],
DeleteTapePoolInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteTapePoolInputRequestTypeDef
def get_value() -> DeleteTapePoolInputRequestTypeDef:
return {
"PoolARN": ...,
}
DeleteVolumeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeleteVolumeInputRequestTypeDef
def get_value() -> DeleteVolumeInputRequestTypeDef:
return {
"VolumeARN": ...,
}
DescribeAvailabilityMonitorTestInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeAvailabilityMonitorTestInputRequestTypeDef
def get_value() -> DescribeAvailabilityMonitorTestInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DescribeBandwidthRateLimitInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeBandwidthRateLimitInputRequestTypeDef
def get_value() -> DescribeBandwidthRateLimitInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DescribeBandwidthRateLimitScheduleInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeBandwidthRateLimitScheduleInputRequestTypeDef
def get_value() -> DescribeBandwidthRateLimitScheduleInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DescribeCacheInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeCacheInputRequestTypeDef
def get_value() -> DescribeCacheInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DescribeCachediSCSIVolumesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeCachediSCSIVolumesInputRequestTypeDef
def get_value() -> DescribeCachediSCSIVolumesInputRequestTypeDef:
return {
"VolumeARNs": ...,
}
Definition
class DescribeCachediSCSIVolumesInputRequestTypeDef(TypedDict):
VolumeARNs: Sequence[str],
DescribeChapCredentialsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeChapCredentialsInputRequestTypeDef
def get_value() -> DescribeChapCredentialsInputRequestTypeDef:
return {
"TargetARN": ...,
}
DescribeFileSystemAssociationsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeFileSystemAssociationsInputRequestTypeDef
def get_value() -> DescribeFileSystemAssociationsInputRequestTypeDef:
return {
"FileSystemAssociationARNList": ...,
}
Definition
class DescribeFileSystemAssociationsInputRequestTypeDef(TypedDict):
FileSystemAssociationARNList: Sequence[str],
DescribeGatewayInformationInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeGatewayInformationInputRequestTypeDef
def get_value() -> DescribeGatewayInformationInputRequestTypeDef:
return {
"GatewayARN": ...,
}
NetworkInterfaceTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import NetworkInterfaceTypeDef
def get_value() -> NetworkInterfaceTypeDef:
return {
"Ipv4Address": ...,
}
Definition
class NetworkInterfaceTypeDef(TypedDict):
Ipv4Address: NotRequired[str],
MacAddress: NotRequired[str],
Ipv6Address: NotRequired[str],
DescribeMaintenanceStartTimeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeMaintenanceStartTimeInputRequestTypeDef
def get_value() -> DescribeMaintenanceStartTimeInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DescribeNFSFileSharesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeNFSFileSharesInputRequestTypeDef
def get_value() -> DescribeNFSFileSharesInputRequestTypeDef:
return {
"FileShareARNList": ...,
}
Definition
class DescribeNFSFileSharesInputRequestTypeDef(TypedDict):
FileShareARNList: Sequence[str],
DescribeSMBFileSharesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeSMBFileSharesInputRequestTypeDef
def get_value() -> DescribeSMBFileSharesInputRequestTypeDef:
return {
"FileShareARNList": ...,
}
Definition
class DescribeSMBFileSharesInputRequestTypeDef(TypedDict):
FileShareARNList: Sequence[str],
DescribeSMBSettingsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeSMBSettingsInputRequestTypeDef
def get_value() -> DescribeSMBSettingsInputRequestTypeDef:
return {
"GatewayARN": ...,
}
SMBLocalGroupsTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import SMBLocalGroupsTypeDef
def get_value() -> SMBLocalGroupsTypeDef:
return {
"GatewayAdmins": ...,
}
DescribeSnapshotScheduleInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeSnapshotScheduleInputRequestTypeDef
def get_value() -> DescribeSnapshotScheduleInputRequestTypeDef:
return {
"VolumeARN": ...,
}
DescribeStorediSCSIVolumesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeStorediSCSIVolumesInputRequestTypeDef
def get_value() -> DescribeStorediSCSIVolumesInputRequestTypeDef:
return {
"VolumeARNs": ...,
}
Definition
class DescribeStorediSCSIVolumesInputRequestTypeDef(TypedDict):
VolumeARNs: Sequence[str],
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeTapeArchivesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeTapeArchivesInputRequestTypeDef
def get_value() -> DescribeTapeArchivesInputRequestTypeDef:
return {
"TapeARNs": ...,
}
Definition
class DescribeTapeArchivesInputRequestTypeDef(TypedDict):
TapeARNs: NotRequired[Sequence[str]],
Marker: NotRequired[str],
Limit: NotRequired[int],
TapeArchiveTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import TapeArchiveTypeDef
def get_value() -> TapeArchiveTypeDef:
return {
"TapeARN": ...,
}
Definition
class TapeArchiveTypeDef(TypedDict):
TapeARN: NotRequired[str],
TapeBarcode: NotRequired[str],
TapeCreatedDate: NotRequired[datetime],
TapeSizeInBytes: NotRequired[int],
CompletionTime: NotRequired[datetime],
RetrievedTo: NotRequired[str],
TapeStatus: NotRequired[str],
TapeUsedInBytes: NotRequired[int],
KMSKey: NotRequired[str],
PoolId: NotRequired[str],
Worm: NotRequired[bool],
RetentionStartDate: NotRequired[datetime],
PoolEntryDate: NotRequired[datetime],
DescribeTapeRecoveryPointsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeTapeRecoveryPointsInputRequestTypeDef
def get_value() -> DescribeTapeRecoveryPointsInputRequestTypeDef:
return {
"GatewayARN": ...,
}
Definition
class DescribeTapeRecoveryPointsInputRequestTypeDef(TypedDict):
GatewayARN: str,
Marker: NotRequired[str],
Limit: NotRequired[int],
TapeRecoveryPointInfoTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import TapeRecoveryPointInfoTypeDef
def get_value() -> TapeRecoveryPointInfoTypeDef:
return {
"TapeARN": ...,
}
Definition
class TapeRecoveryPointInfoTypeDef(TypedDict):
TapeARN: NotRequired[str],
TapeRecoveryPointTime: NotRequired[datetime],
TapeSizeInBytes: NotRequired[int],
TapeStatus: NotRequired[str],
DescribeTapesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeTapesInputRequestTypeDef
def get_value() -> DescribeTapesInputRequestTypeDef:
return {
"GatewayARN": ...,
}
Definition
class DescribeTapesInputRequestTypeDef(TypedDict):
GatewayARN: str,
TapeARNs: NotRequired[Sequence[str]],
Marker: NotRequired[str],
Limit: NotRequired[int],
TapeTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import TapeTypeDef
def get_value() -> TapeTypeDef:
return {
"TapeARN": ...,
}
Definition
class TapeTypeDef(TypedDict):
TapeARN: NotRequired[str],
TapeBarcode: NotRequired[str],
TapeCreatedDate: NotRequired[datetime],
TapeSizeInBytes: NotRequired[int],
TapeStatus: NotRequired[str],
VTLDevice: NotRequired[str],
Progress: NotRequired[float],
TapeUsedInBytes: NotRequired[int],
KMSKey: NotRequired[str],
PoolId: NotRequired[str],
Worm: NotRequired[bool],
RetentionStartDate: NotRequired[datetime],
PoolEntryDate: NotRequired[datetime],
DescribeUploadBufferInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeUploadBufferInputRequestTypeDef
def get_value() -> DescribeUploadBufferInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DescribeVTLDevicesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeVTLDevicesInputRequestTypeDef
def get_value() -> DescribeVTLDevicesInputRequestTypeDef:
return {
"GatewayARN": ...,
}
Definition
class DescribeVTLDevicesInputRequestTypeDef(TypedDict):
GatewayARN: str,
VTLDeviceARNs: NotRequired[Sequence[str]],
Marker: NotRequired[str],
Limit: NotRequired[int],
DescribeWorkingStorageInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DescribeWorkingStorageInputRequestTypeDef
def get_value() -> DescribeWorkingStorageInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DetachVolumeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DetachVolumeInputRequestTypeDef
def get_value() -> DetachVolumeInputRequestTypeDef:
return {
"VolumeARN": ...,
}
Definition
class DetachVolumeInputRequestTypeDef(TypedDict):
VolumeARN: str,
ForceDetach: NotRequired[bool],
DeviceiSCSIAttributesTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DeviceiSCSIAttributesTypeDef
def get_value() -> DeviceiSCSIAttributesTypeDef:
return {
"TargetARN": ...,
}
Definition
class DeviceiSCSIAttributesTypeDef(TypedDict):
TargetARN: NotRequired[str],
NetworkInterfaceId: NotRequired[str],
NetworkInterfacePort: NotRequired[int],
ChapEnabled: NotRequired[bool],
DisableGatewayInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DisableGatewayInputRequestTypeDef
def get_value() -> DisableGatewayInputRequestTypeDef:
return {
"GatewayARN": ...,
}
DisassociateFileSystemInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DisassociateFileSystemInputRequestTypeDef
def get_value() -> DisassociateFileSystemInputRequestTypeDef:
return {
"FileSystemAssociationARN": ...,
}
Definition
class DisassociateFileSystemInputRequestTypeDef(TypedDict):
FileSystemAssociationARN: str,
ForceDelete: NotRequired[bool],
DiskTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import DiskTypeDef
def get_value() -> DiskTypeDef:
return {
"DiskId": ...,
}
Definition
class DiskTypeDef(TypedDict):
DiskId: NotRequired[str],
DiskPath: NotRequired[str],
DiskNode: NotRequired[str],
DiskStatus: NotRequired[str],
DiskSizeInBytes: NotRequired[int],
DiskAllocationType: NotRequired[str],
DiskAllocationResource: NotRequired[str],
DiskAttributeList: NotRequired[List[str]],
FileShareInfoTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import FileShareInfoTypeDef
def get_value() -> FileShareInfoTypeDef:
return {
"FileShareType": ...,
}
Definition
class FileShareInfoTypeDef(TypedDict):
FileShareType: NotRequired[FileShareTypeType], # (1)
FileShareARN: NotRequired[str],
FileShareId: NotRequired[str],
FileShareStatus: NotRequired[str],
GatewayARN: NotRequired[str],
FileSystemAssociationStatusDetailTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import FileSystemAssociationStatusDetailTypeDef
def get_value() -> FileSystemAssociationStatusDetailTypeDef:
return {
"ErrorCode": ...,
}
FileSystemAssociationSummaryTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import FileSystemAssociationSummaryTypeDef
def get_value() -> FileSystemAssociationSummaryTypeDef:
return {
"FileSystemAssociationId": ...,
}
Definition
class FileSystemAssociationSummaryTypeDef(TypedDict):
FileSystemAssociationId: NotRequired[str],
FileSystemAssociationARN: NotRequired[str],
FileSystemAssociationStatus: NotRequired[str],
GatewayARN: NotRequired[str],
GatewayInfoTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import GatewayInfoTypeDef
def get_value() -> GatewayInfoTypeDef:
return {
"GatewayId": ...,
}
Definition
class GatewayInfoTypeDef(TypedDict):
GatewayId: NotRequired[str],
GatewayARN: NotRequired[str],
GatewayType: NotRequired[str],
GatewayOperationalState: NotRequired[str],
GatewayName: NotRequired[str],
Ec2InstanceId: NotRequired[str],
Ec2InstanceRegion: NotRequired[str],
HostEnvironment: NotRequired[HostEnvironmentType], # (1)
HostEnvironmentId: NotRequired[str],
JoinDomainInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import JoinDomainInputRequestTypeDef
def get_value() -> JoinDomainInputRequestTypeDef:
return {
"GatewayARN": ...,
"DomainName": ...,
"UserName": ...,
"Password": ...,
}
Definition
class JoinDomainInputRequestTypeDef(TypedDict):
GatewayARN: str,
DomainName: str,
UserName: str,
Password: str,
OrganizationalUnit: NotRequired[str],
DomainControllers: NotRequired[Sequence[str]],
TimeoutInSeconds: NotRequired[int],
ListAutomaticTapeCreationPoliciesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListAutomaticTapeCreationPoliciesInputRequestTypeDef
def get_value() -> ListAutomaticTapeCreationPoliciesInputRequestTypeDef:
return {
"GatewayARN": ...,
}
Definition
class ListAutomaticTapeCreationPoliciesInputRequestTypeDef(TypedDict):
GatewayARN: NotRequired[str],
ListFileSharesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListFileSharesInputRequestTypeDef
def get_value() -> ListFileSharesInputRequestTypeDef:
return {
"GatewayARN": ...,
}
Definition
class ListFileSharesInputRequestTypeDef(TypedDict):
GatewayARN: NotRequired[str],
Limit: NotRequired[int],
Marker: NotRequired[str],
ListFileSystemAssociationsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListFileSystemAssociationsInputRequestTypeDef
def get_value() -> ListFileSystemAssociationsInputRequestTypeDef:
return {
"GatewayARN": ...,
}
Definition
class ListFileSystemAssociationsInputRequestTypeDef(TypedDict):
GatewayARN: NotRequired[str],
Limit: NotRequired[int],
Marker: NotRequired[str],
ListGatewaysInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListGatewaysInputRequestTypeDef
def get_value() -> ListGatewaysInputRequestTypeDef:
return {
"Marker": ...,
}
Definition
class ListGatewaysInputRequestTypeDef(TypedDict):
Marker: NotRequired[str],
Limit: NotRequired[int],
ListLocalDisksInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListLocalDisksInputRequestTypeDef
def get_value() -> ListLocalDisksInputRequestTypeDef:
return {
"GatewayARN": ...,
}
ListTagsForResourceInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListTagsForResourceInputRequestTypeDef
def get_value() -> ListTagsForResourceInputRequestTypeDef:
return {
"ResourceARN": ...,
}
Definition
class ListTagsForResourceInputRequestTypeDef(TypedDict):
ResourceARN: str,
Marker: NotRequired[str],
Limit: NotRequired[int],
ListTapePoolsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListTapePoolsInputRequestTypeDef
def get_value() -> ListTapePoolsInputRequestTypeDef:
return {
"PoolARNs": ...,
}
Definition
class ListTapePoolsInputRequestTypeDef(TypedDict):
PoolARNs: NotRequired[Sequence[str]],
Marker: NotRequired[str],
Limit: NotRequired[int],
PoolInfoTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import PoolInfoTypeDef
def get_value() -> PoolInfoTypeDef:
return {
"PoolARN": ...,
}
Definition
class PoolInfoTypeDef(TypedDict):
PoolARN: NotRequired[str],
PoolName: NotRequired[str],
StorageClass: NotRequired[TapeStorageClassType], # (1)
RetentionLockType: NotRequired[RetentionLockTypeType], # (2)
RetentionLockTimeInDays: NotRequired[int],
PoolStatus: NotRequired[PoolStatusType], # (3)
- See TapeStorageClassType
- See RetentionLockTypeType
- See PoolStatusType
ListTapesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListTapesInputRequestTypeDef
def get_value() -> ListTapesInputRequestTypeDef:
return {
"TapeARNs": ...,
}
Definition
class ListTapesInputRequestTypeDef(TypedDict):
TapeARNs: NotRequired[Sequence[str]],
Marker: NotRequired[str],
Limit: NotRequired[int],
TapeInfoTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import TapeInfoTypeDef
def get_value() -> TapeInfoTypeDef:
return {
"TapeARN": ...,
}
Definition
class TapeInfoTypeDef(TypedDict):
TapeARN: NotRequired[str],
TapeBarcode: NotRequired[str],
TapeSizeInBytes: NotRequired[int],
TapeStatus: NotRequired[str],
GatewayARN: NotRequired[str],
PoolId: NotRequired[str],
RetentionStartDate: NotRequired[datetime],
PoolEntryDate: NotRequired[datetime],
ListVolumeInitiatorsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListVolumeInitiatorsInputRequestTypeDef
def get_value() -> ListVolumeInitiatorsInputRequestTypeDef:
return {
"VolumeARN": ...,
}
ListVolumeRecoveryPointsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListVolumeRecoveryPointsInputRequestTypeDef
def get_value() -> ListVolumeRecoveryPointsInputRequestTypeDef:
return {
"GatewayARN": ...,
}
VolumeRecoveryPointInfoTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import VolumeRecoveryPointInfoTypeDef
def get_value() -> VolumeRecoveryPointInfoTypeDef:
return {
"VolumeARN": ...,
}
Definition
class VolumeRecoveryPointInfoTypeDef(TypedDict):
VolumeARN: NotRequired[str],
VolumeSizeInBytes: NotRequired[int],
VolumeUsageInBytes: NotRequired[int],
VolumeRecoveryPointTime: NotRequired[str],
ListVolumesInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ListVolumesInputRequestTypeDef
def get_value() -> ListVolumesInputRequestTypeDef:
return {
"GatewayARN": ...,
}
Definition
class ListVolumesInputRequestTypeDef(TypedDict):
GatewayARN: NotRequired[str],
Marker: NotRequired[str],
Limit: NotRequired[int],
VolumeInfoTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import VolumeInfoTypeDef
def get_value() -> VolumeInfoTypeDef:
return {
"VolumeARN": ...,
}
Definition
class VolumeInfoTypeDef(TypedDict):
VolumeARN: NotRequired[str],
VolumeId: NotRequired[str],
GatewayARN: NotRequired[str],
GatewayId: NotRequired[str],
VolumeType: NotRequired[str],
VolumeSizeInBytes: NotRequired[int],
VolumeAttachmentStatus: NotRequired[str],
NotifyWhenUploadedInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import NotifyWhenUploadedInputRequestTypeDef
def get_value() -> NotifyWhenUploadedInputRequestTypeDef:
return {
"FileShareARN": ...,
}
RefreshCacheInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import RefreshCacheInputRequestTypeDef
def get_value() -> RefreshCacheInputRequestTypeDef:
return {
"FileShareARN": ...,
}
Definition
class RefreshCacheInputRequestTypeDef(TypedDict):
FileShareARN: str,
FolderList: NotRequired[Sequence[str]],
Recursive: NotRequired[bool],
RemoveTagsFromResourceInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import RemoveTagsFromResourceInputRequestTypeDef
def get_value() -> RemoveTagsFromResourceInputRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
Definition
class RemoveTagsFromResourceInputRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
ResetCacheInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ResetCacheInputRequestTypeDef
def get_value() -> ResetCacheInputRequestTypeDef:
return {
"GatewayARN": ...,
}
RetrieveTapeArchiveInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import RetrieveTapeArchiveInputRequestTypeDef
def get_value() -> RetrieveTapeArchiveInputRequestTypeDef:
return {
"TapeARN": ...,
"GatewayARN": ...,
}
RetrieveTapeRecoveryPointInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import RetrieveTapeRecoveryPointInputRequestTypeDef
def get_value() -> RetrieveTapeRecoveryPointInputRequestTypeDef:
return {
"TapeARN": ...,
"GatewayARN": ...,
}
Definition
class RetrieveTapeRecoveryPointInputRequestTypeDef(TypedDict):
TapeARN: str,
GatewayARN: str,
SetLocalConsolePasswordInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import SetLocalConsolePasswordInputRequestTypeDef
def get_value() -> SetLocalConsolePasswordInputRequestTypeDef:
return {
"GatewayARN": ...,
"LocalConsolePassword": ...,
}
Definition
class SetLocalConsolePasswordInputRequestTypeDef(TypedDict):
GatewayARN: str,
LocalConsolePassword: str,
SetSMBGuestPasswordInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import SetSMBGuestPasswordInputRequestTypeDef
def get_value() -> SetSMBGuestPasswordInputRequestTypeDef:
return {
"GatewayARN": ...,
"Password": ...,
}
ShutdownGatewayInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ShutdownGatewayInputRequestTypeDef
def get_value() -> ShutdownGatewayInputRequestTypeDef:
return {
"GatewayARN": ...,
}
StartAvailabilityMonitorTestInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import StartAvailabilityMonitorTestInputRequestTypeDef
def get_value() -> StartAvailabilityMonitorTestInputRequestTypeDef:
return {
"GatewayARN": ...,
}
StartGatewayInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import StartGatewayInputRequestTypeDef
def get_value() -> StartGatewayInputRequestTypeDef:
return {
"GatewayARN": ...,
}
UpdateBandwidthRateLimitInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import UpdateBandwidthRateLimitInputRequestTypeDef
def get_value() -> UpdateBandwidthRateLimitInputRequestTypeDef:
return {
"GatewayARN": ...,
}
Definition
class UpdateBandwidthRateLimitInputRequestTypeDef(TypedDict):
GatewayARN: str,
AverageUploadRateLimitInBitsPerSec: NotRequired[int],
AverageDownloadRateLimitInBitsPerSec: NotRequired[int],
UpdateChapCredentialsInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import UpdateChapCredentialsInputRequestTypeDef
def get_value() -> UpdateChapCredentialsInputRequestTypeDef:
return {
"TargetARN": ...,
"SecretToAuthenticateInitiator": ...,
"InitiatorName": ...,
}
Definition
class UpdateChapCredentialsInputRequestTypeDef(TypedDict):
TargetARN: str,
SecretToAuthenticateInitiator: str,
InitiatorName: str,
SecretToAuthenticateTarget: NotRequired[str],
UpdateGatewayInformationInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import UpdateGatewayInformationInputRequestTypeDef
def get_value() -> UpdateGatewayInformationInputRequestTypeDef:
return {
"GatewayARN": ...,
}
Definition
class UpdateGatewayInformationInputRequestTypeDef(TypedDict):
GatewayARN: str,
GatewayName: NotRequired[str],
GatewayTimezone: NotRequired[str],
CloudWatchLogGroupARN: NotRequired[str],
GatewayCapacity: NotRequired[GatewayCapacityType], # (1)
UpdateGatewaySoftwareNowInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import UpdateGatewaySoftwareNowInputRequestTypeDef
def get_value() -> UpdateGatewaySoftwareNowInputRequestTypeDef:
return {
"GatewayARN": ...,
}
UpdateMaintenanceStartTimeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import UpdateMaintenanceStartTimeInputRequestTypeDef
def get_value() -> UpdateMaintenanceStartTimeInputRequestTypeDef:
return {
"GatewayARN": ...,
"HourOfDay": ...,
"MinuteOfHour": ...,
}
Definition
class UpdateMaintenanceStartTimeInputRequestTypeDef(TypedDict):
GatewayARN: str,
HourOfDay: int,
MinuteOfHour: int,
DayOfWeek: NotRequired[int],
DayOfMonth: NotRequired[int],
UpdateSMBFileShareVisibilityInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import UpdateSMBFileShareVisibilityInputRequestTypeDef
def get_value() -> UpdateSMBFileShareVisibilityInputRequestTypeDef:
return {
"GatewayARN": ...,
"FileSharesVisible": ...,
}
Definition
class UpdateSMBFileShareVisibilityInputRequestTypeDef(TypedDict):
GatewayARN: str,
FileSharesVisible: bool,
UpdateSMBSecurityStrategyInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import UpdateSMBSecurityStrategyInputRequestTypeDef
def get_value() -> UpdateSMBSecurityStrategyInputRequestTypeDef:
return {
"GatewayARN": ...,
"SMBSecurityStrategy": ...,
}
Definition
class UpdateSMBSecurityStrategyInputRequestTypeDef(TypedDict):
GatewayARN: str,
SMBSecurityStrategy: SMBSecurityStrategyType, # (1)
UpdateVTLDeviceTypeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import UpdateVTLDeviceTypeInputRequestTypeDef
def get_value() -> UpdateVTLDeviceTypeInputRequestTypeDef:
return {
"VTLDeviceARN": ...,
"DeviceType": ...,
}
Definition
class UpdateVTLDeviceTypeInputRequestTypeDef(TypedDict):
VTLDeviceARN: str,
DeviceType: str,
ActivateGatewayInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import ActivateGatewayInputRequestTypeDef
def get_value() -> ActivateGatewayInputRequestTypeDef:
return {
"ActivationKey": ...,
"GatewayName": ...,
"GatewayTimezone": ...,
"GatewayRegion": ...,
}
Definition
class ActivateGatewayInputRequestTypeDef(TypedDict):
ActivationKey: str,
GatewayName: str,
GatewayTimezone: str,
GatewayRegion: str,
GatewayType: NotRequired[str],
TapeDriveType: NotRequired[str],
MediumChangerType: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
AddTagsToResourceInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import AddTagsToResourceInputRequestTypeDef
def get_value() -> AddTagsToResourceInputRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
Definition
class AddTagsToResourceInputRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateCachediSCSIVolumeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import CreateCachediSCSIVolumeInputRequestTypeDef
def get_value() -> CreateCachediSCSIVolumeInputRequestTypeDef:
return {
"GatewayARN": ...,
"VolumeSizeInBytes": ...,
"TargetName": ...,
"NetworkInterfaceId": ...,
"ClientToken": ...,
}
Definition
class CreateCachediSCSIVolumeInputRequestTypeDef(TypedDict):
GatewayARN: str,
VolumeSizeInBytes: int,
TargetName: str,
NetworkInterfaceId: str,
ClientToken: str,
SnapshotId: NotRequired[str],
SourceVolumeARN: NotRequired[str],
KMSEncrypted: NotRequired[bool],
KMSKey: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef
def get_value() -> CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef:
return {
"VolumeARN": ...,
"SnapshotDescription": ...,
}
Definition
class CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef(TypedDict):
VolumeARN: str,
SnapshotDescription: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateSnapshotInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import CreateSnapshotInputRequestTypeDef
def get_value() -> CreateSnapshotInputRequestTypeDef:
return {
"VolumeARN": ...,
"SnapshotDescription": ...,
}
Definition
class CreateSnapshotInputRequestTypeDef(TypedDict):
VolumeARN: str,
SnapshotDescription: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateStorediSCSIVolumeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import CreateStorediSCSIVolumeInputRequestTypeDef
def get_value() -> CreateStorediSCSIVolumeInputRequestTypeDef:
return {
"GatewayARN": ...,
"DiskId": ...,
"PreserveExistingData": ...,
"TargetName": ...,
"NetworkInterfaceId": ...,
}
Definition
class CreateStorediSCSIVolumeInputRequestTypeDef(TypedDict):
GatewayARN: str,
DiskId: str,
PreserveExistingData: bool,
TargetName: str,
NetworkInterfaceId: str,
SnapshotId: NotRequired[str],
KMSEncrypted: NotRequired[bool],
KMSKey: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateTapePoolInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import CreateTapePoolInputRequestTypeDef
def get_value() -> CreateTapePoolInputRequestTypeDef:
return {
"PoolName": ...,
"StorageClass": ...,
}
Definition
class CreateTapePoolInputRequestTypeDef(TypedDict):
PoolName: str,
StorageClass: TapeStorageClassType, # (1)
RetentionLockType: NotRequired[RetentionLockTypeType], # (2)
RetentionLockTimeInDays: NotRequired[int],
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
- See TapeStorageClassType
- See RetentionLockTypeType
- See TagTypeDef
CreateTapeWithBarcodeInputRequestTypeDef
Usage Example
from mypy_boto3_storagegateway.type_defs import CreateTapeWithBarcodeInputRequestTypeDef
def get_value() -> CreateTapeWithBarcodeInputRequestTypeDef:
return {
"GatewayARN": ...,
"TapeSizeInBytes": ...,
"TapeBarcode": ...,
}
Definition
class CreateTapeWithBarcodeInputRequestTypeDef(TypedDict):
GatewayARN: str,
TapeSizeInBytes: int,
TapeBarcode: str,
KMSEncrypted: NotRequired[bool],
KMSKey: NotRequired[str],
PoolId: NotRequired[str],
Worm: NotRequired[bool],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef