Table of Contents
StorageGateway.Client¶A low-level client representing AWS Storage Gateway
Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the Amazon Web Services storage infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the Storage Gateway Service API Reference :
Note
Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670 . When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670 . Otherwise, the EC2 API might not behave as expected.
Warning
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS resource IDs .
For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:
arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee .
For more information, see Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016 .
import boto3
client = boto3.client('storagegateway')
These are the available methods:
activate_gateway()add_cache()add_tags_to_resource()add_upload_buffer()add_working_storage()assign_tape_pool()associate_file_system()attach_volume()can_paginate()cancel_archival()cancel_retrieval()close()create_cached_iscsi_volume()create_nfs_file_share()create_smb_file_share()create_snapshot()create_snapshot_from_volume_recovery_point()create_stored_iscsi_volume()create_tape_pool()create_tape_with_barcode()create_tapes()delete_automatic_tape_creation_policy()delete_bandwidth_rate_limit()delete_chap_credentials()delete_file_share()delete_gateway()delete_snapshot_schedule()delete_tape()delete_tape_archive()delete_tape_pool()delete_volume()describe_availability_monitor_test()describe_bandwidth_rate_limit()describe_bandwidth_rate_limit_schedule()describe_cache()describe_cached_iscsi_volumes()describe_chap_credentials()describe_file_system_associations()describe_gateway_information()describe_maintenance_start_time()describe_nfs_file_shares()describe_smb_file_shares()describe_smb_settings()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()detach_volume()disable_gateway()disassociate_file_system()get_paginator()get_waiter()join_domain()list_automatic_tape_creation_policies()list_file_shares()list_file_system_associations()list_gateways()list_local_disks()list_tags_for_resource()list_tape_pools()list_tapes()list_volume_initiators()list_volume_recovery_points()list_volumes()notify_when_uploaded()refresh_cache()remove_tags_from_resource()reset_cache()retrieve_tape_archive()retrieve_tape_recovery_point()set_local_console_password()set_smb_guest_password()shutdown_gateway()start_availability_monitor_test()start_gateway()update_automatic_tape_creation_policy()update_bandwidth_rate_limit()update_bandwidth_rate_limit_schedule()update_chap_credentials()update_file_system_association()update_gateway_information()update_gateway_software_now()update_maintenance_start_time()update_nfs_file_share()update_smb_file_share()update_smb_file_share_visibility()update_smb_local_groups()update_smb_security_strategy()update_snapshot_schedule()update_vtl_device_type()activate_gateway(**kwargs)¶Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the Amazon Web Services Region that you want to use for storing snapshots or tapes, 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.
See also: AWS API Documentation
Request Syntax
response = client.activate_gateway(
ActivationKey='string',
GatewayName='string',
GatewayTimezone='string',
GatewayRegion='string',
GatewayType='string',
TapeDriveType='string',
MediumChangerType='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey . It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.
For more information, see Getting activation key in the Storage Gateway User Guide .
[REQUIRED]
The name you configured for your gateway.
[REQUIRED]
A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
[REQUIRED]
A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference .
Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference .
A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED .
Valid Values: STORED | CACHED | VTL | VTL_SNOW | FILE_S3 | FILE_FSX_SMB
The value that indicates the type of tape drive to use for tape gateway. This field is optional.
Valid Values: IBM-ULT3580-TD5
The value that indicates the type of medium changer to use for tape gateway. This field is optional.
Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and Amazon Web Services Region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.
Note
For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Activates the gateway you previously deployed on your host.
response = client.activate_gateway(
ActivationKey='29AV1-3OFV9-VVIUB-NKT0I-LRO6V',
GatewayName='My_Gateway',
GatewayRegion='us-east-1',
GatewayTimezone='GMT-12:00',
GatewayType='STORED',
MediumChangerType='AWS-Gateway-VTL',
TapeDriveType='IBM-ULT3580-TD5',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
'ResponseMetadata': {
'...': '...',
},
}
add_cache(**kwargs)¶Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture) .
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.
See also: AWS API Documentation
Request Syntax
response = client.add_cache(
GatewayARN='string',
DiskIds=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
The following example shows a request that activates a gateway-stored volume.
response = client.add_cache(
DiskIds=[
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:03:00.0-scsi-0:0:1:0',
],
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following Storage Gateway resources:
You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you want to add tags to.
[REQUIRED]
The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'ResourceARN': 'string'
}
Response Structure
(dict) --
AddTagsToResourceOutput
ResourceARN (string) --
The Amazon Resource Name (ARN) of the resource you want to add tags to.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Adds one or more tags to the specified resource.
response = client.add_tags_to_resource(
ResourceARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
Tags=[
{
'Key': 'Dev Gatgeway Region',
'Value': 'East Coast',
},
],
)
print(response)
Expected Output:
{
'ResourceARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
'ResponseMetadata': {
'...': '...',
},
}
add_upload_buffer(**kwargs)¶Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.
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.
See also: AWS API Documentation
Request Syntax
response = client.add_upload_buffer(
GatewayARN='string',
DiskIds=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Configures one or more gateway local disks as upload buffer for a specified gateway.
response = client.add_upload_buffer(
DiskIds=[
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:03:00.0-scsi-0:0:1:0',
],
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
add_working_storage(**kwargs)¶Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume 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.
See also: AWS API Documentation
Request Syntax
response = client.add_working_storage(
GatewayARN='string',
DiskIds=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)
response = client.add_working_storage(
DiskIds=[
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:03:00.0-scsi-0:0:1:0',
],
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
assign_tape_pool(**kwargs)¶Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
See also: AWS API Documentation
Request Syntax
response = client.assign_tape_pool(
TapeARN='string',
PoolId='string',
BypassGovernanceRetention=True|False
)
[REQUIRED]
The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.
[REQUIRED]
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Set permissions to bypass governance retention. If the lock type of the archived tape is Governance , the tape's archived age is not older than RetentionLockInDays , and the user does not already have BypassGovernanceRetention , setting this to TRUE enables the user to bypass the retention lock. This parameter is set to true by default for calls from the console.
Valid values: TRUE | FALSE
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
TapeARN (string) --
The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorassociate_file_system(**kwargs)¶Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.
See also: AWS API Documentation
Request Syntax
response = client.associate_file_system(
UserName='string',
Password='string',
ClientToken='string',
GatewayARN='string',
LocationARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
AuditDestinationARN='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
EndpointNetworkConfiguration={
'IpAddresses': [
'string',
]
}
)
[REQUIRED]
The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
[REQUIRED]
The password of the user credential.
[REQUIRED]
A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
The refresh cache information for the file share or FSx file systems.
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
Specifies the network configuration information for the gateway associated with the Amazon FSx file system.
Note
If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.
A list of gateway IP addresses on which the associated Amazon FSx file system is available.
Note
If multiple file systems are associated with this gateway, this field is required.
dict
Response Syntax
{
'FileSystemAssociationARN': 'string'
}
Response Structure
(dict) --
FileSystemAssociationARN (string) --
The ARN of the newly created file system association.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorattach_volume(**kwargs)¶Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
See also: AWS API Documentation
Request Syntax
response = client.attach_volume(
GatewayARN='string',
TargetName='string',
VolumeARN='string',
NetworkInterfaceId='string',
DiskId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
[REQUIRED]
The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
[REQUIRED]
The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
dict
Response Syntax
{
'VolumeARN': 'string',
'TargetARN': 'string'
}
Response Structure
(dict) --
AttachVolumeOutput
VolumeARN (string) --
The Amazon Resource Name (ARN) of the volume that was attached to the gateway.
TargetARN (string) --
The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorcan_paginate(operation_name)¶Check if an operation can be paginated.
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").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. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.cancel_archival(
GatewayARN='string',
TapeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
CancelArchivalOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
response = client.cancel_archival(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
'ResponseMetadata': {
'...': '...',
},
}
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. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.cancel_retrieval(
GatewayARN='string',
TapeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
CancelRetrievalOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.
response = client.cancel_retrieval(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
'ResponseMetadata': {
'...': '...',
},
}
close()¶Closes underlying endpoint connections.
create_cached_iscsi_volume(**kwargs)¶Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.
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, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.
See also: AWS API Documentation
Request Syntax
response = client.create_cached_iscsi_volume(
GatewayARN='string',
VolumeSizeInBytes=123,
SnapshotId='string',
TargetName='string',
SourceVolumeARN='string',
NetworkInterfaceId='string',
ClientToken='string',
KMSEncrypted=True|False,
KMSKey='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The size of the volume in bytes.
[REQUIRED]
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.[REQUIRED]
The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
[REQUIRED]
A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
KMSEncrypted is true . Optional.A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'VolumeARN': 'string',
'TargetARN': 'string'
}
Response Structure
(dict) --
VolumeARN (string) --
The Amazon Resource Name (ARN) of the configured volume.
TargetARN (string) --
The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Creates a cached volume on a specified cached gateway.
response = client.create_cached_iscsi_volume(
ClientToken='cachedvol112233',
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
NetworkInterfaceId='10.1.1.1',
SnapshotId='snap-f47b7b94',
TargetName='my-volume',
VolumeSizeInBytes=536870912000,
)
print(response)
Expected Output:
{
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for S3 File Gateways.
Warning
S3 File gateway requires Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide .
S3 File Gateways do not support creating hard or symbolic links on a file share.
See also: AWS API Documentation
Request Syntax
response = client.create_nfs_file_share(
ClientToken='string',
NFSFileShareDefaults={
'FileMode': 'string',
'DirectoryMode': 'string',
'GroupId': 123,
'OwnerId': 123
},
GatewayARN='string',
KMSEncrypted=True|False,
KMSKey='string',
Role='string',
LocationARN='string',
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ClientList=[
'string',
],
Squash='string',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FileShareName='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
NotificationPolicy='string',
VPCEndpointDNSName='string',
BucketRegion='string',
AuditDestinationARN='string'
)
[REQUIRED]
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
File share default values. Optional.
The Unix file mode in the form "nnnn". For example, 0666 represents the default file mode inside the file share. The default value is 0666 .
The Unix directory mode in the form "nnnn". For example, 0666 represents the default access mode for all directories inside the file share. The default value is 0777 .
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody .
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody .
[REQUIRED]
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
KMSEncrypted is true . Optional.[REQUIRED]
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
[REQUIRED]
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
Note
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide .
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
private .The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
A value that maps a user to anonymous user.
Valid values are the following:
RootSquash : Only root is mapped to anonymous user.NoSquash : No one is mapped to anonymous user.AllSquash : Everyone is mapped to anonymous user.A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false . The default value is true .
Valid Values: true | false
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN , or if an access point or access point alias is used.
Specifies refresh cache information for the file share.
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
Note
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
Note
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Specifies the Region of the S3 bucket where the NFS file share stores files.
Note
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateNFSFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the newly created file share.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorCreates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for S3 File Gateways.
Warning
S3 File Gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide .
File gateways don't support creating hard or symbolic links on a file share.
See also: AWS API Documentation
Request Syntax
response = client.create_smb_file_share(
ClientToken='string',
GatewayARN='string',
KMSEncrypted=True|False,
KMSKey='string',
Role='string',
LocationARN='string',
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
SMBACLEnabled=True|False,
AccessBasedEnumeration=True|False,
AdminUserList=[
'string',
],
ValidUserList=[
'string',
],
InvalidUserList=[
'string',
],
AuditDestinationARN='string',
Authentication='string',
CaseSensitivity='ClientSpecified'|'CaseSensitive',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FileShareName='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
NotificationPolicy='string',
VPCEndpointDNSName='string',
BucketRegion='string',
OplocksEnabled=True|False
)
[REQUIRED]
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
[REQUIRED]
The ARN of the S3 File Gateway on which you want to create a file share.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
KMSEncrypted is true . Optional.[REQUIRED]
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
[REQUIRED]
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
Note
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide .
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
private .A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false . The default value is true .
Valid Values: true | false
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide .
Valid Values: true | false
A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 .
Warning
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
A list of users or groups in the Active Directory that are allowed to access the file ` share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
The authentication method that users use to access the file share. The default is ActiveDirectory .
Valid Values: ActiveDirectory | GuestAccess
ClientSpecified , the client determines the case sensitivity. For CaseSensitive , the gateway determines the case sensitivity. The default value is ClientSpecified .A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN , or if an access point or access point alias is used.
Specifies refresh cache information for the file share.
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
Note
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
Note
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Specifies the Region of the S3 bucket where the SMB file share stores files.
Note
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Specifies whether opportunistic locking is enabled for the SMB file share.
Note
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateSMBFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the newly created file share.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorcreate_snapshot(**kwargs)¶Initiates a snapshot of a volume.
Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also 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 an ad hoc snapshot. For more information, see Editing a snapshot schedule .
In the CreateSnapshot request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the Storage Gateway console. In response, 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. This operation is only supported in stored and cached volume gateway type.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference .
Warning
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
See also: AWS API Documentation
Request Syntax
response = client.create_snapshot(
VolumeARN='string',
SnapshotDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
[REQUIRED]
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'VolumeARN': 'string',
'SnapshotId': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
VolumeARN (string) --
The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
SnapshotId (string) --
The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots ) or creating a volume from a snapshot ( CreateStorediSCSIVolume ).
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorStorageGateway.Client.exceptions.ServiceUnavailableErrorExamples
Initiates an ad-hoc snapshot of a gateway volume.
response = client.create_snapshot(
SnapshotDescription='My root volume snapshot as of 10/03/2017',
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'SnapshotId': 'snap-78e22663',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
create_snapshot_from_volume_recovery_point(**kwargs)¶Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.
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 cached volume gateway, 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 the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the 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 Amazon Elastic Compute Cloud API Reference .
See also: AWS API Documentation
Request Syntax
response = client.create_snapshot_from_volume_recovery_point(
VolumeARN='string',
SnapshotDescription='string',
Tags=[
{
'Key': 'string',
'Value': '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.
[REQUIRED]
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'SnapshotId': 'string',
'VolumeARN': 'string',
'VolumeRecoveryPointTime': 'string'
}
Response Structure
(dict) --
SnapshotId (string) --
The ID of the snapshot.
VolumeARN (string) --
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
VolumeRecoveryPointTime (string) --
The time the volume was created from the recovery point.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorStorageGateway.Client.exceptions.ServiceUnavailableErrorExamples
Initiates a snapshot of a gateway from a volume recovery point.
response = client.create_snapshot_from_volume_recovery_point(
SnapshotDescription='My root volume snapshot as of 2017-06-30T10:10:10.000Z',
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'SnapshotId': 'snap-78e22663',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeRecoveryPointTime': '2017-06-30T10:10:10.000Z',
'ResponseMetadata': {
'...': '...',
},
}
create_stored_iscsi_volume(**kwargs)¶Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.
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, the 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.
See also: AWS API Documentation
Request Syntax
response = client.create_stored_iscsi_volume(
GatewayARN='string',
DiskId='string',
SnapshotId='string',
PreserveExistingData=True|False,
TargetName='string',
NetworkInterfaceId='string',
KMSEncrypted=True|False,
KMSKey='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
[REQUIRED]
Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.
Valid Values: true | false
[REQUIRED]
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
[REQUIRED]
The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
KMSEncrypted is true . Optional.A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'VolumeARN': 'string',
'VolumeSizeInBytes': 123,
'TargetARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
VolumeARN (string) --
The Amazon Resource Name (ARN) of the configured volume.
VolumeSizeInBytes (integer) --
The size of the volume in bytes.
TargetARN (string) --
The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Creates a stored volume on a specified stored gateway.
response = client.create_stored_iscsi_volume(
DiskId='pci-0000:03:00.0-scsi-0:0:0:0',
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
NetworkInterfaceId='10.1.1.1',
PreserveExistingData=True,
SnapshotId='snap-f47b7b94',
TargetName='my-volume',
)
print(response)
Expected Output:
{
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeSizeInBytes': 1099511627776,
'ResponseMetadata': {
'...': '...',
},
}
create_tape_pool(**kwargs)¶Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.
See also: AWS API Documentation
Request Syntax
response = client.create_tape_pool(
PoolName='string',
StorageClass='DEEP_ARCHIVE'|'GLACIER',
RetentionLockType='COMPLIANCE'|'GOVERNANCE'|'NONE',
RetentionLockTimeInDays=123,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the new custom tape pool.
[REQUIRED]
The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'PoolARN': 'string'
}
Response Structure
(dict) --
PoolARN (string) --
The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the ListTapePools operation to return a list of tape pools for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorcreate_tape_with_barcode(**kwargs)¶Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.
Note
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_tape_with_barcode(
GatewayARN='string',
TapeSizeInBytes=123,
TapeBarcode='string',
KMSEncrypted=True|False,
KMSKey='string',
PoolId='string',
Worm=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The size, in bytes, of the virtual tape that you want to create.
Note
The size must be aligned by gigabyte (1024*1024*1024 bytes).
[REQUIRED]
The barcode that you want to assign to the tape.
Note
Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
KMSEncrypted is true . Optional.TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
CreateTapeOutput
TapeARN (string) --
A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Creates a virtual tape by using your own barcode.
response = client.create_tape_with_barcode(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
TapeBarcode='TEST12345',
TapeSizeInBytes=107374182400,
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345',
'ResponseMetadata': {
'...': '...',
},
}
create_tapes(**kwargs)¶Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_tapes(
GatewayARN='string',
TapeSizeInBytes=123,
ClientToken='string',
NumTapesToCreate=123,
TapeBarcodePrefix='string',
KMSEncrypted=True|False,
KMSKey='string',
PoolId='string',
Worm=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The size, in bytes, of the virtual tapes that you want to create.
Note
The size must be aligned by gigabyte (1024*1024*1024 bytes).
[REQUIRED]
A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
Note
Using the same ClientToken prevents creating the tape multiple times.
[REQUIRED]
The number of virtual tapes that you want to create.
[REQUIRED]
A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.
Note
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
KMSEncrypted is true . Optional.TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'TapeARNs': [
'string',
]
}
Response Structure
(dict) --
CreateTapeOutput
TapeARNs (list) --
A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Creates one or more virtual tapes.
response = client.create_tapes(
ClientToken='77777',
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
NumTapesToCreate=3,
TapeBarcodePrefix='TEST',
TapeSizeInBytes=107374182400,
)
print(response)
Expected Output:
{
'TapeARNs': [
'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D',
'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F',
'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E',
],
'ResponseMetadata': {
'...': '...',
},
}
delete_automatic_tape_creation_policy(**kwargs)¶Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.
See also: AWS API Documentation
Request Syntax
response = client.delete_automatic_tape_creation_policy(
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 Amazon Web Services Region.
{
'GatewayARN': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrordelete_bandwidth_rate_limit(**kwargs)¶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. This operation is supported only for the stored volume, cached volume, and tape gateway types.
See also: AWS API Documentation
Request Syntax
response = client.delete_bandwidth_rate_limit(
GatewayARN='string',
BandwidthType='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.
Valid Values: UPLOAD | DOWNLOAD | ALL
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.
response = client.delete_bandwidth_rate_limit(
BandwidthType='All',
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
delete_chap_credentials(**kwargs)¶Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.
See also: AWS API Documentation
Request Syntax
response = client.delete_chap_credentials(
TargetARN='string',
InitiatorName='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.
[REQUIRED]
The iSCSI initiator that connects to the target.
dict
Response Syntax
{
'TargetARN': 'string',
'InitiatorName': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
TargetARN (string) --
The Amazon Resource Name (ARN) of the target.
InitiatorName (string) --
The iSCSI initiator that connects to the target.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
response = client.delete_chap_credentials(
InitiatorName='iqn.1991-05.com.microsoft:computername.domain.example.com',
TargetARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
)
print(response)
Expected Output:
{
'InitiatorName': 'iqn.1991-05.com.microsoft:computername.domain.example.com',
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
'ResponseMetadata': {
'...': '...',
},
}
Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.
See also: AWS API Documentation
Request Syntax
response = client.delete_file_share(
FileShareARN='string',
ForceDelete=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file share to be deleted.
If this value is set to true , the operation deletes a file share immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.
Valid Values: true | false
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
DeleteFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the deleted file share.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrordelete_gateway(**kwargs)¶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 Storage Gateway detail page .
See also: AWS API Documentation
Request Syntax
response = client.delete_gateway(
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 Amazon Web Services Region.
{
'GatewayARN': 'string'
}
Response Structure
A JSON object containing the ID of the deleted gateway.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
This operation deletes the gateway, but not the gateway's VM from the host computer.
response = client.delete_gateway(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
delete_snapshot_schedule(**kwargs)¶Deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes . In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .
See also: AWS API Documentation
Request Syntax
response = client.delete_snapshot_schedule(
VolumeARN='string'
)
[REQUIRED]
The volume which snapshot schedule to delete.
{
'VolumeARN': 'string'
}
Response Structure
The volume which snapshot schedule was deleted.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
This action enables you to delete a snapshot schedule for a volume.
response = client.delete_snapshot_schedule(
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
delete_tape(**kwargs)¶Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.delete_tape(
GatewayARN='string',
TapeARN='string',
BypassGovernanceRetention=True|False
)
[REQUIRED]
The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape to delete.
TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
DeleteTapeOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the deleted virtual tape.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
This example deletes the specified virtual tape.
response = client.delete_tape(
GatewayARN='arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
'ResponseMetadata': {
'...': '...',
},
}
delete_tape_archive(**kwargs)¶Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.delete_tape_archive(
TapeARN='string',
BypassGovernanceRetention=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
DeleteTapeArchiveOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Deletes the specified virtual tape from the virtual tape shelf (VTS).
response = client.delete_tape_archive(
TapeARN='arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
'ResponseMetadata': {
'...': '...',
},
}
delete_tape_pool(**kwargs)¶Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.
See also: AWS API Documentation
Request Syntax
response = client.delete_tape_pool(
PoolARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the custom tape pool to delete.
{
'PoolARN': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the custom tape pool being deleted.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrordelete_volume(**kwargs)¶Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, 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 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.
See also: AWS API Documentation
Request Syntax
response = client.delete_volume(
VolumeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
{
'VolumeARN': 'string'
}
Response Structure
A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted.
The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.
response = client.delete_volume(
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
describe_availability_monitor_test(**kwargs)¶Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.
See also: AWS API Documentation
Request Syntax
response = client.describe_availability_monitor_test(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'Status': 'COMPLETE'|'FAILED'|'PENDING',
'StartTime': datetime(2015, 1, 1)
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
The status of the high availability monitoring test. If a test hasn't been performed, the value of this field is null.
The time the high availability monitoring test was started. If a test hasn't been performed, the value of this field is null.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrordescribe_bandwidth_rate_limit(**kwargs)¶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 is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule .
This operation 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.
See also: AWS API Documentation
Request Syntax
response = client.describe_bandwidth_rate_limit(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'AverageUploadRateLimitInBitsPerSec': 123,
'AverageDownloadRateLimitInBitsPerSec': 123
}
Response Structure
A JSON object containing the following fields:
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.
response = client.describe_bandwidth_rate_limit(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'AverageDownloadRateLimitInBitsPerSec': 204800,
'AverageUploadRateLimitInBitsPerSec': 102400,
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
describe_bandwidth_rate_limit_schedule(**kwargs)¶Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.
This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading
If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
See also: AWS API Documentation
Request Syntax
response = client.describe_bandwidth_rate_limit_schedule(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'BandwidthRateLimitIntervals': [
{
'StartHourOfDay': 123,
'StartMinuteOfHour': 123,
'EndHourOfDay': 123,
'EndMinuteOfHour': 123,
'DaysOfWeek': [
123,
],
'AverageUploadRateLimitInBitsPerSec': 123,
'AverageDownloadRateLimitInBitsPerSec': 123
},
]
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
An array that contains the bandwidth rate limit intervals for a tape or volume gateway.
Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
The hour of the day to start the bandwidth rate limit interval.
The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0 .
The hour of the day to end the bandwidth rate limit interval.
The minute of the hour to end the bandwidth rate limit interval.
Warning
The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59 .
The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.
The average download rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the download rate limit is not set.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrordescribe_cache(**kwargs)¶Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
See also: AWS API Documentation
Request Syntax
response = client.describe_cache(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'CacheAllocatedInBytes': 123,
'CacheUsedPercentage': 123.0,
'CacheDirtyPercentage': 123.0,
'CacheHitPercentage': 123.0,
'CacheMissPercentage': 123.0
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
The amount of cache in bytes allocated to a gateway.
Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.
The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.
Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.
Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns information about the cache of a gateway.
response = client.describe_cache(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'CacheAllocatedInBytes': 2199023255552,
'CacheDirtyPercentage': 0.07,
'CacheHitPercentage': 99.68,
'CacheMissPercentage': 0.32,
'CacheUsedPercentage': 0.07,
'DiskIds': [
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:04:00.0-scsi-0:1:0:0',
],
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
describe_cached_iscsi_volumes(**kwargs)¶Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.
The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
response = client.describe_cached_iscsi_volumes(
VolumeARNs=[
'string',
]
)
[REQUIRED]
An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
{
'CachediSCSIVolumes': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'VolumeType': 'string',
'VolumeStatus': 'string',
'VolumeAttachmentStatus': 'string',
'VolumeSizeInBytes': 123,
'VolumeProgress': 123.0,
'SourceSnapshotId': 'string',
'VolumeiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'LunNumber': 123,
'ChapEnabled': True|False
},
'CreatedDate': datetime(2015, 1, 1),
'VolumeUsedInBytes': 123,
'KMSKey': 'string',
'TargetName': 'string'
},
]
}
Response Structure
A JSON object containing the following fields:
An array of objects where each object contains metadata about one cached volume.
Describes an iSCSI cached volume.
The Amazon Resource Name (ARN) of the storage volume.
The unique identifier of the volume, e.g., vol-AE4B946D.
One of the VolumeType enumeration values that describes the type of the volume.
One of the VolumeStatus values that indicates the state of the storage volume.
A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving your volumes to a different gateway .
The size, in bytes, of the volume capacity.
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping.
If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g., snap-78e22663. Otherwise, this field is not included.
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
The Amazon Resource Name (ARN) of the volume target.
The network interface identifier.
The port used to communicate with iSCSI targets.
The logical disk number.
Indicates whether mutual CHAP is enabled for the iSCSI target.
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.
Note
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
If you use a delete tool that overwrites the data on your volume with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns a description of the gateway cached iSCSI volumes specified in the request.
response = client.describe_cached_iscsi_volumes(
VolumeARNs=[
'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
],
)
print(response)
Expected Output:
{
'CachediSCSIVolumes': [
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeId': 'vol-1122AABB',
'VolumeSizeInBytes': 1099511627776,
'VolumeStatus': 'AVAILABLE',
'VolumeType': 'CACHED iSCSI',
'VolumeiSCSIAttributes': {
'ChapEnabled': True,
'LunNumber': 1,
'NetworkInterfaceId': '10.243.43.207',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_chap_credentials(**kwargs)¶Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.
See also: AWS API Documentation
Request Syntax
response = client.describe_chap_credentials(
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.
{
'ChapCredentials': [
{
'TargetARN': 'string',
'SecretToAuthenticateInitiator': 'string',
'InitiatorName': 'string',
'SecretToAuthenticateTarget': 'string'
},
]
}
Response Structure
A JSON object containing the following fields:
An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
The Amazon Resource Name (ARN) of the volume.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
The iSCSI initiator that connects to the target.
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g., Windows client).
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
response = client.describe_chap_credentials(
TargetARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
)
print(response)
Expected Output:
{
'ChapCredentials': [
{
'InitiatorName': 'iqn.1991-05.com.microsoft:computername.domain.example.com',
'SecretToAuthenticateInitiator': '111111111111',
'SecretToAuthenticateTarget': '222222222222',
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_file_system_associations(**kwargs)¶Gets the file system association information. This operation is only supported for FSx File Gateways.
See also: AWS API Documentation
Request Syntax
response = client.describe_file_system_associations(
FileSystemAssociationARNList=[
'string',
]
)
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file system association to be described.
{
'FileSystemAssociationInfoList': [
{
'FileSystemAssociationARN': 'string',
'LocationARN': 'string',
'FileSystemAssociationStatus': 'string',
'AuditDestinationARN': 'string',
'GatewayARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CacheAttributes': {
'CacheStaleTimeoutInSeconds': 123
},
'EndpointNetworkConfiguration': {
'IpAddresses': [
'string',
]
},
'FileSystemAssociationStatusDetails': [
{
'ErrorCode': 'string'
},
]
},
]
}
Response Structure
An array containing the FileSystemAssociationInfo data type of each file system association to be described.
Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.
The Amazon Resource Name (ARN) of the file system association.
The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference .
The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR
The Amazon Resource Name (ARN) of the storage used for the audit logs.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
The refresh cache information for the file share or FSx file systems.
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
Specifies network configuration information for the gateway associated with the Amazon FSx file system.
Note
If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.
A list of gateway IP addresses on which the associated Amazon FSx file system is available.
Note
If multiple file systems are associated with this gateway, this field is required.
An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.
Detailed information on file system association status.
The error code for a given file system association status.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrordescribe_gateway_information(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_gateway_information(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'GatewayId': 'string',
'GatewayName': 'string',
'GatewayTimezone': 'string',
'GatewayState': 'string',
'GatewayNetworkInterfaces': [
{
'Ipv4Address': 'string',
'MacAddress': 'string',
'Ipv6Address': 'string'
},
],
'GatewayType': 'string',
'NextUpdateAvailabilityDate': 'string',
'LastSoftwareUpdate': 'string',
'Ec2InstanceId': 'string',
'Ec2InstanceRegion': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VPCEndpoint': 'string',
'CloudWatchLogGroupARN': 'string',
'HostEnvironment': 'VMWARE'|'HYPER-V'|'EC2'|'KVM'|'OTHER'|'SNOWBALL',
'EndpointType': 'string',
'SoftwareUpdatesEndDate': 'string',
'DeprecationDate': 'string',
'GatewayCapacity': 'Small'|'Medium'|'Large',
'SupportedGatewayCapacities': [
'Small'|'Medium'|'Large',
],
'HostEnvironmentId': 'string'
}
Response Structure
A JSON object containing the following fields:
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
The name you configured for your gateway.
A value that indicates the time zone configured for the gateway.
A value that indicates the operating state of the gateway.
A NetworkInterface array that contains descriptions of the gateway network interfaces.
Describes a gateway's network interface.
The Internet Protocol version 4 (IPv4) address of the interface.
The Media Access Control (MAC) address of the interface.
Note
This is currently unsupported and will not be returned in output.
The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported .
The type of the gateway.
The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
The ID of the Amazon EC2 instance that was used to launch the gateway.
The Amazon Web Services Region where the Amazon EC2 instance is located.
A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
The type of hardware or software platform on which the gateway is running.
The type of endpoint for your gateway.
Valid Values: STANDARD | FIPS
Date after which this gateway will not receive software updates for new features.
Date after which this gateway will not receive software updates for new features and bug fixes.
Specifies the size of the gateway's metadata cache.
A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).
response = client.describe_gateway_information(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'GatewayId': 'sgw-AABB1122',
'GatewayName': 'My_Gateway',
'GatewayNetworkInterfaces': [
{
'Ipv4Address': '10.35.69.216',
},
],
'GatewayState': 'STATE_RUNNING',
'GatewayTimezone': 'GMT-8:00',
'GatewayType': 'STORED',
'LastSoftwareUpdate': '2016-01-02T16:00:00',
'NextUpdateAvailabilityDate': '2017-01-02T16:00:00',
'ResponseMetadata': {
'...': '...',
},
}
describe_maintenance_start_time(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_maintenance_start_time(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'HourOfDay': 123,
'MinuteOfHour': 123,
'DayOfWeek': 123,
'DayOfMonth': 123,
'Timezone': 'string'
}
Response Structure
A JSON object containing the following fields:
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
The hour component of the maintenance start time represented as hh , where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
The minute component of the maintenance start time represented as mm , where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.
An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns your gateway's weekly maintenance start time including the day and time of the week.
response = client.describe_maintenance_start_time(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'DayOfWeek': 2,
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'HourOfDay': 15,
'MinuteOfHour': 35,
'Timezone': 'GMT+7:00',
'ResponseMetadata': {
'...': '...',
},
}
Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.
See also: AWS API Documentation
Request Syntax
response = client.describe_nfs_file_shares(
FileShareARNList=[
'string',
]
)
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
The Amazon Resource Name (ARN) of the file share.
{
'NFSFileShareInfoList': [
{
'NFSFileShareDefaults': {
'FileMode': 'string',
'DirectoryMode': 'string',
'GroupId': 123,
'OwnerId': 123
},
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string',
'KMSEncrypted': True|False,
'KMSKey': 'string',
'Path': 'string',
'Role': 'string',
'LocationARN': 'string',
'DefaultStorageClass': 'string',
'ObjectACL': 'private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
'ClientList': [
'string',
],
'Squash': 'string',
'ReadOnly': True|False,
'GuessMIMETypeEnabled': True|False,
'RequesterPays': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'FileShareName': 'string',
'CacheAttributes': {
'CacheStaleTimeoutInSeconds': 123
},
'NotificationPolicy': 'string',
'VPCEndpointDNSName': 'string',
'BucketRegion': 'string',
'AuditDestinationARN': 'string'
},
]
}
Response Structure
DescribeNFSFileSharesOutput
An array containing a description for each requested file share.
The Unix file permissions and ownership information assigned, by default, to native S3 objects when an S3 File Gateway discovers them in S3 buckets. This operation is only supported in S3 File Gateways.
Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for S3 File Gateways.
The Unix file mode in the form "nnnn". For example, 0666 represents the default file mode inside the file share. The default value is 0666 .
The Unix directory mode in the form "nnnn". For example, 0666 represents the default access mode for all directories inside the file share. The default value is 0777 .
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody .
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody .
The Amazon Resource Name (ARN) of the file share.
The ID of the file share.
The status of the file share.
Valid Values: CREATING | UPDATING | AVAILABLE | DELETING
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
The file share path used by the NFS client to identify the mount point.
The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
Note
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide .
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private .
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
The user mapped to anonymous user. Valid options are the following:
RootSquash : Only root is mapped to anonymous user.NoSquash : No one is mapped to anonymous user.AllSquash : Everyone is mapped to anonymous user.A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false . The default value is true .
Valid Values: true | false
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN , or if an access point or access point alias is used.
Refresh cache information for the file share.
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
Note
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
Note
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Specifies the Region of the S3 bucket where the NFS file share stores files.
Note
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
The Amazon Resource Name (ARN) of the storage used for audit logs.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorGets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.
See also: AWS API Documentation
Request Syntax
response = client.describe_smb_file_shares(
FileShareARNList=[
'string',
]
)
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
The Amazon Resource Name (ARN) of the file share.
{
'SMBFileShareInfoList': [
{
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string',
'KMSEncrypted': True|False,
'KMSKey': 'string',
'Path': 'string',
'Role': 'string',
'LocationARN': 'string',
'DefaultStorageClass': 'string',
'ObjectACL': 'private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
'ReadOnly': True|False,
'GuessMIMETypeEnabled': True|False,
'RequesterPays': True|False,
'SMBACLEnabled': True|False,
'AccessBasedEnumeration': True|False,
'AdminUserList': [
'string',
],
'ValidUserList': [
'string',
],
'InvalidUserList': [
'string',
],
'AuditDestinationARN': 'string',
'Authentication': 'string',
'CaseSensitivity': 'ClientSpecified'|'CaseSensitive',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'FileShareName': 'string',
'CacheAttributes': {
'CacheStaleTimeoutInSeconds': 123
},
'NotificationPolicy': 'string',
'VPCEndpointDNSName': 'string',
'BucketRegion': 'string',
'OplocksEnabled': True|False
},
]
}
Response Structure
DescribeSMBFileSharesOutput
An array containing a description for each requested file share.
The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.
The Amazon Resource Name (ARN) of the file share.
The ID of the file share.
The status of the file share.
Valid Values: CREATING | UPDATING | AVAILABLE | DELETING
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
The file share path used by the SMB client to identify the mount point.
The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
Note
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide .
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private .
A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false . The default value is true .
Valid Values: true | false
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
If this value is set to true , it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false , it indicates that file and directory permissions are mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide .
Indicates whether AccessBasedEnumeration is enabled.
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
The Amazon Resource Name (ARN) of the storage used for audit logs.
The authentication method of the file share. The default is ActiveDirectory .
Valid Values: ActiveDirectory | GuestAccess
The case of an object name in an Amazon S3 bucket. For ClientSpecified , the client determines the case sensitivity. For CaseSensitive , the gateway determines the case sensitivity. The default value is ClientSpecified .
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN , or if an access point or access point alias is used.
Refresh cache information for the file share.
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
Note
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
Note
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Specifies the Region of the S3 bucket where the SMB file share stores files.
Note
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Specifies whether opportunistic locking is enabled for the SMB file share.
Note
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrordescribe_smb_settings(**kwargs)¶Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
See also: AWS API Documentation
Request Syntax
response = client.describe_smb_settings(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'DomainName': 'string',
'ActiveDirectoryStatus': 'ACCESS_DENIED'|'DETACHED'|'JOINED'|'JOINING'|'NETWORK_ERROR'|'TIMEOUT'|'UNKNOWN_ERROR',
'SMBGuestPasswordSet': True|False,
'SMBSecurityStrategy': 'ClientSpecified'|'MandatorySigning'|'MandatoryEncryption',
'FileSharesVisible': True|False,
'SMBLocalGroups': {
'GatewayAdmins': [
'string',
]
}
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
The name of the domain that the gateway is joined to.
Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED : Indicates that the JoinDomain operation failed due to an authentication error.DETACHED : Indicates that gateway is not joined to a domain.JOINED : Indicates that the gateway has successfully joined a domain.JOINING : Indicates that a JoinDomain operation is in progress.NETWORK_ERROR : Indicates that JoinDomain operation failed due to a network or connectivity error.TIMEOUT : Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.UNKNOWN_ERROR : Indicates that the JoinDomain operation failed due to another type of error.This value is true if a password for the guest user smbguest is set, otherwise false . Only supported for S3 File Gateways.
Valid Values: true | false
The type of security strategy that was specified for file gateway.
ClientSpecified : If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.MandatorySigning : If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.MandatoryEncryption : If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats include: DOMAIN\User1 , user1 , DOMAIN\group1 , and group1 .
Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force-close files that are open and locked.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrordescribe_snapshot_schedule(**kwargs)¶Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.
See also: AWS API Documentation
Request Syntax
response = client.describe_snapshot_schedule(
VolumeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
{
'VolumeARN': 'string',
'StartAt': 123,
'RecurrenceInHours': 123,
'Description': 'string',
'Timezone': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The Amazon Resource Name (ARN) of the volume that was specified in the request.
The hour of the day at which the snapshot schedule begins represented as hh , where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
The number of hours between snapshots.
The snapshot description.
A value that indicates the time zone of the gateway.
A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.
response = client.describe_snapshot_schedule(
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'Description': 'sgw-AABB1122:vol-AABB1122:Schedule',
'RecurrenceInHours': 24,
'StartAt': 6,
'Timezone': 'GMT+7:00',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
describe_stored_iscsi_volumes(**kwargs)¶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, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_stored_iscsi_volumes(
VolumeARNs=[
'string',
]
)
[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 be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
{
'StorediSCSIVolumes': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'VolumeType': 'string',
'VolumeStatus': 'string',
'VolumeAttachmentStatus': '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
},
'CreatedDate': datetime(2015, 1, 1),
'VolumeUsedInBytes': 123,
'KMSKey': 'string',
'TargetName': 'string'
},
]
}
Response Structure
Describes a single unit of output from DescribeStorediSCSIVolumes . The following fields are returned:
ChapEnabled : Indicates whether mutual CHAP is enabled for the iSCSI target.LunNumber : The logical disk number.NetworkInterfaceId : The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.NetworkInterfacePort : The port used to communicate with iSCSI targets.PreservedExistingData : Indicates when the stored volume was created, existing data on the underlying local disk was preserved.SourceSnapshotId : If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb . Otherwise, this field is not included.StorediSCSIVolumes : An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.TargetARN : The Amazon Resource Name (ARN) of the volume target.VolumeARN : The Amazon Resource Name (ARN) of the stored volume.VolumeDiskId : The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.VolumeId : The unique identifier of the storage volume, e.g. vol-1122AABB .VolumeiSCSIAttributes : An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.VolumeProgress : Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.VolumeSizeInBytes : The size of the volume in bytes.VolumeStatus : One of the VolumeStatus values that indicates the state of the volume.VolumeType : One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.Describes an iSCSI stored volume.
The Amazon Resource Name (ARN) of the storage volume.
The unique identifier of the volume, e.g., vol-AE4B946D.
One of the VolumeType enumeration values describing the type of the volume.
One of the VolumeStatus values that indicates the state of the storage volume.
A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway .
The size of the volume in bytes.
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
Valid Values: true | false
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
The Amazon Resource Name (ARN) of the volume target.
The network interface identifier.
The port used to communicate with iSCSI targets.
The logical disk number.
Indicates whether mutual CHAP is enabled for the iSCSI target.
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.
Note
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns the description of the gateway volumes specified in the request belonging to the same gateway.
response = client.describe_stored_iscsi_volumes(
VolumeARNs=[
'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
],
)
print(response)
Expected Output:
{
'StorediSCSIVolumes': [
{
'PreservedExistingData': False,
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeDiskId': 'pci-0000:03:00.0-scsi-0:0:0:0',
'VolumeId': 'vol-1122AABB',
'VolumeProgress': 23.7,
'VolumeSizeInBytes': 1099511627776,
'VolumeStatus': 'BOOTSTRAPPING',
'VolumeiSCSIAttributes': {
'ChapEnabled': True,
'NetworkInterfaceId': '10.243.43.207',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_tape_archives(**kwargs)¶Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_tape_archives(
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
dict
Response Syntax
{
'TapeArchives': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeCreatedDate': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'CompletionTime': datetime(2015, 1, 1),
'RetrievedTo': 'string',
'TapeStatus': 'string',
'TapeUsedInBytes': 123,
'KMSKey': 'string',
'PoolId': 'string',
'Worm': True|False,
'RetentionStartDate': datetime(2015, 1, 1),
'PoolEntryDate': datetime(2015, 1, 1)
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeTapeArchivesOutput
TapeArchives (list) --
An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.
(dict) --
Represents a virtual tape that is archived in the virtual tape shelf (VTS).
TapeARN (string) --
The Amazon Resource Name (ARN) of an archived virtual tape.
TapeBarcode (string) --
The barcode that identifies the archived virtual tape.
TapeCreatedDate (datetime) --
The date the virtual tape was created.
TapeSizeInBytes (integer) --
The size, in bytes, of the archived virtual tape.
CompletionTime (datetime) --
The time that the archiving of the virtual tape was completed.
The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
RetrievedTo (string) --
The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
TapeStatus (string) --
The current state of the archived virtual tape.
TapeUsedInBytes (integer) --
The size, in bytes, of data stored on the virtual tape.
Note
This value is not available for tapes created prior to May 13, 2015.
KMSKey (string) --
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
PoolId (string) --
The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.
Worm (boolean) --
Set to true if the archived tape is stored as write-once-read-many (WORM).
RetentionStartDate (datetime) --
If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
PoolEntryDate (datetime) --
The time that the tape entered the custom tape pool.
The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
Marker (string) --
An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
response = client.describe_tape_archives(
Limit=123,
Marker='1',
TapeARNs=[
'arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD',
'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
],
)
print(response)
Expected Output:
{
'Marker': '1',
'TapeArchives': [
{
'CompletionTime': datetime(2016, 12, 16, 13, 50, 0, 4, 351, 0),
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD',
'TapeBarcode': 'AM08A1AD',
'TapeSizeInBytes': 107374182400,
'TapeStatus': 'ARCHIVED',
},
{
'CompletionTime': datetime(2016, 12, 16, 13, 59, 0, 4, 351, 0),
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4',
'TapeBarcode': 'AMZN01A2A4',
'TapeSizeInBytes': 429496729600,
'TapeStatus': 'ARCHIVED',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_tape_recovery_points(**kwargs)¶Returns a list of virtual tape recovery points that are available for the specified tape gateway.
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. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_tape_recovery_points(
GatewayARN='string',
Marker='string',
Limit=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
dict
Response Syntax
{
'GatewayARN': 'string',
'TapeRecoveryPointInfos': [
{
'TapeARN': 'string',
'TapeRecoveryPointTime': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeTapeRecoveryPointsOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
TapeRecoveryPointInfos (list) --
An array of TapeRecoveryPointInfos that are available for the specified gateway.
(dict) --
Describes a recovery point.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeRecoveryPointTime (datetime) --
The time when the point-in-time view of the virtual tape was replicated for later recovery.
The default timestamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tapes to recover.
TapeStatus (string) --
The status of the virtual tapes.
Marker (string) --
An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
response = client.describe_tape_recovery_points(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
Limit=1,
Marker='1',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'Marker': '1',
'TapeRecoveryPointInfos': [
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4',
'TapeRecoveryPointTime': datetime(2016, 12, 16, 13, 50, 0, 4, 351, 0),
'TapeSizeInBytes': 1471550497,
'TapeStatus': 'AVAILABLE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
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. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_tapes(
GatewayARN='string',
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.
A marker value, obtained in a previous call to DescribeTapes . This marker indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
Specifies that the number of virtual tapes described be limited to the specified number.
Note
Amazon Web Services may impose its own limit, if this field is not set.
dict
Response Syntax
{
'Tapes': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeCreatedDate': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'VTLDevice': 'string',
'Progress': 123.0,
'TapeUsedInBytes': 123,
'KMSKey': 'string',
'PoolId': 'string',
'Worm': True|False,
'RetentionStartDate': datetime(2015, 1, 1),
'PoolEntryDate': datetime(2015, 1, 1)
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeTapesOutput
Tapes (list) --
An array of virtual tape descriptions.
(dict) --
Describes a virtual tape object.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeBarcode (string) --
The barcode that identifies a specific virtual tape.
TapeCreatedDate (datetime) --
The date the virtual tape was created.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tape capacity.
TapeStatus (string) --
The current state of the virtual tape.
VTLDevice (string) --
The virtual tape library (VTL) device that the virtual tape is associated with.
Progress (float) --
For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
TapeUsedInBytes (integer) --
The size, in bytes, of data stored on the virtual tape.
Note
This value is not available for tapes created prior to May 13, 2015.
KMSKey (string) --
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
PoolId (string) --
The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Worm (boolean) --
If the tape is archived as write-once-read-many (WORM), this value is true .
RetentionStartDate (datetime) --
The date that the tape is first archived with tape retention lock enabled.
PoolEntryDate (datetime) --
The date that the tape enters a custom tape pool.
Marker (string) --
An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be retrieved.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
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.
response = client.describe_tapes(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
Limit=2,
Marker='1',
TapeARNs=[
'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1',
'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0',
],
)
print(response)
Expected Output:
{
'Marker': '1',
'Tapes': [
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1',
'TapeBarcode': 'TEST04A2A1',
'TapeSizeInBytes': 107374182400,
'TapeStatus': 'AVAILABLE',
},
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0',
'TapeBarcode': 'TEST05A2A0',
'TapeSizeInBytes': 107374182400,
'TapeStatus': 'AVAILABLE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_upload_buffer(**kwargs)¶Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
See also: AWS API Documentation
Request Syntax
response = client.describe_upload_buffer(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'UploadBufferUsedInBytes': 123,
'UploadBufferAllocatedInBytes': 123
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
The total number of bytes being used in the gateway's upload buffer.
The total number of bytes allocated in the gateway's as upload buffer.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.
response = client.describe_upload_buffer(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'DiskIds': [
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:04:00.0-scsi-0:1:0:0',
],
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'UploadBufferAllocatedInBytes': 0,
'UploadBufferUsedInBytes': 161061273600,
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.
response = client.describe_upload_buffer(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'DiskIds': [
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:04:00.0-scsi-0:1:0:0',
],
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'UploadBufferAllocatedInBytes': 161061273600,
'UploadBufferUsedInBytes': 0,
'ResponseMetadata': {
'...': '...',
},
}
describe_vtl_devices(**kwargs)¶Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.
This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_vtl_devices(
GatewayARN='string',
VTLDeviceARNs=[
'string',
],
Marker='string',
Limit=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
Note
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
dict
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
(dict) --
DescribeVTLDevicesOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
VTLDevices (list) --
An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.
(dict) --
Represents a device object associated with a tape gateway.
VTLDeviceARN (string) --
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
VTLDeviceType (string) --
Specifies the type of device that the VTL device emulates.
VTLDeviceVendor (string) --
Specifies the vendor of the device that the VTL device object emulates.
VTLDeviceProductIdentifier (string) --
Specifies the model number of device that the VTL device emulates.
DeviceiSCSIAttributes (dict) --
A list of iSCSI information about a VTL device.
TargetARN (string) --
Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
NetworkInterfaceId (string) --
The network interface identifier of the VTL device.
NetworkInterfacePort (integer) --
The port used to communicate with iSCSI VTL device targets.
ChapEnabled (boolean) --
Indicates whether mutual CHAP is enabled for the iSCSI target.
Marker (string) --
An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Returns a description of virtual tape library (VTL) devices for the specified gateway.
response = client.describe_vtl_devices(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
Limit=123,
Marker='1',
VTLDeviceARNs=[
],
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
'Marker': '1',
'VTLDevices': [
{
'DeviceiSCSIAttributes': {
'ChapEnabled': False,
'NetworkInterfaceId': '10.243.43.207',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger',
},
'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001',
'VTLDeviceProductIdentifier': 'L700',
'VTLDeviceType': 'Medium Changer',
'VTLDeviceVendor': 'STK',
},
{
'DeviceiSCSIAttributes': {
'ChapEnabled': False,
'NetworkInterfaceId': '10.243.43.209',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01',
},
'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001',
'VTLDeviceProductIdentifier': 'ULT3580-TD5',
'VTLDeviceType': 'Tape Drive',
'VTLDeviceVendor': 'IBM',
},
{
'DeviceiSCSIAttributes': {
'ChapEnabled': False,
'NetworkInterfaceId': '10.243.43.209',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02',
},
'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002',
'VTLDeviceProductIdentifier': 'ULT3580-TD5',
'VTLDeviceType': 'Tape Drive',
'VTLDeviceVendor': 'IBM',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_working_storage(**kwargs)¶Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. 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.
See also: AWS API Documentation
Request Syntax
response = client.describe_working_storage(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'WorkingStorageUsedInBytes': 123,
'WorkingStorageAllocatedInBytes': 123
}
Response Structure
A JSON object containing the following fields:
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.
response = client.describe_working_storage(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'DiskIds': [
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:03:00.0-scsi-0:0:1:0',
],
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'WorkingStorageAllocatedInBytes': 2199023255552,
'WorkingStorageUsedInBytes': 789207040,
'ResponseMetadata': {
'...': '...',
},
}
detach_volume(**kwargs)¶Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.
See also: AWS API Documentation
Request Syntax
response = client.detach_volume(
VolumeARN='string',
ForceDetach=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume to detach from the gateway.
Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false . If this value is set to false , you must manually disconnect the iSCSI connection from the target volume.
Valid Values: true | false
dict
Response Syntax
{
'VolumeARN': 'string'
}
Response Structure
(dict) --
AttachVolumeOutput
VolumeARN (string) --
The Amazon Resource Name (ARN) of the volume that was detached.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrordisable_gateway(**kwargs)¶Disables a tape 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 tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.
Warning
After a gateway is disabled, it cannot be enabled.
See also: AWS API Documentation
Request Syntax
response = client.disable_gateway(
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 Amazon Web Services Region.
{
'GatewayARN': 'string'
}
Response Structure
DisableGatewayOutput
The unique Amazon Resource Name (ARN) of the disabled gateway.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning.
response = client.disable_gateway(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
disassociate_file_system(**kwargs)¶Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_file_system(
FileSystemAssociationARN='string',
ForceDelete=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file system association to be deleted.
FORCE_DELETING status. If this value is set to false, the Amazon FSx file system does not disassociate until all data is uploaded.dict
Response Syntax
{
'FileSystemAssociationARN': 'string'
}
Response Structure
(dict) --
FileSystemAssociationARN (string) --
The Amazon Resource Name (ARN) of the deleted file system association.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
join_domain(**kwargs)¶Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
See also: AWS API Documentation
Request Syntax
response = client.join_domain(
GatewayARN='string',
DomainName='string',
OrganizationalUnit='string',
DomainControllers=[
'string',
],
TimeoutInSeconds=123,
UserName='string',
Password='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The name of the domain that you want the gateway to join.
List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389 .
JoinDomain operation must complete. The default is 20 seconds.[REQUIRED]
Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.
[REQUIRED]
Sets the password of the user who has permission to add the gateway to the Active Directory domain.
dict
Response Syntax
{
'GatewayARN': 'string',
'ActiveDirectoryStatus': 'ACCESS_DENIED'|'DETACHED'|'JOINED'|'JOINING'|'NETWORK_ERROR'|'TIMEOUT'|'UNKNOWN_ERROR'
}
Response Structure
(dict) --
JoinDomainOutput
GatewayARN (string) --
The unique Amazon Resource Name (ARN) of the gateway that joined the domain.
ActiveDirectoryStatus (string) --
Indicates the status of the gateway as a member of the Active Directory domain.
ACCESS_DENIED : Indicates that the JoinDomain operation failed due to an authentication error.DETACHED : Indicates that gateway is not joined to a domain.JOINED : Indicates that the gateway has successfully joined a domain.JOINING : Indicates that a JoinDomain operation is in progress.NETWORK_ERROR : Indicates that JoinDomain operation failed due to a network or connectivity error.TIMEOUT : Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.UNKNOWN_ERROR : Indicates that the JoinDomain operation failed due to another type of error.Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorlist_automatic_tape_creation_policies(**kwargs)¶Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.
This operation is only supported for tape gateways.
See also: AWS API Documentation
Request Syntax
response = client.list_automatic_tape_creation_policies(
GatewayARN='string'
)
{
'AutomaticTapeCreationPolicyInfos': [
{
'AutomaticTapeCreationRules': [
{
'TapeBarcodePrefix': 'string',
'PoolId': 'string',
'TapeSizeInBytes': 123,
'MinimumNumTapes': 123,
'Worm': True|False
},
],
'GatewayARN': 'string'
},
]
}
Response Structure
Gets a listing of information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
An automatic tape creation policy consists of a list of automatic tape creation rules. This returns the rules that determine when and how to automatically create new tapes.
An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically .
A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.
Note
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
The size, in bytes, of the virtual tape capacity.
The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway. For more information about automatic tape creation, see Creating Tapes Automatically .
Set to true to indicate that tapes are to be archived as write-once-read-many (WORM). Set to false when WORM is not enabled for tapes.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorGets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling user account. This operation is only supported for S3 File Gateways.
See also: AWS API Documentation
Request Syntax
response = client.list_file_shares(
GatewayARN='string',
Limit=123,
Marker='string'
)
Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.dict
Response Syntax
{
'Marker': 'string',
'NextMarker': 'string',
'FileShareInfoList': [
{
'FileShareType': 'NFS'|'SMB',
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string'
},
]
}
Response Structure
(dict) --
ListFileShareOutput
Marker (string) --
If the request includes Marker , the response returns that value in this field.
NextMarker (string) --
If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.
FileShareInfoList (list) --
An array of information about the S3 File Gateway's file shares.
(dict) --
Describes a file share. Only supported S3 File Gateway.
FileShareType (string) --
The type of the file share.
FileShareARN (string) --
The Amazon Resource Name (ARN) of the file share.
FileShareId (string) --
The ID of the file share.
FileShareStatus (string) --
The status of the file share.
Valid Values: CREATING | UPDATING | AVAILABLE | DELETING
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorlist_file_system_associations(**kwargs)¶Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.
See also: AWS API Documentation
Request Syntax
response = client.list_file_system_associations(
GatewayARN='string',
Limit=123,
Marker='string'
)
Limit must be an integer with a value greater than zero. Optional.ListFileSystemAssociations operation. If present, Marker specifies where to continue the list from after a previous call to ListFileSystemAssociations . Optional.dict
Response Syntax
{
'Marker': 'string',
'NextMarker': 'string',
'FileSystemAssociationSummaryList': [
{
'FileSystemAssociationId': 'string',
'FileSystemAssociationARN': 'string',
'FileSystemAssociationStatus': 'string',
'GatewayARN': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
If the request includes Marker , the response returns that value in this field.
NextMarker (string) --
If a value is present, there are more file system associations to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file system associations.
FileSystemAssociationSummaryList (list) --
An array of information about the Amazon FSx gateway's file system associations.
(dict) --
Gets the summary returned by ListFileSystemAssociation , which is a summary of a created file system association.
FileSystemAssociationId (string) --
The ID of the file system association.
FileSystemAssociationARN (string) --
The Amazon Resource Name (ARN) of the file system association.
FileSystemAssociationStatus (string) --
The status of the file share. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorlist_gateways(**kwargs)¶Lists gateways owned by an Amazon Web Services account in an Amazon Web Services 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.
See also: AWS API Documentation
Request Syntax
response = client.list_gateways(
Marker='string',
Limit=123
)
dict
Response Syntax
{
'Gateways': [
{
'GatewayId': 'string',
'GatewayARN': 'string',
'GatewayType': 'string',
'GatewayOperationalState': 'string',
'GatewayName': 'string',
'Ec2InstanceId': 'string',
'Ec2InstanceRegion': 'string',
'HostEnvironment': 'VMWARE'|'HYPER-V'|'EC2'|'KVM'|'OTHER'|'SNOWBALL',
'HostEnvironmentId': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Gateways (list) --
An array of GatewayInfo objects.
(dict) --
Describes a gateway object.
GatewayId (string) --
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
GatewayType (string) --
The type of the gateway.
GatewayOperationalState (string) --
The state of the gateway.
Valid Values: DISABLED | ACTIVE
GatewayName (string) --
The name of the gateway.
Ec2InstanceId (string) --
The ID of the Amazon EC2 instance that was used to launch the gateway.
Ec2InstanceRegion (string) --
The Amazon Web Services Region where the Amazon EC2 instance is located.
HostEnvironment (string) --
The type of hardware or software platform on which the gateway is running.
HostEnvironmentId (string) --
A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
Marker (string) --
Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways.
response = client.list_gateways(
Limit=2,
Marker='1',
)
print(response)
Expected Output:
{
'Gateways': [
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
},
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C',
},
],
'Marker': '1',
'ResponseMetadata': {
'...': '...',
},
}
list_local_disks(**kwargs)¶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).
See also: AWS API Documentation
Request Syntax
response = client.list_local_disks(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'Disks': [
{
'DiskId': 'string',
'DiskPath': 'string',
'DiskNode': 'string',
'DiskStatus': 'string',
'DiskSizeInBytes': 123,
'DiskAllocationType': 'string',
'DiskAllocationResource': 'string',
'DiskAttributeList': [
'string',
]
},
]
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
A JSON object containing the following fields:
Represents a gateway's local disk.
The unique device ID or other distinguishing data that identifies a local disk.
The path of a local disk in the gateway virtual machine (VM).
The device node of a local disk as assigned by the virtualization environment.
A value that represents the status of a local disk.
The local disk size in bytes.
One of the DiskAllocationType enumeration values that identifies how a local disk is used.
Valid Values: UPLOAD_BUFFER | CACHE_STORAGE
The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId .
A list of values that represents attributes of a local disk.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
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.
response = client.list_local_disks(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'Disks': [
{
'DiskAllocationType': 'CACHE_STORAGE',
'DiskId': 'pci-0000:03:00.0-scsi-0:0:0:0',
'DiskNode': 'SCSI(0:0)',
'DiskPath': '/dev/sda',
'DiskSizeInBytes': 1099511627776,
'DiskStatus': 'missing',
},
{
'DiskAllocationResource': '',
'DiskAllocationType': 'UPLOAD_BUFFER',
'DiskId': 'pci-0000:03:00.0-scsi-0:0:1:0',
'DiskNode': 'SCSI(0:1)',
'DiskPath': '/dev/sdb',
'DiskSizeInBytes': 1099511627776,
'DiskStatus': 'present',
},
],
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string',
Marker='string',
Limit=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
dict
Response Syntax
{
'ResourceARN': 'string',
'Marker': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ListTagsForResourceOutput
ResourceARN (string) --
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
Marker (string) --
An opaque string that indicates the position at which to stop returning the list of tags.
Tags (list) --
An array that contains the tags for the specified resource.
(dict) --
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Key (string) --
Tag key. The key can't start with aws:.
Value (string) --
Value of the tag key.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Lists the tags that have been added to the specified resource.
response = client.list_tags_for_resource(
Limit=1,
Marker='1',
ResourceARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
)
print(response)
Expected Output:
{
'Marker': '1',
'ResourceARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
'Tags': [
{
'Key': 'Dev Gatgeway Region',
'Value': 'East Coast',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_tape_pools(**kwargs)¶Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.
This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.
See also: AWS API Documentation
Request Syntax
response = client.list_tape_pools(
PoolARNs=[
'string',
],
Marker='string',
Limit=123
)
The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools.
dict
Response Syntax
{
'PoolInfos': [
{
'PoolARN': 'string',
'PoolName': 'string',
'StorageClass': 'DEEP_ARCHIVE'|'GLACIER',
'RetentionLockType': 'COMPLIANCE'|'GOVERNANCE'|'NONE',
'RetentionLockTimeInDays': 123,
'PoolStatus': 'ACTIVE'|'DELETED'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
PoolInfos (list) --
An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.
(dict) --
Describes a custom tape pool.
PoolARN (string) --
The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and Amazon Web Services Region.
PoolName (string) --
The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and ''.
StorageClass (string) --
The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
RetentionLockType (string) --
Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
RetentionLockTimeInDays (integer) --
Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
PoolStatus (string) --
Status of the custom tape pool. Pool can be ACTIVE or DELETED .
Marker (string) --
A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorlist_tapes(**kwargs)¶Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.
This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.list_tapes(
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.
dict
Response Syntax
{
'TapeInfos': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'GatewayARN': 'string',
'PoolId': 'string',
'RetentionStartDate': datetime(2015, 1, 1),
'PoolEntryDate': datetime(2015, 1, 1)
},
],
'Marker': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
TapeInfos (list) --
An array of TapeInfo objects, where each object describes a single tape. If there are no tapes in the tape library or VTS, then the TapeInfos is an empty array.
(dict) --
Describes a virtual tape.
TapeARN (string) --
The Amazon Resource Name (ARN) of a virtual tape.
TapeBarcode (string) --
The barcode that identifies a specific virtual tape.
TapeSizeInBytes (integer) --
The size, in bytes, of a virtual tape.
TapeStatus (string) --
The status of the tape.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
PoolId (string) --
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
RetentionStartDate (datetime) --
The date that the tape became subject to tape retention lock.
PoolEntryDate (datetime) --
The date that the tape entered the custom tape pool with tape retention lock enabled.
Marker (string) --
A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorlist_volume_initiators(**kwargs)¶Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
See also: AWS API Documentation
Request Syntax
response = client.list_volume_initiators(
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.
{
'Initiators': [
'string',
]
}
Response Structure
ListVolumeInitiatorsOutput
The host names and port numbers of all iSCSI initiators that are connected to the gateway.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorlist_volume_recovery_points(**kwargs)¶Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.
Each cache 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 or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
See also: AWS API Documentation
Request Syntax
response = client.list_volume_recovery_points(
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 Amazon Web Services Region.
{
'GatewayARN': 'string',
'VolumeRecoveryPointInfos': [
{
'VolumeARN': 'string',
'VolumeSizeInBytes': 123,
'VolumeUsageInBytes': 123,
'VolumeRecoveryPointTime': 'string'
},
]
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
An array of VolumeRecoveryPointInfo objects.
Describes a storage volume recovery point object.
The Amazon Resource Name (ARN) of the volume target.
The size of the volume in bytes.
The size of the data stored on the volume in bytes.
Note
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
The time the recovery point was taken.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot.
response = client.list_volume_recovery_points(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'VolumeRecoveryPointInfos': [
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeRecoveryPointTime': '2012-09-04T21:08:44.627Z',
'VolumeSizeInBytes': 536870912000,
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_volumes(**kwargs)¶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 or the DescribeCachediSCSIVolumes 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. This operation is only supported in the cached volume and stored volume gateway types.
See also: AWS API Documentation
Request Syntax
response = client.list_volumes(
GatewayARN='string',
Marker='string',
Limit=123
)
dict
Response Syntax
{
'GatewayARN': 'string',
'Marker': 'string',
'VolumeInfos': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'GatewayARN': 'string',
'GatewayId': 'string',
'VolumeType': 'string',
'VolumeSizeInBytes': 123,
'VolumeAttachmentStatus': 'string'
},
]
}
Response Structure
(dict) --
A JSON object containing the following fields:
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Marker (string) --
Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.
VolumeInfos (list) --
An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".
(dict) --
Describes a storage volume object.
VolumeARN (string) --
The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeId (string) --
The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
GatewayId (string) --
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeType (string) --
One of the VolumeType enumeration values describing the type of the volume.
VolumeSizeInBytes (integer) --
The size of the volume in bytes.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeAttachmentStatus (string) --
One of the VolumeStatus values that indicates the state of the storage volume.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.
response = client.list_volumes(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
Limit=2,
Marker='1',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'Marker': '1',
'VolumeInfos': [
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'GatewayId': 'sgw-12A3456B',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeId': 'vol-1122AABB',
'VolumeSizeInBytes': 107374182400,
'VolumeType': 'STORED',
},
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C',
'GatewayId': 'sgw-gw-13B4567C',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD',
'VolumeId': 'vol-1122AABB',
'VolumeSizeInBytes': 107374182400,
'VolumeType': 'STORED',
},
],
'ResponseMetadata': {
'...': '...',
},
}
notify_when_uploaded(**kwargs)¶Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to S3. Amazon S3.
Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
For more information, see Getting file upload notification in the Storage Gateway User Guide .
See also: AWS API Documentation
Request Syntax
response = client.notify_when_uploaded(
FileShareARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file share.
{
'FileShareARN': 'string',
'NotificationId': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the file share.
The randomly generated ID of the notification that was sent. This ID is in UUID format.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorrefresh_cache(**kwargs)¶Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway User Guide . This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway User Guide .
Warning
InvalidGatewayRequestException error because too many requests were sent to the server.Note
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.
For more information, see Getting notified about file operations in the Storage Gateway User Guide .
See also: AWS API Documentation
Request Syntax
response = client.refresh_cache(
FileShareARN='string',
FolderList=[
'string',
],
Recursive=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file share you want to refresh.
A comma-separated list of the paths of folders to refresh in the cache. The default is ["/" ]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true , the entire S3 bucket that the file share has access to is refreshed.
A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to true , each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is true .
Valid Values: true | false
dict
Response Syntax
{
'FileShareARN': 'string',
'NotificationId': 'string'
}
Response Structure
(dict) --
RefreshCacheOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the file share.
NotificationId (string) --
The randomly generated ID of the notification that was sent. This ID is in UUID format.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorRemoves one or more tags from the specified resource. This operation is supported in storage gateways of all types.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you want to remove the tags from.
[REQUIRED]
The keys of the tags you want to remove from the specified resource. A tag is composed of a key-value pair.
dict
Response Syntax
{
'ResourceARN': 'string'
}
Response Structure
(dict) --
RemoveTagsFromResourceOutput
ResourceARN (string) --
The Amazon Resource Name (ARN) of the resource that the tags were removed from.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource.
response = client.remove_tags_from_resource(
ResourceARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
TagKeys=[
'Dev Gatgeway Region',
'East Coast',
],
)
print(response)
Expected Output:
{
'ResourceARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
'ResponseMetadata': {
'...': '...',
},
}
reset_cache(**kwargs)¶Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an 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. This operation is only supported in the cached volume and tape types.
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.
See also: AWS API Documentation
Request Syntax
response = client.reset_cache(
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 Amazon Web Services Region.
{
'GatewayARN': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage.
response = client.reset_cache(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C',
'ResponseMetadata': {
'...': '...',
},
}
retrieve_tape_archive(**kwargs)¶Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. 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, that is, archive. This operation is only supported in the tape gateway type.
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. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.retrieve_tape_archive(
TapeARN='string',
GatewayARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
RetrieveTapeArchiveOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the retrieved virtual tape.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
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.
response = client.retrieve_tape_archive(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
'ResponseMetadata': {
'...': '...',
},
}
retrieve_tape_recovery_point(**kwargs)¶Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.
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 tape gateway. There is no charge for retrieving recovery points.
See also: AWS API Documentation
Request Syntax
response = client.retrieve_tape_recovery_point(
TapeARN='string',
GatewayARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
RetrieveTapeRecoveryPointOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Retrieves the recovery point for the specified virtual tape.
response = client.retrieve_tape_recovery_point(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
'ResponseMetadata': {
'...': '...',
},
}
set_local_console_password(**kwargs)¶Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.
See also: AWS API Documentation
Request Syntax
response = client.set_local_console_password(
GatewayARN='string',
LocalConsolePassword='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The password you want to set for your VM local console.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Sets the password for your VM local console.
response = client.set_local_console_password(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
LocalConsolePassword='PassWordMustBeAtLeast6Chars.',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
set_smb_guest_password(**kwargs)¶Sets the password for the guest user smbguest . The smbguest user is the user when the authentication method for the file share is set to GuestAccess . This operation only supported for S3 File Gateways
See also: AWS API Documentation
Request Syntax
response = client.set_smb_guest_password(
GatewayARN='string',
Password='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share is associated with.
[REQUIRED]
The password that you want to set for your SMB server.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorshutdown_gateway(**kwargs)¶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 gateway's virtual machine (VM) and not the host 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.
See also: AWS API Documentation
Request Syntax
response = client.shutdown_gateway(
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 Amazon Web Services Region.
{
'GatewayARN': 'string'
}
Response Structure
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.
response = client.shutdown_gateway(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
start_availability_monitor_test(**kwargs)¶Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.
Note
Starting this test will cause your gateway to go offline for a brief period.
See also: AWS API Documentation
Request Syntax
response = client.start_availability_monitor_test(
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 Amazon Web Services Region.
{
'GatewayARN': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorstart_gateway(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.start_gateway(
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 Amazon Web Services Region.
{
'GatewayARN': 'string'
}
Response Structure
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Starts a gateway service that was previously shut down.
response = client.start_gateway(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
update_automatic_tape_creation_policy(**kwargs)¶Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.
By default, there is no automatic tape creation policy.
Note
A gateway can have only one automatic tape creation policy.
See also: AWS API Documentation
Request Syntax
response = client.update_automatic_tape_creation_policy(
AutomaticTapeCreationRules=[
{
'TapeBarcodePrefix': 'string',
'PoolId': 'string',
'TapeSizeInBytes': 123,
'MinimumNumTapes': 123,
'Worm': True|False
},
],
GatewayARN='string'
)
[REQUIRED]
An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.
An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically .
A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.
Note
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
The size, in bytes, of the virtual tape capacity.
The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway. For more information about automatic tape creation, see Creating Tapes Automatically .
Set to true to indicate that tapes are to be archived as write-once-read-many (WORM). Set to false when WORM is not enabled for tapes.
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorupdate_bandwidth_rate_limit(**kwargs)¶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. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule .
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.
See also: AWS API Documentation
Request Syntax
response = client.update_bandwidth_rate_limit(
GatewayARN='string',
AverageUploadRateLimitInBitsPerSec=123,
AverageDownloadRateLimitInBitsPerSec=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains.
response = client.update_bandwidth_rate_limit(
AverageDownloadRateLimitInBitsPerSec=102400,
AverageUploadRateLimitInBitsPerSec=51200,
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
update_bandwidth_rate_limit_schedule(**kwargs)¶Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.
See also: AWS API Documentation
Request Syntax
response = client.update_bandwidth_rate_limit_schedule(
GatewayARN='string',
BandwidthRateLimitIntervals=[
{
'StartHourOfDay': 123,
'StartMinuteOfHour': 123,
'EndHourOfDay': 123,
'EndMinuteOfHour': 123,
'DaysOfWeek': [
123,
],
'AverageUploadRateLimitInBitsPerSec': 123,
'AverageDownloadRateLimitInBitsPerSec': 123
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
The hour of the day to start the bandwidth rate limit interval.
The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0 .
The hour of the day to end the bandwidth rate limit interval.
The minute of the hour to end the bandwidth rate limit interval.
Warning
The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59 .
The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.
The average download rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the download rate limit is not set.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorupdate_chap_credentials(**kwargs)¶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. This operation is supported in the volume and tape gateway types.
Warning
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
See also: AWS API Documentation
Request Syntax
response = client.update_chap_credentials(
TargetARN='string',
SecretToAuthenticateInitiator='string',
InitiatorName='string',
SecretToAuthenticateTarget='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
[REQUIRED]
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
Note
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
[REQUIRED]
The iSCSI initiator that connects to the target.
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
Note
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
dict
Response Syntax
{
'TargetARN': 'string',
'InitiatorName': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
TargetARN (string) --
The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
InitiatorName (string) --
The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
response = client.update_chap_credentials(
InitiatorName='iqn.1991-05.com.microsoft:computername.domain.example.com',
SecretToAuthenticateInitiator='111111111111',
SecretToAuthenticateTarget='222222222222',
TargetARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
)
print(response)
Expected Output:
{
'InitiatorName': 'iqn.1991-05.com.microsoft:computername.domain.example.com',
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
'ResponseMetadata': {
'...': '...',
},
}
update_file_system_association(**kwargs)¶Updates a file system association. This operation is only supported in the FSx File Gateways.
See also: AWS API Documentation
Request Syntax
response = client.update_file_system_association(
FileSystemAssociationARN='string',
UserName='string',
Password='string',
AuditDestinationARN='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file system association that you want to update.
The refresh cache information for the file share or FSx file systems.
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
dict
Response Syntax
{
'FileSystemAssociationARN': 'string'
}
Response Structure
(dict) --
FileSystemAssociationARN (string) --
The ARN of the updated file system association.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorupdate_gateway_information(**kwargs)¶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.
Note
For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_gateway_information(
GatewayARN='string',
GatewayName='string',
GatewayTimezone='string',
CloudWatchLogGroupARN='string',
GatewayCapacity='Small'|'Medium'|'Large'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.
For more information, see What is Amazon CloudWatch Logs?
dict
Response Syntax
{
'GatewayARN': 'string',
'GatewayName': 'string'
}
Response Structure
(dict) --
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
GatewayName (string) --
The name you configured for your gateway.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Updates a gateway's metadata, which includes the gateway's name and time zone.
response = client.update_gateway_information(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
GatewayName='MyGateway2',
GatewayTimezone='GMT-12:00',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'GatewayName': '',
'ResponseMetadata': {
'...': '...',
},
}
update_gateway_software_now(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_gateway_software_now(
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 Amazon Web Services Region.
{
'GatewayARN': 'string'
}
Response Structure
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
response = client.update_gateway_software_now(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
update_maintenance_start_time(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_maintenance_start_time(
GatewayARN='string',
HourOfDay=123,
MinuteOfHour=123,
DayOfWeek=123,
DayOfMonth=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The hour component of the maintenance start time represented as hh , where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
[REQUIRED]
The minute component of the maintenance start time represented as mm , where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is in your gateway's time zone.
response = client.update_maintenance_start_time(
DayOfWeek=2,
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
HourOfDay=0,
MinuteOfHour=30,
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.
Note
To leave a file share field unchanged, set the corresponding input field to null.
Updates the following file share settings:
See also: AWS API Documentation
Request Syntax
response = client.update_nfs_file_share(
FileShareARN='string',
KMSEncrypted=True|False,
KMSKey='string',
NFSFileShareDefaults={
'FileMode': 'string',
'DirectoryMode': 'string',
'GroupId': 123,
'OwnerId': 123
},
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ClientList=[
'string',
],
Squash='string',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
FileShareName='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
NotificationPolicy='string',
AuditDestinationARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file share to be updated.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
KMSEncrypted is true . Optional.The default values for the file share. Optional.
The Unix file mode in the form "nnnn". For example, 0666 represents the default file mode inside the file share. The default value is 0666 .
The Unix directory mode in the form "nnnn". For example, 0666 represents the default access mode for all directories inside the file share. The default value is 0777 .
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody .
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody .
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
private .The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
The user mapped to anonymous user.
Valid values are the following:
RootSquash : Only root is mapped to anonymous user.NoSquash : No one is mapped to anonymous user.AllSquash : Everyone is mapped to anonymous user.A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false . The default value is true .
Valid Values: true | false
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN , or if an access point or access point alias is used.
Specifies refresh cache information for the file share.
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
Note
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateNFSFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the updated file share.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorUpdates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.
Note
To leave a file share field unchanged, set the corresponding input field to null.
Warning
File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide .
File gateways don't support creating hard or symbolic links on a file share.
See also: AWS API Documentation
Request Syntax
response = client.update_smb_file_share(
FileShareARN='string',
KMSEncrypted=True|False,
KMSKey='string',
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
SMBACLEnabled=True|False,
AccessBasedEnumeration=True|False,
AdminUserList=[
'string',
],
ValidUserList=[
'string',
],
InvalidUserList=[
'string',
],
AuditDestinationARN='string',
CaseSensitivity='ClientSpecified'|'CaseSensitive',
FileShareName='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
NotificationPolicy='string',
OplocksEnabled=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
KMSEncrypted is true . Optional.The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
private .A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false .
Valid Values: true | false
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false . The default value is true .
Valid Values: true | false
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide .
Valid Values: true | false
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
ClientSpecified , the client determines the case sensitivity. For CaseSensitive , the gateway determines the case sensitivity. The default value is ClientSpecified .The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN , or if an access point or access point alias is used.
Specifies refresh cache information for the file share.
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
Note
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
Specifies whether opportunistic locking is enabled for the SMB file share.
Note
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateSMBFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the updated SMB file share.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorControls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways.
See also: AWS API Documentation
Request Syntax
response = client.update_smb_file_share_visibility(
GatewayARN='string',
FileSharesVisible=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
The shares on this gateway appear when listing shares.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorupdate_smb_local_groups(**kwargs)¶Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
See also: AWS API Documentation
Request Syntax
response = client.update_smb_local_groups(
GatewayARN='string',
SMBLocalGroups={
'GatewayAdmins': [
'string',
]
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway.
A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats include: DOMAIN\User1 , user1 , DOMAIN\group1 , and group1 .
Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force-close files that are open and locked.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorupdate_smb_security_strategy(**kwargs)¶Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.
Note
This API is called Security level in the User Guide.
A higher security level can affect performance of the gateway.
See also: AWS API Documentation
Request Syntax
response = client.update_smb_security_strategy(
GatewayARN='string',
SMBSecurityStrategy='ClientSpecified'|'MandatorySigning'|'MandatoryEncryption'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
[REQUIRED]
Specifies the type of security strategy.
ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only in S3 File Gateway.
MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorupdate_snapshot_schedule(**kwargs)¶Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.
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.
See also: AWS API Documentation
Request Syntax
response = client.update_snapshot_schedule(
VolumeARN='string',
StartAt=123,
RecurrenceInHours=123,
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
[REQUIRED]
The hour of the day at which the snapshot schedule begins represented as hh , where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
[REQUIRED]
Frequency of snapshots. Specify the number of hours between snapshots.
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Tag key. The key can't start with aws:.
Value of the tag key.
dict
Response Syntax
{
'VolumeARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.
VolumeARN (string) --
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Updates a snapshot schedule configured for a gateway volume.
response = client.update_snapshot_schedule(
Description='Hourly snapshot',
RecurrenceInHours=1,
StartAt=0,
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
update_vtl_device_type(**kwargs)¶Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.update_vtl_device_type(
VTLDeviceARN='string',
DeviceType='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the medium changer you want to select.
[REQUIRED]
The type of medium changer you want to select.
Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402
dict
Response Syntax
{
'VTLDeviceARN': 'string'
}
Response Structure
(dict) --
UpdateVTLDeviceTypeOutput
VTLDeviceARN (string) --
The Amazon Resource Name (ARN) of the medium changer you have selected.
Exceptions
StorageGateway.Client.exceptions.InvalidGatewayRequestExceptionStorageGateway.Client.exceptions.InternalServerErrorExamples
Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated.
response = client.update_vtl_device_type(
DeviceType='Medium Changer',
VTLDeviceARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001',
)
print(response)
Expected Output:
{
'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001',
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
StorageGateway.Paginator.DescribeTapeArchivesStorageGateway.Paginator.DescribeTapeRecoveryPointsStorageGateway.Paginator.DescribeTapesStorageGateway.Paginator.DescribeVTLDevicesStorageGateway.Paginator.ListFileSharesStorageGateway.Paginator.ListFileSystemAssociationsStorageGateway.Paginator.ListGatewaysStorageGateway.Paginator.ListTagsForResourceStorageGateway.Paginator.ListTapePoolsStorageGateway.Paginator.ListTapesStorageGateway.Paginator.ListVolumesStorageGateway.Paginator.DescribeTapeArchives¶paginator = client.get_paginator('describe_tape_archives')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.describe_tape_archives().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TapeARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TapeArchives': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeCreatedDate': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'CompletionTime': datetime(2015, 1, 1),
'RetrievedTo': 'string',
'TapeStatus': 'string',
'TapeUsedInBytes': 123,
'KMSKey': 'string',
'PoolId': 'string',
'Worm': True|False,
'RetentionStartDate': datetime(2015, 1, 1),
'PoolEntryDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DescribeTapeArchivesOutput
TapeArchives (list) --
An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.
(dict) --
Represents a virtual tape that is archived in the virtual tape shelf (VTS).
TapeARN (string) --
The Amazon Resource Name (ARN) of an archived virtual tape.
TapeBarcode (string) --
The barcode that identifies the archived virtual tape.
TapeCreatedDate (datetime) --
The date the virtual tape was created.
TapeSizeInBytes (integer) --
The size, in bytes, of the archived virtual tape.
CompletionTime (datetime) --
The time that the archiving of the virtual tape was completed.
The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
RetrievedTo (string) --
The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
TapeStatus (string) --
The current state of the archived virtual tape.
TapeUsedInBytes (integer) --
The size, in bytes, of data stored on the virtual tape.
Note
This value is not available for tapes created prior to May 13, 2015.
KMSKey (string) --
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
PoolId (string) --
The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.
Worm (boolean) --
Set to true if the archived tape is stored as write-once-read-many (WORM).
RetentionStartDate (datetime) --
If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
PoolEntryDate (datetime) --
The time that the tape entered the custom tape pool.
The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
NextToken (string) --
A token to resume pagination.
StorageGateway.Paginator.DescribeTapeRecoveryPoints¶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().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GatewayARN': 'string',
'TapeRecoveryPointInfos': [
{
'TapeARN': 'string',
'TapeRecoveryPointTime': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DescribeTapeRecoveryPointsOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
TapeRecoveryPointInfos (list) --
An array of TapeRecoveryPointInfos that are available for the specified gateway.
(dict) --
Describes a recovery point.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeRecoveryPointTime (datetime) --
The time when the point-in-time view of the virtual tape was replicated for later recovery.
The default timestamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tapes to recover.
TapeStatus (string) --
The status of the virtual tapes.
NextToken (string) --
A token to resume pagination.
StorageGateway.Paginator.DescribeTapes¶paginator = client.get_paginator('describe_tapes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.describe_tapes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
TapeARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tapes': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeCreatedDate': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'VTLDevice': 'string',
'Progress': 123.0,
'TapeUsedInBytes': 123,
'KMSKey': 'string',
'PoolId': 'string',
'Worm': True|False,
'RetentionStartDate': datetime(2015, 1, 1),
'PoolEntryDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DescribeTapesOutput
Tapes (list) --
An array of virtual tape descriptions.
(dict) --
Describes a virtual tape object.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeBarcode (string) --
The barcode that identifies a specific virtual tape.
TapeCreatedDate (datetime) --
The date the virtual tape was created.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tape capacity.
TapeStatus (string) --
The current state of the virtual tape.
VTLDevice (string) --
The virtual tape library (VTL) device that the virtual tape is associated with.
Progress (float) --
For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
TapeUsedInBytes (integer) --
The size, in bytes, of data stored on the virtual tape.
Note
This value is not available for tapes created prior to May 13, 2015.
KMSKey (string) --
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
PoolId (string) --
The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Worm (boolean) --
If the tape is archived as write-once-read-many (WORM), this value is true .
RetentionStartDate (datetime) --
The date that the tape is first archived with tape retention lock enabled.
PoolEntryDate (datetime) --
The date that the tape enters a custom tape pool.
NextToken (string) --
A token to resume pagination.
StorageGateway.Paginator.DescribeVTLDevices¶paginator = client.get_paginator('describe_vtl_devices')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.describe_vtl_devices().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
VTLDeviceARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
Note
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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
(dict) --
DescribeVTLDevicesOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
VTLDevices (list) --
An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.
(dict) --
Represents a device object associated with a tape gateway.
VTLDeviceARN (string) --
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
VTLDeviceType (string) --
Specifies the type of device that the VTL device emulates.
VTLDeviceVendor (string) --
Specifies the vendor of the device that the VTL device object emulates.
VTLDeviceProductIdentifier (string) --
Specifies the model number of device that the VTL device emulates.
DeviceiSCSIAttributes (dict) --
A list of iSCSI information about a VTL device.
TargetARN (string) --
Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
NetworkInterfaceId (string) --
The network interface identifier of the VTL device.
NetworkInterfacePort (integer) --
The port used to communicate with iSCSI VTL device targets.
ChapEnabled (boolean) --
Indicates whether mutual CHAP is enabled for the iSCSI target.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_file_shares')
Creates an iterator that will paginate through responses from StorageGateway.Client.list_file_shares().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Marker': 'string',
'FileShareInfoList': [
{
'FileShareType': 'NFS'|'SMB',
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ListFileShareOutput
Marker (string) --
If the request includes Marker , the response returns that value in this field.
FileShareInfoList (list) --
An array of information about the S3 File Gateway's file shares.
(dict) --
Describes a file share. Only supported S3 File Gateway.
FileShareType (string) --
The type of the file share.
FileShareARN (string) --
The Amazon Resource Name (ARN) of the file share.
FileShareId (string) --
The ID of the file share.
FileShareStatus (string) --
The status of the file share.
Valid Values: CREATING | UPDATING | AVAILABLE | DELETING
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
NextToken (string) --
A token to resume pagination.
StorageGateway.Paginator.ListFileSystemAssociations¶paginator = client.get_paginator('list_file_system_associations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.list_file_system_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Marker': 'string',
'FileSystemAssociationSummaryList': [
{
'FileSystemAssociationId': 'string',
'FileSystemAssociationARN': 'string',
'FileSystemAssociationStatus': 'string',
'GatewayARN': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Marker (string) --
If the request includes Marker , the response returns that value in this field.
FileSystemAssociationSummaryList (list) --
An array of information about the Amazon FSx gateway's file system associations.
(dict) --
Gets the summary returned by ListFileSystemAssociation , which is a summary of a created file system association.
FileSystemAssociationId (string) --
The ID of the file system association.
FileSystemAssociationARN (string) --
The Amazon Resource Name (ARN) of the file system association.
FileSystemAssociationStatus (string) --
The status of the file share. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
NextToken (string) --
A token to resume pagination.
StorageGateway.Paginator.ListGateways¶paginator = client.get_paginator('list_gateways')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.list_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Gateways': [
{
'GatewayId': 'string',
'GatewayARN': 'string',
'GatewayType': 'string',
'GatewayOperationalState': 'string',
'GatewayName': 'string',
'Ec2InstanceId': 'string',
'Ec2InstanceRegion': 'string',
'HostEnvironment': 'VMWARE'|'HYPER-V'|'EC2'|'KVM'|'OTHER'|'SNOWBALL',
'HostEnvironmentId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
An array of GatewayInfo objects.
Describes a gateway object.
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
The type of the gateway.
The state of the gateway.
Valid Values: DISABLED | ACTIVE
The name of the gateway.
The ID of the Amazon EC2 instance that was used to launch the gateway.
The Amazon Web Services Region where the Amazon EC2 instance is located.
The type of hardware or software platform on which the gateway is running.
A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
A token to resume pagination.
StorageGateway.Paginator.ListTagsForResource¶paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.list_tags_for_resource().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ListTagsForResourceOutput
ResourceARN (string) --
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
Tags (list) --
An array that contains the tags for the specified resource.
(dict) --
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Key (string) --
Tag key. The key can't start with aws:.
Value (string) --
Value of the tag key.
NextToken (string) --
A token to resume pagination.
StorageGateway.Paginator.ListTapePools¶paginator = client.get_paginator('list_tape_pools')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.list_tape_pools().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PoolARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PoolInfos': [
{
'PoolARN': 'string',
'PoolName': 'string',
'StorageClass': 'DEEP_ARCHIVE'|'GLACIER',
'RetentionLockType': 'COMPLIANCE'|'GOVERNANCE'|'NONE',
'RetentionLockTimeInDays': 123,
'PoolStatus': 'ACTIVE'|'DELETED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PoolInfos (list) --
An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.
(dict) --
Describes a custom tape pool.
PoolARN (string) --
The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and Amazon Web Services Region.
PoolName (string) --
The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and ''.
StorageClass (string) --
The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
RetentionLockType (string) --
Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
RetentionLockTimeInDays (integer) --
Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
PoolStatus (string) --
Status of the custom tape pool. Pool can be ACTIVE or DELETED .
NextToken (string) --
A token to resume pagination.
StorageGateway.Paginator.ListTapes¶paginator = client.get_paginator('list_tapes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.list_tapes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TapeARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TapeInfos': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'GatewayARN': 'string',
'PoolId': 'string',
'RetentionStartDate': datetime(2015, 1, 1),
'PoolEntryDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
TapeInfos (list) --
An array of TapeInfo objects, where each object describes a single tape. If there are no tapes in the tape library or VTS, then the TapeInfos is an empty array.
(dict) --
Describes a virtual tape.
TapeARN (string) --
The Amazon Resource Name (ARN) of a virtual tape.
TapeBarcode (string) --
The barcode that identifies a specific virtual tape.
TapeSizeInBytes (integer) --
The size, in bytes, of a virtual tape.
TapeStatus (string) --
The status of the tape.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
PoolId (string) --
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
RetentionStartDate (datetime) --
The date that the tape became subject to tape retention lock.
PoolEntryDate (datetime) --
The date that the tape entered the custom tape pool with tape retention lock enabled.
NextToken (string) --
A token to resume pagination.
StorageGateway.Paginator.ListVolumes¶paginator = client.get_paginator('list_volumes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from StorageGateway.Client.list_volumes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GatewayARN': 'string',
'VolumeInfos': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'GatewayARN': 'string',
'GatewayId': 'string',
'VolumeType': 'string',
'VolumeSizeInBytes': 123,
'VolumeAttachmentStatus': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
VolumeInfos (list) --
An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".
(dict) --
Describes a storage volume object.
VolumeARN (string) --
The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeId (string) --
The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
GatewayId (string) --
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeType (string) --
One of the VolumeType enumeration values describing the type of the volume.
VolumeSizeInBytes (integer) --
The size of the volume in bytes.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeAttachmentStatus (string) --
One of the VolumeStatus values that indicates the state of the storage volume.
NextToken (string) --
A token to resume pagination.