Package-level declarations

A JSON object containing one or more of the following fields:

Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and Amazon Web Services Region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.

AddTagsToResourceInput

AddTagsToResourceOutput

A JSON object containing one or more of the following fields:

A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.

AttachVolumeInput

AttachVolumeOutput

Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.

An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically.

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

The refresh cache information for the file share or FSx file systems.

Describes an iSCSI cached volume.

A list of filter parameters and associated values that determine which files are included or excluded from a cache report created by a StartCacheReport request. Multiple instances of the same filter parameter are combined with an OR operation, while different parameters are combined with an AND operation.

Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.

CancelArchivalInput

CancelArchivalOutput

CancelRetrievalInput

CancelRetrievalOutput

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

CreateNFSFileShareInput

CreateNFSFileShareOutput

CreateSMBFileShareInput

CreateSMBFileShareOutput

A JSON object containing one or more of the following fields:

A JSON object containing the following fields:

A JSON object containing one or more of the following fields:

A JSON object containing the following fields:

CreateTapesInput

CreateTapeOutput

CreateTapeWithBarcodeInput

CreateTapeOutput

A JSON object containing the following fields:

A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.

A JSON object containing one or more of the following fields:

A JSON object containing the following fields:

DeleteFileShareInput

DeleteFileShareOutput

A JSON object containing the ID of the gateway to delete.

A JSON object containing the ID of the deleted gateway.

DeleteTapeArchiveInput

DeleteTapeArchiveOutput

DeleteTapeInput

DeleteTapeOutput

A JSON object containing the DeleteVolumeInput$VolumeARN to delete.

A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted.

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

A JSON object containing the following fields:

A JSON object containing the following fields:

A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.

A JSON object containing the following fields:

A JSON object containing the ID of the gateway.

A JSON object containing the following fields:

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

A JSON object containing the following fields:

DescribeNFSFileSharesInput

DescribeNFSFileSharesOutput

DescribeSMBFileSharesInput

DescribeSMBFileSharesOutput

A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.

A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

DescribeTapeArchivesInput

DescribeTapeArchivesOutput

DescribeTapeRecoveryPointsInput

DescribeTapeRecoveryPointsOutput

DescribeTapesInput

DescribeTapesOutput

DescribeVTLDevicesInput

DescribeVTLDevicesOutput

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

A JSON object containing the following fields:

AttachVolumeInput

AttachVolumeOutput

Lists iSCSI information about a VTL device.

DisableGatewayInput

DisableGatewayOutput

Represents a gateway's local disk.

Specifies network configuration information for the gateway associated with the Amazon FSx file system.

Describes a file share. Only supported S3 File Gateway.

The type of the file share.

Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.

Detailed information on file system association status.

Gets the summary returned by ListFileSystemAssociation, which is a summary of a created file system association.

Describes a gateway object.

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

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

JoinDomainInput

JoinDomainOutput

ListFileShareInput

ListFileShareOutput

A JSON object containing zero or more of the following fields:

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

ListTagsForResourceInput

ListTagsForResourceOutput

A JSON object that contains one or more of the following fields:

A JSON object containing the following fields:

ListVolumeInitiatorsInput

ListVolumeInitiatorsOutput

A JSON object that contains one or more of the following fields:

A JSON object containing the following fields:

Describes a gateway's network interface.

Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for S3 File Gateways.

The Unix file permissions and ownership information assigned, by default, to native S3 objects when an S3 File Gateway discovers them in S3 buckets. This operation is only supported in S3 File Gateways.

A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private.

Describes a custom tape pool.

RefreshCacheInput

RefreshCacheOutput

RemoveTagsFromResourceInput

RemoveTagsFromResourceOutput

RetrieveTapeArchiveInput

RetrieveTapeArchiveOutput

RetrieveTapeRecoveryPointInput

RetrieveTapeRecoveryPointOutput

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

SetLocalConsolePasswordInput

SetSMBGuestPasswordInput

A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.

The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.

A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

A set of variables indicating the software update preferences for the gateway.

A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.

Provides additional information about an error that was returned by the service. See the errorCode and errorDetails members for more information about the error.

Base class for all service related exceptions thrown by the StorageGateway client

Describes an iSCSI stored volume.

A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

Describes a virtual tape object.

Represents a virtual tape that is archived in the virtual tape shelf (VTS).

Describes a virtual tape.

Describes a recovery point.

A JSON object containing one or more of the following fields:

A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.

A JSON object containing one or more of the following fields:

A JSON object containing the following fields:

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.

A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.

A JSON object containing the following fields:

A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.

UpdateNFSFileShareInput

UpdateNFSFileShareOutput

UpdateSMBFileShareInput

UpdateSMBFileShareOutput

A JSON object containing one or more of the following fields:

A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.

UpdateVTLDeviceTypeOutput

Describes a storage volume object.

Lists iSCSI information about a volume.

Describes a storage volume recovery point object.

Represents a device object associated with a tape gateway.