Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/storagegateway.ts?docs=full";

§Classes

StorageGateway

§Interfaces

ActivateGatewayInput

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

ActivateGatewayOutput

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.

AddCacheInput
AddCacheOutput
AddTagsToResourceInput

AddTagsToResourceInput

AddTagsToResourceOutput

AddTagsToResourceOutput

AddUploadBufferInput
AddUploadBufferOutput
AddWorkingStorageInput

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

AddWorkingStorageOutput

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

AssignTapePoolInput
AssignTapePoolOutput
AssociateFileSystemInput
AssociateFileSystemOutput
AttachVolumeInput

AttachVolumeInput

AttachVolumeOutput

AttachVolumeOutput

AutomaticTapeCreationPolicyInfo

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

AutomaticTapeCreationRule

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.

BandwidthRateLimitInterval

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.

CacheAttributes

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

CachediSCSIVolume

Describes an iSCSI cached volume.

CancelArchivalInput

CancelArchivalInput

CancelArchivalOutput

CancelArchivalOutput

CancelRetrievalInput

CancelRetrievalInput

CancelRetrievalOutput

CancelRetrievalOutput

ChapInfo

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

CreateCachediSCSIVolumeInput
CreateCachediSCSIVolumeOutput
CreateNFSFileShareInput

CreateNFSFileShareInput

CreateNFSFileShareOutput

CreateNFSFileShareOutput

CreateSMBFileShareInput

CreateSMBFileShareInput

CreateSMBFileShareOutput

CreateSMBFileShareOutput

CreateSnapshotFromVolumeRecoveryPointInput
CreateSnapshotFromVolumeRecoveryPointOutput
CreateSnapshotInput

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

CreateSnapshotOutput

A JSON object containing the following fields:

CreateStorediSCSIVolumeInput

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

CreateStorediSCSIVolumeOutput

A JSON object containing the following fields:

CreateTapePoolInput
CreateTapePoolOutput
CreateTapesInput

CreateTapesInput

CreateTapesOutput

CreateTapeOutput

CreateTapeWithBarcodeInput

CreateTapeWithBarcodeInput

CreateTapeWithBarcodeOutput

CreateTapeOutput

DeleteAutomaticTapeCreationPolicyInput
DeleteAutomaticTapeCreationPolicyOutput
DeleteBandwidthRateLimitInput

A JSON object containing the following fields:

DeleteBandwidthRateLimitOutput

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

DeleteChapCredentialsInput

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

DeleteChapCredentialsOutput

A JSON object containing the following fields:

DeleteFileShareInput

DeleteFileShareInput

DeleteFileShareOutput

DeleteFileShareOutput

DeleteGatewayInput

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

DeleteGatewayOutput

A JSON object containing the ID of the deleted gateway.

DeleteSnapshotScheduleInput
DeleteSnapshotScheduleOutput
DeleteTapeArchiveInput

DeleteTapeArchiveInput

DeleteTapeArchiveOutput

DeleteTapeArchiveOutput

DeleteTapeInput

DeleteTapeInput

DeleteTapeOutput

DeleteTapeOutput

DeleteTapePoolInput
DeleteTapePoolOutput
DeleteVolumeInput

A JSON object containing the "DeleteVolumeInput$VolumeARN" to delete.

DeleteVolumeOutput

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

DescribeAvailabilityMonitorTestInput
DescribeAvailabilityMonitorTestOutput
DescribeBandwidthRateLimitInput

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

DescribeBandwidthRateLimitOutput

A JSON object containing the following fields:

DescribeBandwidthRateLimitScheduleInput
DescribeBandwidthRateLimitScheduleOutput
DescribeCachediSCSIVolumesInput
DescribeCachediSCSIVolumesOutput

A JSON object containing the following fields:

DescribeCacheInput
DescribeCacheOutput
DescribeChapCredentialsInput

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

DescribeChapCredentialsOutput

A JSON object containing the following fields:

DescribeFileSystemAssociationsInput
DescribeFileSystemAssociationsOutput
DescribeGatewayInformationInput

A JSON object containing the ID of the gateway.

DescribeGatewayInformationOutput

A JSON object containing the following fields:

DescribeMaintenanceStartTimeInput

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

DescribeMaintenanceStartTimeOutput

A JSON object containing the following fields:

DescribeNFSFileSharesInput

DescribeNFSFileSharesInput

DescribeNFSFileSharesOutput

DescribeNFSFileSharesOutput

DescribeSMBFileSharesInput

DescribeSMBFileSharesInput

DescribeSMBFileSharesOutput

DescribeSMBFileSharesOutput

DescribeSMBSettingsInput
DescribeSMBSettingsOutput
DescribeSnapshotScheduleInput

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

DescribeSnapshotScheduleOutput
DescribeStorediSCSIVolumesInput

A JSON object containing a list of "DescribeStorediSCSIVolumesInput$VolumeARNs".

DescribeStorediSCSIVolumesOutput
DescribeTapeArchivesInput

DescribeTapeArchivesInput

DescribeTapeArchivesOutput

DescribeTapeArchivesOutput

DescribeTapeRecoveryPointsInput

DescribeTapeRecoveryPointsInput

DescribeTapeRecoveryPointsOutput

DescribeTapeRecoveryPointsOutput

DescribeTapesInput

DescribeTapesInput

DescribeTapesOutput

DescribeTapesOutput

DescribeUploadBufferInput
DescribeUploadBufferOutput
DescribeVTLDevicesInput

DescribeVTLDevicesInput

DescribeVTLDevicesOutput

DescribeVTLDevicesOutput

DescribeWorkingStorageInput

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

DescribeWorkingStorageOutput

A JSON object containing the following fields:

DetachVolumeInput

AttachVolumeInput

DetachVolumeOutput

AttachVolumeOutput

DeviceiSCSIAttributes

Lists iSCSI information about a VTL device.

DisableGatewayInput

DisableGatewayInput

DisableGatewayOutput

DisableGatewayOutput

DisassociateFileSystemInput
DisassociateFileSystemOutput
Disk

Represents a gateway's local disk.

EndpointNetworkConfiguration

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

FileShareInfo

Describes a file share. Only supported S3 File Gateway.

FileSystemAssociationInfo

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

FileSystemAssociationStatusDetail

Detailed information on file system association status.

FileSystemAssociationSummary

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

GatewayInfo

Describes a gateway object.

JoinDomainInput

JoinDomainInput

JoinDomainOutput

JoinDomainOutput

ListAutomaticTapeCreationPoliciesInput
ListAutomaticTapeCreationPoliciesOutput
ListFileSharesInput

ListFileShareInput

ListFileSharesOutput

ListFileShareOutput

ListFileSystemAssociationsInput
ListFileSystemAssociationsOutput
ListGatewaysInput

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

ListGatewaysOutput
ListLocalDisksInput

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

ListLocalDisksOutput
ListTagsForResourceInput

ListTagsForResourceInput

ListTagsForResourceOutput

ListTagsForResourceOutput

ListTapePoolsInput
ListTapePoolsOutput
ListTapesInput

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

ListTapesOutput

A JSON object containing the following fields:

ListVolumeInitiatorsInput

ListVolumeInitiatorsInput

ListVolumeInitiatorsOutput

ListVolumeInitiatorsOutput

ListVolumeRecoveryPointsInput
ListVolumeRecoveryPointsOutput
ListVolumesInput

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

ListVolumesOutput

A JSON object containing the following fields:

NetworkInterface

Describes a gateway's network interface.

NFSFileShareDefaults

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.

NFSFileShareInfo

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.

NotifyWhenUploadedInput
NotifyWhenUploadedOutput
PoolInfo

Describes a custom tape pool.

RefreshCacheInput

RefreshCacheInput

RefreshCacheOutput

RefreshCacheOutput

RemoveTagsFromResourceInput

RemoveTagsFromResourceInput

RemoveTagsFromResourceOutput

RemoveTagsFromResourceOutput

ResetCacheInput
ResetCacheOutput
RetrieveTapeArchiveInput

RetrieveTapeArchiveInput

RetrieveTapeArchiveOutput

RetrieveTapeArchiveOutput

RetrieveTapeRecoveryPointInput

RetrieveTapeRecoveryPointInput

RetrieveTapeRecoveryPointOutput

RetrieveTapeRecoveryPointOutput

SetLocalConsolePasswordInput

SetLocalConsolePasswordInput

SetLocalConsolePasswordOutput
SetSMBGuestPasswordInput

SetSMBGuestPasswordInput

SetSMBGuestPasswordOutput
ShutdownGatewayInput

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

ShutdownGatewayOutput

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

SMBFileShareInfo

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.

SMBLocalGroups

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

StartAvailabilityMonitorTestInput
StartAvailabilityMonitorTestOutput
StartGatewayInput

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

StartGatewayOutput

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

StorediSCSIVolume

Describes an iSCSI stored volume.

Tag

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: + - = . _ : /.

Tape

Describes a virtual tape object.

TapeArchive

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

TapeInfo

Describes a virtual tape.

TapeRecoveryPointInfo

Describes a recovery point.

UpdateAutomaticTapeCreationPolicyInput
UpdateAutomaticTapeCreationPolicyOutput
UpdateBandwidthRateLimitInput

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

UpdateBandwidthRateLimitOutput

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

UpdateBandwidthRateLimitScheduleInput
UpdateBandwidthRateLimitScheduleOutput
UpdateChapCredentialsInput

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

UpdateChapCredentialsOutput

A JSON object containing the following fields:

UpdateFileSystemAssociationInput
UpdateFileSystemAssociationOutput
UpdateGatewayInformationInput
UpdateGatewayInformationOutput

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

UpdateGatewaySoftwareNowInput

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

UpdateGatewaySoftwareNowOutput

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

UpdateMaintenanceStartTimeInput

A JSON object containing the following fields:

UpdateMaintenanceStartTimeOutput

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

UpdateNFSFileShareInput

UpdateNFSFileShareInput

UpdateNFSFileShareOutput

UpdateNFSFileShareOutput

UpdateSMBFileShareInput

UpdateSMBFileShareInput

UpdateSMBFileShareOutput

UpdateSMBFileShareOutput

UpdateSMBFileShareVisibilityInput
UpdateSMBFileShareVisibilityOutput
UpdateSMBLocalGroupsInput
UpdateSMBLocalGroupsOutput
UpdateSMBSecurityStrategyInput
UpdateSMBSecurityStrategyOutput
UpdateSnapshotScheduleInput

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

UpdateSnapshotScheduleOutput

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

UpdateVTLDeviceTypeInput
UpdateVTLDeviceTypeOutput

UpdateVTLDeviceTypeOutput

VolumeInfo

Describes a storage volume object.

VolumeiSCSIAttributes

Lists iSCSI information about a volume.

VolumeRecoveryPointInfo

Describes a storage volume recovery point object.

VTLDevice

Represents a device object associated with a tape gateway.

§Type Aliases

ActiveDirectoryStatus
AvailabilityMonitorTestStatus
CaseSensitivity
FileShareType

The type of the file share.

GatewayCapacity
HostEnvironment
ObjectACL

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.

PoolStatus
RetentionLockType
SMBSecurityStrategy
TapeStorageClass