NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class StorageGatewayClient

Client to interact with AWS Storage Gateway

  Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
  Guzzle\Http\Client implements Guzzle\Http\ClientInterface
  Guzzle\Service\Client implements Guzzle\Service\ClientInterface
  Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
  Aws\StorageGateway\StorageGatewayClient

Namespace: Aws\StorageGateway
Link: User guide
Link: API docs
Located at Aws/StorageGateway/StorageGatewayClient.php

## Methods summary

- `public static` `factory ( array|Collection $config = array() )`

  Factory method to create a new AWS Storage Gateway client using an array of configuration options.

- `public` `activateGateway ( array $args = array() )`

  Executes the ActivateGateway operation.

- `public` `addCache ( array $args = array() )`

  Executes the AddCache operation.

- `public` `addTagsToResource ( array $args = array() )`

  Executes the AddTagsToResource operation.

- `public` `addUploadBuffer ( array $args = array() )`

  Executes the AddUploadBuffer operation.

- `public` `addWorkingStorage ( array $args = array() )`

  Executes the AddWorkingStorage operation.

- `public` `cancelArchival ( array $args = array() )`

  Executes the CancelArchival operation.

- `public` `cancelRetrieval ( array $args = array() )`

  Executes the CancelRetrieval operation.

- `public` `createCachediSCSIVolume ( array $args = array() )`

  Executes the CreateCachediSCSIVolume operation.

- `public` `createSnapshot ( array $args = array() )`

  Executes the CreateSnapshot operation.

- `public` `createSnapshotFromVolumeRecoveryPoint ( array $args = array() )`

  Executes the CreateSnapshotFromVolumeRecoveryPoint operation.

- `public` `createStorediSCSIVolume ( array $args = array() )`

  Executes the CreateStorediSCSIVolume operation.

- `public` `createTapes ( array $args = array() )`

  Executes the CreateTapes operation.

- `public` `deleteBandwidthRateLimit ( array $args = array() )`

  Executes the DeleteBandwidthRateLimit operation.

- `public` `deleteChapCredentials ( array $args = array() )`

  Executes the DeleteChapCredentials operation.

- `public` `deleteGateway ( array $args = array() )`

  Executes the DeleteGateway operation.

- `public` `deleteSnapshotSchedule ( array $args = array() )`

  Executes the DeleteSnapshotSchedule operation.

- `public` `deleteTape ( array $args = array() )`

  Executes the DeleteTape operation.

- `public` `deleteTapeArchive ( array $args = array() )`

  Executes the DeleteTapeArchive operation.

- `public` `deleteVolume ( array $args = array() )`

  Executes the DeleteVolume operation.

- `public` `describeBandwidthRateLimit ( array $args = array() )`

  Executes the DescribeBandwidthRateLimit operation.

- `public` `describeCache ( array $args = array() )`

  Executes the DescribeCache operation.

- `public` `describeCachediSCSIVolumes ( array $args = array() )`

  Executes the DescribeCachediSCSIVolumes operation.

- `public` `describeChapCredentials ( array $args = array() )`

  Executes the DescribeChapCredentials operation.

- `public` `describeGatewayInformation ( array $args = array() )`

  Executes the DescribeGatewayInformation operation.

- `public` `describeMaintenanceStartTime ( array $args = array() )`

  Executes the DescribeMaintenanceStartTime operation.

- `public` `describeSnapshotSchedule ( array $args = array() )`

  Executes the DescribeSnapshotSchedule operation.

- `public` `describeStorediSCSIVolumes ( array $args = array() )`

  Executes the DescribeStorediSCSIVolumes operation.

- `public` `describeTapeArchives ( array $args = array() )`

  Executes the DescribeTapeArchives operation.

- `public` `describeTapeRecoveryPoints ( array $args = array() )`

  Executes the DescribeTapeRecoveryPoints operation.

- `public` `describeTapes ( array $args = array() )`

  Executes the DescribeTapes operation.

- `public` `describeUploadBuffer ( array $args = array() )`

  Executes the DescribeUploadBuffer operation.

- `public` `describeVTLDevices ( array $args = array() )`

  Executes the DescribeVTLDevices operation.

- `public` `describeWorkingStorage ( array $args = array() )`

  Executes the DescribeWorkingStorage operation.

- `public` `disableGateway ( array $args = array() )`

  Executes the DisableGateway operation.

- `public` `listGateways ( array $args = array() )`

  Executes the ListGateways operation.

- `public` `listLocalDisks ( array $args = array() )`

  Executes the ListLocalDisks operation.

- `public` `listTagsForResource ( array $args = array() )`

  Executes the ListTagsForResource operation.

- `public` `listVolumeInitiators ( array $args = array() )`

  Executes the ListVolumeInitiators operation.

- `public` `listVolumeRecoveryPoints ( array $args = array() )`

  Executes the ListVolumeRecoveryPoints operation.

- `public` `listVolumes ( array $args = array() )`

  Executes the ListVolumes operation.

- `public` `removeTagsFromResource ( array $args = array() )`

  Executes the RemoveTagsFromResource operation.

- `public` `resetCache ( array $args = array() )`

  Executes the ResetCache operation.

- `public` `retrieveTapeArchive ( array $args = array() )`

  Executes the RetrieveTapeArchive operation.

- `public` `retrieveTapeRecoveryPoint ( array $args = array() )`

  Executes the RetrieveTapeRecoveryPoint operation.

