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
# StorageGatewayClient 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.
# 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 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
# 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)
...
# activate_gateway method usage example with argument unpacking
kwargs: ActivateGatewayInputRequestTypeDef = { # (1)
"ActivationKey": ...,
"GatewayName": ...,
"GatewayTimezone": ...,
"GatewayRegion": ...,
}
parent.activate_gateway(**kwargs)
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)
...
# add_cache method usage example with argument unpacking
kwargs: AddCacheInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"DiskIds": ...,
}
parent.add_cache(**kwargs)
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)
...
# add_tags_to_resource method usage example with argument unpacking
kwargs: AddTagsToResourceInputRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.add_tags_to_resource(**kwargs)
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)
...
# add_upload_buffer method usage example with argument unpacking
kwargs: AddUploadBufferInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"DiskIds": ...,
}
parent.add_upload_buffer(**kwargs)
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)
...
# add_working_storage method usage example with argument unpacking
kwargs: AddWorkingStorageInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"DiskIds": ...,
}
parent.add_working_storage(**kwargs)
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)
...
# assign_tape_pool method usage example with argument unpacking
kwargs: AssignTapePoolInputRequestTypeDef = { # (1)
"TapeARN": ...,
"PoolId": ...,
}
parent.assign_tape_pool(**kwargs)
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: EndpointNetworkConfigurationTypeDef = ..., # (3)
) -> AssociateFileSystemOutputTypeDef: # (4)
...
- See TagTypeDef
- See CacheAttributesTypeDef
- See EndpointNetworkConfigurationTypeDef
- See AssociateFileSystemOutputTypeDef
# associate_file_system method usage example with argument unpacking
kwargs: AssociateFileSystemInputRequestTypeDef = { # (1)
"UserName": ...,
"Password": ...,
"ClientToken": ...,
"GatewayARN": ...,
"LocationARN": ...,
}
parent.associate_file_system(**kwargs)
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)
...
# attach_volume method usage example with argument unpacking
kwargs: AttachVolumeInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"VolumeARN": ...,
"NetworkInterfaceId": ...,
}
parent.attach_volume(**kwargs)
can_paginate#
Check if an operation can be paginated.
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:
...
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)
...
# cancel_archival method usage example with argument unpacking
kwargs: CancelArchivalInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"TapeARN": ...,
}
parent.cancel_archival(**kwargs)
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)
...
# cancel_retrieval method usage example with argument unpacking
kwargs: CancelRetrievalInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"TapeARN": ...,
}
parent.cancel_retrieval(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("storagegateway").close
method.
boto3 documentation
# close 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
# 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)
...
# create_cached_iscsi_volume method usage example with argument unpacking
kwargs: CreateCachediSCSIVolumeInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"VolumeSizeInBytes": ...,
"TargetName": ...,
"NetworkInterfaceId": ...,
"ClientToken": ...,
}
parent.create_cached_iscsi_volume(**kwargs)
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)
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)
...
- See NFSFileShareDefaultsTypeDef
- See ObjectACLType
- See TagTypeDef
- See CacheAttributesTypeDef
- See CreateNFSFileShareOutputTypeDef
# create_nfs_file_share method usage example with argument unpacking
kwargs: CreateNFSFileShareInputRequestTypeDef = { # (1)
"ClientToken": ...,
"GatewayARN": ...,
"Role": ...,
"LocationARN": ...,
}
parent.create_nfs_file_share(**kwargs)
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,
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)
...
- See ObjectACLType
- See CaseSensitivityType
- See TagTypeDef
- See CacheAttributesTypeDef
- See CreateSMBFileShareOutputTypeDef
# create_smb_file_share method usage example with argument unpacking
kwargs: CreateSMBFileShareInputRequestTypeDef = { # (1)
"ClientToken": ...,
"GatewayARN": ...,
"Role": ...,
"LocationARN": ...,
}
parent.create_smb_file_share(**kwargs)
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)
...
# create_snapshot method usage example with argument unpacking
kwargs: CreateSnapshotInputRequestTypeDef = { # (1)
"VolumeARN": ...,
"SnapshotDescription": ...,
}
parent.create_snapshot(**kwargs)
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)
...
# create_snapshot_from_volume_recovery_point method usage example with argument unpacking
kwargs: CreateSnapshotFromVolumeRecoveryPointInputRequestTypeDef = { # (1)
"VolumeARN": ...,
"SnapshotDescription": ...,
}
parent.create_snapshot_from_volume_recovery_point(**kwargs)
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)
...
# create_stored_iscsi_volume method usage example with argument unpacking
kwargs: CreateStorediSCSIVolumeInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"DiskId": ...,
"PreserveExistingData": ...,
"TargetName": ...,
"NetworkInterfaceId": ...,
}
parent.create_stored_iscsi_volume(**kwargs)
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)
...
# create_tape_pool method usage example with argument unpacking
kwargs: CreateTapePoolInputRequestTypeDef = { # (1)
"PoolName": ...,
"StorageClass": ...,
}
parent.create_tape_pool(**kwargs)
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)
...
# create_tape_with_barcode method usage example with argument unpacking
kwargs: CreateTapeWithBarcodeInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"TapeSizeInBytes": ...,
"TapeBarcode": ...,
}
parent.create_tape_with_barcode(**kwargs)
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)
...
- See TagTypeDef
- See CreateTapesOutputTypeDef
# create_tapes method usage example with argument unpacking
kwargs: CreateTapesInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"TapeSizeInBytes": ...,
"ClientToken": ...,
"NumTapesToCreate": ...,
"TapeBarcodePrefix": ...,
}
parent.create_tapes(**kwargs)
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)
...
# delete_automatic_tape_creation_policy method usage example with argument unpacking
kwargs: DeleteAutomaticTapeCreationPolicyInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.delete_automatic_tape_creation_policy(**kwargs)
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)
...
# delete_bandwidth_rate_limit method usage example with argument unpacking
kwargs: DeleteBandwidthRateLimitInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"BandwidthType": ...,
}
parent.delete_bandwidth_rate_limit(**kwargs)
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)
...
# delete_chap_credentials method usage example with argument unpacking
kwargs: DeleteChapCredentialsInputRequestTypeDef = { # (1)
"TargetARN": ...,
"InitiatorName": ...,
}
parent.delete_chap_credentials(**kwargs)
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)
...
# delete_file_share method usage example with argument unpacking
kwargs: DeleteFileShareInputRequestTypeDef = { # (1)
"FileShareARN": ...,
}
parent.delete_file_share(**kwargs)
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)
...
# delete_gateway method usage example with argument unpacking
kwargs: DeleteGatewayInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.delete_gateway(**kwargs)
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)
...
# delete_snapshot_schedule method usage example with argument unpacking
kwargs: DeleteSnapshotScheduleInputRequestTypeDef = { # (1)
"VolumeARN": ...,
}
parent.delete_snapshot_schedule(**kwargs)
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)
...
# delete_tape method usage example with argument unpacking
kwargs: DeleteTapeInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"TapeARN": ...,
}
parent.delete_tape(**kwargs)
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)
...
# delete_tape_archive method usage example with argument unpacking
kwargs: DeleteTapeArchiveInputRequestTypeDef = { # (1)
"TapeARN": ...,
}
parent.delete_tape_archive(**kwargs)
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)
...
# delete_tape_pool method usage example with argument unpacking
kwargs: DeleteTapePoolInputRequestTypeDef = { # (1)
"PoolARN": ...,
}
parent.delete_tape_pool(**kwargs)
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)
...
# delete_volume method usage example with argument unpacking
kwargs: DeleteVolumeInputRequestTypeDef = { # (1)
"VolumeARN": ...,
}
parent.delete_volume(**kwargs)
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)
...
# describe_availability_monitor_test method usage example with argument unpacking
kwargs: DescribeAvailabilityMonitorTestInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_availability_monitor_test(**kwargs)
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)
...
# describe_bandwidth_rate_limit method usage example with argument unpacking
kwargs: DescribeBandwidthRateLimitInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_bandwidth_rate_limit(**kwargs)
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)
...
# describe_bandwidth_rate_limit_schedule method usage example with argument unpacking
kwargs: DescribeBandwidthRateLimitScheduleInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_bandwidth_rate_limit_schedule(**kwargs)
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)
...
# describe_cache method usage example with argument unpacking
kwargs: DescribeCacheInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_cache(**kwargs)
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)
...
# describe_cached_iscsi_volumes method usage example with argument unpacking
kwargs: DescribeCachediSCSIVolumesInputRequestTypeDef = { # (1)
"VolumeARNs": ...,
}
parent.describe_cached_iscsi_volumes(**kwargs)
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)
...
# describe_chap_credentials method usage example with argument unpacking
kwargs: DescribeChapCredentialsInputRequestTypeDef = { # (1)
"TargetARN": ...,
}
parent.describe_chap_credentials(**kwargs)
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)
...
# describe_file_system_associations method usage example with argument unpacking
kwargs: DescribeFileSystemAssociationsInputRequestTypeDef = { # (1)
"FileSystemAssociationARNList": ...,
}
parent.describe_file_system_associations(**kwargs)
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)
...
# describe_gateway_information method usage example with argument unpacking
kwargs: DescribeGatewayInformationInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_gateway_information(**kwargs)
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
# describe_maintenance_start_time method definition
def describe_maintenance_start_time(
self,
*,
GatewayARN: str,
) -> DescribeMaintenanceStartTimeOutputTypeDef: # (1)
...
# describe_maintenance_start_time method usage example with argument unpacking
kwargs: DescribeMaintenanceStartTimeInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_maintenance_start_time(**kwargs)
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)
...
# describe_nfs_file_shares method usage example with argument unpacking
kwargs: DescribeNFSFileSharesInputRequestTypeDef = { # (1)
"FileShareARNList": ...,
}
parent.describe_nfs_file_shares(**kwargs)
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)
...
# describe_smb_file_shares method usage example with argument unpacking
kwargs: DescribeSMBFileSharesInputRequestTypeDef = { # (1)
"FileShareARNList": ...,
}
parent.describe_smb_file_shares(**kwargs)
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)
...
# describe_smb_settings method usage example with argument unpacking
kwargs: DescribeSMBSettingsInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_smb_settings(**kwargs)
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)
...
# describe_snapshot_schedule method usage example with argument unpacking
kwargs: DescribeSnapshotScheduleInputRequestTypeDef = { # (1)
"VolumeARN": ...,
}
parent.describe_snapshot_schedule(**kwargs)
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)
...
# describe_stored_iscsi_volumes method usage example with argument unpacking
kwargs: DescribeStorediSCSIVolumesInputRequestTypeDef = { # (1)
"VolumeARNs": ...,
}
parent.describe_stored_iscsi_volumes(**kwargs)
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)
...
# describe_tape_archives method usage example with argument unpacking
kwargs: DescribeTapeArchivesInputRequestTypeDef = { # (1)
"TapeARNs": ...,
}
parent.describe_tape_archives(**kwargs)
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)
...
# describe_tape_recovery_points method usage example with argument unpacking
kwargs: DescribeTapeRecoveryPointsInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_tape_recovery_points(**kwargs)
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)
...
# describe_tapes method usage example with argument unpacking
kwargs: DescribeTapesInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_tapes(**kwargs)
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)
...
# describe_upload_buffer method usage example with argument unpacking
kwargs: DescribeUploadBufferInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_upload_buffer(**kwargs)
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)
...
# describe_vtl_devices method usage example with argument unpacking
kwargs: DescribeVTLDevicesInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_vtl_devices(**kwargs)
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)
...
# describe_working_storage method usage example with argument unpacking
kwargs: DescribeWorkingStorageInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.describe_working_storage(**kwargs)
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)
...
# detach_volume method usage example with argument unpacking
kwargs: DetachVolumeInputRequestTypeDef = { # (1)
"VolumeARN": ...,
}
parent.detach_volume(**kwargs)
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)
...
# disable_gateway method usage example with argument unpacking
kwargs: DisableGatewayInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.disable_gateway(**kwargs)
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)
...
# disassociate_file_system method usage example with argument unpacking
kwargs: DisassociateFileSystemInputRequestTypeDef = { # (1)
"FileSystemAssociationARN": ...,
}
parent.disassociate_file_system(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
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:
...
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)
...
# join_domain method usage example with argument unpacking
kwargs: JoinDomainInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"DomainName": ...,
"UserName": ...,
"Password": ...,
}
parent.join_domain(**kwargs)
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)
...
# list_automatic_tape_creation_policies method usage example with argument unpacking
kwargs: ListAutomaticTapeCreationPoliciesInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.list_automatic_tape_creation_policies(**kwargs)
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)
...
# list_file_shares method usage example with argument unpacking
kwargs: ListFileSharesInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.list_file_shares(**kwargs)
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)
...
# list_file_system_associations method usage example with argument unpacking
kwargs: ListFileSystemAssociationsInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.list_file_system_associations(**kwargs)
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)
...
# list_gateways method usage example with argument unpacking
kwargs: ListGatewaysInputRequestTypeDef = { # (1)
"Marker": ...,
}
parent.list_gateways(**kwargs)
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)
...
# list_local_disks method usage example with argument unpacking
kwargs: ListLocalDisksInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.list_local_disks(**kwargs)
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)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
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)
...
# list_tape_pools method usage example with argument unpacking
kwargs: ListTapePoolsInputRequestTypeDef = { # (1)
"PoolARNs": ...,
}
parent.list_tape_pools(**kwargs)
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)
...
# list_tapes method usage example with argument unpacking
kwargs: ListTapesInputRequestTypeDef = { # (1)
"TapeARNs": ...,
}
parent.list_tapes(**kwargs)
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)
...
# list_volume_initiators method usage example with argument unpacking
kwargs: ListVolumeInitiatorsInputRequestTypeDef = { # (1)
"VolumeARN": ...,
}
parent.list_volume_initiators(**kwargs)
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)
...
# list_volume_recovery_points method usage example with argument unpacking
kwargs: ListVolumeRecoveryPointsInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.list_volume_recovery_points(**kwargs)
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)
...
# list_volumes method usage example with argument unpacking
kwargs: ListVolumesInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.list_volumes(**kwargs)
notify_when_uploaded#
Sends you notification through CloudWatch Events 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)
...
# notify_when_uploaded method usage example with argument unpacking
kwargs: NotifyWhenUploadedInputRequestTypeDef = { # (1)
"FileShareARN": ...,
}
parent.notify_when_uploaded(**kwargs)
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)
...
# refresh_cache method usage example with argument unpacking
kwargs: RefreshCacheInputRequestTypeDef = { # (1)
"FileShareARN": ...,
}
parent.refresh_cache(**kwargs)
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)
...
# remove_tags_from_resource method usage example with argument unpacking
kwargs: RemoveTagsFromResourceInputRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.remove_tags_from_resource(**kwargs)
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)
...
# reset_cache method usage example with argument unpacking
kwargs: ResetCacheInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.reset_cache(**kwargs)
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)
...
# retrieve_tape_archive method usage example with argument unpacking
kwargs: RetrieveTapeArchiveInputRequestTypeDef = { # (1)
"TapeARN": ...,
"GatewayARN": ...,
}
parent.retrieve_tape_archive(**kwargs)
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)
...
# retrieve_tape_recovery_point method usage example with argument unpacking
kwargs: RetrieveTapeRecoveryPointInputRequestTypeDef = { # (1)
"TapeARN": ...,
"GatewayARN": ...,
}
parent.retrieve_tape_recovery_point(**kwargs)
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)
...
# set_local_console_password method usage example with argument unpacking
kwargs: SetLocalConsolePasswordInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"LocalConsolePassword": ...,
}
parent.set_local_console_password(**kwargs)
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)
...
# set_smb_guest_password method usage example with argument unpacking
kwargs: SetSMBGuestPasswordInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"Password": ...,
}
parent.set_smb_guest_password(**kwargs)
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)
...
# shutdown_gateway method usage example with argument unpacking
kwargs: ShutdownGatewayInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.shutdown_gateway(**kwargs)
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)
...
# start_availability_monitor_test method usage example with argument unpacking
kwargs: StartAvailabilityMonitorTestInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.start_availability_monitor_test(**kwargs)
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)
...
# start_gateway method usage example with argument unpacking
kwargs: StartGatewayInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.start_gateway(**kwargs)
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)
...
# update_automatic_tape_creation_policy method usage example with argument unpacking
kwargs: UpdateAutomaticTapeCreationPolicyInputRequestTypeDef = { # (1)
"AutomaticTapeCreationRules": ...,
"GatewayARN": ...,
}
parent.update_automatic_tape_creation_policy(**kwargs)
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)
...
# update_bandwidth_rate_limit method usage example with argument unpacking
kwargs: UpdateBandwidthRateLimitInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.update_bandwidth_rate_limit(**kwargs)
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[BandwidthRateLimitIntervalTypeDef], # (1)
) -> UpdateBandwidthRateLimitScheduleOutputTypeDef: # (2)
...
# update_bandwidth_rate_limit_schedule method usage example with argument unpacking
kwargs: UpdateBandwidthRateLimitScheduleInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"BandwidthRateLimitIntervals": ...,
}
parent.update_bandwidth_rate_limit_schedule(**kwargs)
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)
...
# update_chap_credentials method usage example with argument unpacking
kwargs: UpdateChapCredentialsInputRequestTypeDef = { # (1)
"TargetARN": ...,
"SecretToAuthenticateInitiator": ...,
"InitiatorName": ...,
}
parent.update_chap_credentials(**kwargs)
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)
...
# update_file_system_association method usage example with argument unpacking
kwargs: UpdateFileSystemAssociationInputRequestTypeDef = { # (1)
"FileSystemAssociationARN": ...,
}
parent.update_file_system_association(**kwargs)
update_gateway_information#
Updates a gateway's metadata, which includes the gateway's name and time zone.
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)
...
# update_gateway_information method usage example with argument unpacking
kwargs: UpdateGatewayInformationInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.update_gateway_information(**kwargs)
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)
...
# update_gateway_software_now method usage example with argument unpacking
kwargs: UpdateGatewaySoftwareNowInputRequestTypeDef = { # (1)
"GatewayARN": ...,
}
parent.update_gateway_software_now(**kwargs)
update_maintenance_start_time#
Updates a gateway's weekly maintenance start time information, including day and time of the week.
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 = ...,
) -> UpdateMaintenanceStartTimeOutputTypeDef: # (1)
...
# update_maintenance_start_time method usage example with argument unpacking
kwargs: UpdateMaintenanceStartTimeInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"HourOfDay": ...,
"MinuteOfHour": ...,
}
parent.update_maintenance_start_time(**kwargs)
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,
KMSEncrypted: bool = ...,
KMSKey: str = ...,
NFSFileShareDefaults: NFSFileShareDefaultsTypeDef = ..., # (1)
DefaultStorageClass: str = ...,
ObjectACL: ObjectACLType = ..., # (2)
ClientList: Sequence[str] = ...,
Squash: str = ...,
ReadOnly: bool = ...,
GuessMIMETypeEnabled: bool = ...,
RequesterPays: bool = ...,
FileShareName: str = ...,
CacheAttributes: CacheAttributesTypeDef = ..., # (3)
NotificationPolicy: str = ...,
AuditDestinationARN: str = ...,
) -> UpdateNFSFileShareOutputTypeDef: # (4)
...
- See NFSFileShareDefaultsTypeDef
- See ObjectACLType
- See CacheAttributesTypeDef
- See UpdateNFSFileShareOutputTypeDef
# update_nfs_file_share method usage example with argument unpacking
kwargs: UpdateNFSFileShareInputRequestTypeDef = { # (1)
"FileShareARN": ...,
}
parent.update_nfs_file_share(**kwargs)
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,
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 = ...,
CaseSensitivity: CaseSensitivityType = ..., # (2)
FileShareName: str = ...,
CacheAttributes: CacheAttributesTypeDef = ..., # (3)
NotificationPolicy: str = ...,
OplocksEnabled: bool = ...,
) -> UpdateSMBFileShareOutputTypeDef: # (4)
...
- See ObjectACLType
- See CaseSensitivityType
- See CacheAttributesTypeDef
- See UpdateSMBFileShareOutputTypeDef
# update_smb_file_share method usage example with argument unpacking
kwargs: UpdateSMBFileShareInputRequestTypeDef = { # (1)
"FileShareARN": ...,
}
parent.update_smb_file_share(**kwargs)
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)
...
# update_smb_file_share_visibility method usage example with argument unpacking
kwargs: UpdateSMBFileShareVisibilityInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"FileSharesVisible": ...,
}
parent.update_smb_file_share_visibility(**kwargs)
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: SMBLocalGroupsTypeDef, # (1)
) -> UpdateSMBLocalGroupsOutputTypeDef: # (2)
...
# update_smb_local_groups method usage example with argument unpacking
kwargs: UpdateSMBLocalGroupsInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"SMBLocalGroups": ...,
}
parent.update_smb_local_groups(**kwargs)
update_smb_security_strategy#
Updates the SMB security strategy on a 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)
...
# update_smb_security_strategy method usage example with argument unpacking
kwargs: UpdateSMBSecurityStrategyInputRequestTypeDef = { # (1)
"GatewayARN": ...,
"SMBSecurityStrategy": ...,
}
parent.update_smb_security_strategy(**kwargs)
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)
...
# update_snapshot_schedule method usage example with argument unpacking
kwargs: UpdateSnapshotScheduleInputRequestTypeDef = { # (1)
"VolumeARN": ...,
"StartAt": ...,
"RecurrenceInHours": ...,
}
parent.update_snapshot_schedule(**kwargs)
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)
...
# update_vtl_device_type method usage example with argument unpacking
kwargs: UpdateVTLDeviceTypeInputRequestTypeDef = { # (1)
"VTLDeviceARN": ...,
"DeviceType": ...,
}
parent.update_vtl_device_type(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("storagegateway").get_paginator
method with overloads.
client.get_paginator("describe_tape_archives")
-> DescribeTapeArchivesPaginatorclient.get_paginator("describe_tape_recovery_points")
-> DescribeTapeRecoveryPointsPaginatorclient.get_paginator("describe_tapes")
-> DescribeTapesPaginatorclient.get_paginator("describe_vtl_devices")
-> DescribeVTLDevicesPaginatorclient.get_paginator("list_file_shares")
-> ListFileSharesPaginatorclient.get_paginator("list_file_system_associations")
-> ListFileSystemAssociationsPaginatorclient.get_paginator("list_gateways")
-> ListGatewaysPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginatorclient.get_paginator("list_tape_pools")
-> ListTapePoolsPaginatorclient.get_paginator("list_tapes")
-> ListTapesPaginatorclient.get_paginator("list_volumes")
-> ListVolumesPaginator