Skip to content

StorageGatewayClient

Index > StorageGateway > StorageGatewayClient

Auto-generated documentation for StorageGateway type annotations stubs module mypy-boto3-storagegateway.

StorageGatewayClient

Type annotations and code completion for boto3.client("storagegateway"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_storagegateway.client import StorageGatewayClient

def get_storagegateway_client() -> StorageGatewayClient:
    return Session().client("storagegateway")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("storagegateway").exceptions structure.

Usage example
client = boto3.client("storagegateway")

try:
    do_something(client)
except (
    client.ClientError,
    client.InternalServerError,
    client.InvalidGatewayRequestException,
    client.ServiceUnavailableError,
) as e:
    print(e)
Type checking example
from mypy_boto3_storagegateway.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

activate_gateway

Activates the gateway you previously deployed on your host.

Type annotations and code completion for boto3.client("storagegateway").activate_gateway method. boto3 documentation

Method definition
def activate_gateway(
    self,
    *,
    ActivationKey: str,
    GatewayName: str,
    GatewayTimezone: str,
    GatewayRegion: str,
    GatewayType: str = ...,
    TapeDriveType: str = ...,
    MediumChangerType: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> ActivateGatewayOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See ActivateGatewayOutputTypeDef
Usage example with kwargs
kwargs: ActivateGatewayInputRequestTypeDef = {  # (1)
    "ActivationKey": ...,
    "GatewayName": ...,
    "GatewayTimezone": ...,
    "GatewayRegion": ...,
}

parent.activate_gateway(**kwargs)
  1. See ActivateGatewayInputRequestTypeDef

add_cache

Configures one or more gateway local disks as cache for a gateway.

Type annotations and code completion for boto3.client("storagegateway").add_cache method. boto3 documentation

Method definition
def add_cache(
    self,
    *,
    GatewayARN: str,
    DiskIds: Sequence[str],
) -> AddCacheOutputTypeDef:  # (1)
    ...
  1. See AddCacheOutputTypeDef
Usage example with kwargs
kwargs: AddCacheInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "DiskIds": ...,
}

parent.add_cache(**kwargs)
  1. See AddCacheInputRequestTypeDef

add_tags_to_resource

Adds one or more tags to the specified resource.

Type annotations and code completion for boto3.client("storagegateway").add_tags_to_resource method. boto3 documentation

Method definition
def add_tags_to_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> AddTagsToResourceOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See AddTagsToResourceOutputTypeDef
Usage example with kwargs
kwargs: AddTagsToResourceInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.add_tags_to_resource(**kwargs)
  1. See AddTagsToResourceInputRequestTypeDef

add_upload_buffer

Configures one or more gateway local disks as upload buffer for a specified gateway.

Type annotations and code completion for boto3.client("storagegateway").add_upload_buffer method. boto3 documentation

Method definition
def add_upload_buffer(
    self,
    *,
    GatewayARN: str,
    DiskIds: Sequence[str],
) -> AddUploadBufferOutputTypeDef:  # (1)
    ...
  1. See AddUploadBufferOutputTypeDef
Usage example with kwargs
kwargs: AddUploadBufferInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "DiskIds": ...,
}

parent.add_upload_buffer(**kwargs)
  1. See AddUploadBufferInputRequestTypeDef

add_working_storage

Configures one or more gateway local disks as working storage for a gateway.

Type annotations and code completion for boto3.client("storagegateway").add_working_storage method. boto3 documentation

Method definition
def add_working_storage(
    self,
    *,
    GatewayARN: str,
    DiskIds: Sequence[str],
) -> AddWorkingStorageOutputTypeDef:  # (1)
    ...
  1. See AddWorkingStorageOutputTypeDef
Usage example with kwargs
kwargs: AddWorkingStorageInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "DiskIds": ...,
}

parent.add_working_storage(**kwargs)
  1. See AddWorkingStorageInputRequestTypeDef

assign_tape_pool

Assigns a tape to a tape pool for archiving.

Type annotations and code completion for boto3.client("storagegateway").assign_tape_pool method. boto3 documentation

Method definition
def assign_tape_pool(
    self,
    *,
    TapeARN: str,
    PoolId: str,
    BypassGovernanceRetention: bool = ...,
) -> AssignTapePoolOutputTypeDef:  # (1)
    ...
  1. See AssignTapePoolOutputTypeDef
Usage example with kwargs
kwargs: AssignTapePoolInputRequestTypeDef = {  # (1)
    "TapeARN": ...,
    "PoolId": ...,
}

parent.assign_tape_pool(**kwargs)
  1. See AssignTapePoolInputRequestTypeDef

associate_file_system

Associate an Amazon FSx file system with the FSx File Gateway.

Type annotations and code completion for boto3.client("storagegateway").associate_file_system method. boto3 documentation

Method definition
def associate_file_system(
    self,
    *,
    UserName: str,
    Password: str,
    ClientToken: str,
    GatewayARN: str,
    LocationARN: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    AuditDestinationARN: str = ...,
    CacheAttributes: CacheAttributesTypeDef = ...,  # (2)
    EndpointNetworkConfiguration: EndpointNetworkConfigurationTypeDef = ...,  # (3)
) -> AssociateFileSystemOutputTypeDef:  # (4)
    ...
  1. See TagTypeDef
  2. See CacheAttributesTypeDef
  3. See EndpointNetworkConfigurationTypeDef
  4. See AssociateFileSystemOutputTypeDef
Usage example with kwargs
kwargs: AssociateFileSystemInputRequestTypeDef = {  # (1)
    "UserName": ...,
    "Password": ...,
    "ClientToken": ...,
    "GatewayARN": ...,
    "LocationARN": ...,
}

parent.associate_file_system(**kwargs)
  1. See AssociateFileSystemInputRequestTypeDef

attach_volume

Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway.

Type annotations and code completion for boto3.client("storagegateway").attach_volume method. boto3 documentation

Method definition
def attach_volume(
    self,
    *,
    GatewayARN: str,
    VolumeARN: str,
    NetworkInterfaceId: str,
    TargetName: str = ...,
    DiskId: str = ...,
) -> AttachVolumeOutputTypeDef:  # (1)
    ...
  1. See AttachVolumeOutputTypeDef
Usage example with kwargs
kwargs: AttachVolumeInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "VolumeARN": ...,
    "NetworkInterfaceId": ...,
}

parent.attach_volume(**kwargs)
  1. See AttachVolumeInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("storagegateway").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_archival

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.

Type annotations and code completion for boto3.client("storagegateway").cancel_archival method. boto3 documentation

Method definition
def cancel_archival(
    self,
    *,
    GatewayARN: str,
    TapeARN: str,
) -> CancelArchivalOutputTypeDef:  # (1)
    ...
  1. See CancelArchivalOutputTypeDef
Usage example with kwargs
kwargs: CancelArchivalInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeARN": ...,
}

parent.cancel_archival(**kwargs)
  1. See CancelArchivalInputRequestTypeDef

cancel_retrieval

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.

Type annotations and code completion for boto3.client("storagegateway").cancel_retrieval method. boto3 documentation

Method definition
def cancel_retrieval(
    self,
    *,
    GatewayARN: str,
    TapeARN: str,
) -> CancelRetrievalOutputTypeDef:  # (1)
    ...
  1. See CancelRetrievalOutputTypeDef
Usage example with kwargs
kwargs: CancelRetrievalInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeARN": ...,
}

parent.cancel_retrieval(**kwargs)
  1. See CancelRetrievalInputRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("storagegateway").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_cached_iscsi_volume

Creates a cached volume on a specified cached volume gateway.

Type annotations and code completion for boto3.client("storagegateway").create_cached_iscsi_volume method. boto3 documentation

Method definition
def create_cached_iscsi_volume(
    self,
    *,
    GatewayARN: str,
    VolumeSizeInBytes: int,
    TargetName: str,
    NetworkInterfaceId: str,
    ClientToken: str,
    SnapshotId: str = ...,
    SourceVolumeARN: str = ...,
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateCachediSCSIVolumeOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateCachediSCSIVolumeOutputTypeDef
Usage example with kwargs
kwargs: CreateCachediSCSIVolumeInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "VolumeSizeInBytes": ...,
    "TargetName": ...,
    "NetworkInterfaceId": ...,
    "ClientToken": ...,
}

parent.create_cached_iscsi_volume(**kwargs)
  1. See CreateCachediSCSIVolumeInputRequestTypeDef

create_nfs_file_share

Creates a Network File System (NFS) file share on an existing S3 File Gateway.

Type annotations and code completion for boto3.client("storagegateway").create_nfs_file_share method. boto3 documentation

Method definition
def create_nfs_file_share(
    self,
    *,
    ClientToken: str,
    GatewayARN: str,
    Role: str,
    LocationARN: str,
    NFSFileShareDefaults: NFSFileShareDefaultsTypeDef = ...,  # (1)
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    DefaultStorageClass: str = ...,
    ObjectACL: ObjectACLType = ...,  # (2)
    ClientList: Sequence[str] = ...,
    Squash: str = ...,
    ReadOnly: bool = ...,
    GuessMIMETypeEnabled: bool = ...,
    RequesterPays: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    FileShareName: str = ...,
    CacheAttributes: CacheAttributesTypeDef = ...,  # (4)
    NotificationPolicy: str = ...,
    VPCEndpointDNSName: str = ...,
    BucketRegion: str = ...,
    AuditDestinationARN: str = ...,
) -> CreateNFSFileShareOutputTypeDef:  # (5)
    ...
  1. See NFSFileShareDefaultsTypeDef
  2. See ObjectACLType
  3. See TagTypeDef
  4. See CacheAttributesTypeDef
  5. See CreateNFSFileShareOutputTypeDef
Usage example with kwargs
kwargs: CreateNFSFileShareInputRequestTypeDef = {  # (1)
    "ClientToken": ...,
    "GatewayARN": ...,
    "Role": ...,
    "LocationARN": ...,
}

parent.create_nfs_file_share(**kwargs)
  1. See CreateNFSFileShareInputRequestTypeDef

create_smb_file_share

Creates a Server Message Block (SMB) file share on an existing S3 File Gateway.

Type annotations and code completion for boto3.client("storagegateway").create_smb_file_share method. boto3 documentation

Method definition
def create_smb_file_share(
    self,
    *,
    ClientToken: str,
    GatewayARN: str,
    Role: str,
    LocationARN: str,
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    DefaultStorageClass: str = ...,
    ObjectACL: ObjectACLType = ...,  # (1)
    ReadOnly: bool = ...,
    GuessMIMETypeEnabled: bool = ...,
    RequesterPays: bool = ...,
    SMBACLEnabled: bool = ...,
    AccessBasedEnumeration: bool = ...,
    AdminUserList: Sequence[str] = ...,
    ValidUserList: Sequence[str] = ...,
    InvalidUserList: Sequence[str] = ...,
    AuditDestinationARN: str = ...,
    Authentication: str = ...,
    CaseSensitivity: CaseSensitivityType = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    FileShareName: str = ...,
    CacheAttributes: CacheAttributesTypeDef = ...,  # (4)
    NotificationPolicy: str = ...,
    VPCEndpointDNSName: str = ...,
    BucketRegion: str = ...,
    OplocksEnabled: bool = ...,
) -> CreateSMBFileShareOutputTypeDef:  # (5)
    ...
  1. See ObjectACLType
  2. See CaseSensitivityType
  3. See TagTypeDef
  4. See CacheAttributesTypeDef
  5. See CreateSMBFileShareOutputTypeDef
Usage example with kwargs
kwargs: CreateSMBFileShareInputRequestTypeDef = {  # (1)
    "ClientToken": ...,
    "GatewayARN": ...,
    "Role": ...,
    "LocationARN": ...,
}

parent.create_smb_file_share(**kwargs)
  1. See CreateSMBFileShareInputRequestTypeDef

create_snapshot

Initiates a snapshot of a volume.

Type annotations and code completion for boto3.client("storagegateway").create_snapshot method. boto3 documentation

Method definition
def create_snapshot(
    self,
    *,
    VolumeARN: str,
    SnapshotDescription: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateSnapshotOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateSnapshotOutputTypeDef
Usage example with kwargs
kwargs: CreateSnapshotInputRequestTypeDef = {  # (1)
    "VolumeARN": ...,
    "SnapshotDescription": ...,
}

parent.create_snapshot(**kwargs)
  1. See CreateSnapshotInputRequestTypeDef

create_snapshot_from_volume_recovery_point

Initiates a snapshot of a gateway from a volume recovery point.

Type annotations and code completion for boto3.client("storagegateway").create_snapshot_from_volume_recovery_point method. boto3 documentation

Method definition
def create_snapshot_from_volume_recovery_point(
    self,
    *,
    VolumeARN: str,
    SnapshotDescription: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateSnapshotFromVolumeRecoveryPointOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateSnapshotFromVolumeRecoveryPointOutputTypeDef
Usage example with kwargs
kwargs: CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef = {  # (1)
    "VolumeARN": ...,
    "SnapshotDescription": ...,
}

parent.create_snapshot_from_volume_recovery_point(**kwargs)
  1. See CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef

create_stored_iscsi_volume

Creates a volume on a specified gateway.

Type annotations and code completion for boto3.client("storagegateway").create_stored_iscsi_volume method. boto3 documentation

Method definition
def create_stored_iscsi_volume(
    self,
    *,
    GatewayARN: str,
    DiskId: str,
    PreserveExistingData: bool,
    TargetName: str,
    NetworkInterfaceId: str,
    SnapshotId: str = ...,
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateStorediSCSIVolumeOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateStorediSCSIVolumeOutputTypeDef
Usage example with kwargs
kwargs: CreateStorediSCSIVolumeInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "DiskId": ...,
    "PreserveExistingData": ...,
    "TargetName": ...,
    "NetworkInterfaceId": ...,
}

parent.create_stored_iscsi_volume(**kwargs)
  1. See CreateStorediSCSIVolumeInputRequestTypeDef

create_tape_pool

Creates a new custom tape pool.

Type annotations and code completion for boto3.client("storagegateway").create_tape_pool method. boto3 documentation

Method definition
def create_tape_pool(
    self,
    *,
    PoolName: str,
    StorageClass: TapeStorageClassType,  # (1)
    RetentionLockType: RetentionLockTypeType = ...,  # (2)
    RetentionLockTimeInDays: int = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateTapePoolOutputTypeDef:  # (4)
    ...
  1. See TapeStorageClassType
  2. See RetentionLockTypeType
  3. See TagTypeDef
  4. See CreateTapePoolOutputTypeDef
Usage example with kwargs
kwargs: CreateTapePoolInputRequestTypeDef = {  # (1)
    "PoolName": ...,
    "StorageClass": ...,
}

parent.create_tape_pool(**kwargs)
  1. See CreateTapePoolInputRequestTypeDef

create_tape_with_barcode

Creates a virtual tape by using your own barcode.

Type annotations and code completion for boto3.client("storagegateway").create_tape_with_barcode method. boto3 documentation

Method definition
def create_tape_with_barcode(
    self,
    *,
    GatewayARN: str,
    TapeSizeInBytes: int,
    TapeBarcode: str,
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    PoolId: str = ...,
    Worm: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateTapeWithBarcodeOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateTapeWithBarcodeOutputTypeDef
Usage example with kwargs
kwargs: CreateTapeWithBarcodeInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeSizeInBytes": ...,
    "TapeBarcode": ...,
}

parent.create_tape_with_barcode(**kwargs)
  1. See CreateTapeWithBarcodeInputRequestTypeDef

create_tapes

Creates one or more virtual tapes.

Type annotations and code completion for boto3.client("storagegateway").create_tapes method. boto3 documentation

Method definition
def create_tapes(
    self,
    *,
    GatewayARN: str,
    TapeSizeInBytes: int,
    ClientToken: str,
    NumTapesToCreate: int,
    TapeBarcodePrefix: str,
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    PoolId: str = ...,
    Worm: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateTapesOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateTapesOutputTypeDef
Usage example with kwargs
kwargs: CreateTapesInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeSizeInBytes": ...,
    "ClientToken": ...,
    "NumTapesToCreate": ...,
    "TapeBarcodePrefix": ...,
}

parent.create_tapes(**kwargs)
  1. See CreateTapesInputRequestTypeDef

delete_automatic_tape_creation_policy

Deletes the automatic tape creation policy of a gateway.

Type annotations and code completion for boto3.client("storagegateway").delete_automatic_tape_creation_policy method. boto3 documentation

Method definition
def delete_automatic_tape_creation_policy(
    self,
    *,
    GatewayARN: str,
) -> DeleteAutomaticTapeCreationPolicyOutputTypeDef:  # (1)
    ...
  1. See DeleteAutomaticTapeCreationPolicyOutputTypeDef
Usage example with kwargs
kwargs: DeleteAutomaticTapeCreationPolicyInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.delete_automatic_tape_creation_policy(**kwargs)
  1. See DeleteAutomaticTapeCreationPolicyInputRequestTypeDef

delete_bandwidth_rate_limit

Deletes the bandwidth rate limits of a gateway.

Type annotations and code completion for boto3.client("storagegateway").delete_bandwidth_rate_limit method. boto3 documentation

Method definition
def delete_bandwidth_rate_limit(
    self,
    *,
    GatewayARN: str,
    BandwidthType: str,
) -> DeleteBandwidthRateLimitOutputTypeDef:  # (1)
    ...
  1. See DeleteBandwidthRateLimitOutputTypeDef
Usage example with kwargs
kwargs: DeleteBandwidthRateLimitInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "BandwidthType": ...,
}

parent.delete_bandwidth_rate_limit(**kwargs)
  1. See DeleteBandwidthRateLimitInputRequestTypeDef

delete_chap_credentials

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

Type annotations and code completion for boto3.client("storagegateway").delete_chap_credentials method. boto3 documentation

Method definition
def delete_chap_credentials(
    self,
    *,
    TargetARN: str,
    InitiatorName: str,
) -> DeleteChapCredentialsOutputTypeDef:  # (1)
    ...
  1. See DeleteChapCredentialsOutputTypeDef
Usage example with kwargs
kwargs: DeleteChapCredentialsInputRequestTypeDef = {  # (1)
    "TargetARN": ...,
    "InitiatorName": ...,
}

parent.delete_chap_credentials(**kwargs)
  1. See DeleteChapCredentialsInputRequestTypeDef

delete_file_share

Deletes a file share from an S3 File Gateway.

Type annotations and code completion for boto3.client("storagegateway").delete_file_share method. boto3 documentation

Method definition
def delete_file_share(
    self,
    *,
    FileShareARN: str,
    ForceDelete: bool = ...,
) -> DeleteFileShareOutputTypeDef:  # (1)
    ...
  1. See DeleteFileShareOutputTypeDef
Usage example with kwargs
kwargs: DeleteFileShareInputRequestTypeDef = {  # (1)
    "FileShareARN": ...,
}

parent.delete_file_share(**kwargs)
  1. See DeleteFileShareInputRequestTypeDef

delete_gateway

Deletes a gateway.

Type annotations and code completion for boto3.client("storagegateway").delete_gateway method. boto3 documentation

Method definition
def delete_gateway(
    self,
    *,
    GatewayARN: str,
) -> DeleteGatewayOutputTypeDef:  # (1)
    ...
  1. See DeleteGatewayOutputTypeDef
Usage example with kwargs
kwargs: DeleteGatewayInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.delete_gateway(**kwargs)
  1. See DeleteGatewayInputRequestTypeDef

delete_snapshot_schedule

Deletes a snapshot of a volume.

Type annotations and code completion for boto3.client("storagegateway").delete_snapshot_schedule method. boto3 documentation

Method definition
def delete_snapshot_schedule(
    self,
    *,
    VolumeARN: str,
) -> DeleteSnapshotScheduleOutputTypeDef:  # (1)
    ...
  1. See DeleteSnapshotScheduleOutputTypeDef
Usage example with kwargs
kwargs: DeleteSnapshotScheduleInputRequestTypeDef = {  # (1)
    "VolumeARN": ...,
}

parent.delete_snapshot_schedule(**kwargs)
  1. See DeleteSnapshotScheduleInputRequestTypeDef

delete_tape

Deletes the specified virtual tape.

Type annotations and code completion for boto3.client("storagegateway").delete_tape method. boto3 documentation

Method definition
def delete_tape(
    self,
    *,
    GatewayARN: str,
    TapeARN: str,
    BypassGovernanceRetention: bool = ...,
) -> DeleteTapeOutputTypeDef:  # (1)
    ...
  1. See DeleteTapeOutputTypeDef
Usage example with kwargs
kwargs: DeleteTapeInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeARN": ...,
}

parent.delete_tape(**kwargs)
  1. See DeleteTapeInputRequestTypeDef

delete_tape_archive

Deletes the specified virtual tape from the virtual tape shelf (VTS).

Type annotations and code completion for boto3.client("storagegateway").delete_tape_archive method. boto3 documentation

Method definition
def delete_tape_archive(
    self,
    *,
    TapeARN: str,
    BypassGovernanceRetention: bool = ...,
) -> DeleteTapeArchiveOutputTypeDef:  # (1)
    ...
  1. See DeleteTapeArchiveOutputTypeDef
Usage example with kwargs
kwargs: DeleteTapeArchiveInputRequestTypeDef = {  # (1)
    "TapeARN": ...,
}

parent.delete_tape_archive(**kwargs)
  1. See DeleteTapeArchiveInputRequestTypeDef

delete_tape_pool

Delete a custom tape pool.

Type annotations and code completion for boto3.client("storagegateway").delete_tape_pool method. boto3 documentation

Method definition
def delete_tape_pool(
    self,
    *,
    PoolARN: str,
) -> DeleteTapePoolOutputTypeDef:  # (1)
    ...
  1. See DeleteTapePoolOutputTypeDef
Usage example with kwargs
kwargs: DeleteTapePoolInputRequestTypeDef = {  # (1)
    "PoolARN": ...,
}

parent.delete_tape_pool(**kwargs)
  1. See DeleteTapePoolInputRequestTypeDef

delete_volume

Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.

Type annotations and code completion for boto3.client("storagegateway").delete_volume method. boto3 documentation

Method definition
def delete_volume(
    self,
    *,
    VolumeARN: str,
) -> DeleteVolumeOutputTypeDef:  # (1)
    ...
  1. See DeleteVolumeOutputTypeDef
Usage example with kwargs
kwargs: DeleteVolumeInputRequestTypeDef = {  # (1)
    "VolumeARN": ...,
}

parent.delete_volume(**kwargs)
  1. See DeleteVolumeInputRequestTypeDef

describe_availability_monitor_test

Returns information about the most recent high availability monitoring test that was performed on the host in a cluster.

Type annotations and code completion for boto3.client("storagegateway").describe_availability_monitor_test method. boto3 documentation

Method definition
def describe_availability_monitor_test(
    self,
    *,
    GatewayARN: str,
) -> DescribeAvailabilityMonitorTestOutputTypeDef:  # (1)
    ...
  1. See DescribeAvailabilityMonitorTestOutputTypeDef
Usage example with kwargs
kwargs: DescribeAvailabilityMonitorTestInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_availability_monitor_test(**kwargs)
  1. See DescribeAvailabilityMonitorTestInputRequestTypeDef

describe_bandwidth_rate_limit

Returns the bandwidth rate limits of a gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_bandwidth_rate_limit method. boto3 documentation

Method definition
def describe_bandwidth_rate_limit(
    self,
    *,
    GatewayARN: str,
) -> DescribeBandwidthRateLimitOutputTypeDef:  # (1)
    ...
  1. See DescribeBandwidthRateLimitOutputTypeDef
Usage example with kwargs
kwargs: DescribeBandwidthRateLimitInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_bandwidth_rate_limit(**kwargs)
  1. See DescribeBandwidthRateLimitInputRequestTypeDef

describe_bandwidth_rate_limit_schedule

Returns information about the bandwidth rate limit schedule of a gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_bandwidth_rate_limit_schedule method. boto3 documentation

Method definition
def describe_bandwidth_rate_limit_schedule(
    self,
    *,
    GatewayARN: str,
) -> DescribeBandwidthRateLimitScheduleOutputTypeDef:  # (1)
    ...
  1. See DescribeBandwidthRateLimitScheduleOutputTypeDef
Usage example with kwargs
kwargs: DescribeBandwidthRateLimitScheduleInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_bandwidth_rate_limit_schedule(**kwargs)
  1. See DescribeBandwidthRateLimitScheduleInputRequestTypeDef

describe_cache

Returns information about the cache of a gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_cache method. boto3 documentation

Method definition
def describe_cache(
    self,
    *,
    GatewayARN: str,
) -> DescribeCacheOutputTypeDef:  # (1)
    ...
  1. See DescribeCacheOutputTypeDef
Usage example with kwargs
kwargs: DescribeCacheInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_cache(**kwargs)
  1. See DescribeCacheInputRequestTypeDef

describe_cached_iscsi_volumes

Returns a description of the gateway volumes specified in the request.

Type annotations and code completion for boto3.client("storagegateway").describe_cached_iscsi_volumes method. boto3 documentation

Method definition
def describe_cached_iscsi_volumes(
    self,
    *,
    VolumeARNs: Sequence[str],
) -> DescribeCachediSCSIVolumesOutputTypeDef:  # (1)
    ...
  1. See DescribeCachediSCSIVolumesOutputTypeDef
Usage example with kwargs
kwargs: DescribeCachediSCSIVolumesInputRequestTypeDef = {  # (1)
    "VolumeARNs": ...,
}

parent.describe_cached_iscsi_volumes(**kwargs)
  1. See DescribeCachediSCSIVolumesInputRequestTypeDef

describe_chap_credentials

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target- initiator pair.

Type annotations and code completion for boto3.client("storagegateway").describe_chap_credentials method. boto3 documentation

Method definition
def describe_chap_credentials(
    self,
    *,
    TargetARN: str,
) -> DescribeChapCredentialsOutputTypeDef:  # (1)
    ...
  1. See DescribeChapCredentialsOutputTypeDef
Usage example with kwargs
kwargs: DescribeChapCredentialsInputRequestTypeDef = {  # (1)
    "TargetARN": ...,
}

parent.describe_chap_credentials(**kwargs)
  1. See DescribeChapCredentialsInputRequestTypeDef

describe_file_system_associations

Gets the file system association information.

Type annotations and code completion for boto3.client("storagegateway").describe_file_system_associations method. boto3 documentation

Method definition
def describe_file_system_associations(
    self,
    *,
    FileSystemAssociationARNList: Sequence[str],
) -> DescribeFileSystemAssociationsOutputTypeDef:  # (1)
    ...
  1. See DescribeFileSystemAssociationsOutputTypeDef
Usage example with kwargs
kwargs: DescribeFileSystemAssociationsInputRequestTypeDef = {  # (1)
    "FileSystemAssociationARNList": ...,
}

parent.describe_file_system_associations(**kwargs)
  1. See DescribeFileSystemAssociationsInputRequestTypeDef

describe_gateway_information

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).

Type annotations and code completion for boto3.client("storagegateway").describe_gateway_information method. boto3 documentation

Method definition
def describe_gateway_information(
    self,
    *,
    GatewayARN: str,
) -> DescribeGatewayInformationOutputTypeDef:  # (1)
    ...
  1. See DescribeGatewayInformationOutputTypeDef
Usage example with kwargs
kwargs: DescribeGatewayInformationInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_gateway_information(**kwargs)
  1. See DescribeGatewayInformationInputRequestTypeDef

describe_maintenance_start_time

Returns your gateway's weekly maintenance start time including the day and time of the week.

Type annotations and code completion for boto3.client("storagegateway").describe_maintenance_start_time method. boto3 documentation

Method definition
def describe_maintenance_start_time(
    self,
    *,
    GatewayARN: str,
) -> DescribeMaintenanceStartTimeOutputTypeDef:  # (1)
    ...
  1. See DescribeMaintenanceStartTimeOutputTypeDef
Usage example with kwargs
kwargs: DescribeMaintenanceStartTimeInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_maintenance_start_time(**kwargs)
  1. See DescribeMaintenanceStartTimeInputRequestTypeDef

describe_nfs_file_shares

Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_nfs_file_shares method. boto3 documentation

Method definition
def describe_nfs_file_shares(
    self,
    *,
    FileShareARNList: Sequence[str],
) -> DescribeNFSFileSharesOutputTypeDef:  # (1)
    ...
  1. See DescribeNFSFileSharesOutputTypeDef
Usage example with kwargs
kwargs: DescribeNFSFileSharesInputRequestTypeDef = {  # (1)
    "FileShareARNList": ...,
}

parent.describe_nfs_file_shares(**kwargs)
  1. See DescribeNFSFileSharesInputRequestTypeDef

describe_smb_file_shares

Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_smb_file_shares method. boto3 documentation

Method definition
def describe_smb_file_shares(
    self,
    *,
    FileShareARNList: Sequence[str],
) -> DescribeSMBFileSharesOutputTypeDef:  # (1)
    ...
  1. See DescribeSMBFileSharesOutputTypeDef
Usage example with kwargs
kwargs: DescribeSMBFileSharesInputRequestTypeDef = {  # (1)
    "FileShareARNList": ...,
}

parent.describe_smb_file_shares(**kwargs)
  1. See DescribeSMBFileSharesInputRequestTypeDef

describe_smb_settings

Gets a description of a Server Message Block (SMB) file share settings from a file gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_smb_settings method. boto3 documentation

Method definition
def describe_smb_settings(
    self,
    *,
    GatewayARN: str,
) -> DescribeSMBSettingsOutputTypeDef:  # (1)
    ...
  1. See DescribeSMBSettingsOutputTypeDef
Usage example with kwargs
kwargs: DescribeSMBSettingsInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_smb_settings(**kwargs)
  1. See DescribeSMBSettingsInputRequestTypeDef

describe_snapshot_schedule

Describes the snapshot schedule for the specified gateway volume.

Type annotations and code completion for boto3.client("storagegateway").describe_snapshot_schedule method. boto3 documentation

Method definition
def describe_snapshot_schedule(
    self,
    *,
    VolumeARN: str,
) -> DescribeSnapshotScheduleOutputTypeDef:  # (1)
    ...
  1. See DescribeSnapshotScheduleOutputTypeDef
Usage example with kwargs
kwargs: DescribeSnapshotScheduleInputRequestTypeDef = {  # (1)
    "VolumeARN": ...,
}

parent.describe_snapshot_schedule(**kwargs)
  1. See DescribeSnapshotScheduleInputRequestTypeDef

describe_stored_iscsi_volumes

Returns the description of the gateway volumes specified in the request.

Type annotations and code completion for boto3.client("storagegateway").describe_stored_iscsi_volumes method. boto3 documentation

Method definition
def describe_stored_iscsi_volumes(
    self,
    *,
    VolumeARNs: Sequence[str],
) -> DescribeStorediSCSIVolumesOutputTypeDef:  # (1)
    ...
  1. See DescribeStorediSCSIVolumesOutputTypeDef
Usage example with kwargs
kwargs: DescribeStorediSCSIVolumesInputRequestTypeDef = {  # (1)
    "VolumeARNs": ...,
}