- `public` `shutdownGateway ( array $args = array() )`

  Executes the ShutdownGateway operation.

- `public` `startGateway ( array $args = array() )`

  Executes the StartGateway operation.

- `public` `updateBandwidthRateLimit ( array $args = array() )`

  Executes the UpdateBandwidthRateLimit operation.

- `public` `updateChapCredentials ( array $args = array() )`

  Executes the UpdateChapCredentials operation.

- `public` `updateGatewayInformation ( array $args = array() )`

  Executes the UpdateGatewayInformation operation.

- `public` `updateGatewaySoftwareNow ( array $args = array() )`

  Executes the UpdateGatewaySoftwareNow operation.

- `public` `updateMaintenanceStartTime ( array $args = array() )`

  Executes the UpdateMaintenanceStartTime operation.

- `public` `updateSnapshotSchedule ( array $args = array() )`

  Executes the UpdateSnapshotSchedule operation.

- `public` `updateVTLDeviceType ( array $args = array() )`

  Executes the UpdateVTLDeviceType operation.

- `public` `getDescribeCachediSCSIVolumesIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeCachediSCSIVolumes operation

- `public` `getDescribeStorediSCSIVolumesIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeStorediSCSIVolumes operation

- `public` `getDescribeTapeArchivesIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeTapeArchives operation

- `public` `getDescribeTapeRecoveryPointsIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeTapeRecoveryPoints operation

- `public` `getDescribeTapesIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeTapes operation

- `public` `getDescribeVTLDevicesIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeVTLDevices operation

- `public` `getListGatewaysIterator ( array $args = array() )`

  The input array uses the parameters of the ListGateways operation

- `public` `getListLocalDisksIterator ( array $args = array() )`

  The input array uses the parameters of the ListLocalDisks operation

- `public` `getListVolumeRecoveryPointsIterator ( array $args = array() )`

  The input array uses the parameters of the ListVolumeRecoveryPoints operation

- `public` `getListVolumesIterator ( array $args = array() )`

  The input array uses the parameters of the ListVolumes operation

## Methods detail

# `public static `Aws\StorageGateway\StorageGatewayClient``
`factory( array|`Guzzle\Common\Collection` $config = array() )`

Factory method to create a new AWS Storage Gateway client using an array of configuration options.

#### Parameters

$config
  `array|`Guzzle\Common\Collection``
  $config Client configuration data

#### Returns

``Aws\StorageGateway\StorageGatewayClient``

#### Link

http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options

#### Overrides

`Guzzle\Service\Client::factory`
# `public `Guzzle\Service\Resource\Model``
`activateGateway( array $args = array() )`

Executes the ActivateGateway operation.

This operation activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway. In the activation process, you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.

You must turn on the gateway VM before you can activate your gateway.

#### Examples

- Basic formatting example

      $result = $client->activateGateway(array(
          // ActivationKey is required
          'ActivationKey' => 'string',
          // GatewayName is required
          'GatewayName' => 'string',
          // GatewayTimezone is required
          'GatewayTimezone' => 'string',
          // GatewayRegion is required
          'GatewayRegion' => 'string',
          'GatewayType' => 'string',
          'TapeDriveType' => 'string',
          'MediumChangerType' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ActivationKey => (string)

    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.

  - GatewayName => (string)

    A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.

  - GatewayTimezone => (string)

    One of the values that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

  - GatewayRegion => (string)

    One of the values that indicates the region where you want to store the snapshot backups. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.

    Valid Values: "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

  - GatewayType => (string)

    One of the values 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 STORED.

  - TapeDriveType => (string)

    The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.

    Valid Values: "IBM-ULT3580-TD5"

  - MediumChangerType => (string)

    The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.

    Valid Values: "STK-L700", "AWS-Gateway-VTL"

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`addCache( array $args = array() )`

Executes the AddCache operation.

This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts).

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

#### Examples

- Basic formatting example

      $result = $client->addCache(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // DiskIds is required
          'DiskIds' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - DiskIds => (array<string>)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`addTagsToResource( array $args = array() )`

Executes the AddTagsToResource operation.

This operation 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 AWS Storage Gateway resources:

- Storage gateways of all types

- Storage Volumes

- Virtual Tapes

You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

#### Examples

- Basic formatting example

      $result = $client->addTagsToResource(array(
          // ResourceARN is required
          'ResourceARN' => 'string',
          // Tags is required
          'Tags' => array(
              array(
                  // Key is required
                  'Key' => 'string',
                  // Value is required
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ResourceARN => (string)

    The Amazon Resource Name (ARN) of the resource you want to add tags to.

  - Tags => (array<associative-array>)

    The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

    - (associative-array)
      - Key => (string)
      - Value => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ResourceARN => (string)

  The Amazon Resource Name (ARN) of the resource you want to add tags to.

# `public `Guzzle\Service\Resource\Model``
`addUploadBuffer( array $args = array() )`

Executes the AddUploadBuffer operation.

This operation configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

#### Examples

- Basic formatting example

      $result = $client->addUploadBuffer(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // DiskIds is required
          'DiskIds' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - DiskIds => (array<string>)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`addWorkingStorage( array $args = array() )`

Executes the AddWorkingStorage operation.

This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead.

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.

#### Examples

- Basic formatting example

      $result = $client->addWorkingStorage(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // DiskIds is required
          'DiskIds' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - DiskIds => (array<string>)

    An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`cancelArchival( array $args = array() )`

Executes the CancelArchival operation.

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.

#### Examples

- Basic formatting example

      $result = $client->cancelArchival(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // TapeARN is required
          'TapeARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - TapeARN => (string)

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TapeARN => (string)

  The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.

# `public `Guzzle\Service\Resource\Model``
`cancelRetrieval( array $args = array() )`

Executes the CancelRetrieval operation.

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.

#### Examples

- Basic formatting example

      $result = $client->cancelRetrieval(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // TapeARN is required
          'TapeARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - TapeARN => (string)

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TapeARN => (string)

  The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.

# `public `Guzzle\Service\Resource\Model``
`createCachediSCSIVolume( array $args = array() )`

Executes the CreateCachediSCSIVolume operation.

This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.

Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

#### Examples

- Basic formatting example

      $result = $client->createCachediSCSIVolume(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // VolumeSizeInBytes is required
          'VolumeSizeInBytes' => integer,
          'SnapshotId' => 'string',
          // TargetName is required
          'TargetName' => 'string',
          // NetworkInterfaceId is required
          'NetworkInterfaceId' => 'string',
          // ClientToken is required
          'ClientToken' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - VolumeSizeInBytes => (int)
  - SnapshotId => (string)
  - TargetName => (string)
  - NetworkInterfaceId => (string)
  - ClientToken => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- VolumeARN => (string)
- TargetARN => (string)

# `public `Guzzle\Service\Resource\Model``
`createSnapshot( array $args = array() )`

Executes the CreateSnapshot operation.

This operation initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console.

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.

#### Examples

- Basic formatting example

      $result = $client->createSnapshot(array(
          // VolumeARN is required
          'VolumeARN' => 'string',
          // SnapshotDescription is required
          'SnapshotDescription' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VolumeARN => (string)

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

  - SnapshotDescription => (string)

    Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- 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).

# `public `Guzzle\Service\Resource\Model``
`createSnapshotFromVolumeRecoveryPoint( array $args = array() )`

Executes the CreateSnapshotFromVolumeRecoveryPoint operation.

This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use ListVolumeRecoveryPoints.

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

#### Examples

- Basic formatting example

      $result = $client->createSnapshotFromVolumeRecoveryPoint(array(
          // VolumeARN is required
          'VolumeARN' => 'string',
          // SnapshotDescription is required
          'SnapshotDescription' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VolumeARN => (string)
  - SnapshotDescription => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- SnapshotId => (string)
- VolumeARN => (string)
- VolumeRecoveryPointTime => (string)

# `public `Guzzle\Service\Resource\Model``
`createStorediSCSIVolume( array $args = array() )`

Executes the CreateStorediSCSIVolume operation.

This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.

The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

#### Examples

- Basic formatting example

      $result = $client->createStorediSCSIVolume(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // DiskId is required
          'DiskId' => 'string',
          'SnapshotId' => 'string',
          // PreserveExistingData is required
          'PreserveExistingData' => true || false,
          // TargetName is required
          'TargetName' => 'string',
          // NetworkInterfaceId is required
          'NetworkInterfaceId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - DiskId => (string)

    The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

  - SnapshotId => (string)

    The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

  - PreserveExistingData => (bool)

    Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

    Valid Values: true, false

  - TargetName => (string)

    The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

  - NetworkInterfaceId => (string)

    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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- VolumeARN => (string)

  The Amazon Resource Name (ARN) of the configured volume.

- VolumeSizeInBytes => (int)

  The size of the volume in bytes.

- TargetARN => (string)

  he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.

# `public `Guzzle\Service\Resource\Model``
`createTapes( array $args = array() )`

Executes the CreateTapes operation.

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.

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.

#### Examples

- Basic formatting example

      $result = $client->createTapes(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // TapeSizeInBytes is required
          'TapeSizeInBytes' => integer,
          // ClientToken is required
          'ClientToken' => 'string',
          // NumTapesToCreate is required
          'NumTapesToCreate' => integer,
          // TapeBarcodePrefix is required
          'TapeBarcodePrefix' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    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 region.

  - TapeSizeInBytes => (int)

    The size, in bytes, of the virtual tapes you want to create.

    The size must be gigabyte (1024*1024*1024 byte) aligned.
  - ClientToken => (string)

    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.

    Using the same ClientToken prevents creating the tape multiple times.
  - NumTapesToCreate => (int)

    The number of virtual tapes you want to create.

  - TapeBarcodePrefix => (string)

    A prefix you append to the barcode of the virtual tape you are creating. This makes a barcode unique.

    The prefix must be 1 to 4 characters in length and must be upper-case letters A-Z.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TapeARNs => (array<string>)

  A list of unique Amazon Resource Named (ARN) that represents the virtual tapes that were created.

# `public `Guzzle\Service\Resource\Model``
`deleteBandwidthRateLimit( array $args = array() )`

Executes the DeleteBandwidthRateLimit operation.

This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.

#### Examples

- Basic formatting example

      $result = $client->deleteBandwidthRateLimit(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // BandwidthType is required
          'BandwidthType' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - BandwidthType => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`deleteChapCredentials( array $args = array() )`

Executes the DeleteChapCredentials operation.

This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

#### Examples

- Basic formatting example

      $result = $client->deleteChapCredentials(array(
          // TargetARN is required
          'TargetARN' => 'string',
          // InitiatorName is required
          'InitiatorName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - TargetARN => (string)

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

  - InitiatorName => (string)

    The iSCSI initiator that connects to the target.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TargetARN => (string)

  The Amazon Resource Name (ARN) of the target.

- InitiatorName => (string)

  The iSCSI initiator that connects to the target.

# `public `Guzzle\Service\Resource\Model``
`deleteGateway( array $args = array() )`

Executes the DeleteGateway operation.

This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots.Â You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.Â If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.

#### Examples

- Basic formatting example

      $result = $client->deleteGateway(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`deleteSnapshotSchedule( array $args = array() )`

Executes the DeleteSnapshotSchedule operation.

This operation deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN).

To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

#### Examples

- Basic formatting example

      $result = $client->deleteSnapshotSchedule(array(
          // VolumeARN is required
          'VolumeARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VolumeARN => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- VolumeARN => (string)

# `public `Guzzle\Service\Resource\Model``
`deleteTape( array $args = array() )`

Executes the DeleteTape operation.

Deletes the specified virtual tape.

#### Examples

- Basic formatting example

      $result = $client->deleteTape(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // TapeARN is required
          'TapeARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    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 region.

  - TapeARN => (string)

    The Amazon Resource Name (ARN) of the virtual tape to delete.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TapeARN => (string)

  The Amazon Resource Name (ARN) of the deleted virtual tape.

# `public `Guzzle\Service\Resource\Model``
`deleteTapeArchive( array $args = array() )`

Executes the DeleteTapeArchive operation.

Deletes the specified virtual tape from the virtual tape shelf (VTS).

#### Examples

- Basic formatting example

      $result = $client->deleteTapeArchive(array(
          // TapeARN is required
          'TapeARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - TapeARN => (string)

    The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TapeARN => (string)

  The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).

# `public `Guzzle\Service\Resource\Model``
`deleteVolume( array $args = array() )`

Executes the DeleteVolume operation.

This operation deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

#### Examples

- Basic formatting example

      $result = $client->deleteVolume(array(
          // VolumeARN is required
          'VolumeARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VolumeARN => (string)

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- VolumeARN => (string)

  The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.

# `public `Guzzle\Service\Resource\Model``
`describeBandwidthRateLimit( array $args = array() )`

Executes the DescribeBandwidthRateLimit operation.

This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

#### Examples

- Basic formatting example

      $result = $client->describeBandwidthRateLimit(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- AverageUploadRateLimitInBitsPerSec => (int)

  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.

- AverageDownloadRateLimitInBitsPerSec => (int)

  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.

# `public `Guzzle\Service\Resource\Model``
`describeCache( array $args = array() )`

Executes the DescribeCache operation.

This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

#### Examples

- Basic formatting example

      $result = $client->describeCache(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- DiskIds => (array<string>)
- CacheAllocatedInBytes => (int)
- CacheUsedPercentage => (int)
- CacheDirtyPercentage => (int)
- CacheHitPercentage => (int)
- CacheMissPercentage => (int)

# `public `Guzzle\Service\Resource\Model``
`describeCachediSCSIVolumes( array $args = array() )`

Executes the DescribeCachediSCSIVolumes operation.

This operation returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.

The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

#### Examples

- Basic formatting example

      $result = $client->describeCachediSCSIVolumes(array(
          // VolumeARNs is required
          'VolumeARNs' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VolumeARNs => (array<string>)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- CachediSCSIVolumes => (array<associative-array>)

  An array of objects where each object contains metadata about one cached volume.

  - (associative-array)
    - VolumeARN => (string)
    - VolumeId => (string)
    - VolumeType => (string)
    - VolumeStatus => (string)
    - VolumeSizeInBytes => (int)
    - VolumeProgress => (int)
    - SourceSnapshotId => (string)
    - VolumeiSCSIAttributes => (associative-array)

      Lists iSCSI information about a volume.

      - TargetARN => (string)

        The Amazon Resource Name (ARN) of the volume target.

      - NetworkInterfaceId => (string)

        The network interface identifier.

      - NetworkInterfacePort => (int)

        The port used to communicate with iSCSI targets.

      - LunNumber => (int)

        The logical disk number.

      - ChapEnabled => (bool)

        Indicates whether mutual CHAP is enabled for the iSCSI target.

# `public `Guzzle\Service\Resource\Model``
`describeChapCredentials( array $args = array() )`

Executes the DescribeChapCredentials operation.

This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.

#### Examples

- Basic formatting example

      $result = $client->describeChapCredentials(array(
          // TargetARN is required
          'TargetARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - TargetARN => (string)

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ChapCredentials => (array<associative-array>)

  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:

  - InitiatorName: The iSCSI initiator that connects to the target.

  - SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

  - SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

  - TargetARN: The Amazon Resource Name (ARN) of the storage volume.

  - (associative-array)

    Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.

    - TargetARN => (string)

      The Amazon Resource Name (ARN) of the volume.

      Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    - SecretToAuthenticateInitiator => (string)

      The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

    - InitiatorName => (string)

      The iSCSI initiator that connects to the target.

    - SecretToAuthenticateTarget => (string)

      The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

# `public `Guzzle\Service\Resource\Model``
`describeGatewayInformation( array $args = array() )`

Executes the DescribeGatewayInformation operation.

This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

#### Examples

- Basic formatting example

      $result = $client->describeGatewayInformation(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- GatewayId => (string)

  The gateway ID.

- GatewayName => (string)

  The gateway name.

- GatewayTimezone => (string)

  One of the values that indicates the time zone configured for the gateway.

- GatewayState => (string)

  One of the values that indicates the operating state of the gateway.

- GatewayNetworkInterfaces => (array<associative-array>)

  A NetworkInterface array that contains descriptions of the gateway network interfaces.

  - (associative-array)

    Describes a gateway's network interface.

    - Ipv4Address => (string)

      The Internet Protocol version 4 (IPv4) address of the interface.

    - MacAddress => (string)

      The Media Access Control (MAC) address of the interface.

      This is currently unsupported and will not be returned in output.
    - Ipv6Address => (string)

      The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

- GatewayType => (string)

  The type of the gateway.

- NextUpdateAvailabilityDate => (string)

  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.

- LastSoftwareUpdate => (string)

  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.

# `public `Guzzle\Service\Resource\Model``
`describeMaintenanceStartTime( array $args = array() )`

Executes the DescribeMaintenanceStartTime operation.

This operation returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.

#### Examples

- Basic formatting example

      $result = $client->describeMaintenanceStartTime(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- HourOfDay => (int)
- MinuteOfHour => (int)
- DayOfWeek => (int)
- Timezone => (string)

# `public `Guzzle\Service\Resource\Model``
`describeSnapshotSchedule( array $args = array() )`

Executes the DescribeSnapshotSchedule operation.

This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.

#### Examples

- Basic formatting example

      $result = $client->describeSnapshotSchedule(array(
          // VolumeARN is required
          'VolumeARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VolumeARN => (string)

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- VolumeARN => (string)
- StartAt => (int)
- RecurrenceInHours => (int)
- Description => (string)
- Timezone => (string)

# `public `Guzzle\Service\Resource\Model``
`describeStorediSCSIVolumes( array $args = array() )`

Executes the DescribeStorediSCSIVolumes operation.

This operation returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs.

#### Examples

- Basic formatting example

      $result = $client->describeStorediSCSIVolumes(array(
          // VolumeARNs is required
          'VolumeARNs' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VolumeARNs => (array<string>)

    An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- StorediSCSIVolumes => (array<associative-array>)
  - (associative-array)
    - VolumeARN => (string)
    - VolumeId => (string)
    - VolumeType => (string)
    - VolumeStatus => (string)
    - VolumeSizeInBytes => (int)
    - VolumeProgress => (int)
    - VolumeDiskId => (string)
    - SourceSnapshotId => (string)
    - PreservedExistingData => (bool)
    - VolumeiSCSIAttributes => (associative-array)

      Lists iSCSI information about a volume.

      - TargetARN => (string)

        The Amazon Resource Name (ARN) of the volume target.

      - NetworkInterfaceId => (string)

        The network interface identifier.

      - NetworkInterfacePort => (int)

        The port used to communicate with iSCSI targets.

      - LunNumber => (int)

        The logical disk number.

      - ChapEnabled => (bool)

        Indicates whether mutual CHAP is enabled for the iSCSI target.

# `public `Guzzle\Service\Resource\Model``
`describeTapeArchives( array $args = array() )`

Executes the DescribeTapeArchives operation.

Returns a description of specified virtual tapes in the virtual tape shelf (VTS).

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

#### Examples

- Basic formatting example

      $result = $client->describeTapeArchives(array(
          'TapeARNs' => array('string', ... ),
          'Marker' => 'string',
          'Limit' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - TapeARNs => (array<string>)

    Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

  - Marker => (string)

    An opaque string that indicates the position at which to begin describing virtual tapes.

  - Limit => (int)

    Specifies that the number of virtual tapes descried be limited to the specified number.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TapeArchives => (array<associative-array>)

  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.

  - (associative-array)

    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.

    - TapeSizeInBytes => (int)

      The size, in bytes, of the archived virtual tape.

    - CompletionTime => (string)

      The time that the archiving of the virtual tape was completed.

      The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

    - RetrievedTo => (string)

      The Amazon Resource Name (ARN) of the gateway-VTL 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.

- 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.

# `public `Guzzle\Service\Resource\Model``
`describeTapeRecoveryPoints( array $args = array() )`

Executes the DescribeTapeRecoveryPoints operation.

Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.

A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

#### Examples

- Basic formatting example

      $result = $client->describeTapeRecoveryPoints(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          'Marker' => 'string',
          'Limit' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - Marker => (string)

    An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

  - Limit => (int)

    Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- TapeRecoveryPointInfos => (array<associative-array>)

  An array of TapeRecoveryPointInfos that are available for the specified gateway.

  - (associative-array)

    Describes a recovery point.

    - TapeARN => (string)

      The Amazon Resource Name (ARN) of the virtual tape.

    - TapeRecoveryPointTime => (string)

      The time when the point-in-time view of the virtual tape was replicated for later recovery.

      The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

    - TapeSizeInBytes => (int)

      The size, in bytes, of the virtual tapes to recover.

    - TapeStatus => (string)
- 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.

# `public `Guzzle\Service\Resource\Model``
`describeTapes( array $args = array() )`

Executes the DescribeTapes operation.

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.

#### Examples

- Basic formatting example

      $result = $client->describeTapes(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          'TapeARNs' => array('string', ... ),
          'Marker' => 'string',
          'Limit' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - TapeARNs => (array<string>)

    Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

  - Marker => (string)

    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.

  - Limit => (int)

    Specifies that the number of virtual tapes described be limited to the specified number.

    Amazon Web Services may impose its own limit, if this field is not set.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Tapes => (array<associative-array>)

  An array of virtual tape descriptions.

  - (associative-array)

    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.

    - TapeSizeInBytes => (int)

      The size, in bytes, of the virtual tape.

    - 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 => (int)

      For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

      Range: 0 (not started) to 100 (complete).

- Marker => (string)

  An opaque string which 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.

# `public `Guzzle\Service\Resource\Model``
`describeUploadBuffer( array $args = array() )`

Executes the DescribeUploadBuffer operation.

This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

#### Examples

- Basic formatting example

      $result = $client->describeUploadBuffer(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- DiskIds => (array<string>)
- UploadBufferUsedInBytes => (int)
- UploadBufferAllocatedInBytes => (int)

# `public `Guzzle\Service\Resource\Model``
`describeVTLDevices( array $args = array() )`

Executes the DescribeVTLDevices operation.

Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.

The list of VTL devices must be from one gateway.

#### Examples

- Basic formatting example

      $result = $client->describeVTLDevices(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          'VTLDeviceARNs' => array('string', ... ),
          'Marker' => 'string',
          'Limit' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - VTLDeviceARNs => (array<string>)

    An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

    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.
  - Marker => (string)

    An opaque string that indicates the position at which to begin describing the VTL devices.

  - Limit => (int)

    Specifies that the number of VTL devices described be limited to the specified number.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- VTLDevices => (array<associative-array>)

  An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.

  - (associative-array)

    Represents a device object associated with a gateway-VTL.

    - VTLDeviceARN => (string)

      Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).

    - VTLDeviceType => (string)
    - VTLDeviceVendor => (string)
    - VTLDeviceProductIdentifier => (string)
    - DeviceiSCSIAttributes => (associative-array)

      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 => (int)

        The port used to communicate with iSCSI VTL device targets.

      - ChapEnabled => (bool)

        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.

# `public `Guzzle\Service\Resource\Model``
`describeWorkingStorage( array $args = array() )`

Executes the DescribeWorkingStorage operation.

This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.

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.

#### Examples

- Basic formatting example

      $result = $client->describeWorkingStorage(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- DiskIds => (array<string>)

  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.

- WorkingStorageUsedInBytes => (int)

  The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

- WorkingStorageAllocatedInBytes => (int)

  The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

# `public `Guzzle\Service\Resource\Model``
`disableGateway( array $args = array() )`

Executes the DisableGateway operation.

Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

Use this operation for a gateway-VTL that is not reachable or not functioning.

Once a gateway is disabled it cannot be enabled.

#### Examples

- Basic formatting example

      $result = $client->disableGateway(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The unique Amazon Resource Name of the disabled gateway.

# `public `Guzzle\Service\Resource\Model``
`listGateways( array $args = array() )`

Executes the ListGateways operation.

This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways.

#### Examples

- Basic formatting example

      $result = $client->listGateways(array(
          'Marker' => 'string',
          'Limit' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Marker => (string)

    An opaque string that indicates the position at which to begin the returned list of gateways.

  - Limit => (int)

    Specifies that the list of gateways returned be limited to the specified number of items.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Gateways => (array<associative-array>)
  - (associative-array)
    - GatewayARN => (string)

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

    - GatewayType => (string)
    - GatewayOperationalState => (string)
    - GatewayName => (string)
- Marker => (string)

# `public `Guzzle\Service\Resource\Model``
`listLocalDisks( array $args = array() )`

Executes the ListLocalDisks operation.

This operation returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

#### Examples

- Basic formatting example

      $result = $client->listLocalDisks(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- Disks => (array<associative-array>)
  - (associative-array)
    - DiskId => (string)
    - DiskPath => (string)
    - DiskNode => (string)
    - DiskStatus => (string)
    - DiskSizeInBytes => (int)
    - DiskAllocationType => (string)
    - DiskAllocationResource => (string)

# `public `Guzzle\Service\Resource\Model``
`listTagsForResource( array $args = array() )`

Executes the ListTagsForResource operation.

This operation lists the tags that have been added to the specified resource.

#### Examples

- Basic formatting example

      $result = $client->listTagsForResource(array(
          'ResourceARN' => 'string',
          'Marker' => 'string',
          'Limit' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - 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 begin returning the list of tags.

  - Limit => (int)

    Specifies that the list of tags returned be limited to the specified number of items.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ResourceARN => (string)

  he 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 => (array<associative-array>)

  An array that contains the tags for the specified resource.

  - (associative-array)
    - Key => (string)
    - Value => (string)

# `public `Guzzle\Service\Resource\Model``
`listVolumeInitiators( array $args = array() )`

Executes the ListVolumeInitiators operation.

This operation lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.

#### Examples

- Basic formatting example

      $result = $client->listVolumeInitiators(array(
          // VolumeARN is required
          'VolumeARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VolumeARN => (string)

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Initiators => (array<string>)

  The host names and port numbers of all iSCSI initiators that are connected to the gateway.

# `public `Guzzle\Service\Resource\Model``
`listVolumeRecoveryPoints( array $args = array() )`

Executes the ListVolumeRecoveryPoints operation.

This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.

Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

#### Examples

- Basic formatting example

      $result = $client->listVolumeRecoveryPoints(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- VolumeRecoveryPointInfos => (array<associative-array>)
  - (associative-array)
    - VolumeARN => (string)
    - VolumeSizeInBytes => (int)
    - VolumeUsageInBytes => (int)
    - VolumeRecoveryPointTime => (string)

# `public `Guzzle\Service\Resource\Model``
`listVolumes( array $args = array() )`

Executes the ListVolumes operation.

This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes API.

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.

#### Examples

- Basic formatting example

      $result = $client->listVolumes(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          'Marker' => 'string',
          'Limit' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - Marker => (string)

    A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

  - Limit => (int)

    Specifies that the list of volumes returned be limited to the specified number of items.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- Marker => (string)
- VolumeInfos => (array<associative-array>)
  - (associative-array)
    - VolumeARN => (string)
    - VolumeType => (string)

# `public `Guzzle\Service\Resource\Model``
`removeTagsFromResource( array $args = array() )`

Executes the RemoveTagsFromResource operation.

This operation removes one or more tags from the specified resource.

#### Examples

- Basic formatting example

      $result = $client->removeTagsFromResource(array(
          'ResourceARN' => 'string',
          'TagKeys' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ResourceARN => (string)

    The Amazon Resource Name (ARN) of the resource you want to remove the tags from.

  - TagKeys => (array<string>)

    The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ResourceARN => (string)

  The Amazon Resource Name (ARN) of the resource that the tags were removed from.

# `public `Guzzle\Service\Resource\Model``
`resetCache( array $args = array() )`

Executes the ResetCache operation.

This operation resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks.

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.

#### Examples

- Basic formatting example

      $result = $client->resetCache(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`retrieveTapeArchive( array $args = array() )`

Executes the RetrieveTapeArchive operation.

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS.

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway.

#### Examples

- Basic formatting example

      $result = $client->retrieveTapeArchive(array(
          // TapeARN is required
          'TapeARN' => 'string',
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - TapeARN => (string)

    The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

  - GatewayARN => (string)

    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 region.

    You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TapeARN => (string)

  The Amazon Resource Name (ARN) of the retrieved virtual tape.

# `public `Guzzle\Service\Resource\Model``
`retrieveTapeRecoveryPoint( array $args = array() )`

Executes the RetrieveTapeRecoveryPoint operation.

Retrieves the recovery point for the specified virtual tape.

A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.

#### Examples

- Basic formatting example

      $result = $client->retrieveTapeRecoveryPoint(array(
          // TapeARN is required
          'TapeARN' => 'string',
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - TapeARN => (string)

    The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.

  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TapeARN => (string)

  The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.

# `public `Guzzle\Service\Resource\Model``
`shutdownGateway( array $args = array() )`

Executes the ShutdownGateway operation.

This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.

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.

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.

#### Examples

- Basic formatting example

      $result = $client->shutdownGateway(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`startGateway( array $args = array() )`

Executes the StartGateway operation.

This operation starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

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.

#### Examples

- Basic formatting example

      $result = $client->startGateway(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`updateBandwidthRateLimit( array $args = array() )`

Executes the UpdateBandwidthRateLimit operation.

This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

#### Examples

- Basic formatting example

      $result = $client->updateBandwidthRateLimit(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          'AverageUploadRateLimitInBitsPerSec' => integer,
          'AverageDownloadRateLimitInBitsPerSec' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - AverageUploadRateLimitInBitsPerSec => (int)

    The average upload bandwidth rate limit in bits per second.

  - AverageDownloadRateLimitInBitsPerSec => (int)

    The average download bandwidth rate limit in bits per second.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`updateChapCredentials( array $args = array() )`

Executes the UpdateChapCredentials operation.

This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

#### Examples

- Basic formatting example

      $result = $client->updateChapCredentials(array(
          // TargetARN is required
          'TargetARN' => 'string',
          // SecretToAuthenticateInitiator is required
          'SecretToAuthenticateInitiator' => 'string',
          // InitiatorName is required
          'InitiatorName' => 'string',
          'SecretToAuthenticateTarget' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - TargetARN => (string)

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

  - SecretToAuthenticateInitiator => (string)

    The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.
  - InitiatorName => (string)

    The iSCSI initiator that connects to the target.

  - SecretToAuthenticateTarget => (string)

    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.

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- 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.

# `public `Guzzle\Service\Resource\Model``
`updateGatewayInformation( array $args = array() )`

Executes the UpdateGatewayInformation operation.

This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

#### Examples

- Basic formatting example

      $result = $client->updateGatewayInformation(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          'GatewayName' => 'string',
          'GatewayTimezone' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - GatewayName => (string)

    A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.

  - GatewayTimezone => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

- GatewayName => (string)

# `public `Guzzle\Service\Resource\Model``
`updateGatewaySoftwareNow( array $args = array() )`

Executes the UpdateGatewaySoftwareNow operation.

This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

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. 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.

#### Examples

- Basic formatting example

      $result = $client->updateGatewaySoftwareNow(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`updateMaintenanceStartTime( array $args = array() )`

Executes the UpdateMaintenanceStartTime operation.

This operation updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.

#### Examples

- Basic formatting example

      $result = $client->updateMaintenanceStartTime(array(
          // GatewayARN is required
          'GatewayARN' => 'string',
          // HourOfDay is required
          'HourOfDay' => integer,
          // MinuteOfHour is required
          'MinuteOfHour' => integer,
          // DayOfWeek is required
          'DayOfWeek' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - GatewayARN => (string)

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

  - HourOfDay => (int)

    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.

  - MinuteOfHour => (int)

    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.

  - DayOfWeek => (int)

    The maintenance start time day of the week.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- GatewayARN => (string)

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

# `public `Guzzle\Service\Resource\Model``
`updateSnapshotSchedule( array $args = array() )`

Executes the UpdateSnapshotSchedule operation.

This operation updates a snapshot schedule configured for a gateway volume.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

#### Examples

- Basic formatting example

      $result = $client->updateSnapshotSchedule(array(
          // VolumeARN is required
          'VolumeARN' => 'string',
          // StartAt is required
          'StartAt' => integer,
          // RecurrenceInHours is required
          'RecurrenceInHours' => integer,
          'Description' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VolumeARN => (string)

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

  - StartAt => (int)

    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.

  - RecurrenceInHours => (int)

    Frequency of snapshots. Specify the number of hours between snapshots.

  - Description => (string)

    Optional description of the snapshot that overwrites the existing description.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- VolumeARN => (string)

# `public `Guzzle\Service\Resource\Model``
`updateVTLDeviceType( array $args = array() )`

Executes the UpdateVTLDeviceType operation.

This operation updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated.

#### Examples

- Basic formatting example

      $result = $client->updateVTLDeviceType(array(
          // VTLDeviceARN is required
          'VTLDeviceARN' => 'string',
          // DeviceType is required
          'DeviceType' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - VTLDeviceARN => (string)

    The Amazon Resource Name (ARN) of the medium changer you want to select.

  - DeviceType => (string)

    The type of medium changer you want to select.

    Valid Values: "STK-L700", "AWS-Gateway-VTL"

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- VTLDeviceARN => (string)

  The Amazon Resource Name (ARN) of the medium changer you have selected.

# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeCachediSCSIVolumesIterator( array $args = array() )`

The input array uses the parameters of the DescribeCachediSCSIVolumes operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeStorediSCSIVolumesIterator( array $args = array() )`

The input array uses the parameters of the DescribeStorediSCSIVolumes operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeTapeArchivesIterator( array $args = array() )`

The input array uses the parameters of the DescribeTapeArchives operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeTapeRecoveryPointsIterator( array $args = array() )`

The input array uses the parameters of the DescribeTapeRecoveryPoints operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeTapesIterator( array $args = array() )`

The input array uses the parameters of the DescribeTapes operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeVTLDevicesIterator( array $args = array() )`

The input array uses the parameters of the DescribeVTLDevices operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListGatewaysIterator( array $args = array() )`

The input array uses the parameters of the ListGateways operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListLocalDisksIterator( array $args = array() )`

The input array uses the parameters of the ListLocalDisks operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListVolumeRecoveryPointsIterator( array $args = array() )`

The input array uses the parameters of the ListVolumeRecoveryPoints operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListVolumesIterator( array $args = array() )`

The input array uses the parameters of the ListVolumes operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``

### Methods inherited from Aws\Common\Client\AbstractClient

`__call()`, `__construct()`, `createRequest()`, `getAllEvents()`, `getApiVersion()`, `getCredentials()`, `getRegion()`, `getRegions()`, `getSignature()`, `getWaiter()`, `getWaiterFactory()`, `send()`, `setCredentials()`, `setRegion()`, `setWaiterFactory()`, `waitUntil()`

### Methods inherited from Guzzle\Service\Client

`execute()`, `executeMultiple()`, `getCommand()`, `getCommandFactory()`, `getDescription()`, `getInflector()`, `getIterator()`, `getResourceIteratorFactory()`, `prepareCommand()`, `setCommandFactory()`, `setDescription()`, `setInflector()`, `setResourceIteratorFactory()`

### Methods inherited from Guzzle\Http\Client

`delete()`, `expandTemplate()`, `extractPharCacert()`, `get()`, `getBaseUrl()`, `getConfig()`, `getCurlMulti()`, `getDefaultOption()`, `getDefaultUserAgent()`, `getUriTemplate()`, `head()`, `initSsl()`, `options()`, `patch()`, `post()`, `prepareRequest()`, `put()`, `sendMultiple()`, `setBaseUrl()`, `setConfig()`, `setCurlMulti()`, `setDefaultOption()`, `setRequestFactory()`, `setSslVerification()`, `setUriTemplate()`, `setUserAgent()`

### Methods inherited from Guzzle\Common\AbstractHasDispatcher

`addSubscriber()`, `dispatch()`, `getEventDispatcher()`, `setEventDispatcher()`

### Magic methods summary

## Constants summary

`string` | `LATEST_API_VERSION` | `'2013-06-30'` | #

### Constants inherited from Guzzle\Service\Client

`COMMAND_PARAMS`

### Constants inherited from Guzzle\Http\Client

`CURL_OPTIONS`, `DEFAULT_SELECT_TIMEOUT`, `DISABLE_REDIRECTS`, `MAX_HANDLES`, `REQUEST_OPTIONS`, `SSL_CERT_AUTHORITY`

### Constants inherited from Guzzle\Http\ClientInterface

`CREATE_REQUEST`, `HTTP_DATE`

## Properties summary

### Properties inherited from Aws\Common\Client\AbstractClient

`$aggregator`, `$credentials`, `$signature`, `$waiterFactory`

### Properties inherited from Guzzle\Service\Client

`$commandFactory`, `$inflector`, `$resourceIteratorFactory`, `$serviceDescription`

### Properties inherited from Guzzle\Http\Client

`$defaultHeaders`, `$requestFactory`, `$userAgent`

### Properties inherited from Guzzle\Common\AbstractHasDispatcher

`$eventDispatcher`