Client

storagegateway

R Documentation

AWS Storage Gateway¶

Description¶

Storage Gateway Service

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.

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.

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.

Usage¶

storagegateway(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- storagegateway(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

activate_gateway: Activates the gateway you previously deployed on your host
add_cache: Configures one or more gateway local disks as cache for a gateway
add_tags_to_resource: Adds one or more tags to the specified resource
add_upload_buffer: Configures one or more gateway local disks as upload buffer for a specified gateway
add_working_storage: Configures one or more gateway local disks as working storage for a gateway
assign_tape_pool: Assigns a tape to a tape pool for archiving
associate_file_system: Associate an Amazon FSx file system with the FSx File Gateway
attach_volume: Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway
cancel_archival: Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated
cancel_retrieval: Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated
create_cachedi_scsi_volume: Creates a cached volume on a specified cached volume gateway
create_nfs_file_share: Creates a Network File System (NFS) file share on an existing S3 File Gateway
create_smb_file_share: Creates a Server Message Block (SMB) file share on an existing S3 File Gateway
create_snapshot: Initiates a snapshot of a volume; Initiates a snapshot of a gateway from a volume recovery point
create_storedi_scsi_volume: Creates a volume on a specified gateway
create_tape_pool: Creates a new custom tape pool
create_tapes: Creates one or more virtual tapes
create_tape_with_barcode: Creates a virtual tape by using your own barcode
delete_automatic_tape_creation_policy: Deletes the automatic tape creation policy of a gateway
delete_bandwidth_rate_limit: Deletes the bandwidth rate limits of a gateway
delete_chap_credentials: Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair
delete_file_share: Deletes a file share from an S3 File Gateway
delete_gateway: Deletes a gateway
delete_snapshot_schedule: Deletes a snapshot of a volume
delete_tape: Deletes the specified virtual tape
delete_tape_archive: Deletes the specified virtual tape from the virtual tape shelf (VTS)
delete_tape_pool: Delete a custom tape pool
delete_volume: Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API
describe_availability_monitor_test: Returns information about the most recent high availability monitoring test that was performed on the host in a cluster
describe_bandwidth_rate_limit: Returns the bandwidth rate limits of a gateway; Returns information about the bandwidth rate limit schedule of a gateway
describe_cache: Returns information about the cache of a gateway
describe_cachedi_scsi_volumes: Returns a description of the gateway volumes specified in the request
describe_chap_credentials: Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair
describe_file_system_associations: Gets the file system association information
describe_gateway_information: Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version
describe_maintenance_start_time: Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply
describe_nfs_file_shares: Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway
describe_smb_file_shares: Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway
describe_smb_settings: Gets a description of a Server Message Block (SMB) file share settings from a file gateway
describe_snapshot_schedule: Describes the snapshot schedule for the specified gateway volume
describe_storedi_scsi_volumes: Returns the description of the gateway volumes specified in the request
describe_tape_archives: Returns a description of specified virtual tapes in the virtual tape shelf (VTS)
describe_tape_recovery_points: Returns a list of virtual tape recovery points that are available for the specified tape gateway
describe_tapes: Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs)
describe_upload_buffer: Returns information about the upload buffer of a gateway
describe_vtl_devices: Returns a description of virtual tape library (VTL) devices for the specified tape gateway
describe_working_storage: Returns information about the working storage of a gateway
detach_volume: Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway
disable_gateway: Disables a tape gateway when the gateway is no longer functioning
disassociate_file_system: Disassociates an Amazon FSx file system from the specified gateway
join_domain: Adds a file gateway to an Active Directory domain
list_automatic_tape_creation_policies: Lists the automatic tape creation policies for a gateway
list_file_shares: Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account
list_file_system_associations: Gets a list of FileSystemAssociationSummary objects
list_gateways: Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request
list_local_disks: Returns a list of the gateway's local disks
list_tags_for_resource: Lists the tags that have been added to the specified resource
list_tape_pools: Lists custom tape pools
list_tapes: Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS)
list_volume_initiators: Lists iSCSI initiators that are connected to a volume
list_volume_recovery_points: Lists the recovery points for a specified gateway
list_volumes: Lists the iSCSI stored volumes of a gateway
notify_when_uploaded: Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3
refresh_cache: Refreshes the cached inventory of objects for the specified file share
remove_tags_from_resource: Removes one or more tags from the specified resource
reset_cache: Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage
retrieve_tape_archive: Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway
retrieve_tape_recovery_point: Retrieves the recovery point for the specified virtual tape
set_local_console_password: Sets the password for your VM local console
set_smb_guest_password: Sets the password for the guest user smbguest
shutdown_gateway: Shuts down a Tape Gateway or Volume Gateway
start_availability_monitor_test: Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment
start_gateway: Starts a gateway that you previously shut down (see ShutdownGateway)
update_automatic_tape_creation_policy: Updates the automatic tape creation policy of a gateway
update_bandwidth_rate_limit: Updates the bandwidth rate limits of a gateway
update_bandwidth_rate_limit_schedule: Updates the bandwidth rate limit schedule for a specified gateway
update_chap_credentials: Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target
update_file_system_association: Updates a file system association
update_gateway_information: Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size
update_gateway_software_now: Updates the gateway virtual machine (VM) software
update_maintenance_start_time: Updates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply
update_nfs_file_share: Updates a Network File System (NFS) file share
update_smb_file_share: Updates a Server Message Block (SMB) file share
update_smb_file_share_visibility: Controls whether the shares on an S3 File Gateway are visible in a net view or browse list
update_smb_local_groups: Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway
update_smb_security_strategy: Updates the SMB security strategy level for an Amazon S3 file gateway
update_snapshot_schedule: Updates a snapshot schedule configured for a gateway volume
update_vtl_device_type: Updates the type of medium changer in a tape gateway

Examples¶

## Not run: 
svc <- storagegateway()
# Activates the gateway you previously deployed on your host.
svc$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"
)

## End(Not run)