StorageGatewayClient

Index > StorageGateway > StorageGatewayClient

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

StorageGatewayClient

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

# StorageGatewayClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("storagegateway")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalServerError,
    client.exceptions.InvalidGatewayRequestException,
    client.exceptions.ServiceUnavailableError,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_storagegateway.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

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

# activate_gateway method usage example with argument unpacking

kwargs: ActivateGatewayInputTypeDef = {  # (1)
    "ActivationKey": ...,
    "GatewayName": ...,
    "GatewayTimezone": ...,
    "GatewayRegion": ...,
}

parent.activate_gateway(**kwargs)

1. See ActivateGatewayInputTypeDef

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

# add_cache method definition

def add_cache(
    self,
    *,
    GatewayARN: str,
    DiskIds: Sequence[str],
) -> AddCacheOutputTypeDef:  # (1)
    ...

1. See AddCacheOutputTypeDef

# add_cache method usage example with argument unpacking

kwargs: AddCacheInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "DiskIds": ...,
}

parent.add_cache(**kwargs)

1. See AddCacheInputTypeDef

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

# add_tags_to_resource method definition

def add_tags_to_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> AddTagsToResourceOutputTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See AddTagsToResourceOutputTypeDef

# add_tags_to_resource method usage example with argument unpacking

kwargs: AddTagsToResourceInputTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.add_tags_to_resource(**kwargs)

1. See AddTagsToResourceInputTypeDef

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

# add_upload_buffer method definition

def add_upload_buffer(
    self,
    *,
    GatewayARN: str,
    DiskIds: Sequence[str],
) -> AddUploadBufferOutputTypeDef:  # (1)
    ...

1. See AddUploadBufferOutputTypeDef

# add_upload_buffer method usage example with argument unpacking

kwargs: AddUploadBufferInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "DiskIds": ...,
}

parent.add_upload_buffer(**kwargs)

1. See AddUploadBufferInputTypeDef

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

# add_working_storage method definition

def add_working_storage(
    self,
    *,
    GatewayARN: str,
    DiskIds: Sequence[str],
) -> AddWorkingStorageOutputTypeDef:  # (1)
    ...

1. See AddWorkingStorageOutputTypeDef

# add_working_storage method usage example with argument unpacking

kwargs: AddWorkingStorageInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "DiskIds": ...,
}

parent.add_working_storage(**kwargs)

1. See AddWorkingStorageInputTypeDef

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

# assign_tape_pool method definition

def assign_tape_pool(
    self,
    *,
    TapeARN: str,
    PoolId: str,
    BypassGovernanceRetention: bool = ...,
) -> AssignTapePoolOutputTypeDef:  # (1)
    ...

1. See AssignTapePoolOutputTypeDef

# assign_tape_pool method usage example with argument unpacking

kwargs: AssignTapePoolInputTypeDef = {  # (1)
    "TapeARN": ...,
    "PoolId": ...,
}

parent.assign_tape_pool(**kwargs)

1. See AssignTapePoolInputTypeDef

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

# associate_file_system 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: EndpointNetworkConfigurationUnionTypeDef = ...,  # (3)
) -> AssociateFileSystemOutputTypeDef:  # (4)
    ...

1. See TagTypeDef
2. See CacheAttributesTypeDef
3. See EndpointNetworkConfigurationTypeDef EndpointNetworkConfigurationOutputTypeDef
4. See AssociateFileSystemOutputTypeDef

# associate_file_system method usage example with argument unpacking

kwargs: AssociateFileSystemInputTypeDef = {  # (1)
    "UserName": ...,
    "Password": ...,
    "ClientToken": ...,
    "GatewayARN": ...,
    "LocationARN": ...,
}

parent.associate_file_system(**kwargs)

1. See AssociateFileSystemInputTypeDef

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

# attach_volume method definition

def attach_volume(
    self,
    *,
    GatewayARN: str,
    VolumeARN: str,
    NetworkInterfaceId: str,
    TargetName: str = ...,
    DiskId: str = ...,
) -> AttachVolumeOutputTypeDef:  # (1)
    ...

1. See AttachVolumeOutputTypeDef

# attach_volume method usage example with argument unpacking

kwargs: AttachVolumeInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "VolumeARN": ...,
    "NetworkInterfaceId": ...,
}

parent.attach_volume(**kwargs)

1. See AttachVolumeInputTypeDef

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

# cancel_archival method definition

def cancel_archival(
    self,
    *,
    GatewayARN: str,
    TapeARN: str,
) -> CancelArchivalOutputTypeDef:  # (1)
    ...

1. See CancelArchivalOutputTypeDef

# cancel_archival method usage example with argument unpacking

kwargs: CancelArchivalInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeARN": ...,
}

parent.cancel_archival(**kwargs)

1. See CancelArchivalInputTypeDef

cancel_cache_report

Cancels generation of a specified cache report.

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

# cancel_cache_report method definition

def cancel_cache_report(
    self,
    *,
    CacheReportARN: str,
) -> CancelCacheReportOutputTypeDef:  # (1)
    ...

1. See CancelCacheReportOutputTypeDef

# cancel_cache_report method usage example with argument unpacking

kwargs: CancelCacheReportInputTypeDef = {  # (1)
    "CacheReportARN": ...,
}

parent.cancel_cache_report(**kwargs)

1. See CancelCacheReportInputTypeDef

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

# cancel_retrieval method definition

def cancel_retrieval(
    self,
    *,
    GatewayARN: str,
    TapeARN: str,
) -> CancelRetrievalOutputTypeDef:  # (1)
    ...

1. See CancelRetrievalOutputTypeDef

# cancel_retrieval method usage example with argument unpacking

kwargs: CancelRetrievalInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeARN": ...,
}

parent.cancel_retrieval(**kwargs)

1. See CancelRetrievalInputTypeDef

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

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

# create_cached_iscsi_volume method usage example with argument unpacking

kwargs: CreateCachediSCSIVolumeInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "VolumeSizeInBytes": ...,
    "TargetName": ...,
    "NetworkInterfaceId": ...,
    "ClientToken": ...,
}

parent.create_cached_iscsi_volume(**kwargs)

1. See CreateCachediSCSIVolumeInputTypeDef

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

# create_nfs_file_share method definition

def create_nfs_file_share(
    self,
    *,
    ClientToken: str,
    GatewayARN: str,
    Role: str,
    LocationARN: str,
    NFSFileShareDefaults: NFSFileShareDefaultsTypeDef = ...,  # (1)
    EncryptionType: EncryptionTypeType = ...,  # (2)
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    DefaultStorageClass: str = ...,
    ObjectACL: ObjectACLType = ...,  # (3)
    ClientList: Sequence[str] = ...,
    Squash: str = ...,
    ReadOnly: bool = ...,
    GuessMIMETypeEnabled: bool = ...,
    RequesterPays: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    FileShareName: str = ...,
    CacheAttributes: CacheAttributesTypeDef = ...,  # (5)
    NotificationPolicy: str = ...,
    VPCEndpointDNSName: str = ...,
    BucketRegion: str = ...,
    AuditDestinationARN: str = ...,
) -> CreateNFSFileShareOutputTypeDef:  # (6)
    ...

1. See NFSFileShareDefaultsTypeDef
2. See EncryptionTypeType
3. See ObjectACLType
4. See TagTypeDef
5. See CacheAttributesTypeDef
6. See CreateNFSFileShareOutputTypeDef

# create_nfs_file_share method usage example with argument unpacking

kwargs: CreateNFSFileShareInputTypeDef = {  # (1)
    "ClientToken": ...,
    "GatewayARN": ...,
    "Role": ...,
    "LocationARN": ...,
}

parent.create_nfs_file_share(**kwargs)

1. See CreateNFSFileShareInputTypeDef

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

# create_smb_file_share method definition

def create_smb_file_share(
    self,
    *,
    ClientToken: str,
    GatewayARN: str,
    Role: str,
    LocationARN: str,
    EncryptionType: EncryptionTypeType = ...,  # (1)
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    DefaultStorageClass: str = ...,
    ObjectACL: ObjectACLType = ...,  # (2)
    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 = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    FileShareName: str = ...,
    CacheAttributes: CacheAttributesTypeDef = ...,  # (5)
    NotificationPolicy: str = ...,
    VPCEndpointDNSName: str = ...,
    BucketRegion: str = ...,
    OplocksEnabled: bool = ...,
) -> CreateSMBFileShareOutputTypeDef:  # (6)
    ...

1. See EncryptionTypeType
2. See ObjectACLType
3. See CaseSensitivityType
4. See TagTypeDef
5. See CacheAttributesTypeDef
6. See CreateSMBFileShareOutputTypeDef

# create_smb_file_share method usage example with argument unpacking

kwargs: CreateSMBFileShareInputTypeDef = {  # (1)
    "ClientToken": ...,
    "GatewayARN": ...,
    "Role": ...,
    "LocationARN": ...,
}

parent.create_smb_file_share(**kwargs)

1. See CreateSMBFileShareInputTypeDef

create_snapshot

Initiates a snapshot of a volume.

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

# create_snapshot method definition

def create_snapshot(
    self,
    *,
    VolumeARN: str,
    SnapshotDescription: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateSnapshotOutputTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateSnapshotOutputTypeDef

# create_snapshot method usage example with argument unpacking

kwargs: CreateSnapshotInputTypeDef = {  # (1)
    "VolumeARN": ...,
    "SnapshotDescription": ...,
}

parent.create_snapshot(**kwargs)

1. See CreateSnapshotInputTypeDef

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

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

# create_snapshot_from_volume_recovery_point method usage example with argument unpacking

kwargs: CreateSnapshotFromVolumeRecoveryPointInputTypeDef = {  # (1)
    "VolumeARN": ...,
    "SnapshotDescription": ...,
}

parent.create_snapshot_from_volume_recovery_point(**kwargs)

1. See CreateSnapshotFromVolumeRecoveryPointInputTypeDef

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

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

# create_stored_iscsi_volume method usage example with argument unpacking

kwargs: CreateStorediSCSIVolumeInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "DiskId": ...,
    "PreserveExistingData": ...,
    "TargetName": ...,
    "NetworkInterfaceId": ...,
}

parent.create_stored_iscsi_volume(**kwargs)

1. See CreateStorediSCSIVolumeInputTypeDef

create_tape_pool

Creates a new custom tape pool.

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

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

# create_tape_pool method usage example with argument unpacking

kwargs: CreateTapePoolInputTypeDef = {  # (1)
    "PoolName": ...,
    "StorageClass": ...,
}

parent.create_tape_pool(**kwargs)

1. See CreateTapePoolInputTypeDef

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

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

# create_tape_with_barcode method usage example with argument unpacking

kwargs: CreateTapeWithBarcodeInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeSizeInBytes": ...,
    "TapeBarcode": ...,
}

parent.create_tape_with_barcode(**kwargs)

1. See CreateTapeWithBarcodeInputTypeDef

create_tapes

Creates one or more virtual tapes.

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

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

# create_tapes method usage example with argument unpacking

kwargs: CreateTapesInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeSizeInBytes": ...,
    "ClientToken": ...,
    "NumTapesToCreate": ...,
    "TapeBarcodePrefix": ...,
}

parent.create_tapes(**kwargs)

1. See CreateTapesInputTypeDef

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

# delete_automatic_tape_creation_policy method definition

def delete_automatic_tape_creation_policy(
    self,
    *,
    GatewayARN: str,
) -> DeleteAutomaticTapeCreationPolicyOutputTypeDef:  # (1)
    ...

1. See DeleteAutomaticTapeCreationPolicyOutputTypeDef

# delete_automatic_tape_creation_policy method usage example with argument unpacking

kwargs: DeleteAutomaticTapeCreationPolicyInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.delete_automatic_tape_creation_policy(**kwargs)

1. See DeleteAutomaticTapeCreationPolicyInputTypeDef

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

# delete_bandwidth_rate_limit method definition

def delete_bandwidth_rate_limit(
    self,
    *,
    GatewayARN: str,
    BandwidthType: str,
) -> DeleteBandwidthRateLimitOutputTypeDef:  # (1)
    ...

1. See DeleteBandwidthRateLimitOutputTypeDef

# delete_bandwidth_rate_limit method usage example with argument unpacking

kwargs: DeleteBandwidthRateLimitInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "BandwidthType": ...,
}

parent.delete_bandwidth_rate_limit(**kwargs)

1. See DeleteBandwidthRateLimitInputTypeDef

delete_cache_report

Deletes the specified cache report and any associated tags from the Storage Gateway database.

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

# delete_cache_report method definition

def delete_cache_report(
    self,
    *,
    CacheReportARN: str,
) -> DeleteCacheReportOutputTypeDef:  # (1)
    ...

1. See DeleteCacheReportOutputTypeDef

# delete_cache_report method usage example with argument unpacking

kwargs: DeleteCacheReportInputTypeDef = {  # (1)
    "CacheReportARN": ...,
}

parent.delete_cache_report(**kwargs)

1. See DeleteCacheReportInputTypeDef

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

# delete_chap_credentials method definition

def delete_chap_credentials(
    self,
    *,
    TargetARN: str,
    InitiatorName: str,
) -> DeleteChapCredentialsOutputTypeDef:  # (1)
    ...

1. See DeleteChapCredentialsOutputTypeDef

# delete_chap_credentials method usage example with argument unpacking

kwargs: DeleteChapCredentialsInputTypeDef = {  # (1)
    "TargetARN": ...,
    "InitiatorName": ...,
}

parent.delete_chap_credentials(**kwargs)

1. See DeleteChapCredentialsInputTypeDef

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

# delete_file_share method definition

def delete_file_share(
    self,
    *,
    FileShareARN: str,
    ForceDelete: bool = ...,
) -> DeleteFileShareOutputTypeDef:  # (1)
    ...

1. See DeleteFileShareOutputTypeDef

# delete_file_share method usage example with argument unpacking

kwargs: DeleteFileShareInputTypeDef = {  # (1)
    "FileShareARN": ...,
}

parent.delete_file_share(**kwargs)

1. See DeleteFileShareInputTypeDef

delete_gateway

Deletes a gateway.

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

# delete_gateway method definition

def delete_gateway(
    self,
    *,
    GatewayARN: str,
) -> DeleteGatewayOutputTypeDef:  # (1)
    ...

1. See DeleteGatewayOutputTypeDef

# delete_gateway method usage example with argument unpacking

kwargs: DeleteGatewayInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.delete_gateway(**kwargs)

1. See DeleteGatewayInputTypeDef

delete_snapshot_schedule

Deletes a snapshot of a volume.

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

# delete_snapshot_schedule method definition

def delete_snapshot_schedule(
    self,
    *,
    VolumeARN: str,
) -> DeleteSnapshotScheduleOutputTypeDef:  # (1)
    ...

1. See DeleteSnapshotScheduleOutputTypeDef

# delete_snapshot_schedule method usage example with argument unpacking

kwargs: DeleteSnapshotScheduleInputTypeDef = {  # (1)
    "VolumeARN": ...,
}

parent.delete_snapshot_schedule(**kwargs)

1. See DeleteSnapshotScheduleInputTypeDef

delete_tape

Deletes the specified virtual tape.

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

# delete_tape method definition

def delete_tape(
    self,
    *,
    GatewayARN: str,
    TapeARN: str,
    BypassGovernanceRetention: bool = ...,
) -> DeleteTapeOutputTypeDef:  # (1)
    ...

1. See DeleteTapeOutputTypeDef

# delete_tape method usage example with argument unpacking

kwargs: DeleteTapeInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "TapeARN": ...,
}

parent.delete_tape(**kwargs)

1. See DeleteTapeInputTypeDef

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

# delete_tape_archive method definition

def delete_tape_archive(
    self,
    *,
    TapeARN: str,
    BypassGovernanceRetention: bool = ...,
) -> DeleteTapeArchiveOutputTypeDef:  # (1)
    ...

1. See DeleteTapeArchiveOutputTypeDef

# delete_tape_archive method usage example with argument unpacking

kwargs: DeleteTapeArchiveInputTypeDef = {  # (1)
    "TapeARN": ...,
}

parent.delete_tape_archive(**kwargs)

1. See DeleteTapeArchiveInputTypeDef

delete_tape_pool

Delete a custom tape pool.

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

# delete_tape_pool method definition

def delete_tape_pool(
    self,
    *,
    PoolARN: str,
) -> DeleteTapePoolOutputTypeDef:  # (1)
    ...

1. See DeleteTapePoolOutputTypeDef

# delete_tape_pool method usage example with argument unpacking

kwargs: DeleteTapePoolInputTypeDef = {  # (1)
    "PoolARN": ...,
}

parent.delete_tape_pool(**kwargs)

1. See DeleteTapePoolInputTypeDef

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

# delete_volume method definition

def delete_volume(
    self,
    *,
    VolumeARN: str,
) -> DeleteVolumeOutputTypeDef:  # (1)
    ...

1. See DeleteVolumeOutputTypeDef

# delete_volume method usage example with argument unpacking

kwargs: DeleteVolumeInputTypeDef = {  # (1)
    "VolumeARN": ...,
}

parent.delete_volume(**kwargs)

1. See DeleteVolumeInputTypeDef

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

# describe_availability_monitor_test method definition

def describe_availability_monitor_test(
    self,
    *,
    GatewayARN: str,
) -> DescribeAvailabilityMonitorTestOutputTypeDef:  # (1)
    ...

1. See DescribeAvailabilityMonitorTestOutputTypeDef

# describe_availability_monitor_test method usage example with argument unpacking

kwargs: DescribeAvailabilityMonitorTestInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_availability_monitor_test(**kwargs)

1. See DescribeAvailabilityMonitorTestInputTypeDef

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

# describe_bandwidth_rate_limit method definition

def describe_bandwidth_rate_limit(
    self,
    *,
    GatewayARN: str,
) -> DescribeBandwidthRateLimitOutputTypeDef:  # (1)
    ...

1. See DescribeBandwidthRateLimitOutputTypeDef

# describe_bandwidth_rate_limit method usage example with argument unpacking

kwargs: DescribeBandwidthRateLimitInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_bandwidth_rate_limit(**kwargs)

1. See DescribeBandwidthRateLimitInputTypeDef

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

# describe_bandwidth_rate_limit_schedule method definition

def describe_bandwidth_rate_limit_schedule(
    self,
    *,
    GatewayARN: str,
) -> DescribeBandwidthRateLimitScheduleOutputTypeDef:  # (1)
    ...

1. See DescribeBandwidthRateLimitScheduleOutputTypeDef

# describe_bandwidth_rate_limit_schedule method usage example with argument unpacking

kwargs: DescribeBandwidthRateLimitScheduleInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_bandwidth_rate_limit_schedule(**kwargs)

1. See DescribeBandwidthRateLimitScheduleInputTypeDef

describe_cache

Returns information about the cache of a gateway.

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

# describe_cache method definition

def describe_cache(
    self,
    *,
    GatewayARN: str,
) -> DescribeCacheOutputTypeDef:  # (1)
    ...

1. See DescribeCacheOutputTypeDef

# describe_cache method usage example with argument unpacking

kwargs: DescribeCacheInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_cache(**kwargs)

1. See DescribeCacheInputTypeDef

describe_cache_report

Returns information about the specified cache report, including completion status and generation progress.

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

# describe_cache_report method definition

def describe_cache_report(
    self,
    *,
    CacheReportARN: str,
) -> DescribeCacheReportOutputTypeDef:  # (1)
    ...

1. See DescribeCacheReportOutputTypeDef

# describe_cache_report method usage example with argument unpacking

kwargs: DescribeCacheReportInputTypeDef = {  # (1)
    "CacheReportARN": ...,
}

parent.describe_cache_report(**kwargs)

1. See DescribeCacheReportInputTypeDef

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

# describe_cached_iscsi_volumes method definition

def describe_cached_iscsi_volumes(
    self,
    *,
    VolumeARNs: Sequence[str],
) -> DescribeCachediSCSIVolumesOutputTypeDef:  # (1)
    ...

1. See DescribeCachediSCSIVolumesOutputTypeDef

# describe_cached_iscsi_volumes method usage example with argument unpacking

kwargs: DescribeCachediSCSIVolumesInputTypeDef = {  # (1)
    "VolumeARNs": ...,
}

parent.describe_cached_iscsi_volumes(**kwargs)

1. See DescribeCachediSCSIVolumesInputTypeDef

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

# describe_chap_credentials method definition

def describe_chap_credentials(
    self,
    *,
    TargetARN: str,
) -> DescribeChapCredentialsOutputTypeDef:  # (1)
    ...

1. See DescribeChapCredentialsOutputTypeDef

# describe_chap_credentials method usage example with argument unpacking

kwargs: DescribeChapCredentialsInputTypeDef = {  # (1)
    "TargetARN": ...,
}

parent.describe_chap_credentials(**kwargs)

1. See DescribeChapCredentialsInputTypeDef

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

# describe_file_system_associations method definition

def describe_file_system_associations(
    self,
    *,
    FileSystemAssociationARNList: Sequence[str],
) -> DescribeFileSystemAssociationsOutputTypeDef:  # (1)
    ...

1. See DescribeFileSystemAssociationsOutputTypeDef

# describe_file_system_associations method usage example with argument unpacking

kwargs: DescribeFileSystemAssociationsInputTypeDef = {  # (1)
    "FileSystemAssociationARNList": ...,
}

parent.describe_file_system_associations(**kwargs)

1. See DescribeFileSystemAssociationsInputTypeDef

describe_gateway_information

Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version.

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

# describe_gateway_information method definition

def describe_gateway_information(
    self,
    *,
    GatewayARN: str,
) -> DescribeGatewayInformationOutputTypeDef:  # (1)
    ...

1. See DescribeGatewayInformationOutputTypeDef

# describe_gateway_information method usage example with argument unpacking

kwargs: DescribeGatewayInformationInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_gateway_information(**kwargs)

1. See DescribeGatewayInformationInputTypeDef

describe_maintenance_start_time

Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply.

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

# describe_maintenance_start_time method definition

def describe_maintenance_start_time(
    self,
    *,
    GatewayARN: str,
) -> DescribeMaintenanceStartTimeOutputTypeDef:  # (1)
    ...

1. See DescribeMaintenanceStartTimeOutputTypeDef

# describe_maintenance_start_time method usage example with argument unpacking

kwargs: DescribeMaintenanceStartTimeInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_maintenance_start_time(**kwargs)

1. See DescribeMaintenanceStartTimeInputTypeDef

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

# describe_nfs_file_shares method definition

def describe_nfs_file_shares(
    self,
    *,
    FileShareARNList: Sequence[str],
) -> DescribeNFSFileSharesOutputTypeDef:  # (1)
    ...

1. See DescribeNFSFileSharesOutputTypeDef

# describe_nfs_file_shares method usage example with argument unpacking

kwargs: DescribeNFSFileSharesInputTypeDef = {  # (1)
    "FileShareARNList": ...,
}

parent.describe_nfs_file_shares(**kwargs)

1. See DescribeNFSFileSharesInputTypeDef

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

# describe_smb_file_shares method definition

def describe_smb_file_shares(
    self,
    *,
    FileShareARNList: Sequence[str],
) -> DescribeSMBFileSharesOutputTypeDef:  # (1)
    ...

1. See DescribeSMBFileSharesOutputTypeDef

# describe_smb_file_shares method usage example with argument unpacking

kwargs: DescribeSMBFileSharesInputTypeDef = {  # (1)
    "FileShareARNList": ...,
}

parent.describe_smb_file_shares(**kwargs)

1. See DescribeSMBFileSharesInputTypeDef

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

# describe_smb_settings method definition

def describe_smb_settings(
    self,
    *,
    GatewayARN: str,
) -> DescribeSMBSettingsOutputTypeDef:  # (1)
    ...

1. See DescribeSMBSettingsOutputTypeDef

# describe_smb_settings method usage example with argument unpacking

kwargs: DescribeSMBSettingsInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_smb_settings(**kwargs)

1. See DescribeSMBSettingsInputTypeDef

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

# describe_snapshot_schedule method definition

def describe_snapshot_schedule(
    self,
    *,
    VolumeARN: str,
) -> DescribeSnapshotScheduleOutputTypeDef:  # (1)
    ...

1. See DescribeSnapshotScheduleOutputTypeDef

# describe_snapshot_schedule method usage example with argument unpacking

kwargs: DescribeSnapshotScheduleInputTypeDef = {  # (1)
    "VolumeARN": ...,
}

parent.describe_snapshot_schedule(**kwargs)

1. See DescribeSnapshotScheduleInputTypeDef

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

# describe_stored_iscsi_volumes method definition

def describe_stored_iscsi_volumes(
    self,
    *,
    VolumeARNs: Sequence[str],
) -> DescribeStorediSCSIVolumesOutputTypeDef:  # (1)
    ...

1. See DescribeStorediSCSIVolumesOutputTypeDef

# describe_stored_iscsi_volumes method usage example with argument unpacking

kwargs: DescribeStorediSCSIVolumesInputTypeDef = {  # (1)
    "VolumeARNs": ...,
}

parent.describe_stored_iscsi_volumes(**kwargs)

1. See DescribeStorediSCSIVolumesInputTypeDef

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

# describe_tape_archives method definition

def describe_tape_archives(
    self,
    *,
    TapeARNs: Sequence[str] = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeTapeArchivesOutputTypeDef:  # (1)
    ...

1. See DescribeTapeArchivesOutputTypeDef

# describe_tape_archives method usage example with argument unpacking

kwargs: DescribeTapeArchivesInputTypeDef = {  # (1)
    "TapeARNs": ...,
}

parent.describe_tape_archives(**kwargs)

1. See DescribeTapeArchivesInputTypeDef

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

# describe_tape_recovery_points method definition

def describe_tape_recovery_points(
    self,
    *,
    GatewayARN: str,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeTapeRecoveryPointsOutputTypeDef:  # (1)
    ...

1. See DescribeTapeRecoveryPointsOutputTypeDef

# describe_tape_recovery_points method usage example with argument unpacking

kwargs: DescribeTapeRecoveryPointsInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_tape_recovery_points(**kwargs)

1. See DescribeTapeRecoveryPointsInputTypeDef

describe_tapes

Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs).

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

# describe_tapes method definition

def describe_tapes(
    self,
    *,
    GatewayARN: str,
    TapeARNs: Sequence[str] = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeTapesOutputTypeDef:  # (1)
    ...

1. See DescribeTapesOutputTypeDef

# describe_tapes method usage example with argument unpacking

kwargs: DescribeTapesInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_tapes(**kwargs)

1. See DescribeTapesInputTypeDef

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

# describe_upload_buffer method definition

def describe_upload_buffer(
    self,
    *,
    GatewayARN: str,
) -> DescribeUploadBufferOutputTypeDef:  # (1)
    ...

1. See DescribeUploadBufferOutputTypeDef

# describe_upload_buffer method usage example with argument unpacking

kwargs: DescribeUploadBufferInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_upload_buffer(**kwargs)

1. See DescribeUploadBufferInputTypeDef

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

# describe_vtl_devices method definition

def describe_vtl_devices(
    self,
    *,
    GatewayARN: str,
    VTLDeviceARNs: Sequence[str] = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeVTLDevicesOutputTypeDef:  # (1)
    ...

1. See DescribeVTLDevicesOutputTypeDef

# describe_vtl_devices method usage example with argument unpacking

kwargs: DescribeVTLDevicesInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_vtl_devices(**kwargs)

1. See DescribeVTLDevicesInputTypeDef

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. boto3 documentation

# describe_working_storage method definition

def describe_working_storage(
    self,
    *,
    GatewayARN: str,
) -> DescribeWorkingStorageOutputTypeDef:  # (1)
    ...

1. See DescribeWorkingStorageOutputTypeDef

# describe_working_storage method usage example with argument unpacking

kwargs: DescribeWorkingStorageInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.describe_working_storage(**kwargs)

1. See DescribeWorkingStorageInputTypeDef

detach_volume

Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway.

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

# detach_volume method definition

def detach_volume(
    self,
    *,
    VolumeARN: str,
    ForceDetach: bool = ...,
) -> DetachVolumeOutputTypeDef:  # (1)
    ...

1. See DetachVolumeOutputTypeDef

# detach_volume method usage example with argument unpacking

kwargs: DetachVolumeInputTypeDef = {  # (1)
    "VolumeARN": ...,
}

parent.detach_volume(**kwargs)

1. See DetachVolumeInputTypeDef

disable_gateway

Disables a tape gateway when the gateway is no longer functioning.

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

# disable_gateway method definition

def disable_gateway(
    self,
    *,
    GatewayARN: str,
) -> DisableGatewayOutputTypeDef:  # (1)
    ...

1. See DisableGatewayOutputTypeDef

# disable_gateway method usage example with argument unpacking

kwargs: DisableGatewayInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.disable_gateway(**kwargs)

1. See DisableGatewayInputTypeDef

disassociate_file_system

Disassociates an Amazon FSx file system from the specified gateway.

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

# disassociate_file_system method definition

def disassociate_file_system(
    self,
    *,
    FileSystemAssociationARN: str,
    ForceDelete: bool = ...,
) -> DisassociateFileSystemOutputTypeDef:  # (1)
    ...

1. See DisassociateFileSystemOutputTypeDef

# disassociate_file_system method usage example with argument unpacking

kwargs: DisassociateFileSystemInputTypeDef = {  # (1)
    "FileSystemAssociationARN": ...,
}

parent.disassociate_file_system(**kwargs)

1. See DisassociateFileSystemInputTypeDef

join_domain

Adds a file gateway to an Active Directory domain.

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

# join_domain method definition

def join_domain(
    self,
    *,
    GatewayARN: str,
    DomainName: str,
    UserName: str,
    Password: str,
    OrganizationalUnit: str = ...,
    DomainControllers: Sequence[str] = ...,
    TimeoutInSeconds: int = ...,
) -> JoinDomainOutputTypeDef:  # (1)
    ...

1. See JoinDomainOutputTypeDef

# join_domain method usage example with argument unpacking

kwargs: JoinDomainInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "DomainName": ...,
    "UserName": ...,
    "Password": ...,
}

parent.join_domain(**kwargs)

1. See JoinDomainInputTypeDef

list_automatic_tape_creation_policies

Lists the automatic tape creation policies for a gateway.

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

# list_automatic_tape_creation_policies method definition

def list_automatic_tape_creation_policies(
    self,
    *,
    GatewayARN: str = ...,
) -> ListAutomaticTapeCreationPoliciesOutputTypeDef:  # (1)
    ...

1. See ListAutomaticTapeCreationPoliciesOutputTypeDef

# list_automatic_tape_creation_policies method usage example with argument unpacking

kwargs: ListAutomaticTapeCreationPoliciesInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.list_automatic_tape_creation_policies(**kwargs)

1. See ListAutomaticTapeCreationPoliciesInputTypeDef

list_cache_reports

Returns a list of existing cache reports for all file shares associated with your Amazon Web Services account.

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

# list_cache_reports method definition

def list_cache_reports(
    self,
    *,
    Marker: str = ...,
) -> ListCacheReportsOutputTypeDef:  # (1)
    ...

1. See ListCacheReportsOutputTypeDef

# list_cache_reports method usage example with argument unpacking

kwargs: ListCacheReportsInputTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_cache_reports(**kwargs)

1. See ListCacheReportsInputTypeDef

list_file_shares

Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account.

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

# list_file_shares method definition

def list_file_shares(
    self,
    *,
    GatewayARN: str = ...,
    Limit: int = ...,
    Marker: str = ...,
) -> ListFileSharesOutputTypeDef:  # (1)
    ...

1. See ListFileSharesOutputTypeDef

# list_file_shares method usage example with argument unpacking

kwargs: ListFileSharesInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.list_file_shares(**kwargs)

1. See ListFileSharesInputTypeDef

list_file_system_associations

Gets a list of FileSystemAssociationSummary objects.

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

# list_file_system_associations method definition

def list_file_system_associations(
    self,
    *,
    GatewayARN: str = ...,
    Limit: int = ...,
    Marker: str = ...,
) -> ListFileSystemAssociationsOutputTypeDef:  # (1)
    ...

1. See ListFileSystemAssociationsOutputTypeDef

# list_file_system_associations method usage example with argument unpacking

kwargs: ListFileSystemAssociationsInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.list_file_system_associations(**kwargs)

1. See ListFileSystemAssociationsInputTypeDef

list_gateways

Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request.

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

# list_gateways method definition

def list_gateways(
    self,
    *,
    Marker: str = ...,
    Limit: int = ...,
) -> ListGatewaysOutputTypeDef:  # (1)
    ...

1. See ListGatewaysOutputTypeDef

# list_gateways method usage example with argument unpacking

kwargs: ListGatewaysInputTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_gateways(**kwargs)

1. See ListGatewaysInputTypeDef

list_local_disks

Returns a list of the gateway's local disks.

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

# list_local_disks method definition

def list_local_disks(
    self,
    *,
    GatewayARN: str,
) -> ListLocalDisksOutputTypeDef:  # (1)
    ...

1. See ListLocalDisksOutputTypeDef

# list_local_disks method usage example with argument unpacking

kwargs: ListLocalDisksInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.list_local_disks(**kwargs)

1. See ListLocalDisksInputTypeDef

list_tags_for_resource

Lists the tags that have been added to the specified resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
    Marker: str = ...,
    Limit: int = ...,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputTypeDef

list_tape_pools

Lists custom tape pools.

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

# list_tape_pools method definition

def list_tape_pools(
    self,
    *,
    PoolARNs: Sequence[str] = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> ListTapePoolsOutputTypeDef:  # (1)
    ...

1. See ListTapePoolsOutputTypeDef

# list_tape_pools method usage example with argument unpacking

kwargs: ListTapePoolsInputTypeDef = {  # (1)
    "PoolARNs": ...,
}

parent.list_tape_pools(**kwargs)

1. See ListTapePoolsInputTypeDef

list_tapes

Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).

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

# list_tapes method definition

def list_tapes(
    self,
    *,
    TapeARNs: Sequence[str] = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> ListTapesOutputTypeDef:  # (1)
    ...

1. See ListTapesOutputTypeDef

# list_tapes method usage example with argument unpacking

kwargs: ListTapesInputTypeDef = {  # (1)
    "TapeARNs": ...,
}

parent.list_tapes(**kwargs)

1. See ListTapesInputTypeDef

list_volume_initiators

Lists iSCSI initiators that are connected to a volume.

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

# list_volume_initiators method definition

def list_volume_initiators(
    self,
    *,
    VolumeARN: str,
) -> ListVolumeInitiatorsOutputTypeDef:  # (1)
    ...

1. See ListVolumeInitiatorsOutputTypeDef

# list_volume_initiators method usage example with argument unpacking

kwargs: ListVolumeInitiatorsInputTypeDef = {  # (1)
    "VolumeARN": ...,
}

parent.list_volume_initiators(**kwargs)

1. See ListVolumeInitiatorsInputTypeDef

list_volume_recovery_points

Lists the recovery points for a specified gateway.

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

# list_volume_recovery_points method definition

def list_volume_recovery_points(
    self,
    *,
    GatewayARN: str,
) -> ListVolumeRecoveryPointsOutputTypeDef:  # (1)
    ...

1. See ListVolumeRecoveryPointsOutputTypeDef

# list_volume_recovery_points method usage example with argument unpacking

kwargs: ListVolumeRecoveryPointsInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.list_volume_recovery_points(**kwargs)

1. See ListVolumeRecoveryPointsInputTypeDef

list_volumes

Lists the iSCSI stored volumes of a gateway.

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

# list_volumes method definition

def list_volumes(
    self,
    *,
    GatewayARN: str = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> ListVolumesOutputTypeDef:  # (1)
    ...

1. See ListVolumesOutputTypeDef

# list_volumes method usage example with argument unpacking

kwargs: ListVolumesInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.list_volumes(**kwargs)

1. See ListVolumesInputTypeDef

notify_when_uploaded

Sends you notification through Amazon EventBridge when all files written to your file share have been uploaded to Amazon S3.

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

# notify_when_uploaded method definition

def notify_when_uploaded(
    self,
    *,
    FileShareARN: str,
) -> NotifyWhenUploadedOutputTypeDef:  # (1)
    ...

1. See NotifyWhenUploadedOutputTypeDef

# notify_when_uploaded method usage example with argument unpacking

kwargs: NotifyWhenUploadedInputTypeDef = {  # (1)
    "FileShareARN": ...,
}

parent.notify_when_uploaded(**kwargs)

1. See NotifyWhenUploadedInputTypeDef

refresh_cache

Refreshes the cached inventory of objects for the specified file share.

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

# refresh_cache method definition

def refresh_cache(
    self,
    *,
    FileShareARN: str,
    FolderList: Sequence[str] = ...,
    Recursive: bool = ...,
) -> RefreshCacheOutputTypeDef:  # (1)
    ...

1. See RefreshCacheOutputTypeDef

# refresh_cache method usage example with argument unpacking

kwargs: RefreshCacheInputTypeDef = {  # (1)
    "FileShareARN": ...,
}

parent.refresh_cache(**kwargs)

1. See RefreshCacheInputTypeDef

remove_tags_from_resource

Removes one or more tags from the specified resource.

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

# remove_tags_from_resource method definition

def remove_tags_from_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> RemoveTagsFromResourceOutputTypeDef:  # (1)
    ...

1. See RemoveTagsFromResourceOutputTypeDef

# remove_tags_from_resource method usage example with argument unpacking

kwargs: RemoveTagsFromResourceInputTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.remove_tags_from_resource(**kwargs)

1. See RemoveTagsFromResourceInputTypeDef

reset_cache

Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage.

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

# reset_cache method definition

def reset_cache(
    self,
    *,
    GatewayARN: str,
) -> ResetCacheOutputTypeDef:  # (1)
    ...

1. See ResetCacheOutputTypeDef

# reset_cache method usage example with argument unpacking

kwargs: ResetCacheInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.reset_cache(**kwargs)

1. See ResetCacheInputTypeDef

retrieve_tape_archive

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.

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

# retrieve_tape_archive method definition

def retrieve_tape_archive(
    self,
    *,
    TapeARN: str,
    GatewayARN: str,
) -> RetrieveTapeArchiveOutputTypeDef:  # (1)
    ...

1. See RetrieveTapeArchiveOutputTypeDef

# retrieve_tape_archive method usage example with argument unpacking

kwargs: RetrieveTapeArchiveInputTypeDef = {  # (1)
    "TapeARN": ...,
    "GatewayARN": ...,
}

parent.retrieve_tape_archive(**kwargs)

1. See RetrieveTapeArchiveInputTypeDef

retrieve_tape_recovery_point

Retrieves the recovery point for the specified virtual tape.

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

# retrieve_tape_recovery_point method definition

def retrieve_tape_recovery_point(
    self,
    *,
    TapeARN: str,
    GatewayARN: str,
) -> RetrieveTapeRecoveryPointOutputTypeDef:  # (1)
    ...

1. See RetrieveTapeRecoveryPointOutputTypeDef

# retrieve_tape_recovery_point method usage example with argument unpacking

kwargs: RetrieveTapeRecoveryPointInputTypeDef = {  # (1)
    "TapeARN": ...,
    "GatewayARN": ...,
}

parent.retrieve_tape_recovery_point(**kwargs)

1. See RetrieveTapeRecoveryPointInputTypeDef

set_local_console_password

Sets the password for your VM local console.

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

# set_local_console_password method definition

def set_local_console_password(
    self,
    *,
    GatewayARN: str,
    LocalConsolePassword: str,
) -> SetLocalConsolePasswordOutputTypeDef:  # (1)
    ...

1. See SetLocalConsolePasswordOutputTypeDef

# set_local_console_password method usage example with argument unpacking

kwargs: SetLocalConsolePasswordInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "LocalConsolePassword": ...,
}

parent.set_local_console_password(**kwargs)

1. See SetLocalConsolePasswordInputTypeDef

set_smb_guest_password

Sets the password for the guest user smbguest.

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

# set_smb_guest_password method definition

def set_smb_guest_password(
    self,
    *,
    GatewayARN: str,
    Password: str,
) -> SetSMBGuestPasswordOutputTypeDef:  # (1)
    ...

1. See SetSMBGuestPasswordOutputTypeDef

# set_smb_guest_password method usage example with argument unpacking

kwargs: SetSMBGuestPasswordInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "Password": ...,
}

parent.set_smb_guest_password(**kwargs)

1. See SetSMBGuestPasswordInputTypeDef

shutdown_gateway

Shuts down a Tape Gateway or Volume Gateway.

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

# shutdown_gateway method definition

def shutdown_gateway(
    self,
    *,
    GatewayARN: str,
) -> ShutdownGatewayOutputTypeDef:  # (1)
    ...

1. See ShutdownGatewayOutputTypeDef

# shutdown_gateway method usage example with argument unpacking

kwargs: ShutdownGatewayInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.shutdown_gateway(**kwargs)

1. See ShutdownGatewayInputTypeDef

start_availability_monitor_test

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment.

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

# start_availability_monitor_test method definition

def start_availability_monitor_test(
    self,
    *,
    GatewayARN: str,
) -> StartAvailabilityMonitorTestOutputTypeDef:  # (1)
    ...

1. See StartAvailabilityMonitorTestOutputTypeDef

# start_availability_monitor_test method usage example with argument unpacking

kwargs: StartAvailabilityMonitorTestInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.start_availability_monitor_test(**kwargs)

1. See StartAvailabilityMonitorTestInputTypeDef

start_cache_report

Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share.

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

# start_cache_report method definition

def start_cache_report(
    self,
    *,
    FileShareARN: str,
    Role: str,
    LocationARN: str,
    BucketRegion: str,
    ClientToken: str,
    VPCEndpointDNSName: str = ...,
    InclusionFilters: Sequence[CacheReportFilterUnionTypeDef] = ...,  # (1)
    ExclusionFilters: Sequence[CacheReportFilterUnionTypeDef] = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> StartCacheReportOutputTypeDef:  # (4)
    ...

1. See CacheReportFilterTypeDef CacheReportFilterOutputTypeDef
2. See CacheReportFilterTypeDef CacheReportFilterOutputTypeDef
3. See TagTypeDef
4. See StartCacheReportOutputTypeDef

# start_cache_report method usage example with argument unpacking

kwargs: StartCacheReportInputTypeDef = {  # (1)
    "FileShareARN": ...,
    "Role": ...,
    "LocationARN": ...,
    "BucketRegion": ...,
    "ClientToken": ...,
}

parent.start_cache_report(**kwargs)

1. See StartCacheReportInputTypeDef

start_gateway

Starts a gateway that you previously shut down (see ShutdownGateway).

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

# start_gateway method definition

def start_gateway(
    self,
    *,
    GatewayARN: str,
) -> StartGatewayOutputTypeDef:  # (1)
    ...

1. See StartGatewayOutputTypeDef

# start_gateway method usage example with argument unpacking

kwargs: StartGatewayInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.start_gateway(**kwargs)

1. See StartGatewayInputTypeDef

update_automatic_tape_creation_policy

Updates the automatic tape creation policy of a gateway.

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

# update_automatic_tape_creation_policy method definition

def update_automatic_tape_creation_policy(
    self,
    *,
    AutomaticTapeCreationRules: Sequence[AutomaticTapeCreationRuleTypeDef],  # (1)
    GatewayARN: str,
) -> UpdateAutomaticTapeCreationPolicyOutputTypeDef:  # (2)
    ...

1. See AutomaticTapeCreationRuleTypeDef
2. See UpdateAutomaticTapeCreationPolicyOutputTypeDef

# update_automatic_tape_creation_policy method usage example with argument unpacking

kwargs: UpdateAutomaticTapeCreationPolicyInputTypeDef = {  # (1)
    "AutomaticTapeCreationRules": ...,
    "GatewayARN": ...,
}

parent.update_automatic_tape_creation_policy(**kwargs)

1. See UpdateAutomaticTapeCreationPolicyInputTypeDef

update_bandwidth_rate_limit

Updates the bandwidth rate limits of a gateway.

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

# update_bandwidth_rate_limit method definition

def update_bandwidth_rate_limit(
    self,
    *,
    GatewayARN: str,
    AverageUploadRateLimitInBitsPerSec: int = ...,
    AverageDownloadRateLimitInBitsPerSec: int = ...,
) -> UpdateBandwidthRateLimitOutputTypeDef:  # (1)
    ...

1. See UpdateBandwidthRateLimitOutputTypeDef

# update_bandwidth_rate_limit method usage example with argument unpacking

kwargs: UpdateBandwidthRateLimitInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.update_bandwidth_rate_limit(**kwargs)

1. See UpdateBandwidthRateLimitInputTypeDef

update_bandwidth_rate_limit_schedule

Updates the bandwidth rate limit schedule for a specified gateway.

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

# update_bandwidth_rate_limit_schedule method definition

def update_bandwidth_rate_limit_schedule(
    self,
    *,
    GatewayARN: str,
    BandwidthRateLimitIntervals: Sequence[BandwidthRateLimitIntervalUnionTypeDef],  # (1)
) -> UpdateBandwidthRateLimitScheduleOutputTypeDef:  # (2)
    ...

1. See BandwidthRateLimitIntervalTypeDef BandwidthRateLimitIntervalOutputTypeDef
2. See UpdateBandwidthRateLimitScheduleOutputTypeDef

# update_bandwidth_rate_limit_schedule method usage example with argument unpacking

kwargs: UpdateBandwidthRateLimitScheduleInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "BandwidthRateLimitIntervals": ...,
}

parent.update_bandwidth_rate_limit_schedule(**kwargs)

1. See UpdateBandwidthRateLimitScheduleInputTypeDef

update_chap_credentials

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.

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

# update_chap_credentials method definition

def update_chap_credentials(
    self,
    *,
    TargetARN: str,
    SecretToAuthenticateInitiator: str,
    InitiatorName: str,
    SecretToAuthenticateTarget: str = ...,
) -> UpdateChapCredentialsOutputTypeDef:  # (1)
    ...

1. See UpdateChapCredentialsOutputTypeDef

# update_chap_credentials method usage example with argument unpacking

kwargs: UpdateChapCredentialsInputTypeDef = {  # (1)
    "TargetARN": ...,
    "SecretToAuthenticateInitiator": ...,
    "InitiatorName": ...,
}

parent.update_chap_credentials(**kwargs)

1. See UpdateChapCredentialsInputTypeDef

update_file_system_association

Updates a file system association.

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

# update_file_system_association method definition

def update_file_system_association(
    self,
    *,
    FileSystemAssociationARN: str,
    UserName: str = ...,
    Password: str = ...,
    AuditDestinationARN: str = ...,
    CacheAttributes: CacheAttributesTypeDef = ...,  # (1)
) -> UpdateFileSystemAssociationOutputTypeDef:  # (2)
    ...

1. See CacheAttributesTypeDef
2. See UpdateFileSystemAssociationOutputTypeDef

# update_file_system_association method usage example with argument unpacking

kwargs: UpdateFileSystemAssociationInputTypeDef = {  # (1)
    "FileSystemAssociationARN": ...,
}

parent.update_file_system_association(**kwargs)

1. See UpdateFileSystemAssociationInputTypeDef

update_gateway_information

Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size.

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

# update_gateway_information method definition

def update_gateway_information(
    self,
    *,
    GatewayARN: str,
    GatewayName: str = ...,
    GatewayTimezone: str = ...,
    CloudWatchLogGroupARN: str = ...,
    GatewayCapacity: GatewayCapacityType = ...,  # (1)
) -> UpdateGatewayInformationOutputTypeDef:  # (2)
    ...

1. See GatewayCapacityType
2. See UpdateGatewayInformationOutputTypeDef

# update_gateway_information method usage example with argument unpacking

kwargs: UpdateGatewayInformationInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.update_gateway_information(**kwargs)

1. See UpdateGatewayInformationInputTypeDef

update_gateway_software_now

Updates the gateway virtual machine (VM) software.

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

# update_gateway_software_now method definition

def update_gateway_software_now(
    self,
    *,
    GatewayARN: str,
) -> UpdateGatewaySoftwareNowOutputTypeDef:  # (1)
    ...

1. See UpdateGatewaySoftwareNowOutputTypeDef

# update_gateway_software_now method usage example with argument unpacking

kwargs: UpdateGatewaySoftwareNowInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.update_gateway_software_now(**kwargs)

1. See UpdateGatewaySoftwareNowInputTypeDef

update_maintenance_start_time

Updates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply.

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

# update_maintenance_start_time method definition

def update_maintenance_start_time(
    self,
    *,
    GatewayARN: str,
    HourOfDay: int = ...,
    MinuteOfHour: int = ...,
    DayOfWeek: int = ...,
    DayOfMonth: int = ...,
    SoftwareUpdatePreferences: SoftwareUpdatePreferencesTypeDef = ...,  # (1)
) -> UpdateMaintenanceStartTimeOutputTypeDef:  # (2)
    ...

1. See SoftwareUpdatePreferencesTypeDef
2. See UpdateMaintenanceStartTimeOutputTypeDef

# update_maintenance_start_time method usage example with argument unpacking

kwargs: UpdateMaintenanceStartTimeInputTypeDef = {  # (1)
    "GatewayARN": ...,
}

parent.update_maintenance_start_time(**kwargs)

1. See UpdateMaintenanceStartTimeInputTypeDef

update_nfs_file_share

Updates a Network File System (NFS) file share.

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

# update_nfs_file_share method definition

def update_nfs_file_share(
    self,
    *,
    FileShareARN: str,
    EncryptionType: EncryptionTypeType = ...,  # (1)
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    NFSFileShareDefaults: NFSFileShareDefaultsTypeDef = ...,  # (2)
    DefaultStorageClass: str = ...,
    ObjectACL: ObjectACLType = ...,  # (3)
    ClientList: Sequence[str] = ...,
    Squash: str = ...,
    ReadOnly: bool = ...,
    GuessMIMETypeEnabled: bool = ...,
    RequesterPays: bool = ...,
    FileShareName: str = ...,
    CacheAttributes: CacheAttributesTypeDef = ...,  # (4)
    NotificationPolicy: str = ...,
    AuditDestinationARN: str = ...,
) -> UpdateNFSFileShareOutputTypeDef:  # (5)
    ...

1. See EncryptionTypeType
2. See NFSFileShareDefaultsTypeDef
3. See ObjectACLType
4. See CacheAttributesTypeDef
5. See UpdateNFSFileShareOutputTypeDef

# update_nfs_file_share method usage example with argument unpacking

kwargs: UpdateNFSFileShareInputTypeDef = {  # (1)
    "FileShareARN": ...,
}

parent.update_nfs_file_share(**kwargs)

1. See UpdateNFSFileShareInputTypeDef

update_smb_file_share

Updates a Server Message Block (SMB) file share.

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

# update_smb_file_share method definition

def update_smb_file_share(
    self,
    *,
    FileShareARN: str,
    EncryptionType: EncryptionTypeType = ...,  # (1)
    KMSEncrypted: bool = ...,
    KMSKey: str = ...,
    DefaultStorageClass: str = ...,
    ObjectACL: ObjectACLType = ...,  # (2)
    ReadOnly: bool = ...,
    GuessMIMETypeEnabled: bool = ...,
    RequesterPays: bool = ...,
    SMBACLEnabled: bool = ...,
    AccessBasedEnumeration: bool = ...,
    AdminUserList: Sequence[str] = ...,
    ValidUserList: Sequence[str] = ...,
    InvalidUserList: Sequence[str] = ...,
    AuditDestinationARN: str = ...,
    CaseSensitivity: CaseSensitivityType = ...,  # (3)
    FileShareName: str = ...,
    CacheAttributes: CacheAttributesTypeDef = ...,  # (4)
    NotificationPolicy: str = ...,
    OplocksEnabled: bool = ...,
) -> UpdateSMBFileShareOutputTypeDef:  # (5)
    ...

1. See EncryptionTypeType
2. See ObjectACLType
3. See CaseSensitivityType
4. See CacheAttributesTypeDef
5. See UpdateSMBFileShareOutputTypeDef

# update_smb_file_share method usage example with argument unpacking

kwargs: UpdateSMBFileShareInputTypeDef = {  # (1)
    "FileShareARN": ...,
}

parent.update_smb_file_share(**kwargs)

1. See UpdateSMBFileShareInputTypeDef

update_smb_file_share_visibility

Controls whether the shares on an S3 File Gateway are visible in a net view or browse list.

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

# update_smb_file_share_visibility method definition

def update_smb_file_share_visibility(
    self,
    *,
    GatewayARN: str,
    FileSharesVisible: bool,
) -> UpdateSMBFileShareVisibilityOutputTypeDef:  # (1)
    ...

1. See UpdateSMBFileShareVisibilityOutputTypeDef

# update_smb_file_share_visibility method usage example with argument unpacking

kwargs: UpdateSMBFileShareVisibilityInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "FileSharesVisible": ...,
}

parent.update_smb_file_share_visibility(**kwargs)

1. See UpdateSMBFileShareVisibilityInputTypeDef

update_smb_local_groups

Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

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

# update_smb_local_groups method definition

def update_smb_local_groups(
    self,
    *,
    GatewayARN: str,
    SMBLocalGroups: SMBLocalGroupsUnionTypeDef,  # (1)
) -> UpdateSMBLocalGroupsOutputTypeDef:  # (2)
    ...

1. See SMBLocalGroupsTypeDef SMBLocalGroupsOutputTypeDef
2. See UpdateSMBLocalGroupsOutputTypeDef

# update_smb_local_groups method usage example with argument unpacking

kwargs: UpdateSMBLocalGroupsInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "SMBLocalGroups": ...,
}

parent.update_smb_local_groups(**kwargs)

1. See UpdateSMBLocalGroupsInputTypeDef

update_smb_security_strategy

Updates the SMB security strategy level for an Amazon S3 file gateway.

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

# update_smb_security_strategy method definition

def update_smb_security_strategy(
    self,
    *,
    GatewayARN: str,
    SMBSecurityStrategy: SMBSecurityStrategyType,  # (1)
) -> UpdateSMBSecurityStrategyOutputTypeDef:  # (2)
    ...

1. See SMBSecurityStrategyType
2. See UpdateSMBSecurityStrategyOutputTypeDef

# update_smb_security_strategy method usage example with argument unpacking

kwargs: UpdateSMBSecurityStrategyInputTypeDef = {  # (1)
    "GatewayARN": ...,
    "SMBSecurityStrategy": ...,
}

parent.update_smb_security_strategy(**kwargs)

1. See UpdateSMBSecurityStrategyInputTypeDef

update_snapshot_schedule

Updates a snapshot schedule configured for a gateway volume.

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

# update_snapshot_schedule method definition

def update_snapshot_schedule(
    self,
    *,
    VolumeARN: str,
    StartAt: int,
    RecurrenceInHours: int,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> UpdateSnapshotScheduleOutputTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See UpdateSnapshotScheduleOutputTypeDef

# update_snapshot_schedule method usage example with argument unpacking

kwargs: UpdateSnapshotScheduleInputTypeDef = {  # (1)
    "VolumeARN": ...,
    "StartAt": ...,
    "RecurrenceInHours": ...,
}

parent.update_snapshot_schedule(**kwargs)

1. See UpdateSnapshotScheduleInputTypeDef

update_vtl_device_type

Updates the type of medium changer in a tape gateway.

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

# update_vtl_device_type method definition

def update_vtl_device_type(
    self,
    *,
    VTLDeviceARN: str,
    DeviceType: str,
) -> UpdateVTLDeviceTypeOutputTypeDef:  # (1)
    ...

1. See UpdateVTLDeviceTypeOutputTypeDef

# update_vtl_device_type method usage example with argument unpacking

kwargs: UpdateVTLDeviceTypeInputTypeDef = {  # (1)
    "VTLDeviceARN": ...,
    "DeviceType": ...,
}

parent.update_vtl_device_type(**kwargs)

1. See UpdateVTLDeviceTypeInputTypeDef

get_paginator

Type annotations and code completion for boto3.client("storagegateway").get_paginator method with overloads.

• client.get_paginator("describe_tape_archives") -> DescribeTapeArchivesPaginator
• client.get_paginator("describe_tape_recovery_points") -> DescribeTapeRecoveryPointsPaginator
• client.get_paginator("describe_tapes") -> DescribeTapesPaginator
• client.get_paginator("describe_vtl_devices") -> DescribeVTLDevicesPaginator
• client.get_paginator("list_file_shares") -> ListFileSharesPaginator
• client.get_paginator("list_file_system_associations") -> ListFileSystemAssociationsPaginator
• client.get_paginator("list_gateways") -> ListGatewaysPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator
• client.get_paginator("list_tape_pools") -> ListTapePoolsPaginator
• client.get_paginator("list_tapes") -> ListTapesPaginator
• client.get_paginator("list_volumes") -> ListVolumesPaginator