StorageGateway#
Client#
- class StorageGateway.Client#
A low-level client representing AWS Storage Gateway
Warning
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.
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:
Storage Gateway required request headers: Describes the required headers that you must send with every POST request to Storage Gateway.
Signing requests: Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
Error responses: Provides reference information about Storage Gateway errors.
Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
Storage Gateway endpoints and quotas: Provides a list of each Amazon Web Services Region and the endpoints available for use with Storage Gateway.
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 tovol-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
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: