naftiko: 1.0.0-alpha2 info: label: AWS Storage Gateway description: 'AWS Storage Gateway. 90 operations. Lead operation: AWS Storage Gateway. Self-contained Naftiko capability covering one Amazon Storage Gateway business surface.' tags: - Amazon Storage Gateway - AWS Storage Gateway created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: AMAZON_STORAGE_GATEWAY_API_KEY: AMAZON_STORAGE_GATEWAY_API_KEY capability: consumes: - type: http namespace: amazon-storage-gateway baseUri: http://storagegateway.{region}.amazonaws.com description: AWS Storage Gateway business capability. Self-contained, no shared references. resources: - name: '#X-Amz-Target=StorageGateway_20130630.ActivateGateway' path: /#X-Amz-Target=StorageGateway_20130630.ActivateGateway operations: - name: activategateway method: POST description:
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 snapsh outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.AddCache' path: /#X-Amz-Target=StorageGateway_20130630.AddCache operations: - name: addcache method: POST description:
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 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 vo outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeAvailabilityMonitorTest' path: /#X-Amz-Target=StorageGateway_20130630.DescribeAvailabilityMonitorTest operations: - name: describeavailabilitymonitortest method: POST description: 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. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeBandwidthRateLimit' path: /#X-Amz-Target=StorageGateway_20130630.DescribeBandwidthRateLimit operations: - name: describebandwidthratelimit method: POST description: '
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 ' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeBandwidthRateLimitSchedule' path: /#X-Amz-Target=StorageGateway_20130630.DescribeBandwidthRateLimitSchedule operations: - name: describebandwidthratelimitschedule method: POST description:
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, outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeCache' path: /#X-Amz-Target=StorageGateway_20130630.DescribeCache operations: - name: describecache method: POST description:
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 cach outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeCachediSCSIVolumes' path: /#X-Amz-Target=StorageGateway_20130630.DescribeCachediSCSIVolumes operations: - name: describecachediscsivolumes method: POST description:
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, Stor outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeChapCredentials' path: /#X-Amz-Target=StorageGateway_20130630.DescribeChapCredentials operations: - name: describechapcredentials method: POST description: 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. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeFileSystemAssociations' path: /#X-Amz-Target=StorageGateway_20130630.DescribeFileSystemAssociations operations: - name: describefilesystemassociations method: POST description: Gets the file system association information. This operation is only supported for FSx File Gateways. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeGatewayInformation' path: /#X-Amz-Target=StorageGateway_20130630.DescribeGatewayInformation operations: - name: describegatewayinformation method: POST description: Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in y outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeMaintenanceStartTime' path: /#X-Amz-Target=StorageGateway_20130630.DescribeMaintenanceStartTime operations: - name: describemaintenancestarttime method: POST description: 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. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeNFSFileShares' path: /#X-Amz-Target=StorageGateway_20130630.DescribeNFSFileShares operations: - name: describenfsfileshares method: POST description: 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. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeSMBFileShares' path: /#X-Amz-Target=StorageGateway_20130630.DescribeSMBFileShares operations: - name: describesmbfileshares method: POST description: 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. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeSMBSettings' path: /#X-Amz-Target=StorageGateway_20130630.DescribeSMBSettings operations: - name: describesmbsettings method: POST description: Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeSnapshotSchedule' path: /#X-Amz-Target=StorageGateway_20130630.DescribeSnapshotSchedule operations: - name: describesnapshotschedule method: POST description: 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 s outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeStorediSCSIVolumes' path: /#X-Amz-Target=StorageGateway_20130630.DescribeStorediSCSIVolumes operations: - name: describestorediscsivolumes method: POST description: '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 ' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeTapeArchives' path: /#X-Amz-Target=StorageGateway_20130630.DescribeTapeArchives operations: - name: describetapearchives method: POST description:
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 descriptio
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Limit
in: query
type: string
description: Pagination limit
- name: Marker
in: query
type: string
description: Pagination token
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.DescribeTapeRecoveryPoints'
path: /#X-Amz-Target=StorageGateway_20130630.DescribeTapeRecoveryPoints
operations:
- name: describetaperecoverypoints
method: POST
description: '
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 '
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Limit
in: query
type: string
description: Pagination limit
- name: Marker
in: query
type: string
description: Pagination token
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.DescribeTapes'
path: /#X-Amz-Target=StorageGateway_20130630.DescribeTapes
operations:
- name: describetapes
method: POST
description: Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN
is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation
is only support
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Limit
in: query
type: string
description: Pagination limit
- name: Marker
in: query
type: string
description: Pagination token
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.DescribeUploadBuffer'
path: /#X-Amz-Target=StorageGateway_20130630.DescribeUploadBuffer
operations:
- name: describeuploadbuffer
method: POST
description: '
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 ' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeVTLDevices' path: /#X-Amz-Target=StorageGateway_20130630.DescribeVTLDevices operations: - name: describevtldevices method: POST description:
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.
outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: Limit in: query type: string description: Pagination limit - name: Marker in: query type: string description: Pagination token - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DescribeWorkingStorage' path: /#X-Amz-Target=StorageGateway_20130630.DescribeWorkingStorage operations: - name: describeworkingstorage method: POST description: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.
outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DetachVolume' path: /#X-Amz-Target=StorageGateway_20130630.DetachVolume operations: - name: detachvolume method: POST description: 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 outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DisableGateway' path: /#X-Amz-Target=StorageGateway_20130630.DisableGateway operations: - name: disablegateway method: POST description: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 reachab outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.DisassociateFileSystem' path: /#X-Amz-Target=StorageGateway_20130630.DisassociateFileSystem operations: - name: disassociatefilesystem method: POST description: 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. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.JoinDomain' path: /#X-Amz-Target=StorageGateway_20130630.JoinDomain operations: - name: joindomain method: POST description: Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListAutomaticTapeCreationPolicies' path: /#X-Amz-Target=StorageGateway_20130630.ListAutomaticTapeCreationPolicies operations: - name: listautomatictapecreationpolicies method: POST description:
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.
outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListFileShares' path: /#X-Amz-Target=StorageGateway_20130630.ListFileShares operations: - name: listfileshares method: POST description: Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling user account. This operation is only supported for S3 File Gateways. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: Limit in: query type: string description: Pagination limit - name: Marker in: query type: string description: Pagination token - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListFileSystemAssociations' path: /#X-Amz-Target=StorageGateway_20130630.ListFileSystemAssociations operations: - name: listfilesystemassociations method: POST description: Gets a list ofFileSystemAssociationSummary objects. Each object contains a summary of a
file system association. This operation is only supported for FSx File Gateways.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Limit
in: query
type: string
description: Pagination limit
- name: Marker
in: query
type: string
description: Pagination token
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.ListGateways'
path: /#X-Amz-Target=StorageGateway_20130630.ListGateways
operations:
- name: listgateways
method: POST
description: 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 1 outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: Limit in: query type: string description: Pagination limit - name: Marker in: query type: string description: Pagination token - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListLocalDisks' path: /#X-Amz-Target=StorageGateway_20130630.ListLocalDisks operations: - name: listlocaldisks method: POST description:
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 con outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListTagsForResource' path: /#X-Amz-Target=StorageGateway_20130630.ListTagsForResource operations: - name: listtagsforresource method: POST description: Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: Limit in: query type: string description: Pagination limit - name: Marker in: query type: string description: Pagination token - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListTapePools' path: /#X-Amz-Target=StorageGateway_20130630.ListTapePools operations: - name: listtapepools method: POST description:
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 o outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: Limit in: query type: string description: Pagination limit - name: Marker in: query type: string description: Pagination token - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListTapes' path: /#X-Amz-Target=StorageGateway_20130630.ListTapes operations: - name: listtapes method: POST description:
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 outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: Limit in: query type: string description: Pagination limit - name: Marker in: query type: string description: Pagination token - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListVolumeInitiators' path: /#X-Amz-Target=StorageGateway_20130630.ListVolumeInitiators operations: - name: listvolumeinitiators method: POST description: 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. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListVolumeRecoveryPoints' path: /#X-Amz-Target=StorageGateway_20130630.ListVolumeRecoveryPoints operations: - name: listvolumerecoverypoints method: POST description:
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 v outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=StorageGateway_20130630.ListVolumes' path: /#X-Amz-Target=StorageGateway_20130630.ListVolumes operations: - name: listvolumes method: POST description:
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
DescribeCachediSCSI
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Limit
in: query
type: string
description: Pagination limit
- name: Marker
in: query
type: string
description: Pagination token
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.NotifyWhenUploaded'
path: /#X-Amz-Target=StorageGateway_20130630.NotifyWhenUploaded
operations:
- name: notifywhenuploaded
method: POST
description: Sends you notification through CloudWatch Events when all files written to your file share have been
uploaded to S3. Amazon S3. Storage Gateway can send a notification through Amazon CloudWatch Events when
all files written to you
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.RefreshCache'
path: /#X-Amz-Target=StorageGateway_20130630.RefreshCache
operations:
- name: refreshcache
method: POST
description: 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
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.RemoveTagsFromResource'
path: /#X-Amz-Target=StorageGateway_20130630.RemoveTagsFromResource
operations:
- name: removetagsfromresource
method: POST
description: Removes one or more tags from the specified resource. This operation is supported in storage gateways
of all types.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.ResetCache'
path: /#X-Amz-Target=StorageGateway_20130630.ResetCache
operations:
- name: resetcache
method: POST
description: Resets all cache disks that have encountered an error and makes the disks available for reconfiguration
as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual
tapes in the gate
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.RetrieveTapeArchive'
path: /#X-Amz-Target=StorageGateway_20130630.RetrieveTapeArchive
operations:
- name: retrievetapearchive
method: POST
description: Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes
archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with
a gateway, even thoug
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.RetrieveTapeRecoveryPoint'
path: /#X-Amz-Target=StorageGateway_20130630.RetrieveTapeRecoveryPoint
operations:
- name: retrievetaperecoverypoint
method: POST
description: Retrieves the recovery point for the specified virtual tape. This operation is only supported in the
tape gateway type. A recovery point is a point in time view of a virtual tape at which all the data on the
tape is consistent. If
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.SetLocalConsolePassword'
path: /#X-Amz-Target=StorageGateway_20130630.SetLocalConsolePassword
operations:
- name: setlocalconsolepassword
method: POST
description: Sets the password for your VM local console. When you log in to the local console for the first time,
you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know
the default password t
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.SetSMBGuestPassword'
path: /#X-Amz-Target=StorageGateway_20130630.SetSMBGuestPassword
operations:
- name: setsmbguestpassword
method: POST
description: Sets the password for the guest user Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of
the gateway in the body of your request. The operation shuts down the gateway service component running in
the gateway's virtual ma
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest'
path: /#X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest
operations:
- name: startavailabilitymonitortest
method: POST
description: ' Start a test that verifies that the specified gateway is configured for High Availability monitoring
in your host environment. This request only initiates the test and that a successful response only indicates that
the test was started. '
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.StartGateway'
path: /#X-Amz-Target=StorageGateway_20130630.StartGateway
operations:
- name: startgateway
method: POST
description: Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts,
you can then make other API calls, your applications can read from or write to the gateway's storage volumes and
you will be able to t
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateAutomaticTapeCreationPolicy'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateAutomaticTapeCreationPolicy
operations:
- name: updateautomatictapecreationpolicy
method: POST
description: Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new
set of automatic tape creation rules. This is only supported for tape gateways. By default, there is no automatic
tape creation poli
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateBandwidthRateLimit'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateBandwidthRateLimit
operations:
- name: updatebandwidthratelimit
method: POST
description: ' Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth
rate limit or specify only one of the two. If you don''t set a bandwidth rate limit, the existing rate limit remains.
This operation is '
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateBandwidthRateLimitSchedule'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateBandwidthRateLimitSchedule
operations:
- name: updatebandwidthratelimitschedule
method: POST
description: Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth
rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's
bandwidth ra
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateChapCredentials'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateChapCredentials
operations:
- name: updatechapcredentials
method: POST
description: ' Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI
target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation
is supported in the '
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateFileSystemAssociation'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateFileSystemAssociation
operations:
- name: updatefilesystemassociation
method: POST
description: Updates a file system association. This operation is only supported in the FSx File Gateways.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateGatewayInformation'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateGatewayInformation
operations:
- name: updategatewayinformation
method: POST
description: Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway
to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated
after September 2,
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateGatewaySoftwareNow'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateGatewaySoftwareNow
operations:
- name: updategatewaysoftwarenow
method: POST
description: Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways. To leave a file share field unchanged, set the corresponding input field to null. Updates
the following fi
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShare'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShare
operations:
- name: updatesmbfileshare
method: POST
description: Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways. To leave a file share field unchanged, set the corresponding input field to null. File gatew
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShareVisibility'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShareVisibility
operations:
- name: updatesmbfilesharevisibility
method: POST
description: Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation
is only supported for S3 File Gateways.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateSMBLocalGroups'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateSMBLocalGroups
operations:
- name: updatesmblocalgroups
method: POST
description: Updates the list of Active Directory users and groups that have special permissions for SMB file shares
on the gateway.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateSMBSecurityStrategy'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateSMBSecurityStrategy
operations:
- name: updatesmbsecuritystrategy
method: POST
description: Updates the SMB security strategy on a file gateway. This action is only supported in file gateways. This API is called Security level in the User Guide. A higher security level can affect performance
of the gateway.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateSnapshotSchedule'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateSnapshotSchedule
operations:
- name: updatesnapshotschedule
method: POST
description: Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the
cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24
hours, starting at the c
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateVTLDeviceType'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateVTLDeviceType
operations:
- name: updatevtldevicetype
method: POST
description: Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a
medium changer type for the tape gateway. This operation enables you to select a different type of medium changer
after a tape gateway is a
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
authentication:
type: apikey
key: Authorization
value: '{{env.AMAZON_STORAGE_GATEWAY_API_KEY}}'
placement: header
exposes:
- type: rest
namespace: amazon-storage-gateway-rest
port: 8080
description: REST adapter for AWS Storage Gateway. One Spectral-compliant resource per consumed operation, prefixed with
/v1.
resources:
- path: /v1/x-amz-target-storagegateway-20130630-activategateway
name: x-amz-target-storagegateway-20130630-activategateway
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ActivateGateway.'
operations:
- method: POST
name: activategateway
description: 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 snapsh
call: amazon-storage-gateway.activategateway
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-addcache
name: x-amz-target-storagegateway-20130630-addcache
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.AddCache.'
operations:
- method: POST
name: addcache
description: 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 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 vo
call: amazon-storage-gateway.deletevolume
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describeavailabilitymonitortest
name: x-amz-target-storagegateway-20130630-describeavailabilitymonitortest
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeAvailabilityMonitorTest.'
operations:
- method: POST
name: describeavailabilitymonitortest
description: 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.
call: amazon-storage-gateway.describeavailabilitymonitortest
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describebandwidthratelimit
name: x-amz-target-storagegateway-20130630-describebandwidthratelimit
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeBandwidthRateLimit.'
operations:
- method: POST
name: describebandwidthratelimit
description: ' 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 '
call: amazon-storage-gateway.describebandwidthratelimit
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describebandwidthratelimitschedule
name: x-amz-target-storagegateway-20130630-describebandwidthratelimitschedule
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeBandwidthRateLimitSchedule.'
operations:
- method: POST
name: describebandwidthratelimitschedule
description: 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,
call: amazon-storage-gateway.describebandwidthratelimitschedule
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describecache
name: x-amz-target-storagegateway-20130630-describecache
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeCache.'
operations:
- method: POST
name: describecache
description: 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 cach
call: amazon-storage-gateway.describecache
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describecachediscsivolumes
name: x-amz-target-storagegateway-20130630-describecachediscsivolumes
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeCachediSCSIVolumes.'
operations:
- method: POST
name: describecachediscsivolumes
description: 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, Stor
call: amazon-storage-gateway.describecachediscsivolumes
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describechapcredentials
name: x-amz-target-storagegateway-20130630-describechapcredentials
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeChapCredentials.'
operations:
- method: POST
name: describechapcredentials
description: 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.
call: amazon-storage-gateway.describechapcredentials
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describefilesystemassociations
name: x-amz-target-storagegateway-20130630-describefilesystemassociations
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeFileSystemAssociations.'
operations:
- method: POST
name: describefilesystemassociations
description: Gets the file system association information. This operation is only supported for FSx File Gateways.
call: amazon-storage-gateway.describefilesystemassociations
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describegatewayinformation
name: x-amz-target-storagegateway-20130630-describegatewayinformation
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeGatewayInformation.'
operations:
- method: POST
name: describegatewayinformation
description: Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the
state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name
(ARN) of the gateway in y
call: amazon-storage-gateway.describegatewayinformation
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describemaintenancestarttime
name: x-amz-target-storagegateway-20130630-describemaintenancestarttime
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeMaintenanceStartTime.'
operations:
- method: POST
name: describemaintenancestarttime
description: 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.
call: amazon-storage-gateway.describemaintenancestarttime
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describenfsfileshares
name: x-amz-target-storagegateway-20130630-describenfsfileshares
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeNFSFileShares.'
operations:
- method: POST
name: describenfsfileshares
description: 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.
call: amazon-storage-gateway.describenfsfileshares
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describesmbfileshares
name: x-amz-target-storagegateway-20130630-describesmbfileshares
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeSMBFileShares.'
operations:
- method: POST
name: describesmbfileshares
description: 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.
call: amazon-storage-gateway.describesmbfileshares
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describesmbsettings
name: x-amz-target-storagegateway-20130630-describesmbsettings
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeSMBSettings.'
operations:
- method: POST
name: describesmbsettings
description: Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation
is only supported for file gateways.
call: amazon-storage-gateway.describesmbsettings
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describesnapshotschedule
name: x-amz-target-storagegateway-20130630-describesnapshotschedule
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeSnapshotSchedule.'
operations:
- method: POST
name: describesnapshotschedule
description: 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 s
call: amazon-storage-gateway.describesnapshotschedule
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describestorediscsivolumes
name: x-amz-target-storagegateway-20130630-describestorediscsivolumes
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeStorediSCSIVolumes.'
operations:
- method: POST
name: describestorediscsivolumes
description: '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 '
call: amazon-storage-gateway.describestorediscsivolumes
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describetapearchives
name: x-amz-target-storagegateway-20130630-describetapearchives
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeTapeArchives.'
operations:
- method: POST
name: describetapearchives
description: 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 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 '
call: amazon-storage-gateway.describetaperecoverypoints
with:
Limit: rest.Limit
Marker: rest.Marker
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describetapes
name: x-amz-target-storagegateway-20130630-describetapes
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeTapes.'
operations:
- method: POST
name: describetapes
description: Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a 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 '
call: amazon-storage-gateway.describeuploadbuffer
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describevtldevices
name: x-amz-target-storagegateway-20130630-describevtldevices
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeVTLDevices.'
operations:
- method: POST
name: describevtldevices
description: 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. 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. 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 reachab
call: amazon-storage-gateway.disablegateway
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-disassociatefilesystem
name: x-amz-target-storagegateway-20130630-disassociatefilesystem
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DisassociateFileSystem.'
operations:
- method: POST
name: disassociatefilesystem
description: 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.
call: amazon-storage-gateway.disassociatefilesystem
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-joindomain
name: x-amz-target-storagegateway-20130630-joindomain
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.JoinDomain.'
operations:
- method: POST
name: joindomain
description: Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways
that support the SMB file protocol.
call: amazon-storage-gateway.joindomain
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-listautomatictapecreationpolicies
name: x-amz-target-storagegateway-20130630-listautomatictapecreationpolicies
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ListAutomaticTapeCreationPolicies.'
operations:
- method: POST
name: listautomatictapecreationpolicies
description: 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. 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 1
call: amazon-storage-gateway.listgateways
with:
Limit: rest.Limit
Marker: rest.Marker
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-listlocaldisks
name: x-amz-target-storagegateway-20130630-listlocaldisks
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ListLocalDisks.'
operations:
- method: POST
name: listlocaldisks
description: 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 con
call: amazon-storage-gateway.listlocaldisks
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-listtagsforresource
name: x-amz-target-storagegateway-20130630-listtagsforresource
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ListTagsForResource.'
operations:
- method: POST
name: listtagsforresource
description: Lists the tags that have been added to the specified resource. This operation is supported in storage
gateways of all types.
call: amazon-storage-gateway.listtagsforresource
with:
Limit: rest.Limit
Marker: rest.Marker
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-listtapepools
name: x-amz-target-storagegateway-20130630-listtapepools
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ListTapePools.'
operations:
- method: POST
name: listtapepools
description: 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 o
call: amazon-storage-gateway.listtapepools
with:
Limit: rest.Limit
Marker: rest.Marker
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-listtapes
name: x-amz-target-storagegateway-20130630-listtapes
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ListTapes.'
operations:
- method: POST
name: listtapes
description: 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
call: amazon-storage-gateway.listtapes
with:
Limit: rest.Limit
Marker: rest.Marker
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-listvolumeinitiators
name: x-amz-target-storagegateway-20130630-listvolumeinitiators
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ListVolumeInitiators.'
operations:
- method: POST
name: listvolumeinitiators
description: 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.
call: amazon-storage-gateway.listvolumeinitiators
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-listvolumerecoverypoints
name: x-amz-target-storagegateway-20130630-listvolumerecoverypoints
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ListVolumeRecoveryPoints.'
operations:
- method: POST
name: listvolumerecoverypoints
description: 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 v
call: amazon-storage-gateway.listvolumerecoverypoints
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-listvolumes
name: x-amz-target-storagegateway-20130630-listvolumes
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ListVolumes.'
operations:
- method: POST
name: listvolumes
description: 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
DescribeCachediSCSI
call: amazon-storage-gateway.listvolumes
with:
Limit: rest.Limit
Marker: rest.Marker
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-notifywhenuploaded
name: x-amz-target-storagegateway-20130630-notifywhenuploaded
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.NotifyWhenUploaded.'
operations:
- method: POST
name: notifywhenuploaded
description: Sends you notification through CloudWatch Events when all files written to your file share have been
uploaded to S3. Amazon S3. Storage Gateway can send a notification through Amazon CloudWatch Events when
all files written to you
call: amazon-storage-gateway.notifywhenuploaded
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-refreshcache
name: x-amz-target-storagegateway-20130630-refreshcache
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.RefreshCache.'
operations:
- method: POST
name: refreshcache
description: 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
call: amazon-storage-gateway.refreshcache
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-removetagsfromresource
name: x-amz-target-storagegateway-20130630-removetagsfromresource
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.RemoveTagsFromResource.'
operations:
- method: POST
name: removetagsfromresource
description: Removes one or more tags from the specified resource. This operation is supported in storage gateways
of all types.
call: amazon-storage-gateway.removetagsfromresource
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-resetcache
name: x-amz-target-storagegateway-20130630-resetcache
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ResetCache.'
operations:
- method: POST
name: resetcache
description: Resets all cache disks that have encountered an error and makes the disks available for reconfiguration
as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual
tapes in the gate
call: amazon-storage-gateway.resetcache
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-retrievetapearchive
name: x-amz-target-storagegateway-20130630-retrievetapearchive
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.RetrieveTapeArchive.'
operations:
- method: POST
name: retrievetapearchive
description: Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes
archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with
a gateway, even thoug
call: amazon-storage-gateway.retrievetapearchive
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-retrievetaperecoverypoint
name: x-amz-target-storagegateway-20130630-retrievetaperecoverypoint
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.RetrieveTapeRecoveryPoint.'
operations:
- method: POST
name: retrievetaperecoverypoint
description: Retrieves the recovery point for the specified virtual tape. This operation is only supported in the
tape gateway type. A recovery point is a point in time view of a virtual tape at which all the data on the
tape is consistent. If
call: amazon-storage-gateway.retrievetaperecoverypoint
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-setlocalconsolepassword
name: x-amz-target-storagegateway-20130630-setlocalconsolepassword
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.SetLocalConsolePassword.'
operations:
- method: POST
name: setlocalconsolepassword
description: Sets the password for your VM local console. When you log in to the local console for the first time,
you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know
the default password t
call: amazon-storage-gateway.setlocalconsolepassword
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-setsmbguestpassword
name: x-amz-target-storagegateway-20130630-setsmbguestpassword
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.SetSMBGuestPassword.'
operations:
- method: POST
name: setsmbguestpassword
description: Sets the password for the guest user Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of
the gateway in the body of your request. The operation shuts down the gateway service component running in
the gateway's virtual ma
call: amazon-storage-gateway.shutdowngateway
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-startavailabilitymonitortest
name: x-amz-target-storagegateway-20130630-startavailabilitymonitortest
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest.'
operations:
- method: POST
name: startavailabilitymonitortest
description: ' Start a test that verifies that the specified gateway is configured for High Availability monitoring
in your host environment. This request only initiates the test and that a successful response only indicates that
the test was started. '
call: amazon-storage-gateway.startavailabilitymonitortest
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-startgateway
name: x-amz-target-storagegateway-20130630-startgateway
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.StartGateway.'
operations:
- method: POST
name: startgateway
description: Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts,
you can then make other API calls, your applications can read from or write to the gateway's storage volumes and
you will be able to t
call: amazon-storage-gateway.startgateway
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updateautomatictapecreationpolicy
name: x-amz-target-storagegateway-20130630-updateautomatictapecreationpolicy
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateAutomaticTapeCreationPolicy.'
operations:
- method: POST
name: updateautomatictapecreationpolicy
description: Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new
set of automatic tape creation rules. This is only supported for tape gateways. By default, there is no automatic
tape creation poli
call: amazon-storage-gateway.updateautomatictapecreationpolicy
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatebandwidthratelimit
name: x-amz-target-storagegateway-20130630-updatebandwidthratelimit
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateBandwidthRateLimit.'
operations:
- method: POST
name: updatebandwidthratelimit
description: ' Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth
rate limit or specify only one of the two. If you don''t set a bandwidth rate limit, the existing rate limit remains.
This operation is '
call: amazon-storage-gateway.updatebandwidthratelimit
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatebandwidthratelimitschedule
name: x-amz-target-storagegateway-20130630-updatebandwidthratelimitschedule
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateBandwidthRateLimitSchedule.'
operations:
- method: POST
name: updatebandwidthratelimitschedule
description: Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth
rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's
bandwidth ra
call: amazon-storage-gateway.updatebandwidthratelimitschedule
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatechapcredentials
name: x-amz-target-storagegateway-20130630-updatechapcredentials
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateChapCredentials.'
operations:
- method: POST
name: updatechapcredentials
description: ' Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI
target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation
is supported in the '
call: amazon-storage-gateway.updatechapcredentials
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatefilesystemassociation
name: x-amz-target-storagegateway-20130630-updatefilesystemassociation
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateFileSystemAssociation.'
operations:
- method: POST
name: updatefilesystemassociation
description: Updates a file system association. This operation is only supported in the FSx File Gateways.
call: amazon-storage-gateway.updatefilesystemassociation
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updategatewayinformation
name: x-amz-target-storagegateway-20130630-updategatewayinformation
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateGatewayInformation.'
operations:
- method: POST
name: updategatewayinformation
description: Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway
to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated
after September 2,
call: amazon-storage-gateway.updategatewayinformation
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updategatewaysoftwarenow
name: x-amz-target-storagegateway-20130630-updategatewaysoftwarenow
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateGatewaySoftwareNow.'
operations:
- method: POST
name: updategatewaysoftwarenow
description: Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways. To leave a file share field unchanged, set the corresponding input field to null. Updates
the following fi
call: amazon-storage-gateway.updatenfsfileshare
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatesmbfileshare
name: x-amz-target-storagegateway-20130630-updatesmbfileshare
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShare.'
operations:
- method: POST
name: updatesmbfileshare
description: Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways. To leave a file share field unchanged, set the corresponding input field to null. File gatew
call: amazon-storage-gateway.updatesmbfileshare
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatesmbfilesharevisibility
name: x-amz-target-storagegateway-20130630-updatesmbfilesharevisibility
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShareVisibility.'
operations:
- method: POST
name: updatesmbfilesharevisibility
description: Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation
is only supported for S3 File Gateways.
call: amazon-storage-gateway.updatesmbfilesharevisibility
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatesmblocalgroups
name: x-amz-target-storagegateway-20130630-updatesmblocalgroups
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateSMBLocalGroups.'
operations:
- method: POST
name: updatesmblocalgroups
description: Updates the list of Active Directory users and groups that have special permissions for SMB file shares
on the gateway.
call: amazon-storage-gateway.updatesmblocalgroups
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatesmbsecuritystrategy
name: x-amz-target-storagegateway-20130630-updatesmbsecuritystrategy
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateSMBSecurityStrategy.'
operations:
- method: POST
name: updatesmbsecuritystrategy
description: Updates the SMB security strategy on a file gateway. This action is only supported in file gateways. This API is called Security level in the User Guide. A higher security level can affect performance
of the gateway.
call: amazon-storage-gateway.updatesmbsecuritystrategy
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatesnapshotschedule
name: x-amz-target-storagegateway-20130630-updatesnapshotschedule
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateSnapshotSchedule.'
operations:
- method: POST
name: updatesnapshotschedule
description: Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the
cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24
hours, starting at the c
call: amazon-storage-gateway.updatesnapshotschedule
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatevtldevicetype
name: x-amz-target-storagegateway-20130630-updatevtldevicetype
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateVTLDeviceType.'
operations:
- method: POST
name: updatevtldevicetype
description: Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a
medium changer type for the tape gateway. This operation enables you to select a different type of medium changer
after a tape gateway is a
call: amazon-storage-gateway.updatevtldevicetype
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: amazon-storage-gateway-mcp
port: 9090
transport: http
description: MCP adapter for AWS Storage Gateway. One tool per consumed operation, routed inline through this capability's
consumes block.
tools:
- name: p-activates-gateway-you-previously-deployed
description: 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
snapsh
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.activategateway
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-configures-one-more-gateway-local
description: 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 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 vo
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.deletevolume
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-information-about-most-recent
description: 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.
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.describeavailabilitymonitortest
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-bandwidth-rate-limits-gateway
description: ' 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 '
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describebandwidthratelimit
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-information-about-bandwidth
description: 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,
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describebandwidthratelimitschedule
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-information-about-cache-gateway
description: 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 cach
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describecache
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-description-gateway-volumes-specified
description: 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, Stor
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.describecachediscsivolumes
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-array-challenge-handshake-authentication
description: 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.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describechapcredentials
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: gets-file-system-association-information
description: Gets the file system association information. This operation is only supported for FSx File Gateways.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describefilesystemassociations
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-metadata-about-gateway-such
description: Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state
(whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN)
of the gateway in y
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describegatewayinformation
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-your-gateway-s-weekly-maintenance
description: 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.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describemaintenancestarttime
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: gets-description-one-more-network
description: 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.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describenfsfileshares
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: gets-description-one-more-server
description: 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.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describesmbfileshares
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: gets-description-server-message-block
description: Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation
is only supported for file gateways.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describesmbsettings
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: describes-snapshot-schedule-specified-gateway
description: 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 s
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describesnapshotschedule
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-description-gateway-volumes-specified
description: '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 '
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.describestorediscsivolumes
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-description-specified-virtual-tapes
description: 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 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 '
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.describetaperecoverypoints
with:
Limit: tools.Limit
Marker: tools.Marker
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-description-specified-amazon-resource
description: Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a 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 '
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describeuploadbuffer
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-description-virtual-tape-library
description: 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. 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. 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 reachab
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.disablegateway
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: disassociates-amazon-fsx-file-system
description: 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.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.disassociatefilesystem
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: adds-file-gateway-active-directory
description: Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that
support the SMB file protocol.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.joindomain
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-lists-automatic-tape-creation-policies
description: 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. 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 1
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.listgateways
with:
Limit: tools.Limit
Marker: tools.Marker
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-list-gateway-s-local-disks
description: 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 con
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.listlocaldisks
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: lists-tags-that-have-been
description: Lists the tags that have been added to the specified resource. This operation is supported in storage gateways
of all types.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.listtagsforresource
with:
Limit: tools.Limit
Marker: tools.Marker
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-lists-custom-tape-pools-you
description: 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 o
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.listtapepools
with:
Limit: tools.Limit
Marker: tools.Marker
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-lists-virtual-tapes-your-virtual
description: 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
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.listtapes
with:
Limit: tools.Limit
Marker: tools.Marker
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: lists-iscsi-initiators-that-are
description: 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.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.listvolumeinitiators
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-lists-recovery-points-specified-gateway
description: 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 v
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.listvolumerecoverypoints
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-lists-iscsi-stored-volumes-gateway
description: 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
DescribeCachediSCSI
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.listvolumes
with:
Limit: tools.Limit
Marker: tools.Marker
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-sends-you-notification-through-cloudwatch
description: Sends you notification through CloudWatch Events when all files written to your file share have been
uploaded to S3. Amazon S3. Storage Gateway can send a notification through Amazon CloudWatch Events when all
files written to you
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.notifywhenuploaded
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-refreshes-cached-inventory-objects-specified
description: 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
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.refreshcache
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: removes-one-more-tags-specified
description: Removes one or more tags from the specified resource. This operation is supported in storage gateways of
all types.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.removetagsfromresource
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-resets-all-cache-disks-that
description: Resets all cache disks that have encountered an error and makes the disks available for reconfiguration
as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual
tapes in the gate
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.resetcache
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-retrieves-archived-virtual-tape-virtual
description: Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes
archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with
a gateway, even thoug
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.retrievetapearchive
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-retrieves-recovery-point-specified-virtual
description: Retrieves the recovery point for the specified virtual tape. This operation is only supported in the
tape gateway type. A recovery point is a point in time view of a virtual tape at which all the data on the
tape is consistent. If
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.retrievetaperecoverypoint
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: sets-password-your-vm-local
description: Sets the password for your VM local console. When you log in to the local console for the first time, you
log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the
default password t
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.setlocalconsolepassword
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: sets-password-guest-user-code-smbguest
description: Sets the password for the guest user Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the
gateway in the body of your request. The operation shuts down the gateway service component running in the
gateway's virtual ma
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.shutdowngateway
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-start-test-that-verifies-that
description: ' Start a test that verifies that the specified gateway is configured for High Availability monitoring
in your host environment. This request only initiates the test and that a successful response only indicates that
the test was started. '
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.startavailabilitymonitortest
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-starts-gateway-that-you-previously
description: Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts,
you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you
will be able to t
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.startgateway
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-automatic-tape-creation-policy
description: Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set
of automatic tape creation rules. This is only supported for tape gateways. By default, there is no automatic
tape creation poli
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updateautomatictapecreationpolicy
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-bandwidth-rate-limits-gateway
description: ' Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth
rate limit or specify only one of the two. If you don''t set a bandwidth rate limit, the existing rate limit remains.
This operation is '
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatebandwidthratelimit
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: updates-bandwidth-rate-limit-schedule
description: Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth
rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's
bandwidth ra
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatebandwidthratelimitschedule
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-challenge-handshake-authentication-protocol
description: ' Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is
supported in the '
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatechapcredentials
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: updates-file-system-association-this
description: Updates a file system association. This operation is only supported in the FSx File Gateways.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatefilesystemassociation
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-gateway-s-metadata-which-includes
description: Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway
to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated
after September 2,
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updategatewayinformation
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-gateway-virtual-machine-vm
description: Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways. To leave a file share field unchanged, set the corresponding input field to null. Updates
the following fi
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatenfsfileshare
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-server-message-block-smb
description: Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways. To leave a file share field unchanged, set the corresponding input field to null. File gatew
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatesmbfileshare
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: controls-whether-shares-s3-file
description: Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation
is only supported for S3 File Gateways.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatesmbfilesharevisibility
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: updates-list-active-directory-users
description: Updates the list of Active Directory users and groups that have special permissions for SMB file shares
on the gateway.
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.updatesmblocalgroups
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-smb-security-strategy-file
description: Updates the SMB security strategy on a file gateway. This action is only supported in file gateways. This API is called Security level in the User Guide. A higher security level can affect performance
of the gateway.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatesmbsecuritystrategy
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-snapshot-schedule-configured-gateway
description: Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the
cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24 hours,
starting at the c
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatesnapshotschedule
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: updates-type-medium-changer-tape
description: Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium
changer type for the tape gateway. This operation enables you to select a different type of medium changer after a
tape gateway is a
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatevtldevicetype
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
smbguest. The smbguest user is the user
when the authentication method for the file share is set to GuestAccess. This operation only supported
for S3 File Gateways
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.ShutdownGateway'
path: /#X-Amz-Target=StorageGateway_20130630.ShutdownGateway
operations:
- name: shutdowngateway
method: POST
description: 200 OK success response immediately. However, it might
take some ti
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateMaintenanceStartTime'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateMaintenanceStartTime
operations:
- name: updatemaintenancestarttime
method: POST
description: Updates a gateway's weekly maintenance start time information, including day and time of the week. The
maintenance time is the time in your gateway's time zone.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=StorageGateway_20130630.UpdateNFSFileShare'
path: /#X-Amz-Target=StorageGateway_20130630.UpdateNFSFileShare
operations:
- name: updatenfsfileshare
method: POST
description: TapeARN is not specified, Storage Gateway
returns a descriptio
call: amazon-storage-gateway.describetapearchives
with:
Limit: rest.Limit
Marker: rest.Marker
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describetaperecoverypoints
name: x-amz-target-storagegateway-20130630-describetaperecoverypoints
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeTapeRecoveryPoints.'
operations:
- method: POST
name: describetaperecoverypoints
description: 'TapeARN
is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation
is only support
call: amazon-storage-gateway.describetapes
with:
Limit: rest.Limit
Marker: rest.Marker
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-describeuploadbuffer
name: x-amz-target-storagegateway-20130630-describeuploadbuffer
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.DescribeUploadBuffer.'
operations:
- method: POST
name: describeuploadbuffer
description: 'FileSystemAssociationSummary objects. Each object contains a summary of a
file system association. This operation is only supported for FSx File Gateways.
call: amazon-storage-gateway.listfilesystemassociations
with:
Limit: rest.Limit
Marker: rest.Marker
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-listgateways
name: x-amz-target-storagegateway-20130630-listgateways
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ListGateways.'
operations:
- method: POST
name: listgateways
description: smbguest. The smbguest user is the user
when the authentication method for the file share is set to GuestAccess. This operation only supported
for S3 File Gateways
call: amazon-storage-gateway.setsmbguestpassword
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-shutdowngateway
name: x-amz-target-storagegateway-20130630-shutdowngateway
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.ShutdownGateway.'
operations:
- method: POST
name: shutdowngateway
description: 200 OK success response immediately. However, it might
take some ti
call: amazon-storage-gateway.updategatewaysoftwarenow
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatemaintenancestarttime
name: x-amz-target-storagegateway-20130630-updatemaintenancestarttime
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateMaintenanceStartTime.'
operations:
- method: POST
name: updatemaintenancestarttime
description: Updates a gateway's weekly maintenance start time information, including day and time of the week. The
maintenance time is the time in your gateway's time zone.
call: amazon-storage-gateway.updatemaintenancestarttime
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-storagegateway-20130630-updatenfsfileshare
name: x-amz-target-storagegateway-20130630-updatenfsfileshare
description: 'REST surface for #X-Amz-Target=StorageGateway_20130630.UpdateNFSFileShare.'
operations:
- method: POST
name: updatenfsfileshare
description: TapeARN is not specified, Storage Gateway
returns a descriptio
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describetapearchives
with:
Limit: tools.Limit
Marker: tools.Marker
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-list-virtual-tape-recovery
description: 'TapeARN
is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation
is only support
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.describetapes
with:
Limit: tools.Limit
Marker: tools.Marker
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-information-about-upload-buffer
description: 'FileSystemAssociationSummary objects. Each object contains a summary of a file
system association. This operation is only supported for FSx File Gateways.
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.listfilesystemassociations
with:
Limit: tools.Limit
Marker: tools.Marker
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-lists-gateways-owned-amazon-web
description: smbguest. The smbguest user is the user
when the authentication method for the file share is set to GuestAccess. This operation only supported
for S3 File Gateways
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.setsmbguestpassword
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-shuts-down-gateway-specify-which
description: 200 OK success response immediately. However, it might
take some ti
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-storage-gateway.updategatewaysoftwarenow
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: updates-gateway-s-weekly-maintenance-start
description: Updates a gateway's weekly maintenance start time information, including day and time of the week. The
maintenance time is the time in your gateway's time zone.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-storage-gateway.updatemaintenancestarttime
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-network-file-system-nfs
description: