ActivateGateway

$result = $client->activateGateway([/* ... */]);
$promise = $client->activateGatewayAsync([/* ... */]);

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the Amazon Web Services Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation.

Parameter Syntax

$result = $client->activateGateway([
    'ActivationKey' => '<string>', // REQUIRED
    'GatewayName' => '<string>', // REQUIRED
    'GatewayRegion' => '<string>', // REQUIRED
    'GatewayTimezone' => '<string>', // REQUIRED
    'GatewayType' => '<string>',
    'MediumChangerType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TapeDriveType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To activate the gateway

Activates the gateway you previously deployed on your host.

$result = $client->activateGateway([
    'ActivationKey' => '29AV1-3OFV9-VVIUB-NKT0I-LRO6V',
    'GatewayName' => 'My_Gateway',
    'GatewayRegion' => 'us-east-1',
    'GatewayTimezone' => 'GMT-12:00',
    'GatewayType' => 'STORED',
    'MediumChangerType' => 'AWS-Gateway-VTL',
    'TapeDriveType' => 'IBM-ULT3580-TD5',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
]

AddCache

$result = $client->addCache([/* ... */]);
$promise = $client->addCacheAsync([/* ... */]);

Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture).

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

Parameter Syntax

$result = $client->addCache([
    'DiskIds' => ['<string>', ...], // REQUIRED
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To add a cache

The following example shows a request that activates a gateway-stored volume.

$result = $client->addCache([
    'DiskIds' => [
        'pci-0000:03:00.0-scsi-0:0:0:0',
        'pci-0000:03:00.0-scsi-0:0:1:0',
    ],
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]

AddTagsToResource

$result = $client->addTagsToResource([/* ... */]);
$promise = $client->addTagsToResourceAsync([/* ... */]);

Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following Storage Gateway resources:

• Storage gateways of all types

• Storage volumes

• Virtual tapes

• NFS and SMB file shares

• File System associations

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

Parameter Syntax

$result = $client->addTagsToResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ResourceARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To add tags to resource

Adds one or more tags to the specified resource.

$result = $client->addTagsToResource([
    'ResourceARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
    'Tags' => [
        [
            'Key' => 'Dev Gatgeway Region',
            'Value' => 'East Coast',
        ],
    ],
]);

Result syntax:

[
    'ResourceARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
]

AddUploadBuffer

$result = $client->addUploadBuffer([/* ... */]);
$promise = $client->addUploadBufferAsync([/* ... */]);

Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

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

Parameter Syntax

$result = $client->addUploadBuffer([
    'DiskIds' => ['<string>', ...], // REQUIRED
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To add upload buffer on local disk

Configures one or more gateway local disks as upload buffer for a specified gateway.

$result = $client->addUploadBuffer([
    'DiskIds' => [
        'pci-0000:03:00.0-scsi-0:0:0:0',
        'pci-0000:03:00.0-scsi-0:0:1:0',
    ],
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]

AddWorkingStorage

$result = $client->addWorkingStorage([/* ... */]);
$promise = $client->addWorkingStorageAsync([/* ... */]);

Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.

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.

Parameter Syntax

$result = $client->addWorkingStorage([
    'DiskIds' => ['<string>', ...], // REQUIRED
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To add storage on local disk

Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)

$result = $client->addWorkingStorage([
    'DiskIds' => [
        'pci-0000:03:00.0-scsi-0:0:0:0',
        'pci-0000:03:00.0-scsi-0:0:1:0',
    ],
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]

AssignTapePool

$result = $client->assignTapePool([/* ... */]);
$promise = $client->assignTapePoolAsync([/* ... */]);

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Parameter Syntax

$result = $client->assignTapePool([
    'BypassGovernanceRetention' => true || false,
    'PoolId' => '<string>', // REQUIRED
    'TapeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TapeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

AssociateFileSystem

$result = $client->associateFileSystem([/* ... */]);
$promise = $client->associateFileSystemAsync([/* ... */]);

Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.

Parameter Syntax

$result = $client->associateFileSystem([
    'AuditDestinationARN' => '<string>',
    'CacheAttributes' => [
        'CacheStaleTimeoutInSeconds' => <integer>,
    ],
    'ClientToken' => '<string>', // REQUIRED
    'EndpointNetworkConfiguration' => [
        'IpAddresses' => ['<string>', ...],
    ],
    'GatewayARN' => '<string>', // REQUIRED
    'LocationARN' => '<string>', // REQUIRED
    'Password' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FileSystemAssociationARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

AttachVolume

$result = $client->attachVolume([/* ... */]);
$promise = $client->attachVolumeAsync([/* ... */]);

Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

Parameter Syntax

$result = $client->attachVolume([
    'DiskId' => '<string>',
    'GatewayARN' => '<string>', // REQUIRED
    'NetworkInterfaceId' => '<string>', // REQUIRED
    'TargetName' => '<string>',
    'VolumeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TargetARN' => '<string>',
    'VolumeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

CancelArchival

$result = $client->cancelArchival([/* ... */]);
$promise = $client->cancelArchivalAsync([/* ... */]);

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.

Parameter Syntax

$result = $client->cancelArchival([
    'GatewayARN' => '<string>', // REQUIRED
    'TapeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TapeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To cancel virtual tape archiving

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

$result = $client->cancelArchival([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
]);

Result syntax:

[
    'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
]

CancelRetrieval

$result = $client->cancelRetrieval([/* ... */]);
$promise = $client->cancelRetrievalAsync([/* ... */]);

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.

Parameter Syntax

$result = $client->cancelRetrieval([
    'GatewayARN' => '<string>', // REQUIRED
    'TapeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TapeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To cancel virtual tape retrieval

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

$result = $client->cancelRetrieval([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
]);

Result syntax:

[
    'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
]

CreateCachediSCSIVolume

$result = $client->createCachediSCSIVolume([/* ... */]);
$promise = $client->createCachediSCSIVolumeAsync([/* ... */]);

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

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

Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

Parameter Syntax

$result = $client->createCachediSCSIVolume([
    'ClientToken' => '<string>', // REQUIRED
    'GatewayARN' => '<string>', // REQUIRED
    'KMSEncrypted' => true || false,
    'KMSKey' => '<string>',
    'NetworkInterfaceId' => '<string>', // REQUIRED
    'SnapshotId' => '<string>',
    'SourceVolumeARN' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TargetName' => '<string>', // REQUIRED
    'VolumeSizeInBytes' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TargetARN' => '<string>',
    'VolumeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To create a cached iSCSI volume

Creates a cached volume on a specified cached gateway.

$result = $client->createCachediSCSIVolume([
    'ClientToken' => 'cachedvol112233',
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'NetworkInterfaceId' => '10.1.1.1',
    'SnapshotId' => 'snap-f47b7b94',
    'TargetName' => 'my-volume',
    'VolumeSizeInBytes' => 536870912000,
]);

Result syntax:

[
    'TargetARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]

CreateNFSFileShare

$result = $client->createNFSFileShare([/* ... */]);
$promise = $client->createNFSFileShareAsync([/* ... */]);

Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for S3 File Gateways.

Parameter Syntax

$result = $client->createNFSFileShare([
    'AuditDestinationARN' => '<string>',
    'BucketRegion' => '<string>',
    'CacheAttributes' => [
        'CacheStaleTimeoutInSeconds' => <integer>,
    ],
    'ClientList' => ['<string>', ...],
    'ClientToken' => '<string>', // REQUIRED
    'DefaultStorageClass' => '<string>',
    'FileShareName' => '<string>',
    'GatewayARN' => '<string>', // REQUIRED
    'GuessMIMETypeEnabled' => true || false,
    'KMSEncrypted' => true || false,
    'KMSKey' => '<string>',
    'LocationARN' => '<string>', // REQUIRED
    'NFSFileShareDefaults' => [
        'DirectoryMode' => '<string>',
        'FileMode' => '<string>',
        'GroupId' => <integer>,
        'OwnerId' => <integer>,
    ],
    'NotificationPolicy' => '<string>',
    'ObjectACL' => 'private|public-read|public-read-write|authenticated-read|bucket-owner-read|bucket-owner-full-control|aws-exec-read',
    'ReadOnly' => true || false,
    'RequesterPays' => true || false,
    'Role' => '<string>', // REQUIRED
    'Squash' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VPCEndpointDNSName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FileShareARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

CreateSMBFileShare

$result = $client->createSMBFileShare([/* ... */]);
$promise = $client->createSMBFileShareAsync([/* ... */]);

Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for S3 File Gateways.

Parameter Syntax

$result = $client->createSMBFileShare([
    'AccessBasedEnumeration' => true || false,
    'AdminUserList' => ['<string>', ...],
    'AuditDestinationARN' => '<string>',
    'Authentication' => '<string>',
    'BucketRegion' => '<string>',
    'CacheAttributes' => [
        'CacheStaleTimeoutInSeconds' => <integer>,
    ],
    'CaseSensitivity' => 'ClientSpecified|CaseSensitive',
    'ClientToken' => '<string>', // REQUIRED
    'DefaultStorageClass' => '<string>',
    'FileShareName' => '<string>',
    'GatewayARN' => '<string>', // REQUIRED
    'GuessMIMETypeEnabled' => true || false,
    'InvalidUserList' => ['<string>', ...],
    'KMSEncrypted' => true || false,
    'KMSKey' => '<string>',
    'LocationARN' => '<string>', // REQUIRED
    'NotificationPolicy' => '<string>',
    'ObjectACL' => 'private|public-read|public-read-write|authenticated-read|bucket-owner-read|bucket-owner-full-control|aws-exec-read',
    'OplocksEnabled' => true || false,
    'ReadOnly' => true || false,
    'RequesterPays' => true || false,
    'Role' => '<string>', // REQUIRED
    'SMBACLEnabled' => true || false,
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VPCEndpointDNSName' => '<string>',
    'ValidUserList' => ['<string>', ...],
]);

Parameter Details

[
    'FileShareARN' => '<string>',
]

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

CreateSnapshot

$result = $client->createSnapshot([/* ... */]);
$promise = $client->createSnapshotAsync([/* ... */]);

Initiates a snapshot of a volume.

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

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

Parameter Syntax

$result = $client->createSnapshot([
    'SnapshotDescription' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VolumeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SnapshotId' => '<string>',
    'VolumeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

ServiceUnavailableError:

An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.

Examples

Example 1: To create a snapshot of a gateway volume

Initiates an ad-hoc snapshot of a gateway volume.

$result = $client->createSnapshot([
    'SnapshotDescription' => 'My root volume snapshot as of 10/03/2017',
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]);

Result syntax:

[
    'SnapshotId' => 'snap-78e22663',
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]

CreateSnapshotFromVolumeRecoveryPoint

$result = $client->createSnapshotFromVolumeRecoveryPoint([/* ... */]);
$promise = $client->createSnapshotFromVolumeRecoveryPointAsync([/* ... */]);

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

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

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

Parameter Syntax

$result = $client->createSnapshotFromVolumeRecoveryPoint([
    'SnapshotDescription' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VolumeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SnapshotId' => '<string>',
    'VolumeARN' => '<string>',
    'VolumeRecoveryPointTime' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

ServiceUnavailableError:

An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.

Examples

Example 1: To create a snapshot of a gateway volume

Initiates a snapshot of a gateway from a volume recovery point.

$result = $client->createSnapshotFromVolumeRecoveryPoint([
    'SnapshotDescription' => 'My root volume snapshot as of 2017-06-30T10:10:10.000Z',
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]);

Result syntax:

[
    'SnapshotId' => 'snap-78e22663',
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
    'VolumeRecoveryPointTime' => '2017-06-30T10:10:10.000Z',
]

CreateStorediSCSIVolume

$result = $client->createStorediSCSIVolume([/* ... */]);
$promise = $client->createStorediSCSIVolumeAsync([/* ... */]);

Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

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

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

Parameter Syntax

$result = $client->createStorediSCSIVolume([
    'DiskId' => '<string>', // REQUIRED
    'GatewayARN' => '<string>', // REQUIRED
    'KMSEncrypted' => true || false,
    'KMSKey' => '<string>',
    'NetworkInterfaceId' => '<string>', // REQUIRED
    'PreserveExistingData' => true || false, // REQUIRED
    'SnapshotId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TargetName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TargetARN' => '<string>',
    'VolumeARN' => '<string>',
    'VolumeSizeInBytes' => <integer>,
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To create a stored iSCSI volume

Creates a stored volume on a specified stored gateway.

$result = $client->createStorediSCSIVolume([
    'DiskId' => 'pci-0000:03:00.0-scsi-0:0:0:0',
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'NetworkInterfaceId' => '10.1.1.1',
    'PreserveExistingData' => 1,
    'SnapshotId' => 'snap-f47b7b94',
    'TargetName' => 'my-volume',
]);

Result syntax:

[
    'TargetARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
    'VolumeSizeInBytes' => 1099511627776,
]

CreateTapePool

$result = $client->createTapePool([/* ... */]);
$promise = $client->createTapePoolAsync([/* ... */]);

Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.

Parameter Syntax

$result = $client->createTapePool([
    'PoolName' => '<string>', // REQUIRED
    'RetentionLockTimeInDays' => <integer>,
    'RetentionLockType' => 'COMPLIANCE|GOVERNANCE|NONE',
    'StorageClass' => 'DEEP_ARCHIVE|GLACIER', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'PoolARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

CreateTapeWithBarcode

$result = $client->createTapeWithBarcode([/* ... */]);
$promise = $client->createTapeWithBarcodeAsync([/* ... */]);

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

Parameter Syntax

$result = $client->createTapeWithBarcode([
    'GatewayARN' => '<string>', // REQUIRED
    'KMSEncrypted' => true || false,
    'KMSKey' => '<string>',
    'PoolId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TapeBarcode' => '<string>', // REQUIRED
    'TapeSizeInBytes' => <integer>, // REQUIRED
    'Worm' => true || false,
]);

Parameter Details

Result Syntax

[
    'TapeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To create a virtual tape using a barcode

Creates a virtual tape by using your own barcode.

$result = $client->createTapeWithBarcode([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    'TapeBarcode' => 'TEST12345',
    'TapeSizeInBytes' => 107374182400,
]);

Result syntax:

[
    'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345',
]

CreateTapes

$result = $client->createTapes([/* ... */]);
$promise = $client->createTapesAsync([/* ... */]);

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

Parameter Syntax

$result = $client->createTapes([
    'ClientToken' => '<string>', // REQUIRED
    'GatewayARN' => '<string>', // REQUIRED
    'KMSEncrypted' => true || false,
    'KMSKey' => '<string>',
    'NumTapesToCreate' => <integer>, // REQUIRED
    'PoolId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TapeBarcodePrefix' => '<string>', // REQUIRED
    'TapeSizeInBytes' => <integer>, // REQUIRED
    'Worm' => true || false,
]);

Parameter Details

Result Syntax

[
    'TapeARNs' => ['<string>', ...],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To create a virtual tape

Creates one or more virtual tapes.

$result = $client->createTapes([
    'ClientToken' => '77777',
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    'NumTapesToCreate' => 3,
    'TapeBarcodePrefix' => 'TEST',
    'TapeSizeInBytes' => 107374182400,
]);

Result syntax:

[
    'TapeARNs' => [
        'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D',
        'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F',
        'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E',
    ],
]

DeleteAutomaticTapeCreationPolicy

$result = $client->deleteAutomaticTapeCreationPolicy([/* ... */]);
$promise = $client->deleteAutomaticTapeCreationPolicyAsync([/* ... */]);

Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

Parameter Syntax

$result = $client->deleteAutomaticTapeCreationPolicy([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DeleteBandwidthRateLimit

$result = $client->deleteBandwidthRateLimit([/* ... */]);
$promise = $client->deleteBandwidthRateLimitAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteBandwidthRateLimit([
    'BandwidthType' => '<string>', // REQUIRED
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To delete bandwidth rate limits of gateway

Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.

$result = $client->deleteBandwidthRateLimit([
    'BandwidthType' => 'All',
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]

DeleteChapCredentials

$result = $client->deleteChapCredentials([/* ... */]);
$promise = $client->deleteChapCredentialsAsync([/* ... */]);

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.

Parameter Syntax

$result = $client->deleteChapCredentials([
    'InitiatorName' => '<string>', // REQUIRED
    'TargetARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'InitiatorName' => '<string>',
    'TargetARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To delete CHAP credentials

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

$result = $client->deleteChapCredentials([
    'InitiatorName' => 'iqn.1991-05.com.microsoft:computername.domain.example.com',
    'TargetARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
]);

Result syntax:

[
    'InitiatorName' => 'iqn.1991-05.com.microsoft:computername.domain.example.com',
    'TargetARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
]

DeleteFileShare

$result = $client->deleteFileShare([/* ... */]);
$promise = $client->deleteFileShareAsync([/* ... */]);

Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.

Parameter Syntax

$result = $client->deleteFileShare([
    'FileShareARN' => '<string>', // REQUIRED
    'ForceDelete' => true || false,
]);

Parameter Details

Result Syntax

[
    'FileShareARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DeleteGateway

$result = $client->deleteGateway([/* ... */]);
$promise = $client->deleteGatewayAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteGateway([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To delete a gatgeway

This operation deletes the gateway, but not the gateway's VM from the host computer.

$result = $client->deleteGateway([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]

DeleteSnapshotSchedule

$result = $client->deleteSnapshotSchedule([/* ... */]);
$promise = $client->deleteSnapshotScheduleAsync([/* ... */]);

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.

Parameter Syntax

$result = $client->deleteSnapshotSchedule([
    'VolumeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'VolumeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To delete a snapshot of a volume

This action enables you to delete a snapshot schedule for a volume.

$result = $client->deleteSnapshotSchedule([
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]);

Result syntax:

[
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]

DeleteTape

$result = $client->deleteTape([/* ... */]);
$promise = $client->deleteTapeAsync([/* ... */]);

Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

Parameter Syntax

$result = $client->deleteTape([
    'BypassGovernanceRetention' => true || false,
    'GatewayARN' => '<string>', // REQUIRED
    'TapeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TapeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To delete a virtual tape

This example deletes the specified virtual tape.

$result = $client->deleteTape([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B',
    'TapeARN' => 'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
]);

Result syntax:

[
    'TapeARN' => 'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
]

DeleteTapeArchive

$result = $client->deleteTapeArchive([/* ... */]);
$promise = $client->deleteTapeArchiveAsync([/* ... */]);

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

Parameter Syntax

$result = $client->deleteTapeArchive([
    'BypassGovernanceRetention' => true || false,
    'TapeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TapeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To delete a virtual tape from the shelf (VTS)

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

$result = $client->deleteTapeArchive([
    'TapeARN' => 'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
]);

Result syntax:

[
    'TapeARN' => 'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
]

DeleteTapePool

$result = $client->deleteTapePool([/* ... */]);
$promise = $client->deleteTapePoolAsync([/* ... */]);

Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.

Parameter Syntax

$result = $client->deleteTapePool([
    'PoolARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PoolARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DeleteVolume

$result = $client->deleteVolume([/* ... */]);
$promise = $client->deleteVolumeAsync([/* ... */]);

Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

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

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

Parameter Syntax

$result = $client->deleteVolume([
    'VolumeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'VolumeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To delete a gateway volume

Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.

$result = $client->deleteVolume([
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]);

Result syntax:

[
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]

DescribeAvailabilityMonitorTest

$result = $client->describeAvailabilityMonitorTest([/* ... */]);
$promise = $client->describeAvailabilityMonitorTestAsync([/* ... */]);

Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.

Parameter Syntax

$result = $client->describeAvailabilityMonitorTest([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
    'StartTime' => <DateTime>,
    'Status' => 'COMPLETE|FAILED|PENDING',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DescribeBandwidthRateLimit

$result = $client->describeBandwidthRateLimit([/* ... */]);
$promise = $client->describeBandwidthRateLimitAsync([/* ... */]);

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.

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

Parameter Syntax

$result = $client->describeBandwidthRateLimit([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AverageDownloadRateLimitInBitsPerSec' => <integer>,
    'AverageUploadRateLimitInBitsPerSec' => <integer>,
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe the bandwidth rate limits of a gateway

Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.

$result = $client->describeBandwidthRateLimit([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'AverageDownloadRateLimitInBitsPerSec' => 204800,
    'AverageUploadRateLimitInBitsPerSec' => 102400,
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]

DescribeBandwidthRateLimitSchedule

$result = $client->describeBandwidthRateLimitSchedule([/* ... */]);
$promise = $client->describeBandwidthRateLimitScheduleAsync([/* ... */]);

Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.

This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading

If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Parameter Syntax

$result = $client->describeBandwidthRateLimitSchedule([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BandwidthRateLimitIntervals' => [
        [
            'AverageDownloadRateLimitInBitsPerSec' => <integer>,
            'AverageUploadRateLimitInBitsPerSec' => <integer>,
            'DaysOfWeek' => [<integer>, ...],
            'EndHourOfDay' => <integer>,
            'EndMinuteOfHour' => <integer>,
            'StartHourOfDay' => <integer>,
            'StartMinuteOfHour' => <integer>,
        ],
        // ...
    ],
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DescribeCache

$result = $client->describeCache([/* ... */]);
$promise = $client->describeCacheAsync([/* ... */]);

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

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

Parameter Syntax

$result = $client->describeCache([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CacheAllocatedInBytes' => <integer>,
    'CacheDirtyPercentage' => <float>,
    'CacheHitPercentage' => <float>,
    'CacheMissPercentage' => <float>,
    'CacheUsedPercentage' => <float>,
    'DiskIds' => ['<string>', ...],
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe cache information

Returns information about the cache of a gateway.

$result = $client->describeCache([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'CacheAllocatedInBytes' => 2199023255552,
    'CacheDirtyPercentage' => 0.07,
    'CacheHitPercentage' => 99.68,
    'CacheMissPercentage' => 0.32,
    'CacheUsedPercentage' => 0.07,
    'DiskIds' => [
        'pci-0000:03:00.0-scsi-0:0:0:0',
        'pci-0000:04:00.0-scsi-0:1:0:0',
    ],
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]

DescribeCachediSCSIVolumes

$result = $client->describeCachediSCSIVolumes([/* ... */]);
$promise = $client->describeCachediSCSIVolumesAsync([/* ... */]);

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

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

Parameter Syntax

$result = $client->describeCachediSCSIVolumes([
    'VolumeARNs' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CachediSCSIVolumes' => [
        [
            'CreatedDate' => <DateTime>,
            'KMSKey' => '<string>',
            'SourceSnapshotId' => '<string>',
            'TargetName' => '<string>',
            'VolumeARN' => '<string>',
            'VolumeAttachmentStatus' => '<string>',
            'VolumeId' => '<string>',
            'VolumeProgress' => <float>,
            'VolumeSizeInBytes' => <integer>,
            'VolumeStatus' => '<string>',
            'VolumeType' => '<string>',
            'VolumeUsedInBytes' => <integer>,
            'VolumeiSCSIAttributes' => [
                'ChapEnabled' => true || false,
                'LunNumber' => <integer>,
                'NetworkInterfaceId' => '<string>',
                'NetworkInterfacePort' => <integer>,
                'TargetARN' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe gateway cached iSCSI volumes

Returns a description of the gateway cached iSCSI volumes specified in the request.

$result = $client->describeCachediSCSIVolumes([
    'VolumeARNs' => [
        'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
    ],
]);

Result syntax:

[
    'CachediSCSIVolumes' => [
        [
            'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
            'VolumeId' => 'vol-1122AABB',
            'VolumeSizeInBytes' => 1099511627776,
            'VolumeStatus' => 'AVAILABLE',
            'VolumeType' => 'CACHED iSCSI',
            'VolumeiSCSIAttributes' => [
                'ChapEnabled' => 1,
                'LunNumber' => 1,
                'NetworkInterfaceId' => '10.243.43.207',
                'NetworkInterfacePort' => 3260,
                'TargetARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
            ],
        ],
    ],
]

DescribeChapCredentials

$result = $client->describeChapCredentials([/* ... */]);
$promise = $client->describeChapCredentialsAsync([/* ... */]);

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.

Parameter Syntax

$result = $client->describeChapCredentials([
    'TargetARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChapCredentials' => [
        [
            'InitiatorName' => '<string>',
            'SecretToAuthenticateInitiator' => '<string>',
            'SecretToAuthenticateTarget' => '<string>',
            'TargetARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe CHAP credetnitals for an iSCSI

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

$result = $client->describeChapCredentials([
    'TargetARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
]);

Result syntax:

[
    'ChapCredentials' => [
        [
            'InitiatorName' => 'iqn.1991-05.com.microsoft:computername.domain.example.com',
            'SecretToAuthenticateInitiator' => '111111111111',
            'SecretToAuthenticateTarget' => '222222222222',
            'TargetARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
        ],
    ],
]

DescribeFileSystemAssociations

$result = $client->describeFileSystemAssociations([/* ... */]);
$promise = $client->describeFileSystemAssociationsAsync([/* ... */]);

Gets the file system association information. This operation is only supported for FSx File Gateways.

Parameter Syntax

$result = $client->describeFileSystemAssociations([
    'FileSystemAssociationARNList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FileSystemAssociationInfoList' => [
        [
            'AuditDestinationARN' => '<string>',
            'CacheAttributes' => [
                'CacheStaleTimeoutInSeconds' => <integer>,
            ],
            'EndpointNetworkConfiguration' => [
                'IpAddresses' => ['<string>', ...],
            ],
            'FileSystemAssociationARN' => '<string>',
            'FileSystemAssociationStatus' => '<string>',
            'FileSystemAssociationStatusDetails' => [
                [
                    'ErrorCode' => '<string>',
                ],
                // ...
            ],
            'GatewayARN' => '<string>',
            'LocationARN' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DescribeGatewayInformation

$result = $client->describeGatewayInformation([/* ... */]);
$promise = $client->describeGatewayInformationAsync([/* ... */]);

Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Parameter Syntax

$result = $client->describeGatewayInformation([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CloudWatchLogGroupARN' => '<string>',
    'DeprecationDate' => '<string>',
    'Ec2InstanceId' => '<string>',
    'Ec2InstanceRegion' => '<string>',
    'EndpointType' => '<string>',
    'GatewayARN' => '<string>',
    'GatewayCapacity' => 'Small|Medium|Large',
    'GatewayId' => '<string>',
    'GatewayName' => '<string>',
    'GatewayNetworkInterfaces' => [
        [
            'Ipv4Address' => '<string>',
            'Ipv6Address' => '<string>',
            'MacAddress' => '<string>',
        ],
        // ...
    ],
    'GatewayState' => '<string>',
    'GatewayTimezone' => '<string>',
    'GatewayType' => '<string>',
    'HostEnvironment' => 'VMWARE|HYPER-V|EC2|KVM|OTHER|SNOWBALL',
    'HostEnvironmentId' => '<string>',
    'LastSoftwareUpdate' => '<string>',
    'NextUpdateAvailabilityDate' => '<string>',
    'SoftwareUpdatesEndDate' => '<string>',
    'SoftwareVersion' => '<string>',
    'SupportedGatewayCapacities' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VPCEndpoint' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe metadata about the gateway

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).

$result = $client->describeGatewayInformation([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'GatewayId' => 'sgw-AABB1122',
    'GatewayName' => 'My_Gateway',
    'GatewayNetworkInterfaces' => [
        [
            'Ipv4Address' => '10.35.69.216',
        ],
    ],
    'GatewayState' => 'STATE_RUNNING',
    'GatewayTimezone' => 'GMT-8:00',
    'GatewayType' => 'STORED',
    'LastSoftwareUpdate' => '2016-01-02T16:00:00',
    'NextUpdateAvailabilityDate' => '2017-01-02T16:00:00',
]

DescribeMaintenanceStartTime

$result = $client->describeMaintenanceStartTime([/* ... */]);
$promise = $client->describeMaintenanceStartTimeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeMaintenanceStartTime([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DayOfMonth' => <integer>,
    'DayOfWeek' => <integer>,
    'GatewayARN' => '<string>',
    'HourOfDay' => <integer>,
    'MinuteOfHour' => <integer>,
    'Timezone' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe gateway's maintenance start time

Returns your gateway's weekly maintenance start time including the day and time of the week.

$result = $client->describeMaintenanceStartTime([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'DayOfWeek' => 2,
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'HourOfDay' => 15,
    'MinuteOfHour' => 35,
    'Timezone' => 'GMT+7:00',
]

DescribeNFSFileShares

$result = $client->describeNFSFileShares([/* ... */]);
$promise = $client->describeNFSFileSharesAsync([/* ... */]);

Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.

Parameter Syntax

$result = $client->describeNFSFileShares([
    'FileShareARNList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NFSFileShareInfoList' => [
        [
            'AuditDestinationARN' => '<string>',
            'BucketRegion' => '<string>',
            'CacheAttributes' => [
                'CacheStaleTimeoutInSeconds' => <integer>,
            ],
            'ClientList' => ['<string>', ...],
            'DefaultStorageClass' => '<string>',
            'FileShareARN' => '<string>',
            'FileShareId' => '<string>',
            'FileShareName' => '<string>',
            'FileShareStatus' => '<string>',
            'GatewayARN' => '<string>',
            'GuessMIMETypeEnabled' => true || false,
            'KMSEncrypted' => true || false,
            'KMSKey' => '<string>',
            'LocationARN' => '<string>',
            'NFSFileShareDefaults' => [
                'DirectoryMode' => '<string>',
                'FileMode' => '<string>',
                'GroupId' => <integer>,
                'OwnerId' => <integer>,
            ],
            'NotificationPolicy' => '<string>',
            'ObjectACL' => 'private|public-read|public-read-write|authenticated-read|bucket-owner-read|bucket-owner-full-control|aws-exec-read',
            'Path' => '<string>',
            'ReadOnly' => true || false,
            'RequesterPays' => true || false,
            'Role' => '<string>',
            'Squash' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VPCEndpointDNSName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DescribeSMBFileShares

$result = $client->describeSMBFileShares([/* ... */]);
$promise = $client->describeSMBFileSharesAsync([/* ... */]);

Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.

Parameter Syntax

$result = $client->describeSMBFileShares([
    'FileShareARNList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SMBFileShareInfoList' => [
        [
            'AccessBasedEnumeration' => true || false,
            'AdminUserList' => ['<string>', ...],
            'AuditDestinationARN' => '<string>',
            'Authentication' => '<string>',
            'BucketRegion' => '<string>',
            'CacheAttributes' => [
                'CacheStaleTimeoutInSeconds' => <integer>,
            ],
            'CaseSensitivity' => 'ClientSpecified|CaseSensitive',
            'DefaultStorageClass' => '<string>',
            'FileShareARN' => '<string>',
            'FileShareId' => '<string>',
            'FileShareName' => '<string>',
            'FileShareStatus' => '<string>',
            'GatewayARN' => '<string>',
            'GuessMIMETypeEnabled' => true || false,
            'InvalidUserList' => ['<string>', ...],
            'KMSEncrypted' => true || false,
            'KMSKey' => '<string>',
            'LocationARN' => '<string>',
            'NotificationPolicy' => '<string>',
            'ObjectACL' => 'private|public-read|public-read-write|authenticated-read|bucket-owner-read|bucket-owner-full-control|aws-exec-read',
            'OplocksEnabled' => true || false,
            'Path' => '<string>',
            'ReadOnly' => true || false,
            'RequesterPays' => true || false,
            'Role' => '<string>',
            'SMBACLEnabled' => true || false,
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'VPCEndpointDNSName' => '<string>',
            'ValidUserList' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DescribeSMBSettings

$result = $client->describeSMBSettings([/* ... */]);
$promise = $client->describeSMBSettingsAsync([/* ... */]);

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

Parameter Syntax

$result = $client->describeSMBSettings([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ActiveDirectoryStatus' => 'ACCESS_DENIED|DETACHED|JOINED|JOINING|NETWORK_ERROR|TIMEOUT|UNKNOWN_ERROR',
    'DomainName' => '<string>',
    'FileSharesVisible' => true || false,
    'GatewayARN' => '<string>',
    'SMBGuestPasswordSet' => true || false,
    'SMBLocalGroups' => [
        'GatewayAdmins' => ['<string>', ...],
    ],
    'SMBSecurityStrategy' => 'ClientSpecified|MandatorySigning|MandatoryEncryption|MandatoryEncryptionNoAes128',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DescribeSnapshotSchedule

$result = $client->describeSnapshotSchedule([/* ... */]);
$promise = $client->describeSnapshotScheduleAsync([/* ... */]);

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.

Parameter Syntax

$result = $client->describeSnapshotSchedule([
    'VolumeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'RecurrenceInHours' => <integer>,
    'StartAt' => <integer>,
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Timezone' => '<string>',
    'VolumeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe snapshot schedule for gateway volume

Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.

$result = $client->describeSnapshotSchedule([
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]);

Result syntax:

[
    'Description' => 'sgw-AABB1122:vol-AABB1122:Schedule',
    'RecurrenceInHours' => 24,
    'StartAt' => 6,
    'Timezone' => 'GMT+7:00',
    'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
]

DescribeStorediSCSIVolumes

$result = $client->describeStorediSCSIVolumes([/* ... */]);
$promise = $client->describeStorediSCSIVolumesAsync([/* ... */]);

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

Parameter Syntax

$result = $client->describeStorediSCSIVolumes([
    'VolumeARNs' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'StorediSCSIVolumes' => [
        [
            'CreatedDate' => <DateTime>,
            'KMSKey' => '<string>',
            'PreservedExistingData' => true || false,
            'SourceSnapshotId' => '<string>',
            'TargetName' => '<string>',
            'VolumeARN' => '<string>',
            'VolumeAttachmentStatus' => '<string>',
            'VolumeDiskId' => '<string>',
            'VolumeId' => '<string>',
            'VolumeProgress' => <float>,
            'VolumeSizeInBytes' => <integer>,
            'VolumeStatus' => '<string>',
            'VolumeType' => '<string>',
            'VolumeUsedInBytes' => <integer>,
            'VolumeiSCSIAttributes' => [
                'ChapEnabled' => true || false,
                'LunNumber' => <integer>,
                'NetworkInterfaceId' => '<string>',
                'NetworkInterfacePort' => <integer>,
                'TargetARN' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe the volumes of a gateway

Returns the description of the gateway volumes specified in the request belonging to the same gateway.

$result = $client->describeStorediSCSIVolumes([
    'VolumeARNs' => [
        'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
    ],
]);

Result syntax:

[
    'StorediSCSIVolumes' => [
        [
            'PreservedExistingData' => ,
            'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
            'VolumeDiskId' => 'pci-0000:03:00.0-scsi-0:0:0:0',
            'VolumeId' => 'vol-1122AABB',
            'VolumeProgress' => 23.7,
            'VolumeSizeInBytes' => 1099511627776,
            'VolumeStatus' => 'BOOTSTRAPPING',
            'VolumeiSCSIAttributes' => [
                'ChapEnabled' => 1,
                'NetworkInterfaceId' => '10.243.43.207',
                'NetworkInterfacePort' => 3260,
                'TargetARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
            ],
        ],
    ],
]

DescribeTapeArchives

$result = $client->describeTapeArchives([/* ... */]);
$promise = $client->describeTapeArchivesAsync([/* ... */]);

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'TapeArchives' => [
        [
            'CompletionTime' => <DateTime>,
            'KMSKey' => '<string>',
            'PoolEntryDate' => <DateTime>,
            'PoolId' => '<string>',
            'RetentionStartDate' => <DateTime>,
            'RetrievedTo' => '<string>',
            'TapeARN' => '<string>',
            'TapeBarcode' => '<string>',
            'TapeCreatedDate' => <DateTime>,
            'TapeSizeInBytes' => <integer>,
            'TapeStatus' => '<string>',
            'TapeUsedInBytes' => <integer>,
            'Worm' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe virtual tapes in the VTS

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

$result = $client->describeTapeArchives([
    'Limit' => 123,
    'Marker' => '1',
    'TapeARNs' => [
        'arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD',
        'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
    ],
]);

Result syntax:

[
    'Marker' => '1',
    'TapeArchives' => [
        [
            'CompletionTime' => ,
            'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD',
            'TapeBarcode' => 'AM08A1AD',
            'TapeSizeInBytes' => 107374182400,
            'TapeStatus' => 'ARCHIVED',
        ],
        [
            'CompletionTime' => ,
            'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4',
            'TapeBarcode' => 'AMZN01A2A4',
            'TapeSizeInBytes' => 429496729600,
            'TapeStatus' => 'ARCHIVED',
        ],
    ],
]

DescribeTapeRecoveryPoints

$result = $client->describeTapeRecoveryPoints([/* ... */]);
$promise = $client->describeTapeRecoveryPointsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->describeTapeRecoveryPoints([
    'GatewayARN' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
    'Marker' => '<string>',
    'TapeRecoveryPointInfos' => [
        [
            'TapeARN' => '<string>',
            'TapeRecoveryPointTime' => <DateTime>,
            'TapeSizeInBytes' => <integer>,
            'TapeStatus' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe virtual tape recovery points

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

$result = $client->describeTapeRecoveryPoints([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'Limit' => 1,
    'Marker' => '1',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'Marker' => '1',
    'TapeRecoveryPointInfos' => [
        [
            'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4',
            'TapeRecoveryPointTime' => ,
            'TapeSizeInBytes' => 1471550497,
            'TapeStatus' => 'AVAILABLE',
        ],
    ],
]

DescribeTapes

$result = $client->describeTapes([/* ... */]);
$promise = $client->describeTapesAsync([/* ... */]);

Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs). If TapeARN is not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type.

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

Parameter Syntax

$result = $client->describeTapes([
    'GatewayARN' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Marker' => '<string>',
    'TapeARNs' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'Tapes' => [
        [
            'KMSKey' => '<string>',
            'PoolEntryDate' => <DateTime>,
            'PoolId' => '<string>',
            'Progress' => <float>,
            'RetentionStartDate' => <DateTime>,
            'TapeARN' => '<string>',
            'TapeBarcode' => '<string>',
            'TapeCreatedDate' => <DateTime>,
            'TapeSizeInBytes' => <integer>,
            'TapeStatus' => '<string>',
            'TapeUsedInBytes' => <integer>,
            'VTLDevice' => '<string>',
            'Worm' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe virtual tape(s) associated with gateway

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.

$result = $client->describeTapes([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    'Limit' => 2,
    'Marker' => '1',
    'TapeARNs' => [
        'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1',
        'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0',
    ],
]);

Result syntax:

[
    'Marker' => '1',
    'Tapes' => [
        [
            'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1',
            'TapeBarcode' => 'TEST04A2A1',
            'TapeSizeInBytes' => 107374182400,
            'TapeStatus' => 'AVAILABLE',
        ],
        [
            'TapeARN' => 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0',
            'TapeBarcode' => 'TEST05A2A0',
            'TapeSizeInBytes' => 107374182400,
            'TapeStatus' => 'AVAILABLE',
        ],
    ],
]

DescribeUploadBuffer

$result = $client->describeUploadBuffer([/* ... */]);
$promise = $client->describeUploadBufferAsync([/* ... */]);

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

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

Parameter Syntax

$result = $client->describeUploadBuffer([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DiskIds' => ['<string>', ...],
    'GatewayARN' => '<string>',
    'UploadBufferAllocatedInBytes' => <integer>,
    'UploadBufferUsedInBytes' => <integer>,
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe upload buffer of gateway

Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.

$result = $client->describeUploadBuffer([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'DiskIds' => [
        'pci-0000:03:00.0-scsi-0:0:0:0',
        'pci-0000:04:00.0-scsi-0:1:0:0',
    ],
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'UploadBufferAllocatedInBytes' => 0,
    'UploadBufferUsedInBytes' => 161061273600,
]

Example 2: To describe upload buffer of a gateway

Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.

$result = $client->describeUploadBuffer([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'DiskIds' => [
        'pci-0000:03:00.0-scsi-0:0:0:0',
        'pci-0000:04:00.0-scsi-0:1:0:0',
    ],
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'UploadBufferAllocatedInBytes' => 161061273600,
    'UploadBufferUsedInBytes' => 0,
]

DescribeVTLDevices

$result = $client->describeVTLDevices([/* ... */]);
$promise = $client->describeVTLDevicesAsync([/* ... */]);

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

This operation is only supported in the tape gateway type.

Parameter Syntax

$result = $client->describeVTLDevices([
    'GatewayARN' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Marker' => '<string>',
    'VTLDeviceARNs' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
    'Marker' => '<string>',
    'VTLDevices' => [
        [
            'DeviceiSCSIAttributes' => [
                'ChapEnabled' => true || false,
                'NetworkInterfaceId' => '<string>',
                'NetworkInterfacePort' => <integer>,
                'TargetARN' => '<string>',
            ],
            'VTLDeviceARN' => '<string>',
            'VTLDeviceProductIdentifier' => '<string>',
            'VTLDeviceType' => '<string>',
            'VTLDeviceVendor' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe virtual tape library (VTL) devices of a single gateway

Returns a description of virtual tape library (VTL) devices for the specified gateway.

$result = $client->describeVTLDevices([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    'Limit' => 123,
    'Marker' => '1',
    'VTLDeviceARNs' => [
    ],
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    'Marker' => '1',
    'VTLDevices' => [
        [
            'DeviceiSCSIAttributes' => [
                'ChapEnabled' => ,
                'NetworkInterfaceId' => '10.243.43.207',
                'NetworkInterfacePort' => 3260,
                'TargetARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger',
            ],
            'VTLDeviceARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001',
            'VTLDeviceProductIdentifier' => 'L700',
            'VTLDeviceType' => 'Medium Changer',
            'VTLDeviceVendor' => 'STK',
        ],
        [
            'DeviceiSCSIAttributes' => [
                'ChapEnabled' => ,
                'NetworkInterfaceId' => '10.243.43.209',
                'NetworkInterfacePort' => 3260,
                'TargetARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01',
            ],
            'VTLDeviceARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001',
            'VTLDeviceProductIdentifier' => 'ULT3580-TD5',
            'VTLDeviceType' => 'Tape Drive',
            'VTLDeviceVendor' => 'IBM',
        ],
        [
            'DeviceiSCSIAttributes' => [
                'ChapEnabled' => ,
                'NetworkInterfaceId' => '10.243.43.209',
                'NetworkInterfacePort' => 3260,
                'TargetARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02',
            ],
            'VTLDeviceARN' => 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002',
            'VTLDeviceProductIdentifier' => 'ULT3580-TD5',
            'VTLDeviceType' => 'Tape Drive',
            'VTLDeviceVendor' => 'IBM',
        ],
    ],
]

DescribeWorkingStorage

$result = $client->describeWorkingStorage([/* ... */]);
$promise = $client->describeWorkingStorageAsync([/* ... */]);

Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

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

Parameter Syntax

$result = $client->describeWorkingStorage([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DiskIds' => ['<string>', ...],
    'GatewayARN' => '<string>',
    'WorkingStorageAllocatedInBytes' => <integer>,
    'WorkingStorageUsedInBytes' => <integer>,
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To describe the working storage of a gateway [Depreciated]

This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.

$result = $client->describeWorkingStorage([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'DiskIds' => [
        'pci-0000:03:00.0-scsi-0:0:0:0',
        'pci-0000:03:00.0-scsi-0:0:1:0',
    ],
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'WorkingStorageAllocatedInBytes' => 2199023255552,
    'WorkingStorageUsedInBytes' => 789207040,
]

DetachVolume

$result = $client->detachVolume([/* ... */]);
$promise = $client->detachVolumeAsync([/* ... */]);

Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.

Parameter Syntax

$result = $client->detachVolume([
    'ForceDetach' => true || false,
    'VolumeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'VolumeARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

DisableGateway

$result = $client->disableGateway([/* ... */]);
$promise = $client->disableGatewayAsync([/* ... */]);

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

Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

Parameter Syntax

$result = $client->disableGateway([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To disable a gateway when it is no longer functioning

Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning.

$result = $client->disableGateway([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]

DisassociateFileSystem

$result = $client->disassociateFileSystem([/* ... */]);
$promise = $client->disassociateFileSystemAsync([/* ... */]);

Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.

Parameter Syntax

$result = $client->disassociateFileSystem([
    'FileSystemAssociationARN' => '<string>', // REQUIRED
    'ForceDelete' => true || false,
]);

Parameter Details

Result Syntax

[
    'FileSystemAssociationARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

JoinDomain

$result = $client->joinDomain([/* ... */]);
$promise = $client->joinDomainAsync([/* ... */]);

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

Parameter Syntax

$result = $client->joinDomain([
    'DomainControllers' => ['<string>', ...],
    'DomainName' => '<string>', // REQUIRED
    'GatewayARN' => '<string>', // REQUIRED
    'OrganizationalUnit' => '<string>',
    'Password' => '<string>', // REQUIRED
    'TimeoutInSeconds' => <integer>,
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ActiveDirectoryStatus' => 'ACCESS_DENIED|DETACHED|JOINED|JOINING|NETWORK_ERROR|TIMEOUT|UNKNOWN_ERROR',
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

ListAutomaticTapeCreationPolicies

$result = $client->listAutomaticTapeCreationPolicies([/* ... */]);
$promise = $client->listAutomaticTapeCreationPoliciesAsync([/* ... */]);

Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.

This operation is only supported for tape gateways.

Parameter Syntax

$result = $client->listAutomaticTapeCreationPolicies([
    'GatewayARN' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AutomaticTapeCreationPolicyInfos' => [
        [
            'AutomaticTapeCreationRules' => [
                [
                    'MinimumNumTapes' => <integer>,
                    'PoolId' => '<string>',
                    'TapeBarcodePrefix' => '<string>',
                    'TapeSizeInBytes' => <integer>,
                    'Worm' => true || false,
                ],
                // ...
            ],
            'GatewayARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

ListFileShares

$result = $client->listFileShares([/* ... */]);
$promise = $client->listFileSharesAsync([/* ... */]);

Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.

Parameter Syntax

$result = $client->listFileShares([
    'GatewayARN' => '<string>',
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FileShareInfoList' => [
        [
            'FileShareARN' => '<string>',
            'FileShareId' => '<string>',
            'FileShareStatus' => '<string>',
            'FileShareType' => 'NFS|SMB',
            'GatewayARN' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
    'NextMarker' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

ListFileSystemAssociations

$result = $client->listFileSystemAssociations([/* ... */]);
$promise = $client->listFileSystemAssociationsAsync([/* ... */]);

Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.

Parameter Syntax

$result = $client->listFileSystemAssociations([
    'GatewayARN' => '<string>',
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FileSystemAssociationSummaryList' => [
        [
            'FileSystemAssociationARN' => '<string>',
            'FileSystemAssociationId' => '<string>',
            'FileSystemAssociationStatus' => '<string>',
            'GatewayARN' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
    'NextMarker' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

ListGateways

$result = $client->listGateways([/* ... */]);
$promise = $client->listGatewaysAsync([/* ... */]);

Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Gateways' => [
        [
            'DeprecationDate' => '<string>',
            'Ec2InstanceId' => '<string>',
            'Ec2InstanceRegion' => '<string>',
            'GatewayARN' => '<string>',
            'GatewayId' => '<string>',
            'GatewayName' => '<string>',
            'GatewayOperationalState' => '<string>',
            'GatewayType' => '<string>',
            'HostEnvironment' => 'VMWARE|HYPER-V|EC2|KVM|OTHER|SNOWBALL',
            'HostEnvironmentId' => '<string>',
            'SoftwareVersion' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To lists region specific gateways per AWS account

Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways.

$result = $client->listGateways([
    'Limit' => 2,
    'Marker' => '1',
]);

Result syntax:

[
    'Gateways' => [
        [
            'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
        ],
        [
            'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C',
        ],
    ],
    'Marker' => '1',
]

ListLocalDisks

$result = $client->listLocalDisks([/* ... */]);
$promise = $client->listLocalDisksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listLocalDisks([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Disks' => [
        [
            'DiskAllocationResource' => '<string>',
            'DiskAllocationType' => '<string>',
            'DiskAttributeList' => ['<string>', ...],
            'DiskId' => '<string>',
            'DiskNode' => '<string>',
            'DiskPath' => '<string>',
            'DiskSizeInBytes' => <integer>,
            'DiskStatus' => '<string>',
        ],
        // ...
    ],
    'GatewayARN' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To list the gateway's local disks

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.

$result = $client->listLocalDisks([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'Disks' => [
        [
            'DiskAllocationType' => 'CACHE_STORAGE',
            'DiskId' => 'pci-0000:03:00.0-scsi-0:0:0:0',
            'DiskNode' => 'SCSI(0:0)',
            'DiskPath' => '/dev/sda',
            'DiskSizeInBytes' => 1099511627776,
            'DiskStatus' => 'missing',
        ],
        [
            'DiskAllocationResource' => '',
            'DiskAllocationType' => 'UPLOAD_BUFFER',
            'DiskId' => 'pci-0000:03:00.0-scsi-0:0:1:0',
            'DiskNode' => 'SCSI(0:1)',
            'DiskPath' => '/dev/sdb',
            'DiskSizeInBytes' => 1099511627776,
            'DiskStatus' => 'present',
        ],
    ],
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.

Parameter Syntax

$result = $client->listTagsForResource([
    'Limit' => <integer>,
    'Marker' => '<string>',
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'ResourceARN' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To list tags that have been added to a resource

Lists the tags that have been added to the specified resource.

$result = $client->listTagsForResource([
    'Limit' => 1,
    'Marker' => '1',
    'ResourceARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
]);

Result syntax:

[
    'Marker' => '1',
    'ResourceARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
    'Tags' => [
        [
            'Key' => 'Dev Gatgeway Region',
            'Value' => 'East Coast',
        ],
    ],
]

ListTapePools

$result = $client->listTapePools([/* ... */]);
$promise = $client->listTapePoolsAsync([/* ... */]);

Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.

This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.

Parameter Syntax

$result = $client->listTapePools([
    'Limit' => <integer>,
    'Marker' => '<string>',
    'PoolARNs' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'PoolInfos' => [
        [
            'PoolARN' => '<string>',
            'PoolName' => '<string>',
            'PoolStatus' => 'ACTIVE|DELETED',
            'RetentionLockTimeInDays' => <integer>,
            'RetentionLockType' => 'COMPLIANCE|GOVERNANCE|NONE',
            'StorageClass' => 'DEEP_ARCHIVE|GLACIER',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

ListTapes

$result = $client->listTapes([/* ... */]);
$promise = $client->listTapesAsync([/* ... */]);

Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.

Parameter Syntax

$result = $client->listTapes([
    'Limit' => <integer>,
    'Marker' => '<string>',
    'TapeARNs' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'TapeInfos' => [
        [
            'GatewayARN' => '<string>',
            'PoolEntryDate' => <DateTime>,
            'PoolId' => '<string>',
            'RetentionStartDate' => <DateTime>,
            'TapeARN' => '<string>',
            'TapeBarcode' => '<string>',
            'TapeSizeInBytes' => <integer>,
            'TapeStatus' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

ListVolumeInitiators

$result = $client->listVolumeInitiators([/* ... */]);
$promise = $client->listVolumeInitiatorsAsync([/* ... */]);

Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.

Parameter Syntax

$result = $client->listVolumeInitiators([
    'VolumeARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Initiators' => ['<string>', ...],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

ListVolumeRecoveryPoints

$result = $client->listVolumeRecoveryPoints([/* ... */]);
$promise = $client->listVolumeRecoveryPointsAsync([/* ... */]);

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

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

Parameter Syntax

$result = $client->listVolumeRecoveryPoints([
    'GatewayARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
    'VolumeRecoveryPointInfos' => [
        [
            'VolumeARN' => '<string>',
            'VolumeRecoveryPointTime' => '<string>',
            'VolumeSizeInBytes' => <integer>,
            'VolumeUsageInBytes' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To list recovery points for a gateway

Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot.

$result = $client->listVolumeRecoveryPoints([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'VolumeRecoveryPointInfos' => [
        [
            'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
            'VolumeRecoveryPointTime' => '2012-09-04T21:08:44.627Z',
            'VolumeSizeInBytes' => 536870912000,
        ],
    ],
]

ListVolumes

$result = $client->listVolumes([/* ... */]);
$promise = $client->listVolumesAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listVolumes([
    'GatewayARN' => '<string>',
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GatewayARN' => '<string>',
    'Marker' => '<string>',
    'VolumeInfos' => [
        [
            'GatewayARN' => '<string>',
            'GatewayId' => '<string>',
            'VolumeARN' => '<string>',
            'VolumeAttachmentStatus' => '<string>',
            'VolumeId' => '<string>',
            'VolumeSizeInBytes' => <integer>,
            'VolumeType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

Examples

Example 1: To list the iSCSI stored volumes of a gateway

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.

$result = $client->listVolumes([
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'Limit' => 2,
    'Marker' => '1',
]);

Result syntax:

[
    'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'Marker' => '1',
    'VolumeInfos' => [
        [
            'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
            'GatewayId' => 'sgw-12A3456B',
            'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
            'VolumeId' => 'vol-1122AABB',
            'VolumeSizeInBytes' => 107374182400,
            'VolumeType' => 'STORED',
        ],
        [
            'GatewayARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C',
            'GatewayId' => 'sgw-gw-13B4567C',
            'VolumeARN' => 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD',
            'VolumeId' => 'vol-1122AABB',
            'VolumeSizeInBytes' => 107374182400,
            'VolumeType' => 'STORED',
        ],
    ],
]

NotifyWhenUploaded

$result = $client->notifyWhenUploaded([/* ... */]);
$promise = $client->notifyWhenUploadedAsync([/* ... */]);

Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.

Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.

Parameter Syntax

$result = $client->notifyWhenUploaded([
    'FileShareARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FileShareARN' => '<string>',
    'NotificationId' => '<string>',
]

Result Details

Errors

InvalidGatewayRequestException:

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

InternalServerError:

An internal server error has occurred during the request. For more information, see the error and message fields.

RefreshCache

$result = $client->refreshCache([/* ... */]);
$promise = $client->refreshCacheAsync([/* ... */]);

Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.

You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. This operation is Only supported for S3 File Gateways.

When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes.

Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.

For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.

Parameter Syntax

$result = $client->refreshCache([
    'FileShareARN' => '<string>', // REQUIRED
    'FolderList' => ['<string>', ...],
    'Recursive' => true || false,
]);

Parameter Details