Skip to content

Type definitions#

Index > StorageGateway > Type definitions

Auto-generated documentation for StorageGateway type annotations stubs module types-aiobotocore-storagegateway.

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

AddCacheInputRequestTypeDef#

# AddCacheInputRequestTypeDef definition

class AddCacheInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    DiskIds: Sequence[str],

AddUploadBufferInputRequestTypeDef#

# AddUploadBufferInputRequestTypeDef definition

class AddUploadBufferInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    DiskIds: Sequence[str],

AddWorkingStorageInputRequestTypeDef#

# AddWorkingStorageInputRequestTypeDef definition

class AddWorkingStorageInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    DiskIds: Sequence[str],

AssignTapePoolInputRequestTypeDef#

# AssignTapePoolInputRequestTypeDef definition

class AssignTapePoolInputRequestTypeDef(TypedDict):
    TapeARN: str,
    PoolId: str,
    BypassGovernanceRetention: NotRequired[bool],

CacheAttributesTypeDef#

# CacheAttributesTypeDef definition

class CacheAttributesTypeDef(TypedDict):
    CacheStaleTimeoutInSeconds: NotRequired[int],

EndpointNetworkConfigurationTypeDef#

# EndpointNetworkConfigurationTypeDef definition

class EndpointNetworkConfigurationTypeDef(TypedDict):
    IpAddresses: NotRequired[Sequence[str]],

AttachVolumeInputRequestTypeDef#

# AttachVolumeInputRequestTypeDef definition

class AttachVolumeInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    VolumeARN: str,
    NetworkInterfaceId: str,
    TargetName: NotRequired[str],
    DiskId: NotRequired[str],

AutomaticTapeCreationRuleTypeDef#

# AutomaticTapeCreationRuleTypeDef definition

class AutomaticTapeCreationRuleTypeDef(TypedDict):
    TapeBarcodePrefix: str,
    PoolId: str,
    TapeSizeInBytes: int,
    MinimumNumTapes: int,
    Worm: NotRequired[bool],

BandwidthRateLimitIntervalTypeDef#

# BandwidthRateLimitIntervalTypeDef definition

class BandwidthRateLimitIntervalTypeDef(TypedDict):
    StartHourOfDay: int,
    StartMinuteOfHour: int,
    EndHourOfDay: int,
    EndMinuteOfHour: int,
    DaysOfWeek: List[int],
    AverageUploadRateLimitInBitsPerSec: NotRequired[int],
    AverageDownloadRateLimitInBitsPerSec: NotRequired[int],

VolumeiSCSIAttributesTypeDef#

# VolumeiSCSIAttributesTypeDef definition

class VolumeiSCSIAttributesTypeDef(TypedDict):
    TargetARN: NotRequired[str],
    NetworkInterfaceId: NotRequired[str],
    NetworkInterfacePort: NotRequired[int],
    LunNumber: NotRequired[int],
    ChapEnabled: NotRequired[bool],

CancelArchivalInputRequestTypeDef#

# CancelArchivalInputRequestTypeDef definition

class CancelArchivalInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    TapeARN: str,

CancelRetrievalInputRequestTypeDef#

# CancelRetrievalInputRequestTypeDef definition

class CancelRetrievalInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    TapeARN: str,

ChapInfoTypeDef#

# ChapInfoTypeDef definition

class ChapInfoTypeDef(TypedDict):
    TargetARN: NotRequired[str],
    SecretToAuthenticateInitiator: NotRequired[str],
    InitiatorName: NotRequired[str],
    SecretToAuthenticateTarget: NotRequired[str],

NFSFileShareDefaultsTypeDef#

# NFSFileShareDefaultsTypeDef definition

class NFSFileShareDefaultsTypeDef(TypedDict):
    FileMode: NotRequired[str],
    DirectoryMode: NotRequired[str],
    GroupId: NotRequired[int],
    OwnerId: NotRequired[int],

DeleteAutomaticTapeCreationPolicyInputRequestTypeDef#

# DeleteAutomaticTapeCreationPolicyInputRequestTypeDef definition

class DeleteAutomaticTapeCreationPolicyInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DeleteBandwidthRateLimitInputRequestTypeDef#

# DeleteBandwidthRateLimitInputRequestTypeDef definition

class DeleteBandwidthRateLimitInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    BandwidthType: str,

DeleteChapCredentialsInputRequestTypeDef#

# DeleteChapCredentialsInputRequestTypeDef definition

class DeleteChapCredentialsInputRequestTypeDef(TypedDict):
    TargetARN: str,
    InitiatorName: str,

DeleteFileShareInputRequestTypeDef#

# DeleteFileShareInputRequestTypeDef definition

class DeleteFileShareInputRequestTypeDef(TypedDict):
    FileShareARN: str,
    ForceDelete: NotRequired[bool],

DeleteGatewayInputRequestTypeDef#

# DeleteGatewayInputRequestTypeDef definition

class DeleteGatewayInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DeleteSnapshotScheduleInputRequestTypeDef#

# DeleteSnapshotScheduleInputRequestTypeDef definition

class DeleteSnapshotScheduleInputRequestTypeDef(TypedDict):
    VolumeARN: str,

DeleteTapeArchiveInputRequestTypeDef#

# DeleteTapeArchiveInputRequestTypeDef definition

class DeleteTapeArchiveInputRequestTypeDef(TypedDict):
    TapeARN: str,
    BypassGovernanceRetention: NotRequired[bool],

DeleteTapeInputRequestTypeDef#

# DeleteTapeInputRequestTypeDef definition

class DeleteTapeInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    TapeARN: str,
    BypassGovernanceRetention: NotRequired[bool],

DeleteTapePoolInputRequestTypeDef#

# DeleteTapePoolInputRequestTypeDef definition

class DeleteTapePoolInputRequestTypeDef(TypedDict):
    PoolARN: str,

DeleteVolumeInputRequestTypeDef#

# DeleteVolumeInputRequestTypeDef definition

class DeleteVolumeInputRequestTypeDef(TypedDict):
    VolumeARN: str,

DescribeAvailabilityMonitorTestInputRequestTypeDef#

# DescribeAvailabilityMonitorTestInputRequestTypeDef definition

class DescribeAvailabilityMonitorTestInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DescribeBandwidthRateLimitInputRequestTypeDef#

# DescribeBandwidthRateLimitInputRequestTypeDef definition

class DescribeBandwidthRateLimitInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DescribeBandwidthRateLimitScheduleInputRequestTypeDef#

# DescribeBandwidthRateLimitScheduleInputRequestTypeDef definition

class DescribeBandwidthRateLimitScheduleInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DescribeCacheInputRequestTypeDef#

# DescribeCacheInputRequestTypeDef definition

class DescribeCacheInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DescribeCachediSCSIVolumesInputRequestTypeDef#

# DescribeCachediSCSIVolumesInputRequestTypeDef definition

class DescribeCachediSCSIVolumesInputRequestTypeDef(TypedDict):
    VolumeARNs: Sequence[str],

DescribeChapCredentialsInputRequestTypeDef#

# DescribeChapCredentialsInputRequestTypeDef definition

class DescribeChapCredentialsInputRequestTypeDef(TypedDict):
    TargetARN: str,

DescribeFileSystemAssociationsInputRequestTypeDef#

# DescribeFileSystemAssociationsInputRequestTypeDef definition

class DescribeFileSystemAssociationsInputRequestTypeDef(TypedDict):
    FileSystemAssociationARNList: Sequence[str],

DescribeGatewayInformationInputRequestTypeDef#

# DescribeGatewayInformationInputRequestTypeDef definition

class DescribeGatewayInformationInputRequestTypeDef(TypedDict):
    GatewayARN: str,

NetworkInterfaceTypeDef#

# NetworkInterfaceTypeDef definition

class NetworkInterfaceTypeDef(TypedDict):
    Ipv4Address: NotRequired[str],
    MacAddress: NotRequired[str],
    Ipv6Address: NotRequired[str],

DescribeMaintenanceStartTimeInputRequestTypeDef#

# DescribeMaintenanceStartTimeInputRequestTypeDef definition

class DescribeMaintenanceStartTimeInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DescribeNFSFileSharesInputRequestTypeDef#

# DescribeNFSFileSharesInputRequestTypeDef definition

class DescribeNFSFileSharesInputRequestTypeDef(TypedDict):
    FileShareARNList: Sequence[str],

DescribeSMBFileSharesInputRequestTypeDef#

# DescribeSMBFileSharesInputRequestTypeDef definition

class DescribeSMBFileSharesInputRequestTypeDef(TypedDict):
    FileShareARNList: Sequence[str],

DescribeSMBSettingsInputRequestTypeDef#

# DescribeSMBSettingsInputRequestTypeDef definition

class DescribeSMBSettingsInputRequestTypeDef(TypedDict):
    GatewayARN: str,

SMBLocalGroupsTypeDef#

# SMBLocalGroupsTypeDef definition

class SMBLocalGroupsTypeDef(TypedDict):
    GatewayAdmins: NotRequired[List[str]],

DescribeSnapshotScheduleInputRequestTypeDef#

# DescribeSnapshotScheduleInputRequestTypeDef definition

class DescribeSnapshotScheduleInputRequestTypeDef(TypedDict):
    VolumeARN: str,

DescribeStorediSCSIVolumesInputRequestTypeDef#

# DescribeStorediSCSIVolumesInputRequestTypeDef definition

