Table of Contents
StorageGateway.
Client
¶A low-level client representing AWS Storage Gateway:
import boto3
client = boto3.client('storagegateway')
These are the available methods:
activate_gateway()
add_cache()
add_upload_buffer()
add_working_storage()
can_paginate()
cancel_archival()
cancel_retrieval()
create_cached_iscsi_volume()
create_snapshot()
create_snapshot_from_volume_recovery_point()
create_stored_iscsi_volume()
create_tapes()
delete_bandwidth_rate_limit()
delete_chap_credentials()
delete_gateway()
delete_snapshot_schedule()
delete_tape()
delete_tape_archive()
delete_volume()
describe_bandwidth_rate_limit()
describe_cache()
describe_cached_iscsi_volumes()
describe_chap_credentials()
describe_gateway_information()
describe_maintenance_start_time()
describe_snapshot_schedule()
describe_stored_iscsi_volumes()
describe_tape_archives()
describe_tape_recovery_points()
describe_tapes()
describe_upload_buffer()
describe_vtl_devices()
describe_working_storage()
disable_gateway()
generate_presigned_url()
get_paginator()
get_waiter()
list_gateways()
list_local_disks()
list_volume_initiators()
list_volume_recovery_points()
list_volumes()
reset_cache()
retrieve_tape_archive()
retrieve_tape_recovery_point()
shutdown_gateway()
start_gateway()
update_bandwidth_rate_limit()
update_chap_credentials()
update_gateway_information()
update_gateway_software_now()
update_maintenance_start_time()
update_snapshot_schedule()
update_vtl_device_type()
activate_gateway
(**kwargs)¶This operation activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway . In the activation process, you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation .
Note
You must turn on the gateway VM before you can activate your gateway.
Request Syntax
response = client.activate_gateway(
ActivationKey='string',
GatewayName='string',
GatewayTimezone='string',
GatewayRegion='string',
GatewayType='string',
TapeDriveType='string',
MediumChangerType='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string'
}
Response Structure
|
add_cache
(**kwargs)¶This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts ).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
Request Syntax
response = client.add_cache(
GatewayARN='string',
DiskIds=[
'string',
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string'
}
Response Structure
|
add_upload_buffer
(**kwargs)¶This operation configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
Request Syntax
response = client.add_upload_buffer(
GatewayARN='string',
DiskIds=[
'string',
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string'
}
Response Structure
|
add_working_storage
(**kwargs)¶This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead.
Note
Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored-volume gateway.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.
Request Syntax
response = client.add_working_storage(
GatewayARN='string',
DiskIds=[
'string',
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string'
}
Response Structure
|
can_paginate
(operation_name)¶Check if an operation can be paginated.
Parameters: | operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo , and you'd normally invoke the
operation as client.create_foo(**kwargs) , if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo") . |
---|---|
Returns: | True if the operation can be paginated,
False otherwise. |
cancel_archival
(**kwargs)¶Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
Request Syntax
response = client.cancel_archival(
GatewayARN='string',
TapeARN='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TapeARN': 'string'
}
Response Structure
|
cancel_retrieval
(**kwargs)¶Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS.
Request Syntax
response = client.cancel_retrieval(
GatewayARN='string',
TapeARN='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TapeARN': 'string'
}
Response Structure
|
create_cached_iscsi_volume
(**kwargs)¶This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.
Note
Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.
In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
Request Syntax
response = client.create_cached_iscsi_volume(
GatewayARN='string',
VolumeSizeInBytes=123,
SnapshotId='string',
TargetName='string',
NetworkInterfaceId='string',
ClientToken='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'VolumeARN': 'string',
'TargetARN': 'string'
}
Response Structure
|
create_snapshot
(**kwargs)¶This operation initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console .
In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference .
Request Syntax
response = client.create_snapshot(
VolumeARN='string',
SnapshotDescription='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'VolumeARN': 'string',
'SnapshotId': 'string'
}
Response Structure
|
create_snapshot_from_volume_recovery_point
(**kwargs)¶This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).
A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use ListVolumeRecoveryPoints .
In the CreateSnapshotFromVolumeRecoveryPoint
request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference .
Request Syntax
response = client.create_snapshot_from_volume_recovery_point(
VolumeARN='string',
SnapshotDescription='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'SnapshotId': 'string',
'VolumeARN': 'string',
'VolumeRecoveryPointTime': 'string'
}
Response Structure
|
create_stored_iscsi_volume
(**kwargs)¶This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.
The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.
In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
Request Syntax
response = client.create_stored_iscsi_volume(
GatewayARN='string',
DiskId='string',
SnapshotId='string',
PreserveExistingData=True|False,
TargetName='string',
NetworkInterfaceId='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'VolumeARN': 'string',
'VolumeSizeInBytes': 123,
'TargetARN': 'string'
}
Response Structure
|
create_tapes
(**kwargs)¶Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.
Note
Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
Request Syntax
response = client.create_tapes(
GatewayARN='string',
TapeSizeInBytes=123,
ClientToken='string',
NumTapesToCreate=123,
TapeBarcodePrefix='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TapeARNs': [
'string',
]
}
Response Structure
|
delete_bandwidth_rate_limit
(**kwargs)¶This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
response = client.delete_bandwidth_rate_limit(
GatewayARN='string',
BandwidthType='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string'
}
Response Structure
|
delete_chap_credentials
(**kwargs)¶This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
Request Syntax
response = client.delete_chap_credentials(
TargetARN='string',
InitiatorName='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TargetARN': 'string',
'InitiatorName': 'string'
}
Response Structure
|
delete_gateway
(**kwargs)¶This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.
After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.
Warning
You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page .
Request Syntax
response = client.delete_gateway(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string'
}
Response Structure
|
delete_snapshot_schedule
(**kwargs)¶This operation deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots . In the DeleteSnapshotSchedule
request, you identify the volume by providing its Amazon Resource Name (ARN).
Note
To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference .
Request Syntax
response = client.delete_snapshot_schedule(
VolumeARN='string'
)
Parameters: | VolumeARN (string) -- [REQUIRED] |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'VolumeARN': 'string'
}
Response Structure
|
delete_tape
(**kwargs)¶Deletes the specified virtual tape.
Request Syntax
response = client.delete_tape(
GatewayARN='string',
TapeARN='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TapeARN': 'string'
}
Response Structure
|
delete_tape_archive
(**kwargs)¶Deletes the specified virtual tape from the virtual tape shelf (VTS).
Request Syntax
response = client.delete_tape_archive(
TapeARN='string'
)
Parameters: | TapeARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS). |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'TapeARN': 'string'
}
Response Structure
|
delete_volume
(**kwargs)¶This operation delete the specified gateway volume that you previously created using the CreateStorediSCSIVolume API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.
Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .
In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
Request Syntax
response = client.delete_volume(
VolumeARN='string'
)
Parameters: | VolumeARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'VolumeARN': 'string'
}
Response Structure
|
describe_bandwidth_rate_limit
(**kwargs)¶This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
response = client.describe_bandwidth_rate_limit(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string',
'AverageUploadRateLimitInBitsPerSec': 123,
'AverageDownloadRateLimitInBitsPerSec': 123
}
Response Structure
|
describe_cache
(**kwargs)¶This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
Request Syntax
response = client.describe_cache(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'CacheAllocatedInBytes': 123,
'CacheUsedPercentage': 123.0,
'CacheDirtyPercentage': 123.0,
'CacheHitPercentage': 123.0,
'CacheMissPercentage': 123.0
}
Response Structure
|
describe_cached_iscsi_volumes
(**kwargs)¶This operation returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.
The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
Request Syntax
response = client.describe_cached_iscsi_volumes(
VolumeARNs=[
'string',
]
)
Parameters: | VolumeARNs (list) -- [REQUIRED]
|
---|---|
Return type: | dict |
Returns: | Response Syntax{
'CachediSCSIVolumes': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'VolumeType': 'string',
'VolumeStatus': 'string',
'VolumeSizeInBytes': 123,
'VolumeProgress': 123.0,
'SourceSnapshotId': 'string',
'VolumeiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'LunNumber': 123,
'ChapEnabled': True|False
}
},
]
}
Response Structure
|
describe_chap_credentials
(**kwargs)¶This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
Request Syntax
response = client.describe_chap_credentials(
TargetARN='string'
)
Parameters: | TargetARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'ChapCredentials': [
{
'TargetARN': 'string',
'SecretToAuthenticateInitiator': 'string',
'InitiatorName': 'string',
'SecretToAuthenticateTarget': 'string'
},
]
}
Response Structure
|
describe_gateway_information
(**kwargs)¶This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
response = client.describe_gateway_information(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string',
'GatewayId': 'string',
'GatewayTimezone': 'string',
'GatewayState': 'string',
'GatewayNetworkInterfaces': [
{
'Ipv4Address': 'string',
'MacAddress': 'string',
'Ipv6Address': 'string'
},
],
'GatewayType': 'string',
'NextUpdateAvailabilityDate': 'string',
'LastSoftwareUpdate': 'string'
}
Response Structure
|
describe_maintenance_start_time
(**kwargs)¶This operation returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
Request Syntax
response = client.describe_maintenance_start_time(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string',
'HourOfDay': 123,
'MinuteOfHour': 123,
'DayOfWeek': 123,
'Timezone': 'string'
}
Response Structure
|
describe_snapshot_schedule
(**kwargs)¶This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.
Request Syntax
response = client.describe_snapshot_schedule(
VolumeARN='string'
)
Parameters: | VolumeARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'VolumeARN': 'string',
'StartAt': 123,
'RecurrenceInHours': 123,
'Description': 'string',
'Timezone': 'string'
}
Response Structure
|
describe_stored_iscsi_volumes
(**kwargs)¶This operation returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs.
Request Syntax
response = client.describe_stored_iscsi_volumes(
VolumeARNs=[
'string',
]
)
Parameters: | VolumeARNs (list) -- [REQUIRED] An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
|
---|---|
Return type: | dict |
Returns: | Response Syntax{
'StorediSCSIVolumes': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'VolumeType': 'string',
'VolumeStatus': 'string',
'VolumeSizeInBytes': 123,
'VolumeProgress': 123.0,
'VolumeDiskId': 'string',
'SourceSnapshotId': 'string',
'PreservedExistingData': True|False,
'VolumeiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'LunNumber': 123,
'ChapEnabled': True|False
}
},
]
}
Response Structure
|
describe_tape_archives
(**kwargs)¶Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
If a specific TapeARN
is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
Request Syntax
response = client.describe_tape_archives(
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TapeArchives': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'CompletionTime': datetime(2015, 1, 1),
'RetrievedTo': 'string',
'TapeStatus': 'string'
},
],
'Marker': 'string'
}
Response Structure
|
describe_tape_recovery_points
(**kwargs)¶Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
Request Syntax
response = client.describe_tape_recovery_points(
GatewayARN='string',
Marker='string',
Limit=123
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string',
'TapeRecoveryPointInfos': [
{
'TapeARN': 'string',
'TapeRecoveryPointTime': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string'
},
],
'Marker': 'string'
}
Response Structure
|
describe_tapes
(**kwargs)¶Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN
is not specified, returns a description of all virtual tapes associated with the specified gateway.
Request Syntax
response = client.describe_tapes(
GatewayARN='string',
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'Tapes': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'VTLDevice': 'string',
'Progress': 123.0
},
],
'Marker': 'string'
}
Response Structure
|
describe_upload_buffer
(**kwargs)¶This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
Request Syntax
response = client.describe_upload_buffer(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'UploadBufferUsedInBytes': 123,
'UploadBufferAllocatedInBytes': 123
}
Response Structure
|
describe_vtl_devices
(**kwargs)¶Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.
The list of VTL devices must be from one gateway.
Request Syntax
response = client.describe_vtl_devices(
GatewayARN='string',
VTLDeviceARNs=[
'string',
],
Marker='string',
Limit=123
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string',
'VTLDevices': [
{
'VTLDeviceARN': 'string',
'VTLDeviceType': 'string',
'VTLDeviceVendor': 'string',
'VTLDeviceProductIdentifier': 'string',
'DeviceiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'ChapEnabled': True|False
}
},
],
'Marker': 'string'
}
Response Structure
|
describe_working_storage
(**kwargs)¶This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.
Note
Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway.
The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
Request Syntax
response = client.describe_working_storage(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'WorkingStorageUsedInBytes': 123,
'WorkingStorageAllocatedInBytes': 123
}
Response Structure
|
disable_gateway
(**kwargs)¶Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a gateway-VTL that is not reachable or not functioning.
Warning
Once a gateway is disabled it cannot be enabled.
Request Syntax
response = client.disable_gateway(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string'
}
Response Structure
|
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
Parameters: |
|
---|---|
Returns: | The presigned url |
get_paginator
(operation_name)¶Create a paginator for an operation.
Parameters: | operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo , and you'd normally invoke the
operation as client.create_foo(**kwargs) , if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo") . |
---|---|
Raises OperationNotPageableError: | |
Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
|
Return type: | L{botocore.paginate.Paginator} |
Returns: | A paginator object. |
get_waiter
(waiter_name)¶list_gateways
(**kwargs)¶This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways.
Request Syntax
response = client.list_gateways(
Marker='string',
Limit=123
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'Gateways': [
{
'GatewayARN': 'string',
'GatewayType': 'string',
'GatewayOperationalState': 'string'
},
],
'Marker': 'string'
}
Response Structure
|
list_local_disks
(**kwargs)¶This operation returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.
The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus
field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
Request Syntax
response = client.list_local_disks(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string',
'Disks': [
{
'DiskId': 'string',
'DiskPath': 'string',
'DiskNode': 'string',
'DiskStatus': 'string',
'DiskSizeInBytes': 123,
'DiskAllocationType': 'string',
'DiskAllocationResource': 'string'
},
]
}
Response Structure
|
list_volume_initiators
(**kwargs)¶This operation lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.
Request Syntax
response = client.list_volume_initiators(
VolumeARN='string'
)
Parameters: | VolumeARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'Initiators': [
'string',
]
}
Response Structure
|
list_volume_recovery_points
(**kwargs)¶This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.
Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
Request Syntax
response = client.list_volume_recovery_points(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string',
'VolumeRecoveryPointInfos': [
{
'VolumeARN': 'string',
'VolumeSizeInBytes': 123,
'VolumeUsageInBytes': 123,
'VolumeRecoveryPointTime': 'string'
},
]
}
Response Structure
|
list_volumes
(**kwargs)¶This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit
field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.
Request Syntax
response = client.list_volumes(
GatewayARN='string',
Marker='string',
Limit=123
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string',
'Marker': 'string',
'VolumeInfos': [
{
'VolumeARN': 'string',
'VolumeType': 'string'
},
]
}
Response Structure
|
reset_cache
(**kwargs)¶This operation resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks.
Warning
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
Request Syntax
response = client.reset_cache(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string'
}
Response Structure
|
retrieve_tape_archive
(**kwargs)¶Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS.
Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway.
Request Syntax
response = client.retrieve_tape_archive(
TapeARN='string',
GatewayARN='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TapeARN': 'string'
}
Response Structure
|
retrieve_tape_recovery_point
(**kwargs)¶Retrieves the recovery point for the specified virtual tape.
A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
Note
The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.
Request Syntax
response = client.retrieve_tape_recovery_point(
TapeARN='string',
GatewayARN='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TapeARN': 'string'
}
Response Structure
|
shutdown_gateway
(**kwargs)¶This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.
Note
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway , DescribeGatewayInformation , and ListGateways . For more information, see ActivateGateway . Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
Note
When you make a shutdown request, you will get a 200 OK
success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway .
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway ) to no longer pay software charges associated with the gateway.
Request Syntax
response = client.shutdown_gateway(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string'
}
Response Structure
|
start_gateway
(**kwargs)¶This operation starts a gateway that you previously shut down (see ShutdownGateway ). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.
Note
When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway .
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
response = client.start_gateway(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string'
}
Response Structure
|
update_bandwidth_rate_limit
(**kwargs)¶This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
response = client.update_bandwidth_rate_limit(
GatewayARN='string',
AverageUploadRateLimitInBitsPerSec=123,
AverageDownloadRateLimitInBitsPerSec=123
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string'
}
Response Structure
|
update_chap_credentials
(**kwargs)¶This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.
Warning
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
Request Syntax
response = client.update_chap_credentials(
TargetARN='string',
SecretToAuthenticateInitiator='string',
InitiatorName='string',
SecretToAuthenticateTarget='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TargetARN': 'string',
'InitiatorName': 'string'
}
Response Structure
|
update_gateway_information
(**kwargs)¶This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
Request Syntax
response = client.update_gateway_information(
GatewayARN='string',
GatewayName='string',
GatewayTimezone='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string'
}
Response Structure
|
update_gateway_software_now
(**kwargs)¶This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
Note
When you make this request, you get a 200 OK
success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING
state.
Warning
A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings , respectively.
Request Syntax
response = client.update_gateway_software_now(
GatewayARN='string'
)
Parameters: | GatewayARN (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'GatewayARN': 'string'
}
Response Structure
|
update_maintenance_start_time
(**kwargs)¶This operation updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
Request Syntax
response = client.update_maintenance_start_time(
GatewayARN='string',
HourOfDay=123,
MinuteOfHour=123,
DayOfWeek=123
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string'
}
Response Structure
|
update_snapshot_schedule
(**kwargs)¶This operation updates a snapshot schedule configured for a gateway volume.
The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.
In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
Request Syntax
response = client.update_snapshot_schedule(
VolumeARN='string',
StartAt=123,
RecurrenceInHours=123,
Description='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'VolumeARN': 'string'
}
Response Structure
|
update_vtl_device_type
(**kwargs)¶This operation updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated.
Request Syntax
response = client.update_vtl_device_type(
VTLDeviceARN='string',
DeviceType='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'VTLDeviceARN': 'string'
}
Response Structure
|
The available paginators are:
StorageGateway.Paginator.describe_tape_archives
StorageGateway.Paginator.describe_tape_recovery_points
StorageGateway.Paginator.describe_tapes
StorageGateway.Paginator.describe_vtl_devices
StorageGateway.Paginator.list_gateways
StorageGateway.Paginator.list_volumes
StorageGateway.Paginator.
describe_tape_archives
¶paginator = client.get_paginator('describe_tape_archives')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.describe_tape_archives()
.
Request Syntax
response_iterator = paginator.paginate(
TapeARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'TapeArchives': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'CompletionTime': datetime(2015, 1, 1),
'RetrievedTo': 'string',
'TapeStatus': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
StorageGateway.Paginator.
describe_tape_recovery_points
¶paginator = client.get_paginator('describe_tape_recovery_points')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.describe_tape_recovery_points()
.
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string',
'TapeRecoveryPointInfos': [
{
'TapeARN': 'string',
'TapeRecoveryPointTime': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
StorageGateway.Paginator.
describe_tapes
¶paginator = client.get_paginator('describe_tapes')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.describe_tapes()
.
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
TapeARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'Tapes': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'VTLDevice': 'string',
'Progress': 123.0
},
],
'NextToken': 'string'
}
Response Structure
|
StorageGateway.Paginator.
describe_vtl_devices
¶paginator = client.get_paginator('describe_vtl_devices')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.describe_vtl_devices()
.
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
VTLDeviceARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string',
'VTLDevices': [
{
'VTLDeviceARN': 'string',
'VTLDeviceType': 'string',
'VTLDeviceVendor': 'string',
'VTLDeviceProductIdentifier': 'string',
'DeviceiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'ChapEnabled': True|False
}
},
],
'NextToken': 'string'
}
Response Structure
|
StorageGateway.Paginator.
list_gateways
¶paginator = client.get_paginator('list_gateways')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.list_gateways()
.
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters: | PaginationConfig (dict) -- A dictionary that provides parameters to control pagination.
|
---|---|
Return type: | dict |
Returns: | Response Syntax{
'Gateways': [
{
'GatewayARN': 'string',
'GatewayType': 'string',
'GatewayOperationalState': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
StorageGateway.Paginator.
list_volumes
¶paginator = client.get_paginator('list_volumes')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.list_volumes()
.
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'GatewayARN': 'string',
'VolumeInfos': [
{
'VolumeARN': 'string',
'VolumeType': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|