parent.describe_stored_iscsi_volumes(**kwargs)
  1. See DescribeStorediSCSIVolumesInputRequestTypeDef

describe_tape_archives

Returns a description of specified virtual tapes in the virtual tape shelf (VTS).

Type annotations and code completion for boto3.client("storagegateway").describe_tape_archives method. boto3 documentation

Method definition
def describe_tape_archives(
    self,
    *,
    TapeARNs: Sequence[str] = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeTapeArchivesOutputTypeDef:  # (1)
    ...
  1. See DescribeTapeArchivesOutputTypeDef
Usage example with kwargs
kwargs: DescribeTapeArchivesInputRequestTypeDef = {  # (1)
    "TapeARNs": ...,
}

parent.describe_tape_archives(**kwargs)
  1. See DescribeTapeArchivesInputRequestTypeDef

describe_tape_recovery_points

Returns a list of virtual tape recovery points that are available for the specified tape gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_tape_recovery_points method. boto3 documentation

Method definition
def describe_tape_recovery_points(
    self,
    *,
    GatewayARN: str,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeTapeRecoveryPointsOutputTypeDef:  # (1)
    ...
  1. See DescribeTapeRecoveryPointsOutputTypeDef
Usage example with kwargs
kwargs: DescribeTapeRecoveryPointsInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_tape_recovery_points(**kwargs)
  1. See DescribeTapeRecoveryPointsInputRequestTypeDef

describe_tapes

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.

Type annotations and code completion for boto3.client("storagegateway").describe_tapes method. boto3 documentation

Method definition
def describe_tapes(
    self,
    *,
    GatewayARN: str,
    TapeARNs: Sequence[str] = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeTapesOutputTypeDef:  # (1)
    ...
  1. See DescribeTapesOutputTypeDef
Usage example with kwargs
kwargs: DescribeTapesInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_tapes(**kwargs)
  1. See DescribeTapesInputRequestTypeDef

describe_upload_buffer

Returns information about the upload buffer of a gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_upload_buffer method. boto3 documentation

Method definition
def describe_upload_buffer(
    self,
    *,
    GatewayARN: str,
) -> DescribeUploadBufferOutputTypeDef:  # (1)
    ...
  1. See DescribeUploadBufferOutputTypeDef
Usage example with kwargs
kwargs: DescribeUploadBufferInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_upload_buffer(**kwargs)
  1. See DescribeUploadBufferInputRequestTypeDef

describe_vtl_devices

Returns a description of virtual tape library (VTL) devices for the specified tape gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_vtl_devices method. boto3 documentation

Method definition
def describe_vtl_devices(
    self,
    *,
    GatewayARN: str,
    VTLDeviceARNs: Sequence[str] = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeVTLDevicesOutputTypeDef:  # (1)
    ...
  1. See DescribeVTLDevicesOutputTypeDef
Usage example with kwargs
kwargs: DescribeVTLDevicesInputRequestTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_vtl_devices(**kwargs)
  1. See DescribeVTLDevicesInputRequestTypeDef

describe_working_storage

Returns information about the working storage of a gateway.

Type annotations and code completion for boto3.client("storagegateway").describe_working_storage method.