class DescribeStorediSCSIVolumesInputRequestTypeDef(TypedDict):
    VolumeARNs: Sequence[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeTapeArchivesInputRequestTypeDef#

# DescribeTapeArchivesInputRequestTypeDef definition

class DescribeTapeArchivesInputRequestTypeDef(TypedDict):
    TapeARNs: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    Limit: NotRequired[int],

TapeArchiveTypeDef#

# TapeArchiveTypeDef 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#

# DescribeTapeRecoveryPointsInputRequestTypeDef definition

class DescribeTapeRecoveryPointsInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    Marker: NotRequired[str],
    Limit: NotRequired[int],

TapeRecoveryPointInfoTypeDef#

# TapeRecoveryPointInfoTypeDef definition

class TapeRecoveryPointInfoTypeDef(TypedDict):
    TapeARN: NotRequired[str],
    TapeRecoveryPointTime: NotRequired[datetime],
    TapeSizeInBytes: NotRequired[int],
    TapeStatus: NotRequired[str],

DescribeTapesInputRequestTypeDef#

# DescribeTapesInputRequestTypeDef definition

class DescribeTapesInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    TapeARNs: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    Limit: NotRequired[int],

TapeTypeDef#

# TapeTypeDef 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#

# DescribeUploadBufferInputRequestTypeDef definition

class DescribeUploadBufferInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DescribeVTLDevicesInputRequestTypeDef#

# DescribeVTLDevicesInputRequestTypeDef definition

class DescribeVTLDevicesInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    VTLDeviceARNs: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    Limit: NotRequired[int],

DescribeWorkingStorageInputRequestTypeDef#

# DescribeWorkingStorageInputRequestTypeDef definition

class DescribeWorkingStorageInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DetachVolumeInputRequestTypeDef#

# DetachVolumeInputRequestTypeDef definition

class DetachVolumeInputRequestTypeDef(TypedDict):
    VolumeARN: str,
    ForceDetach: NotRequired[bool],

DeviceiSCSIAttributesTypeDef#

# DeviceiSCSIAttributesTypeDef definition

class DeviceiSCSIAttributesTypeDef(TypedDict):
    TargetARN: NotRequired[str],
    NetworkInterfaceId: NotRequired[str],
    NetworkInterfacePort: NotRequired[int],
    ChapEnabled: NotRequired[bool],

DisableGatewayInputRequestTypeDef#

# DisableGatewayInputRequestTypeDef definition

class DisableGatewayInputRequestTypeDef(TypedDict):
    GatewayARN: str,

DisassociateFileSystemInputRequestTypeDef#

# DisassociateFileSystemInputRequestTypeDef definition

class DisassociateFileSystemInputRequestTypeDef(TypedDict):
    FileSystemAssociationARN: str,
    ForceDelete: NotRequired[bool],

DiskTypeDef#

# DiskTypeDef 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#

# FileShareInfoTypeDef definition

class FileShareInfoTypeDef(TypedDict):
    FileShareType: NotRequired[FileShareTypeType],  # (1)
    FileShareARN: NotRequired[str],
    FileShareId: NotRequired[str],
    FileShareStatus: NotRequired[str],
    GatewayARN: NotRequired[str],
  1. See FileShareTypeType

FileSystemAssociationStatusDetailTypeDef#

# FileSystemAssociationStatusDetailTypeDef definition

class FileSystemAssociationStatusDetailTypeDef(TypedDict):
    ErrorCode: NotRequired[str],

FileSystemAssociationSummaryTypeDef#

# FileSystemAssociationSummaryTypeDef definition

class FileSystemAssociationSummaryTypeDef(TypedDict):
    FileSystemAssociationId: NotRequired[str],
    FileSystemAssociationARN: NotRequired[str],
    FileSystemAssociationStatus: NotRequired[str],
    GatewayARN: NotRequired[str],

GatewayInfoTypeDef#

# GatewayInfoTypeDef 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],
  1. See HostEnvironmentType

JoinDomainInputRequestTypeDef#

# JoinDomainInputRequestTypeDef definition

class JoinDomainInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    DomainName: str,
    UserName: str,
    Password: str,
    OrganizationalUnit: NotRequired[str],
    DomainControllers: NotRequired[Sequence[str]],
    TimeoutInSeconds: NotRequired[int],

ListAutomaticTapeCreationPoliciesInputRequestTypeDef#

# ListAutomaticTapeCreationPoliciesInputRequestTypeDef definition

class ListAutomaticTapeCreationPoliciesInputRequestTypeDef(TypedDict):
    GatewayARN: NotRequired[str],

ListFileSharesInputRequestTypeDef#

# ListFileSharesInputRequestTypeDef definition

class ListFileSharesInputRequestTypeDef(TypedDict):
    GatewayARN: NotRequired[str],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

ListFileSystemAssociationsInputRequestTypeDef#

# ListFileSystemAssociationsInputRequestTypeDef definition

class ListFileSystemAssociationsInputRequestTypeDef(TypedDict):
    GatewayARN: NotRequired[str],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

ListGatewaysInputRequestTypeDef#

# ListGatewaysInputRequestTypeDef definition

class ListGatewaysInputRequestTypeDef(TypedDict):
    Marker: NotRequired[str],
    Limit: NotRequired[int],

ListLocalDisksInputRequestTypeDef#

# ListLocalDisksInputRequestTypeDef definition

class ListLocalDisksInputRequestTypeDef(TypedDict):
    GatewayARN: str,

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    Marker: NotRequired[str],
    Limit: NotRequired[int],

ListTapePoolsInputRequestTypeDef#

# ListTapePoolsInputRequestTypeDef definition

class ListTapePoolsInputRequestTypeDef(TypedDict):
    PoolARNs: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    Limit: NotRequired[int],

PoolInfoTypeDef#

# PoolInfoTypeDef 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)
  1. See TapeStorageClassType
  2. See RetentionLockTypeType
  3. See PoolStatusType

ListTapesInputRequestTypeDef#

# ListTapesInputRequestTypeDef definition

class ListTapesInputRequestTypeDef(TypedDict):
    TapeARNs: NotRequired[Sequence[str]],
    Marker: NotRequired[str],
    Limit: NotRequired[int],

TapeInfoTypeDef#

# TapeInfoTypeDef 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#

# ListVolumeInitiatorsInputRequestTypeDef definition

class ListVolumeInitiatorsInputRequestTypeDef(TypedDict):
    VolumeARN: str,

ListVolumeRecoveryPointsInputRequestTypeDef#

# ListVolumeRecoveryPointsInputRequestTypeDef definition

class ListVolumeRecoveryPointsInputRequestTypeDef(TypedDict):
    GatewayARN: str,

VolumeRecoveryPointInfoTypeDef#

# VolumeRecoveryPointInfoTypeDef definition

class VolumeRecoveryPointInfoTypeDef(TypedDict):
    VolumeARN: NotRequired[str],
    VolumeSizeInBytes: NotRequired[int],
    VolumeUsageInBytes: NotRequired[int],
    VolumeRecoveryPointTime: NotRequired[str],

ListVolumesInputRequestTypeDef#

# ListVolumesInputRequestTypeDef definition

class ListVolumesInputRequestTypeDef(TypedDict):
    GatewayARN: NotRequired[str],
    Marker: NotRequired[str],
    Limit: NotRequired[int],

VolumeInfoTypeDef#

# VolumeInfoTypeDef 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#

# NotifyWhenUploadedInputRequestTypeDef definition

class NotifyWhenUploadedInputRequestTypeDef(TypedDict):
    FileShareARN: str,

RefreshCacheInputRequestTypeDef#

# RefreshCacheInputRequestTypeDef definition

class RefreshCacheInputRequestTypeDef(TypedDict):
    FileShareARN: str,
    FolderList: NotRequired[Sequence[str]],
    Recursive: NotRequired[bool],

RemoveTagsFromResourceInputRequestTypeDef#

# RemoveTagsFromResourceInputRequestTypeDef definition

class RemoveTagsFromResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

ResetCacheInputRequestTypeDef#

# ResetCacheInputRequestTypeDef definition

class ResetCacheInputRequestTypeDef(TypedDict):
    GatewayARN: str,

RetrieveTapeArchiveInputRequestTypeDef#

# RetrieveTapeArchiveInputRequestTypeDef definition

class RetrieveTapeArchiveInputRequestTypeDef(TypedDict):
    TapeARN: str,
    GatewayARN: str,

RetrieveTapeRecoveryPointInputRequestTypeDef#

# RetrieveTapeRecoveryPointInputRequestTypeDef definition

class RetrieveTapeRecoveryPointInputRequestTypeDef(TypedDict):
    TapeARN: str,
    GatewayARN: str,

SetLocalConsolePasswordInputRequestTypeDef#

# SetLocalConsolePasswordInputRequestTypeDef definition

class SetLocalConsolePasswordInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    LocalConsolePassword: str,

SetSMBGuestPasswordInputRequestTypeDef#

# SetSMBGuestPasswordInputRequestTypeDef definition

class SetSMBGuestPasswordInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    Password: str,

ShutdownGatewayInputRequestTypeDef#

# ShutdownGatewayInputRequestTypeDef definition

class ShutdownGatewayInputRequestTypeDef(TypedDict):
    GatewayARN: str,

StartAvailabilityMonitorTestInputRequestTypeDef#

# StartAvailabilityMonitorTestInputRequestTypeDef definition

class StartAvailabilityMonitorTestInputRequestTypeDef(TypedDict):
    GatewayARN: str,

StartGatewayInputRequestTypeDef#

# StartGatewayInputRequestTypeDef definition

class StartGatewayInputRequestTypeDef(TypedDict):
    GatewayARN: str,

UpdateBandwidthRateLimitInputRequestTypeDef#

# UpdateBandwidthRateLimitInputRequestTypeDef definition

class UpdateBandwidthRateLimitInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    AverageUploadRateLimitInBitsPerSec: NotRequired[int],
    AverageDownloadRateLimitInBitsPerSec: NotRequired[int],

UpdateChapCredentialsInputRequestTypeDef#

# UpdateChapCredentialsInputRequestTypeDef definition

class UpdateChapCredentialsInputRequestTypeDef(TypedDict):
    TargetARN: str,
    SecretToAuthenticateInitiator: str,
    InitiatorName: str,
    SecretToAuthenticateTarget: NotRequired[str],

UpdateGatewayInformationInputRequestTypeDef#

# UpdateGatewayInformationInputRequestTypeDef definition

class UpdateGatewayInformationInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    GatewayName: NotRequired[str],
    GatewayTimezone: NotRequired[str],
    CloudWatchLogGroupARN: NotRequired[str],
    GatewayCapacity: NotRequired[GatewayCapacityType],  # (1)
  1. See GatewayCapacityType

UpdateGatewaySoftwareNowInputRequestTypeDef#

# UpdateGatewaySoftwareNowInputRequestTypeDef definition

class UpdateGatewaySoftwareNowInputRequestTypeDef(TypedDict):
    GatewayARN: str,

UpdateMaintenanceStartTimeInputRequestTypeDef#

# UpdateMaintenanceStartTimeInputRequestTypeDef definition

class UpdateMaintenanceStartTimeInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    HourOfDay: int,
    MinuteOfHour: int,
    DayOfWeek: NotRequired[int],
    DayOfMonth: NotRequired[int],

UpdateSMBFileShareVisibilityInputRequestTypeDef#

# UpdateSMBFileShareVisibilityInputRequestTypeDef definition

class UpdateSMBFileShareVisibilityInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    FileSharesVisible: bool,

UpdateSMBSecurityStrategyInputRequestTypeDef#

# UpdateSMBSecurityStrategyInputRequestTypeDef definition

class UpdateSMBSecurityStrategyInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    SMBSecurityStrategy: SMBSecurityStrategyType,  # (1)
  1. See SMBSecurityStrategyType

UpdateVTLDeviceTypeInputRequestTypeDef#

# UpdateVTLDeviceTypeInputRequestTypeDef definition

class UpdateVTLDeviceTypeInputRequestTypeDef(TypedDict):
    VTLDeviceARN: str,
    DeviceType: str,

ActivateGatewayInputRequestTypeDef#

# ActivateGatewayInputRequestTypeDef 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)
  1. See TagTypeDef

AddTagsToResourceInputRequestTypeDef#

# AddTagsToResourceInputRequestTypeDef definition

class AddTagsToResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateCachediSCSIVolumeInputRequestTypeDef#

# CreateCachediSCSIVolumeInputRequestTypeDef 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)
  1. See TagTypeDef

CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef#

# CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef definition

class CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef(TypedDict):
    VolumeARN: str,
    SnapshotDescription: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateSnapshotInputRequestTypeDef#

# CreateSnapshotInputRequestTypeDef definition

class CreateSnapshotInputRequestTypeDef(TypedDict):
    VolumeARN: str,
    SnapshotDescription: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateStorediSCSIVolumeInputRequestTypeDef#

# CreateStorediSCSIVolumeInputRequestTypeDef 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)
  1. See TagTypeDef

CreateTapePoolInputRequestTypeDef#

# CreateTapePoolInputRequestTypeDef definition

class CreateTapePoolInputRequestTypeDef(TypedDict):
    PoolName: str,
    StorageClass: TapeStorageClassType,  # (1)
    RetentionLockType: NotRequired[RetentionLockTypeType],  # (2)
    RetentionLockTimeInDays: NotRequired[int],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See TapeStorageClassType
  2. See RetentionLockTypeType
  3. See TagTypeDef

CreateTapeWithBarcodeInputRequestTypeDef#

# CreateTapeWithBarcodeInputRequestTypeDef 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)
  1. See TagTypeDef

CreateTapesInputRequestTypeDef#

# CreateTapesInputRequestTypeDef definition

class CreateTapesInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    TapeSizeInBytes: int,
    ClientToken: str,
    NumTapesToCreate: int,
    TapeBarcodePrefix: str,
    KMSEncrypted: NotRequired[bool],
    KMSKey: NotRequired[str],
    PoolId: NotRequired[str],
    Worm: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

UpdateSnapshotScheduleInputRequestTypeDef#

# UpdateSnapshotScheduleInputRequestTypeDef definition

class UpdateSnapshotScheduleInputRequestTypeDef(TypedDict):
    VolumeARN: str,
    StartAt: int,
    RecurrenceInHours: int,
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

ActivateGatewayOutputTypeDef#

# ActivateGatewayOutputTypeDef definition

class ActivateGatewayOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AddCacheOutputTypeDef#

# AddCacheOutputTypeDef definition

class AddCacheOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AddTagsToResourceOutputTypeDef#

# AddTagsToResourceOutputTypeDef definition

class AddTagsToResourceOutputTypeDef(TypedDict):
    ResourceARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AddUploadBufferOutputTypeDef#

# AddUploadBufferOutputTypeDef definition

class AddUploadBufferOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AddWorkingStorageOutputTypeDef#

# AddWorkingStorageOutputTypeDef definition

class AddWorkingStorageOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssignTapePoolOutputTypeDef#

# AssignTapePoolOutputTypeDef definition

class AssignTapePoolOutputTypeDef(TypedDict):
    TapeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateFileSystemOutputTypeDef#

# AssociateFileSystemOutputTypeDef definition

class AssociateFileSystemOutputTypeDef(TypedDict):
    FileSystemAssociationARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AttachVolumeOutputTypeDef#

# AttachVolumeOutputTypeDef definition

class AttachVolumeOutputTypeDef(TypedDict):
    VolumeARN: str,
    TargetARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CancelArchivalOutputTypeDef#

# CancelArchivalOutputTypeDef definition

class CancelArchivalOutputTypeDef(TypedDict):
    TapeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CancelRetrievalOutputTypeDef#

# CancelRetrievalOutputTypeDef definition

class CancelRetrievalOutputTypeDef(TypedDict):
    TapeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateCachediSCSIVolumeOutputTypeDef#

# CreateCachediSCSIVolumeOutputTypeDef definition

class CreateCachediSCSIVolumeOutputTypeDef(TypedDict):
    VolumeARN: str,
    TargetARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateNFSFileShareOutputTypeDef#

# CreateNFSFileShareOutputTypeDef definition

class CreateNFSFileShareOutputTypeDef(TypedDict):
    FileShareARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSMBFileShareOutputTypeDef#

# CreateSMBFileShareOutputTypeDef definition

class CreateSMBFileShareOutputTypeDef(TypedDict):
    FileShareARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSnapshotFromVolumeRecoveryPointOutputTypeDef#

# CreateSnapshotFromVolumeRecoveryPointOutputTypeDef definition

class CreateSnapshotFromVolumeRecoveryPointOutputTypeDef(TypedDict):
    SnapshotId: str,
    VolumeARN: str,
    VolumeRecoveryPointTime: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSnapshotOutputTypeDef#

# CreateSnapshotOutputTypeDef definition

class CreateSnapshotOutputTypeDef(TypedDict):
    VolumeARN: str,
    SnapshotId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateStorediSCSIVolumeOutputTypeDef#

# CreateStorediSCSIVolumeOutputTypeDef definition

class CreateStorediSCSIVolumeOutputTypeDef(TypedDict):
    VolumeARN: str,
    VolumeSizeInBytes: int,
    TargetARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTapePoolOutputTypeDef#

# CreateTapePoolOutputTypeDef definition

class CreateTapePoolOutputTypeDef(TypedDict):
    PoolARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTapeWithBarcodeOutputTypeDef#

# CreateTapeWithBarcodeOutputTypeDef definition

class CreateTapeWithBarcodeOutputTypeDef(TypedDict):
    TapeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTapesOutputTypeDef#

# CreateTapesOutputTypeDef definition

class CreateTapesOutputTypeDef(TypedDict):
    TapeARNs: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteAutomaticTapeCreationPolicyOutputTypeDef#

# DeleteAutomaticTapeCreationPolicyOutputTypeDef definition

class DeleteAutomaticTapeCreationPolicyOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBandwidthRateLimitOutputTypeDef#

# DeleteBandwidthRateLimitOutputTypeDef definition

class DeleteBandwidthRateLimitOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteChapCredentialsOutputTypeDef#

# DeleteChapCredentialsOutputTypeDef definition

class DeleteChapCredentialsOutputTypeDef(TypedDict):
    TargetARN: str,
    InitiatorName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteFileShareOutputTypeDef#

# DeleteFileShareOutputTypeDef definition

class DeleteFileShareOutputTypeDef(TypedDict):
    FileShareARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteGatewayOutputTypeDef#

# DeleteGatewayOutputTypeDef definition

class DeleteGatewayOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteSnapshotScheduleOutputTypeDef#

# DeleteSnapshotScheduleOutputTypeDef definition

class DeleteSnapshotScheduleOutputTypeDef(TypedDict):
    VolumeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteTapeArchiveOutputTypeDef#

# DeleteTapeArchiveOutputTypeDef definition

class DeleteTapeArchiveOutputTypeDef(TypedDict):
    TapeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteTapeOutputTypeDef#

# DeleteTapeOutputTypeDef definition

class DeleteTapeOutputTypeDef(TypedDict):
    TapeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteTapePoolOutputTypeDef#

# DeleteTapePoolOutputTypeDef definition

class DeleteTapePoolOutputTypeDef(TypedDict):
    PoolARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteVolumeOutputTypeDef#

# DeleteVolumeOutputTypeDef definition

class DeleteVolumeOutputTypeDef(TypedDict):
    VolumeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAvailabilityMonitorTestOutputTypeDef#

# DescribeAvailabilityMonitorTestOutputTypeDef definition

class DescribeAvailabilityMonitorTestOutputTypeDef(TypedDict):
    GatewayARN: str,
    Status: AvailabilityMonitorTestStatusType,  # (1)
    StartTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AvailabilityMonitorTestStatusType
  2. See ResponseMetadataTypeDef

DescribeBandwidthRateLimitOutputTypeDef#

# DescribeBandwidthRateLimitOutputTypeDef definition

class DescribeBandwidthRateLimitOutputTypeDef(TypedDict):
    GatewayARN: str,
    AverageUploadRateLimitInBitsPerSec: int,
    AverageDownloadRateLimitInBitsPerSec: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeCacheOutputTypeDef#

# DescribeCacheOutputTypeDef definition

class DescribeCacheOutputTypeDef(TypedDict):
    GatewayARN: str,
    DiskIds: List[str],
    CacheAllocatedInBytes: int,
    CacheUsedPercentage: float,
    CacheDirtyPercentage: float,
    CacheHitPercentage: float,
    CacheMissPercentage: float,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeMaintenanceStartTimeOutputTypeDef#

# DescribeMaintenanceStartTimeOutputTypeDef definition

class DescribeMaintenanceStartTimeOutputTypeDef(TypedDict):
    GatewayARN: str,
    HourOfDay: int,
    MinuteOfHour: int,
    DayOfWeek: int,
    DayOfMonth: int,
    Timezone: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeSnapshotScheduleOutputTypeDef#

# DescribeSnapshotScheduleOutputTypeDef definition

class DescribeSnapshotScheduleOutputTypeDef(TypedDict):
    VolumeARN: str,
    StartAt: int,
    RecurrenceInHours: int,
    Description: str,
    Timezone: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

DescribeUploadBufferOutputTypeDef#

# DescribeUploadBufferOutputTypeDef definition

class DescribeUploadBufferOutputTypeDef(TypedDict):
    GatewayARN: str,
    DiskIds: List[str],
    UploadBufferUsedInBytes: int,
    UploadBufferAllocatedInBytes: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeWorkingStorageOutputTypeDef#

# DescribeWorkingStorageOutputTypeDef definition

class DescribeWorkingStorageOutputTypeDef(TypedDict):
    GatewayARN: str,
    DiskIds: List[str],
    WorkingStorageUsedInBytes: int,
    WorkingStorageAllocatedInBytes: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DetachVolumeOutputTypeDef#

# DetachVolumeOutputTypeDef definition

class DetachVolumeOutputTypeDef(TypedDict):
    VolumeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisableGatewayOutputTypeDef#

# DisableGatewayOutputTypeDef definition

class DisableGatewayOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisassociateFileSystemOutputTypeDef#

# DisassociateFileSystemOutputTypeDef definition

class DisassociateFileSystemOutputTypeDef(TypedDict):
    FileSystemAssociationARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

JoinDomainOutputTypeDef#

# JoinDomainOutputTypeDef definition

class JoinDomainOutputTypeDef(TypedDict):
    GatewayARN: str,
    ActiveDirectoryStatus: ActiveDirectoryStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ActiveDirectoryStatusType
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    ResourceARN: str,
    Marker: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

ListVolumeInitiatorsOutputTypeDef#

# ListVolumeInitiatorsOutputTypeDef definition

class ListVolumeInitiatorsOutputTypeDef(TypedDict):
    Initiators: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

NotifyWhenUploadedOutputTypeDef#

# NotifyWhenUploadedOutputTypeDef definition

class NotifyWhenUploadedOutputTypeDef(TypedDict):
    FileShareARN: str,
    NotificationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RefreshCacheOutputTypeDef#

# RefreshCacheOutputTypeDef definition

class RefreshCacheOutputTypeDef(TypedDict):
    FileShareARN: str,
    NotificationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RemoveTagsFromResourceOutputTypeDef#

# RemoveTagsFromResourceOutputTypeDef definition

class RemoveTagsFromResourceOutputTypeDef(TypedDict):
    ResourceARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ResetCacheOutputTypeDef#

# ResetCacheOutputTypeDef definition

class ResetCacheOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RetrieveTapeArchiveOutputTypeDef#

# RetrieveTapeArchiveOutputTypeDef definition

class RetrieveTapeArchiveOutputTypeDef(TypedDict):
    TapeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RetrieveTapeRecoveryPointOutputTypeDef#

# RetrieveTapeRecoveryPointOutputTypeDef definition

class RetrieveTapeRecoveryPointOutputTypeDef(TypedDict):
    TapeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SetLocalConsolePasswordOutputTypeDef#

# SetLocalConsolePasswordOutputTypeDef definition

class SetLocalConsolePasswordOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SetSMBGuestPasswordOutputTypeDef#

# SetSMBGuestPasswordOutputTypeDef definition

class SetSMBGuestPasswordOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ShutdownGatewayOutputTypeDef#

# ShutdownGatewayOutputTypeDef definition

class ShutdownGatewayOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartAvailabilityMonitorTestOutputTypeDef#

# StartAvailabilityMonitorTestOutputTypeDef definition

class StartAvailabilityMonitorTestOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartGatewayOutputTypeDef#

# StartGatewayOutputTypeDef definition

class StartGatewayOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAutomaticTapeCreationPolicyOutputTypeDef#

# UpdateAutomaticTapeCreationPolicyOutputTypeDef definition

class UpdateAutomaticTapeCreationPolicyOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateBandwidthRateLimitOutputTypeDef#

# UpdateBandwidthRateLimitOutputTypeDef definition

class UpdateBandwidthRateLimitOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateBandwidthRateLimitScheduleOutputTypeDef#

# UpdateBandwidthRateLimitScheduleOutputTypeDef definition

class UpdateBandwidthRateLimitScheduleOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateChapCredentialsOutputTypeDef#

# UpdateChapCredentialsOutputTypeDef definition

class UpdateChapCredentialsOutputTypeDef(TypedDict):
    TargetARN: str,
    InitiatorName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateFileSystemAssociationOutputTypeDef#

# UpdateFileSystemAssociationOutputTypeDef definition

class UpdateFileSystemAssociationOutputTypeDef(TypedDict):
    FileSystemAssociationARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateGatewayInformationOutputTypeDef#

# UpdateGatewayInformationOutputTypeDef definition

class UpdateGatewayInformationOutputTypeDef(TypedDict):
    GatewayARN: str,
    GatewayName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateGatewaySoftwareNowOutputTypeDef#

# UpdateGatewaySoftwareNowOutputTypeDef definition

class UpdateGatewaySoftwareNowOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateMaintenanceStartTimeOutputTypeDef#

# UpdateMaintenanceStartTimeOutputTypeDef definition

class UpdateMaintenanceStartTimeOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateNFSFileShareOutputTypeDef#

# UpdateNFSFileShareOutputTypeDef definition

class UpdateNFSFileShareOutputTypeDef(TypedDict):
    FileShareARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSMBFileShareOutputTypeDef#

# UpdateSMBFileShareOutputTypeDef definition

class UpdateSMBFileShareOutputTypeDef(TypedDict):
    FileShareARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSMBFileShareVisibilityOutputTypeDef#

# UpdateSMBFileShareVisibilityOutputTypeDef definition

class UpdateSMBFileShareVisibilityOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSMBLocalGroupsOutputTypeDef#

# UpdateSMBLocalGroupsOutputTypeDef definition

class UpdateSMBLocalGroupsOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSMBSecurityStrategyOutputTypeDef#

# UpdateSMBSecurityStrategyOutputTypeDef definition

class UpdateSMBSecurityStrategyOutputTypeDef(TypedDict):
    GatewayARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSnapshotScheduleOutputTypeDef#

# UpdateSnapshotScheduleOutputTypeDef definition

class UpdateSnapshotScheduleOutputTypeDef(TypedDict):
    VolumeARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateVTLDeviceTypeOutputTypeDef#

# UpdateVTLDeviceTypeOutputTypeDef definition

class UpdateVTLDeviceTypeOutputTypeDef(TypedDict):
    VTLDeviceARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSMBFileShareInputRequestTypeDef#

# CreateSMBFileShareInputRequestTypeDef definition

class CreateSMBFileShareInputRequestTypeDef(TypedDict):
    ClientToken: str,
    GatewayARN: str,
    Role: str,
    LocationARN: str,
    KMSEncrypted: NotRequired[bool],
    KMSKey: NotRequired[str],
    DefaultStorageClass: NotRequired[str],
    ObjectACL: NotRequired[ObjectACLType],  # (1)
    ReadOnly: NotRequired[bool],
    GuessMIMETypeEnabled: NotRequired[bool],
    RequesterPays: NotRequired[bool],
    SMBACLEnabled: NotRequired[bool],
    AccessBasedEnumeration: NotRequired[bool],
    AdminUserList: NotRequired[Sequence[str]],
    ValidUserList: NotRequired[Sequence[str]],
    InvalidUserList: NotRequired[Sequence[str]],
    AuditDestinationARN: NotRequired[str],
    Authentication: NotRequired[str],
    CaseSensitivity: NotRequired[CaseSensitivityType],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    FileShareName: NotRequired[str],
    CacheAttributes: NotRequired[CacheAttributesTypeDef],  # (4)
    NotificationPolicy: NotRequired[str],
    VPCEndpointDNSName: NotRequired[str],
    BucketRegion: NotRequired[str],
    OplocksEnabled: NotRequired[bool],
  1. See ObjectACLType
  2. See CaseSensitivityType
  3. See TagTypeDef
  4. See CacheAttributesTypeDef

SMBFileShareInfoTypeDef#

# SMBFileShareInfoTypeDef definition

class SMBFileShareInfoTypeDef(TypedDict):
    FileShareARN: NotRequired[str],
    FileShareId: NotRequired[str],
    FileShareStatus: NotRequired[str],
    GatewayARN: NotRequired[str],
    KMSEncrypted: NotRequired[bool],
    KMSKey: NotRequired[str],
    Path: NotRequired[str],
    Role: NotRequired[str],
    LocationARN: NotRequired[str],
    DefaultStorageClass: NotRequired[str],
    ObjectACL: NotRequired[ObjectACLType],  # (1)
    ReadOnly: NotRequired[bool],
    GuessMIMETypeEnabled: NotRequired[bool],
    RequesterPays: NotRequired[bool],
    SMBACLEnabled: NotRequired[bool],
    AccessBasedEnumeration: NotRequired[bool],
    AdminUserList: NotRequired[List[str]],
    ValidUserList: NotRequired[List[str]],
    InvalidUserList: NotRequired[List[str]],
    AuditDestinationARN: NotRequired[str],
    Authentication: NotRequired[str],
    CaseSensitivity: NotRequired[CaseSensitivityType],  # (2)
    Tags: NotRequired[List[TagTypeDef]],  # (3)
    FileShareName: NotRequired[str],
    CacheAttributes: NotRequired[CacheAttributesTypeDef],  # (4)
    NotificationPolicy: NotRequired[str],
    VPCEndpointDNSName: NotRequired[str],
    BucketRegion: NotRequired[str],
    OplocksEnabled: NotRequired[bool],
  1. See ObjectACLType
  2. See CaseSensitivityType
  3. See TagTypeDef
  4. See CacheAttributesTypeDef

UpdateFileSystemAssociationInputRequestTypeDef#

# UpdateFileSystemAssociationInputRequestTypeDef definition

class UpdateFileSystemAssociationInputRequestTypeDef(TypedDict):
    FileSystemAssociationARN: str,
    UserName: NotRequired[str],
    Password: NotRequired[str],
    AuditDestinationARN: NotRequired[str],
    CacheAttributes: NotRequired[CacheAttributesTypeDef],  # (1)
  1. See CacheAttributesTypeDef

UpdateSMBFileShareInputRequestTypeDef#

# UpdateSMBFileShareInputRequestTypeDef definition

class UpdateSMBFileShareInputRequestTypeDef(TypedDict):
    FileShareARN: str,
    KMSEncrypted: NotRequired[bool],
    KMSKey: NotRequired[str],
    DefaultStorageClass: NotRequired[str],
    ObjectACL: NotRequired[ObjectACLType],  # (1)
    ReadOnly: NotRequired[bool],
    GuessMIMETypeEnabled: NotRequired[bool],
    RequesterPays: NotRequired[bool],
    SMBACLEnabled: NotRequired[bool],
    AccessBasedEnumeration: NotRequired[bool],
    AdminUserList: NotRequired[Sequence[str]],
    ValidUserList: NotRequired[Sequence[str]],
    InvalidUserList: NotRequired[Sequence[str]],
    AuditDestinationARN: NotRequired[str],
    CaseSensitivity: NotRequired[CaseSensitivityType],  # (2)
    FileShareName: NotRequired[str],
    CacheAttributes: NotRequired[CacheAttributesTypeDef],  # (3)
    NotificationPolicy: NotRequired[str],
    OplocksEnabled: NotRequired[bool],
  1. See ObjectACLType
  2. See CaseSensitivityType
  3. See CacheAttributesTypeDef

AssociateFileSystemInputRequestTypeDef#

# AssociateFileSystemInputRequestTypeDef definition

class AssociateFileSystemInputRequestTypeDef(TypedDict):
    UserName: str,
    Password: str,
    ClientToken: str,
    GatewayARN: str,
    LocationARN: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    AuditDestinationARN: NotRequired[str],
    CacheAttributes: NotRequired[CacheAttributesTypeDef],  # (2)
    EndpointNetworkConfiguration: NotRequired[EndpointNetworkConfigurationTypeDef],  # (3)
  1. See TagTypeDef
  2. See CacheAttributesTypeDef
  3. See EndpointNetworkConfigurationTypeDef

AutomaticTapeCreationPolicyInfoTypeDef#

# AutomaticTapeCreationPolicyInfoTypeDef definition

class AutomaticTapeCreationPolicyInfoTypeDef(TypedDict):
    AutomaticTapeCreationRules: NotRequired[List[AutomaticTapeCreationRuleTypeDef]],  # (1)
    GatewayARN: NotRequired[str],
  1. See AutomaticTapeCreationRuleTypeDef

UpdateAutomaticTapeCreationPolicyInputRequestTypeDef#

# UpdateAutomaticTapeCreationPolicyInputRequestTypeDef definition

class UpdateAutomaticTapeCreationPolicyInputRequestTypeDef(TypedDict):
    AutomaticTapeCreationRules: Sequence[AutomaticTapeCreationRuleTypeDef],  # (1)
    GatewayARN: str,
  1. See AutomaticTapeCreationRuleTypeDef

DescribeBandwidthRateLimitScheduleOutputTypeDef#

# DescribeBandwidthRateLimitScheduleOutputTypeDef definition

class DescribeBandwidthRateLimitScheduleOutputTypeDef(TypedDict):
    GatewayARN: str,
    BandwidthRateLimitIntervals: List[BandwidthRateLimitIntervalTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BandwidthRateLimitIntervalTypeDef
  2. See ResponseMetadataTypeDef

UpdateBandwidthRateLimitScheduleInputRequestTypeDef#

# UpdateBandwidthRateLimitScheduleInputRequestTypeDef definition

class UpdateBandwidthRateLimitScheduleInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    BandwidthRateLimitIntervals: Sequence[BandwidthRateLimitIntervalTypeDef],  # (1)
  1. See BandwidthRateLimitIntervalTypeDef

CachediSCSIVolumeTypeDef#

# CachediSCSIVolumeTypeDef definition

class CachediSCSIVolumeTypeDef(TypedDict):
    VolumeARN: NotRequired[str],
    VolumeId: NotRequired[str],
    VolumeType: NotRequired[str],
    VolumeStatus: NotRequired[str],
    VolumeAttachmentStatus: NotRequired[str],
    VolumeSizeInBytes: NotRequired[int],
    VolumeProgress: NotRequired[float],
    SourceSnapshotId: NotRequired[str],
    VolumeiSCSIAttributes: NotRequired[VolumeiSCSIAttributesTypeDef],  # (1)
    CreatedDate: NotRequired[datetime],
    VolumeUsedInBytes: NotRequired[int],
    KMSKey: NotRequired[str],
    TargetName: NotRequired[str],
  1. See VolumeiSCSIAttributesTypeDef

StorediSCSIVolumeTypeDef#

# StorediSCSIVolumeTypeDef definition

class StorediSCSIVolumeTypeDef(TypedDict):
    VolumeARN: NotRequired[str],
    VolumeId: NotRequired[str],
    VolumeType: NotRequired[str],
    VolumeStatus: NotRequired[str],
    VolumeAttachmentStatus: NotRequired[str],
    VolumeSizeInBytes: NotRequired[int],
    VolumeProgress: NotRequired[float],
    VolumeDiskId: NotRequired[str],
    SourceSnapshotId: NotRequired[str],
    PreservedExistingData: NotRequired[bool],
    VolumeiSCSIAttributes: NotRequired[VolumeiSCSIAttributesTypeDef],  # (1)
    CreatedDate: NotRequired[datetime],
    VolumeUsedInBytes: NotRequired[int],
    KMSKey: NotRequired[str],
    TargetName: NotRequired[str],
  1. See VolumeiSCSIAttributesTypeDef

DescribeChapCredentialsOutputTypeDef#

# DescribeChapCredentialsOutputTypeDef definition

class DescribeChapCredentialsOutputTypeDef(TypedDict):
    ChapCredentials: List[ChapInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChapInfoTypeDef
  2. See ResponseMetadataTypeDef

CreateNFSFileShareInputRequestTypeDef#

# CreateNFSFileShareInputRequestTypeDef definition

class CreateNFSFileShareInputRequestTypeDef(TypedDict):
    ClientToken: str,
    GatewayARN: str,
    Role: str,
    LocationARN: str,
    NFSFileShareDefaults: NotRequired[NFSFileShareDefaultsTypeDef],  # (1)
    KMSEncrypted: NotRequired[bool],
    KMSKey: NotRequired[str],
    DefaultStorageClass: NotRequired[str],
    ObjectACL: NotRequired[ObjectACLType],  # (2)
    ClientList: NotRequired[Sequence[str]],
    Squash: NotRequired[str],
    ReadOnly: NotRequired[bool],
    GuessMIMETypeEnabled: NotRequired[bool],
    RequesterPays: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    FileShareName: NotRequired[str],
    CacheAttributes: NotRequired[CacheAttributesTypeDef],  # (4)
    NotificationPolicy: NotRequired[str],
    VPCEndpointDNSName: NotRequired[str],
    BucketRegion: NotRequired[str],
    AuditDestinationARN: NotRequired[str],
  1. See NFSFileShareDefaultsTypeDef
  2. See ObjectACLType
  3. See TagTypeDef
  4. See CacheAttributesTypeDef

NFSFileShareInfoTypeDef#

# NFSFileShareInfoTypeDef definition

class NFSFileShareInfoTypeDef(TypedDict):
    NFSFileShareDefaults: NotRequired[NFSFileShareDefaultsTypeDef],  # (1)
    FileShareARN: NotRequired[str],
    FileShareId: NotRequired[str],
    FileShareStatus: NotRequired[str],
    GatewayARN: NotRequired[str],
    KMSEncrypted: NotRequired[bool],
    KMSKey: NotRequired[str],
    Path: NotRequired[str],
    Role: NotRequired[str],
    LocationARN: NotRequired[str],
    DefaultStorageClass: NotRequired[str],
    ObjectACL: NotRequired[ObjectACLType],  # (2)
    ClientList: NotRequired[List[str]],
    Squash: NotRequired[str],
    ReadOnly: NotRequired[bool],
    GuessMIMETypeEnabled: NotRequired[bool],
    RequesterPays: NotRequired[bool],
    Tags: NotRequired[List[TagTypeDef]],  # (3)
    FileShareName: NotRequired[str],
    CacheAttributes: NotRequired[CacheAttributesTypeDef],  # (4)
    NotificationPolicy: NotRequired[str],
    VPCEndpointDNSName: NotRequired[str],
    BucketRegion: NotRequired[str],
    AuditDestinationARN: NotRequired[str],
  1. See NFSFileShareDefaultsTypeDef
  2. See ObjectACLType
  3. See TagTypeDef
  4. See CacheAttributesTypeDef

UpdateNFSFileShareInputRequestTypeDef#

# UpdateNFSFileShareInputRequestTypeDef definition

class UpdateNFSFileShareInputRequestTypeDef(TypedDict):
    FileShareARN: str,
    KMSEncrypted: NotRequired[bool],
    KMSKey: NotRequired[str],
    NFSFileShareDefaults: NotRequired[NFSFileShareDefaultsTypeDef],  # (1)
    DefaultStorageClass: NotRequired[str],
    ObjectACL: NotRequired[ObjectACLType],  # (2)
    ClientList: NotRequired[Sequence[str]],
    Squash: NotRequired[str],
    ReadOnly: NotRequired[bool],
    GuessMIMETypeEnabled: NotRequired[bool],
    RequesterPays: NotRequired[bool],
    FileShareName: NotRequired[str],
    CacheAttributes: NotRequired[CacheAttributesTypeDef],  # (3)
    NotificationPolicy: NotRequired[str],
    AuditDestinationARN: NotRequired[str],
  1. See NFSFileShareDefaultsTypeDef
  2. See ObjectACLType
  3. See CacheAttributesTypeDef

DescribeGatewayInformationOutputTypeDef#

# DescribeGatewayInformationOutputTypeDef definition

class DescribeGatewayInformationOutputTypeDef(TypedDict):
    GatewayARN: str,
    GatewayId: str,
    GatewayName: str,
    GatewayTimezone: str,
    GatewayState: str,
    GatewayNetworkInterfaces: List[NetworkInterfaceTypeDef],  # (1)
    GatewayType: str,
    NextUpdateAvailabilityDate: str,
    LastSoftwareUpdate: str,
    Ec2InstanceId: str,
    Ec2InstanceRegion: str,
    Tags: List[TagTypeDef],  # (2)
    VPCEndpoint: str,
    CloudWatchLogGroupARN: str,
    HostEnvironment: HostEnvironmentType,  # (3)
    EndpointType: str,
    SoftwareUpdatesEndDate: str,
    DeprecationDate: str,
    GatewayCapacity: GatewayCapacityType,  # (4)
    SupportedGatewayCapacities: List[GatewayCapacityType],  # (5)
    HostEnvironmentId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See NetworkInterfaceTypeDef
  2. See TagTypeDef
  3. See HostEnvironmentType
  4. See GatewayCapacityType
  5. See GatewayCapacityType
  6. See ResponseMetadataTypeDef

DescribeSMBSettingsOutputTypeDef#

# DescribeSMBSettingsOutputTypeDef definition

class DescribeSMBSettingsOutputTypeDef(TypedDict):
    GatewayARN: str,
    DomainName: str,
    ActiveDirectoryStatus: ActiveDirectoryStatusType,  # (1)
    SMBGuestPasswordSet: bool,
    SMBSecurityStrategy: SMBSecurityStrategyType,  # (2)
    FileSharesVisible: bool,
    SMBLocalGroups: SMBLocalGroupsTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ActiveDirectoryStatusType
  2. See SMBSecurityStrategyType
  3. See SMBLocalGroupsTypeDef
  4. See ResponseMetadataTypeDef

UpdateSMBLocalGroupsInputRequestTypeDef#

# UpdateSMBLocalGroupsInputRequestTypeDef definition

class UpdateSMBLocalGroupsInputRequestTypeDef(TypedDict):
    GatewayARN: str,
    SMBLocalGroups: SMBLocalGroupsTypeDef,  # (1)
  1. See SMBLocalGroupsTypeDef

DescribeTapeArchivesInputDescribeTapeArchivesPaginateTypeDef#

# DescribeTapeArchivesInputDescribeTapeArchivesPaginateTypeDef definition

class DescribeTapeArchivesInputDescribeTapeArchivesPaginateTypeDef(TypedDict):
    TapeARNs: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeTapeRecoveryPointsInputDescribeTapeRecoveryPointsPaginateTypeDef#

# DescribeTapeRecoveryPointsInputDescribeTapeRecoveryPointsPaginateTypeDef definition

class DescribeTapeRecoveryPointsInputDescribeTapeRecoveryPointsPaginateTypeDef(TypedDict):
    GatewayARN: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeTapesInputDescribeTapesPaginateTypeDef#

# DescribeTapesInputDescribeTapesPaginateTypeDef definition

class DescribeTapesInputDescribeTapesPaginateTypeDef(TypedDict):
    GatewayARN: str,
    TapeARNs: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeVTLDevicesInputDescribeVTLDevicesPaginateTypeDef#

# DescribeVTLDevicesInputDescribeVTLDevicesPaginateTypeDef definition

class DescribeVTLDevicesInputDescribeVTLDevicesPaginateTypeDef(TypedDict):
    GatewayARN: str,
    VTLDeviceARNs: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFileSharesInputListFileSharesPaginateTypeDef#

# ListFileSharesInputListFileSharesPaginateTypeDef definition

class ListFileSharesInputListFileSharesPaginateTypeDef(TypedDict):
    GatewayARN: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFileSystemAssociationsInputListFileSystemAssociationsPaginateTypeDef#

# ListFileSystemAssociationsInputListFileSystemAssociationsPaginateTypeDef definition

class ListFileSystemAssociationsInputListFileSystemAssociationsPaginateTypeDef(TypedDict):
    GatewayARN: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListGatewaysInputListGatewaysPaginateTypeDef#

# ListGatewaysInputListGatewaysPaginateTypeDef definition

class ListGatewaysInputListGatewaysPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceInputListTagsForResourcePaginateTypeDef#

# ListTagsForResourceInputListTagsForResourcePaginateTypeDef definition

class ListTagsForResourceInputListTagsForResourcePaginateTypeDef(TypedDict):
    ResourceARN: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTapePoolsInputListTapePoolsPaginateTypeDef#

# ListTapePoolsInputListTapePoolsPaginateTypeDef definition

class ListTapePoolsInputListTapePoolsPaginateTypeDef(TypedDict):
    PoolARNs: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTapesInputListTapesPaginateTypeDef#

# ListTapesInputListTapesPaginateTypeDef definition

class ListTapesInputListTapesPaginateTypeDef(TypedDict):
    TapeARNs: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListVolumesInputListVolumesPaginateTypeDef#

# ListVolumesInputListVolumesPaginateTypeDef definition

class ListVolumesInputListVolumesPaginateTypeDef(TypedDict):
    GatewayARN: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeTapeArchivesOutputTypeDef#

# DescribeTapeArchivesOutputTypeDef definition

class DescribeTapeArchivesOutputTypeDef(TypedDict):
    TapeArchives: List[TapeArchiveTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TapeArchiveTypeDef
  2. See ResponseMetadataTypeDef

DescribeTapeRecoveryPointsOutputTypeDef#

# DescribeTapeRecoveryPointsOutputTypeDef definition

class DescribeTapeRecoveryPointsOutputTypeDef(TypedDict):
    GatewayARN: str,
    TapeRecoveryPointInfos: List[TapeRecoveryPointInfoTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TapeRecoveryPointInfoTypeDef
  2. See ResponseMetadataTypeDef

DescribeTapesOutputTypeDef#

# DescribeTapesOutputTypeDef definition

class DescribeTapesOutputTypeDef(TypedDict):
    Tapes: List[TapeTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TapeTypeDef
  2. See ResponseMetadataTypeDef

VTLDeviceTypeDef#

# VTLDeviceTypeDef definition

class VTLDeviceTypeDef(TypedDict):
    VTLDeviceARN: NotRequired[str],
    VTLDeviceType: NotRequired[str],
    VTLDeviceVendor: NotRequired[str],
    VTLDeviceProductIdentifier: NotRequired[str],
    DeviceiSCSIAttributes: NotRequired[DeviceiSCSIAttributesTypeDef],  # (1)
  1. See DeviceiSCSIAttributesTypeDef

ListLocalDisksOutputTypeDef#

# ListLocalDisksOutputTypeDef definition

class ListLocalDisksOutputTypeDef(TypedDict):
    GatewayARN: str,
    Disks: List[DiskTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DiskTypeDef
  2. See ResponseMetadataTypeDef

ListFileSharesOutputTypeDef#

# ListFileSharesOutputTypeDef definition

class ListFileSharesOutputTypeDef(TypedDict):
    Marker: str,
    NextMarker: str,
    FileShareInfoList: List[FileShareInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileShareInfoTypeDef
  2. See ResponseMetadataTypeDef

FileSystemAssociationInfoTypeDef#

# FileSystemAssociationInfoTypeDef definition

class FileSystemAssociationInfoTypeDef(TypedDict):
    FileSystemAssociationARN: NotRequired[str],
    LocationARN: NotRequired[str],
    FileSystemAssociationStatus: NotRequired[str],
    AuditDestinationARN: NotRequired[str],
    GatewayARN: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)
    CacheAttributes: NotRequired[CacheAttributesTypeDef],  # (2)
    EndpointNetworkConfiguration: NotRequired[EndpointNetworkConfigurationTypeDef],  # (3)
    FileSystemAssociationStatusDetails: NotRequired[List[FileSystemAssociationStatusDetailTypeDef]],  # (4)
  1. See TagTypeDef
  2. See CacheAttributesTypeDef
  3. See EndpointNetworkConfigurationTypeDef
  4. See FileSystemAssociationStatusDetailTypeDef

ListFileSystemAssociationsOutputTypeDef#

# ListFileSystemAssociationsOutputTypeDef definition

class ListFileSystemAssociationsOutputTypeDef(TypedDict):
    Marker: str,
    NextMarker: str,
    FileSystemAssociationSummaryList: List[FileSystemAssociationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileSystemAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListGatewaysOutputTypeDef#

# ListGatewaysOutputTypeDef definition

class ListGatewaysOutputTypeDef(TypedDict):
    Gateways: List[GatewayInfoTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GatewayInfoTypeDef
  2. See ResponseMetadataTypeDef

ListTapePoolsOutputTypeDef#

# ListTapePoolsOutputTypeDef definition

class ListTapePoolsOutputTypeDef(TypedDict):
    PoolInfos: List[PoolInfoTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PoolInfoTypeDef
  2. See ResponseMetadataTypeDef

ListTapesOutputTypeDef#

# ListTapesOutputTypeDef definition

class ListTapesOutputTypeDef(TypedDict):
    TapeInfos: List[TapeInfoTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TapeInfoTypeDef
  2. See ResponseMetadataTypeDef

ListVolumeRecoveryPointsOutputTypeDef#

# ListVolumeRecoveryPointsOutputTypeDef definition

class ListVolumeRecoveryPointsOutputTypeDef(TypedDict):
    GatewayARN: str,
    VolumeRecoveryPointInfos: List[VolumeRecoveryPointInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VolumeRecoveryPointInfoTypeDef
  2. See ResponseMetadataTypeDef

ListVolumesOutputTypeDef#

# ListVolumesOutputTypeDef definition

class ListVolumesOutputTypeDef(TypedDict):
    GatewayARN: str,
    Marker: str,
    VolumeInfos: List[VolumeInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VolumeInfoTypeDef
  2. See ResponseMetadataTypeDef

DescribeSMBFileSharesOutputTypeDef#

# DescribeSMBFileSharesOutputTypeDef definition

class DescribeSMBFileSharesOutputTypeDef(TypedDict):
    SMBFileShareInfoList: List[SMBFileShareInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SMBFileShareInfoTypeDef
  2. See ResponseMetadataTypeDef

ListAutomaticTapeCreationPoliciesOutputTypeDef#

# ListAutomaticTapeCreationPoliciesOutputTypeDef definition

class ListAutomaticTapeCreationPoliciesOutputTypeDef(TypedDict):
    AutomaticTapeCreationPolicyInfos: List[AutomaticTapeCreationPolicyInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AutomaticTapeCreationPolicyInfoTypeDef
  2. See ResponseMetadataTypeDef

DescribeCachediSCSIVolumesOutputTypeDef#

# DescribeCachediSCSIVolumesOutputTypeDef definition

class DescribeCachediSCSIVolumesOutputTypeDef(TypedDict):
    CachediSCSIVolumes: List[CachediSCSIVolumeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CachediSCSIVolumeTypeDef
  2. See ResponseMetadataTypeDef

DescribeStorediSCSIVolumesOutputTypeDef#

# DescribeStorediSCSIVolumesOutputTypeDef definition

class DescribeStorediSCSIVolumesOutputTypeDef(TypedDict):
    StorediSCSIVolumes: List[StorediSCSIVolumeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StorediSCSIVolumeTypeDef
  2. See ResponseMetadataTypeDef

DescribeNFSFileSharesOutputTypeDef#

# DescribeNFSFileSharesOutputTypeDef definition

class DescribeNFSFileSharesOutputTypeDef(TypedDict):
    NFSFileShareInfoList: List[NFSFileShareInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NFSFileShareInfoTypeDef
  2. See ResponseMetadataTypeDef

DescribeVTLDevicesOutputTypeDef#

# DescribeVTLDevicesOutputTypeDef definition

class DescribeVTLDevicesOutputTypeDef(TypedDict):
    GatewayARN: str,
    VTLDevices: List[VTLDeviceTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VTLDeviceTypeDef
  2. See ResponseMetadataTypeDef

DescribeFileSystemAssociationsOutputTypeDef#

# DescribeFileSystemAssociationsOutputTypeDef definition

class DescribeFileSystemAssociationsOutputTypeDef(TypedDict):
    FileSystemAssociationInfoList: List[FileSystemAssociationInfoTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileSystemAssociationInfoTypeDef
  2. See ResponseMetadataTypeDef