# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [ActivateGateway](API_ActivateGateway.md) 
+  [AddCache](API_AddCache.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [AddUploadBuffer](API_AddUploadBuffer.md) 
+  [AddWorkingStorage](API_AddWorkingStorage.md) 
+  [AssignTapePool](API_AssignTapePool.md) 
+  [AssociateFileSystem](API_AssociateFileSystem.md) 
+  [AttachVolume](API_AttachVolume.md) 
+  [CancelArchival](API_CancelArchival.md) 
+  [CancelCacheReport](API_CancelCacheReport.md) 
+  [CancelRetrieval](API_CancelRetrieval.md) 
+  [CreateCachediSCSIVolume](API_CreateCachediSCSIVolume.md) 
+  [CreateNFSFileShare](API_CreateNFSFileShare.md) 
+  [CreateSMBFileShare](API_CreateSMBFileShare.md) 
+  [CreateSnapshot](API_CreateSnapshot.md) 
+  [CreateSnapshotFromVolumeRecoveryPoint](API_CreateSnapshotFromVolumeRecoveryPoint.md) 
+  [CreateStorediSCSIVolume](API_CreateStorediSCSIVolume.md) 
+  [CreateTapePool](API_CreateTapePool.md) 
+  [CreateTapes](API_CreateTapes.md) 
+  [CreateTapeWithBarcode](API_CreateTapeWithBarcode.md) 
+  [DeleteAutomaticTapeCreationPolicy](API_DeleteAutomaticTapeCreationPolicy.md) 
+  [DeleteBandwidthRateLimit](API_DeleteBandwidthRateLimit.md) 
+  [DeleteCacheReport](API_DeleteCacheReport.md) 
+  [DeleteChapCredentials](API_DeleteChapCredentials.md) 
+  [DeleteFileShare](API_DeleteFileShare.md) 
+  [DeleteGateway](API_DeleteGateway.md) 
+  [DeleteSnapshotSchedule](API_DeleteSnapshotSchedule.md) 
+  [DeleteTape](API_DeleteTape.md) 
+  [DeleteTapeArchive](API_DeleteTapeArchive.md) 
+  [DeleteTapePool](API_DeleteTapePool.md) 
+  [DeleteVolume](API_DeleteVolume.md) 
+  [DescribeAvailabilityMonitorTest](API_DescribeAvailabilityMonitorTest.md) 
+  [DescribeBandwidthRateLimit](API_DescribeBandwidthRateLimit.md) 
+  [DescribeBandwidthRateLimitSchedule](API_DescribeBandwidthRateLimitSchedule.md) 
+  [DescribeCache](API_DescribeCache.md) 
+  [DescribeCachediSCSIVolumes](API_DescribeCachediSCSIVolumes.md) 
+  [DescribeCacheReport](API_DescribeCacheReport.md) 
+  [DescribeChapCredentials](API_DescribeChapCredentials.md) 
+  [DescribeFileSystemAssociations](API_DescribeFileSystemAssociations.md) 
+  [DescribeGatewayInformation](API_DescribeGatewayInformation.md) 
+  [DescribeMaintenanceStartTime](API_DescribeMaintenanceStartTime.md) 
+  [DescribeNFSFileShares](API_DescribeNFSFileShares.md) 
+  [DescribeSMBFileShares](API_DescribeSMBFileShares.md) 
+  [DescribeSMBSettings](API_DescribeSMBSettings.md) 
+  [DescribeSnapshotSchedule](API_DescribeSnapshotSchedule.md) 
+  [DescribeStorediSCSIVolumes](API_DescribeStorediSCSIVolumes.md) 
+  [DescribeTapeArchives](API_DescribeTapeArchives.md) 
+  [DescribeTapeRecoveryPoints](API_DescribeTapeRecoveryPoints.md) 
+  [DescribeTapes](API_DescribeTapes.md) 
+  [DescribeUploadBuffer](API_DescribeUploadBuffer.md) 
+  [DescribeVTLDevices](API_DescribeVTLDevices.md) 
+  [DescribeWorkingStorage](API_DescribeWorkingStorage.md) 
+  [DetachVolume](API_DetachVolume.md) 
+  [DisableGateway](API_DisableGateway.md) 
+  [DisassociateFileSystem](API_DisassociateFileSystem.md) 
+  [EvictFilesFailingUpload](API_EvictFilesFailingUpload.md) 
+  [JoinDomain](API_JoinDomain.md) 
+  [ListAutomaticTapeCreationPolicies](API_ListAutomaticTapeCreationPolicies.md) 
+  [ListCacheReports](API_ListCacheReports.md) 
+  [ListFileShares](API_ListFileShares.md) 
+  [ListFileSystemAssociations](API_ListFileSystemAssociations.md) 
+  [ListGateways](API_ListGateways.md) 
+  [ListLocalDisks](API_ListLocalDisks.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTapePools](API_ListTapePools.md) 
+  [ListTapes](API_ListTapes.md) 
+  [ListVolumeInitiators](API_ListVolumeInitiators.md) 
+  [ListVolumeRecoveryPoints](API_ListVolumeRecoveryPoints.md) 
+  [ListVolumes](API_ListVolumes.md) 
+  [NotifyWhenUploaded](API_NotifyWhenUploaded.md) 
+  [RefreshCache](API_RefreshCache.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetCache](API_ResetCache.md) 
+  [RetrieveTapeArchive](API_RetrieveTapeArchive.md) 
+  [RetrieveTapeRecoveryPoint](API_RetrieveTapeRecoveryPoint.md) 
+  [SetLocalConsolePassword](API_SetLocalConsolePassword.md) 
+  [SetSMBGuestPassword](API_SetSMBGuestPassword.md) 
+  [ShutdownGateway](API_ShutdownGateway.md) 
+  [StartAvailabilityMonitorTest](API_StartAvailabilityMonitorTest.md) 
+  [StartCacheReport](API_StartCacheReport.md) 
+  [StartGateway](API_StartGateway.md) 
+  [UpdateAutomaticTapeCreationPolicy](API_UpdateAutomaticTapeCreationPolicy.md) 
+  [UpdateBandwidthRateLimit](API_UpdateBandwidthRateLimit.md) 
+  [UpdateBandwidthRateLimitSchedule](API_UpdateBandwidthRateLimitSchedule.md) 
+  [UpdateChapCredentials](API_UpdateChapCredentials.md) 
+  [UpdateFileSystemAssociation](API_UpdateFileSystemAssociation.md) 
+  [UpdateGatewayInformation](API_UpdateGatewayInformation.md) 
+  [UpdateGatewaySoftwareNow](API_UpdateGatewaySoftwareNow.md) 
+  [UpdateMaintenanceStartTime](API_UpdateMaintenanceStartTime.md) 
+  [UpdateNFSFileShare](API_UpdateNFSFileShare.md) 
+  [UpdateSMBFileShare](API_UpdateSMBFileShare.md) 
+  [UpdateSMBFileShareVisibility](API_UpdateSMBFileShareVisibility.md) 
+  [UpdateSMBLocalGroups](API_UpdateSMBLocalGroups.md) 
+  [UpdateSMBSecurityStrategy](API_UpdateSMBSecurityStrategy.md) 
+  [UpdateSnapshotSchedule](API_UpdateSnapshotSchedule.md) 
+  [UpdateVTLDeviceType](API_UpdateVTLDeviceType.md) 

# ActivateGateway
<a name="API_ActivateGateway"></a>

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

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

## Request Syntax
<a name="API_ActivateGateway_RequestSyntax"></a>

```
{
   "ActivationKey": "string",
   "GatewayName": "string",
   "GatewayRegion": "string",
   "GatewayTimezone": "string",
   "GatewayType": "string",
   "MediumChangerType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TapeDriveType": "string"
}
```

## Request Parameters
<a name="API_ActivateGateway_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ActivationKey](#API_ActivateGateway_RequestSyntax) **   <a name="StorageGateway-ActivateGateway-request-ActivationKey"></a>
Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter `activationKey`. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the `ActivateGateway` API call determine the actual configuration of your gateway.  
For more information, see [Getting activation key](https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html) in the *Storage Gateway User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: Yes

 ** [GatewayName](#API_ActivateGateway_RequestSyntax) **   <a name="StorageGateway-ActivateGateway-request-GatewayName"></a>
The name you configured for your gateway.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 255.  
Pattern: `^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$`   
Required: Yes

 ** [GatewayRegion](#API_ActivateGateway_RequestSyntax) **   <a name="StorageGateway-ActivateGateway-request-GatewayRegion"></a>
A value that indicates the AWS Region where you want to store your data. The gateway AWS Region specified must be the same AWS Region as the AWS Region in your `Host` header in the request. For more information about available AWS Regions and endpoints for Storage Gateway, see [ Storage Gateway endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sg.html) in the * AWS General Reference*.  
Valid Values: See [ Storage Gateway endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sg.html) in the * AWS General Reference*.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Required: Yes

 ** [GatewayTimezone](#API_ActivateGateway_RequestSyntax) **   <a name="StorageGateway-ActivateGateway-request-GatewayTimezone"></a>
A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT\$1hr:mm". For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT\$12:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 10.  
Required: Yes

 ** [GatewayType](#API_ActivateGateway_RequestSyntax) **   <a name="StorageGateway-ActivateGateway-request-GatewayType"></a>
A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is `CACHED`.  
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit [this blog post](https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/).
Valid Values: `STORED` \$1 `CACHED` \$1 `VTL` \$1 `FILE_S3` \$1 `FILE_FSX_SMB`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 20.  
Required: No

 ** [MediumChangerType](#API_ActivateGateway_RequestSyntax) **   <a name="StorageGateway-ActivateGateway-request-MediumChangerType"></a>
The value that indicates the type of medium changer to use for tape gateway. This field is optional.  
Valid Values: `STK-L700` \$1 `AWS-Gateway-VTL` \$1 `IBM-03584L32-0402`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Required: No

 ** [Tags](#API_ActivateGateway_RequestSyntax) **   <a name="StorageGateway-ActivateGateway-request-Tags"></a>
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [TapeDriveType](#API_ActivateGateway_RequestSyntax) **   <a name="StorageGateway-ActivateGateway-request-TapeDriveType"></a>
The value that indicates the type of tape drive to use for tape gateway. This field is optional.  
Valid Values: `IBM-ULT3580-TD5`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Required: No

## Response Syntax
<a name="API_ActivateGateway_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_ActivateGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_ActivateGateway_ResponseSyntax) **   <a name="StorageGateway-ActivateGateway-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_ActivateGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ActivateGateway_Examples"></a>

### Activate a gateway
<a name="API_ActivateGateway_Example_1"></a>

The following example shows a request that activates a gateway.

#### Sample Request
<a name="API_ActivateGateway_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.ActivateGateway

{
   "ActivationKey": "29AV1-3OFV9-VVIUB-NKT0I-LRO6V",
   "GatewayName": "mygateway",
   "GatewayTimezone": "GMT-12:00",
   "GatewayRegion": "us-east-2",
   "GatewayType": "STORED",
}
```

#### Sample Response
<a name="API_ActivateGateway_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-11A2222B"
}
```

## See Also
<a name="API_ActivateGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ActivateGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ActivateGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ActivateGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ActivateGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ActivateGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ActivateGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ActivateGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ActivateGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ActivateGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ActivateGateway) 

# AddCache
<a name="API_AddCache"></a>

Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see [How Storage Gateway works (architecture)](https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html).

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

## Request Syntax
<a name="API_AddCache_RequestSyntax"></a>

```
{
   "DiskIds": [ "string" ],
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_AddCache_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DiskIds](#API_AddCache_RequestSyntax) **   <a name="StorageGateway-AddCache-request-DiskIds"></a>
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the [ListLocalDisks](API_ListLocalDisks.md) API.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: Yes

 ** [GatewayARN](#API_AddCache_RequestSyntax) **   <a name="StorageGateway-AddCache-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_AddCache_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_AddCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_AddCache_ResponseSyntax) **   <a name="StorageGateway-AddCache-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_AddCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_AddCache_Examples"></a>

### Example request
<a name="API_AddCache_Example_1"></a>

The following example shows a request that activates a stored volumes gateway.

#### Sample Request
<a name="API_AddCache_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120425T120000Z
x-amz-target: StorageGateway_20130630.AddCache

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "DiskIds": [
        "pci-0000:03:00.0-scsi-0:0:0:0",
        "pci-0000:03:00.0-scsi-0:0:1:0"
    ]
}
```

#### Sample Response
<a name="API_AddCache_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 85

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_AddCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/AddCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/AddCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/AddCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/AddCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/AddCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/AddCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/AddCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/AddCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/AddCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/AddCache) 

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following Storage Gateway resources:
+ Storage gateways of all types
+ Storage volumes
+ Virtual tapes
+ NFS and SMB file shares
+ File System associations

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

## Request Syntax
<a name="API_AddTagsToResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_AddTagsToResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_AddTagsToResource_RequestSyntax) **   <a name="StorageGateway-AddTagsToResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource you want to add tags to.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [Tags](#API_AddTagsToResource_RequestSyntax) **   <a name="StorageGateway-AddTagsToResource-request-Tags"></a>
The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: Yes

## Response Syntax
<a name="API_AddTagsToResource_ResponseSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## Response Elements
<a name="API_AddTagsToResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ResourceARN](#API_AddTagsToResource_ResponseSyntax) **   <a name="StorageGateway-AddTagsToResource-response-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource you want to add tags to.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_AddTagsToResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_AddTagsToResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/AddTagsToResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/AddTagsToResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/AddTagsToResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/AddTagsToResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/AddTagsToResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/AddTagsToResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/AddTagsToResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/AddTagsToResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/AddTagsToResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/AddTagsToResource) 

# AddUploadBuffer
<a name="API_AddUploadBuffer"></a>

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

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

## Request Syntax
<a name="API_AddUploadBuffer_RequestSyntax"></a>

```
{
   "DiskIds": [ "string" ],
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_AddUploadBuffer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DiskIds](#API_AddUploadBuffer_RequestSyntax) **   <a name="StorageGateway-AddUploadBuffer-request-DiskIds"></a>
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the [ListLocalDisks](API_ListLocalDisks.md) API.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: Yes

 ** [GatewayARN](#API_AddUploadBuffer_RequestSyntax) **   <a name="StorageGateway-AddUploadBuffer-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_AddUploadBuffer_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_AddUploadBuffer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_AddUploadBuffer_ResponseSyntax) **   <a name="StorageGateway-AddUploadBuffer-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_AddUploadBuffer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_AddUploadBuffer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/AddUploadBuffer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/AddUploadBuffer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/AddUploadBuffer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/AddUploadBuffer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/AddUploadBuffer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/AddUploadBuffer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/AddUploadBuffer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/AddUploadBuffer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/AddUploadBuffer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/AddUploadBuffer) 

# AddWorkingStorage
<a name="API_AddWorkingStorage"></a>

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

**Note**  
Working storage is also referred to as upload buffer. You can also use the [AddUploadBuffer](API_AddUploadBuffer.md) operation to add upload buffer to a stored volume gateway.

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

## Request Syntax
<a name="API_AddWorkingStorage_RequestSyntax"></a>

```
{
   "DiskIds": [ "string" ],
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_AddWorkingStorage_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DiskIds](#API_AddWorkingStorage_RequestSyntax) **   <a name="StorageGateway-AddWorkingStorage-request-DiskIds"></a>
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the [ListLocalDisks](API_ListLocalDisks.md) API.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: Yes

 ** [GatewayARN](#API_AddWorkingStorage_RequestSyntax) **   <a name="StorageGateway-AddWorkingStorage-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_AddWorkingStorage_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_AddWorkingStorage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_AddWorkingStorage_ResponseSyntax) **   <a name="StorageGateway-AddWorkingStorage-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_AddWorkingStorage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_AddWorkingStorage_Examples"></a>

### Example request
<a name="API_AddWorkingStorage_Example_1"></a>

The following example shows a request that specifies that two local disks of a gateway are to be configured as working storage.

#### Sample Request
<a name="API_AddWorkingStorage_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.AddWorkingStorage

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "DiskIds": [
        "pci-0000:03:00.0-scsi-0:0:0:0",
        "pci-0000:04:00.0-scsi-1:0:0:0"
    ]
}
```

#### Sample Response
<a name="API_AddWorkingStorage_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_AddWorkingStorage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/AddWorkingStorage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/AddWorkingStorage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/AddWorkingStorage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/AddWorkingStorage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/AddWorkingStorage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/AddWorkingStorage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/AddWorkingStorage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/AddWorkingStorage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/AddWorkingStorage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/AddWorkingStorage) 

# AssignTapePool
<a name="API_AssignTapePool"></a>

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

## Request Syntax
<a name="API_AssignTapePool_RequestSyntax"></a>

```
{
   "BypassGovernanceRetention": boolean,
   "PoolId": "string",
   "TapeARN": "string"
}
```

## Request Parameters
<a name="API_AssignTapePool_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BypassGovernanceRetention](#API_AssignTapePool_RequestSyntax) **   <a name="StorageGateway-AssignTapePool-request-BypassGovernanceRetention"></a>
Set permissions to bypass governance retention. If the lock type of the archived tape is `Governance`, the tape's archived age is not older than `RetentionLockInDays`, and the user does not already have `BypassGovernanceRetention`, setting this to TRUE enables the user to bypass the retention lock. This parameter is set to true by default for calls from the console.  
Valid values: `TRUE` \$1 `FALSE`   
Type: Boolean  
Required: No

 ** [PoolId](#API_AssignTapePool_RequestSyntax) **   <a name="StorageGateway-AssignTapePool-request-PoolId"></a>
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [TapeARN](#API_AssignTapePool_RequestSyntax) **   <a name="StorageGateway-AssignTapePool-request-TapeARN"></a>
The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: Yes

## Response Syntax
<a name="API_AssignTapePool_ResponseSyntax"></a>

```
{
   "TapeARN": "string"
}
```

## Response Elements
<a name="API_AssignTapePool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARN](#API_AssignTapePool_ResponseSyntax) **   <a name="StorageGateway-AssignTapePool-response-TapeARN"></a>
The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$` 

## Errors
<a name="API_AssignTapePool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_AssignTapePool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/AssignTapePool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/AssignTapePool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/AssignTapePool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/AssignTapePool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/AssignTapePool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/AssignTapePool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/AssignTapePool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/AssignTapePool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/AssignTapePool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/AssignTapePool) 

# AssociateFileSystem
<a name="API_AssociateFileSystem"></a>

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

## Request Syntax
<a name="API_AssociateFileSystem_RequestSyntax"></a>

```
{
   "AuditDestinationARN": "string",
   "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": number
   },
   "ClientToken": "string",
   "EndpointNetworkConfiguration": { 
      "IpAddresses": [ "string" ]
   },
   "GatewayARN": "string",
   "LocationARN": "string",
   "Password": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "UserName": "string"
}
```

## Request Parameters
<a name="API_AssociateFileSystem_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AuditDestinationARN](#API_AssociateFileSystem_RequestSyntax) **   <a name="StorageGateway-AssociateFileSystem-request-AuditDestinationARN"></a>
The Amazon Resource Name (ARN) of the storage used for the audit logs.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [CacheAttributes](#API_AssociateFileSystem_RequestSyntax) **   <a name="StorageGateway-AssociateFileSystem-request-CacheAttributes"></a>
The refresh cache information for the file share or FSx file systems.  
Type: [CacheAttributes](API_CacheAttributes.md) object  
Required: No

 ** [ClientToken](#API_AssociateFileSystem_RequestSyntax) **   <a name="StorageGateway-AssociateFileSystem-request-ClientToken"></a>
A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 100.  
Required: Yes

 ** [EndpointNetworkConfiguration](#API_AssociateFileSystem_RequestSyntax) **   <a name="StorageGateway-AssociateFileSystem-request-EndpointNetworkConfiguration"></a>
Specifies the network configuration information for the gateway associated with the Amazon FSx file system.  
If multiple file systems are associated with this gateway, this parameter's `IpAddresses` field is required.
Type: [EndpointNetworkConfiguration](API_EndpointNetworkConfiguration.md) object  
Required: No

 ** [GatewayARN](#API_AssociateFileSystem_RequestSyntax) **   <a name="StorageGateway-AssociateFileSystem-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [LocationARN](#API_AssociateFileSystem_RequestSyntax) **   <a name="StorageGateway-AssociateFileSystem-request-LocationARN"></a>
The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 512.  
Required: Yes

 ** [Password](#API_AssociateFileSystem_RequestSyntax) **   <a name="StorageGateway-AssociateFileSystem-request-Password"></a>
The password of the user credential.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[ -~]+$`   
Required: Yes

 ** [Tags](#API_AssociateFileSystem_RequestSyntax) **   <a name="StorageGateway-AssociateFileSystem-request-Tags"></a>
A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [UserName](#API_AssociateFileSystem_RequestSyntax) **   <a name="StorageGateway-AssociateFileSystem-request-UserName"></a>
The user name of the user credential that has permission to access the root share D\$1 of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^\w[\w\.\- ]*$`   
Required: Yes

## Response Syntax
<a name="API_AssociateFileSystem_ResponseSyntax"></a>

```
{
   "FileSystemAssociationARN": "string"
}
```

## Response Elements
<a name="API_AssociateFileSystem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileSystemAssociationARN](#API_AssociateFileSystem_ResponseSyntax) **   <a name="StorageGateway-AssociateFileSystem-response-FileSystemAssociationARN"></a>
The ARN of the newly created file system association.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_AssociateFileSystem_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_AssociateFileSystem_Examples"></a>

### Example
<a name="API_AssociateFileSystem_Example_1"></a>

This example illustrates one usage of AssociateFileSystem.

#### Sample Request
<a name="API_AssociateFileSystem_Example_1_Request"></a>

```
__Sample Request__
{
 "UserName": "Admin",
 "Password": "Password123",
 "ClientToken": "foo-fsx-101",
 "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-7A8D6313",
 "LocationARN": "arn:aws:fsx:us-east-1:111122223333:file-system/fs-0bb4bf5cedebd814f",
 
}
```

### Example
<a name="API_AssociateFileSystem_Example_2"></a>

This example illustrates one usage of AssociateFileSystem.

#### Sample Response
<a name="API_AssociateFileSystem_Example_2_Response"></a>

```
__Sample Response__
{
  "FileSystemAssociationARNList": ["arn:aws:storagegateway:us-east-1:111122223333:fs-association/fsa-1122AABBCCDDEEFFG"]
}
```

## See Also
<a name="API_AssociateFileSystem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/AssociateFileSystem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/AssociateFileSystem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/AssociateFileSystem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/AssociateFileSystem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/AssociateFileSystem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/AssociateFileSystem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/AssociateFileSystem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/AssociateFileSystem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/AssociateFileSystem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/AssociateFileSystem) 

# AttachVolume
<a name="API_AttachVolume"></a>

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

## Request Syntax
<a name="API_AttachVolume_RequestSyntax"></a>

```
{
   "DiskId": "string",
   "GatewayARN": "string",
   "NetworkInterfaceId": "string",
   "TargetName": "string",
   "VolumeARN": "string"
}
```

## Request Parameters
<a name="API_AttachVolume_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DiskId](#API_AttachVolume_RequestSyntax) **   <a name="StorageGateway-AttachVolume-request-DiskId"></a>
The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: No

 ** [GatewayARN](#API_AttachVolume_RequestSyntax) **   <a name="StorageGateway-AttachVolume-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [NetworkInterfaceId](#API_AttachVolume_RequestSyntax) **   <a name="StorageGateway-AttachVolume-request-NetworkInterfaceId"></a>
The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use [DescribeGatewayInformation](API_DescribeGatewayInformation.md) to get a list of the network interfaces available on a gateway.  
Valid Values: A valid IP address.  
Type: String  
Required: Yes

 ** [TargetName](#API_AttachVolume_RequestSyntax) **   <a name="StorageGateway-AttachVolume-request-TargetName"></a>
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying `TargetName` as *myvolume* results in the target ARN of `arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume`. The target name must be unique across all volumes on a gateway.  
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[-\.;a-z0-9]+$`   
Required: No

 ** [VolumeARN](#API_AttachVolume_RequestSyntax) **   <a name="StorageGateway-AttachVolume-request-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_AttachVolume_ResponseSyntax"></a>

```
{
   "TargetARN": "string",
   "VolumeARN": "string"
}
```

## Response Elements
<a name="API_AttachVolume_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TargetARN](#API_AttachVolume_ResponseSyntax) **   <a name="StorageGateway-AttachVolume-response-TargetARN"></a>
The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.

 ** [VolumeARN](#API_AttachVolume_ResponseSyntax) **   <a name="StorageGateway-AttachVolume-response-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume that was attached to the gateway.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

## Errors
<a name="API_AttachVolume_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_AttachVolume_Examples"></a>

### Example request
<a name="API_AttachVolume_Example_1"></a>

The following example shows a request that attaches a volume to a gateway.

#### Sample Request
<a name="API_AttachVolume_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20181025T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630. AttachVolume

{
    "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "NetworkInterfaceId": "10.1.1.1",
    "TargetName": "myvolume",
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

#### Sample Response
<a name="API_AttachVolume_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Thu, 25 Oct 2018 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

## See Also
<a name="API_AttachVolume_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/AttachVolume) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/AttachVolume) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/AttachVolume) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/AttachVolume) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/AttachVolume) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/AttachVolume) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/AttachVolume) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/AttachVolume) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/AttachVolume) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/AttachVolume) 

# CancelArchival
<a name="API_CancelArchival"></a>

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

## Request Syntax
<a name="API_CancelArchival_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "TapeARN": "string"
}
```

## Request Parameters
<a name="API_CancelArchival_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_CancelArchival_RequestSyntax) **   <a name="StorageGateway-CancelArchival-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [TapeARN](#API_CancelArchival_RequestSyntax) **   <a name="StorageGateway-CancelArchival-request-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: Yes

## Response Syntax
<a name="API_CancelArchival_ResponseSyntax"></a>

```
{
   "TapeARN": "string"
}
```

## Response Elements
<a name="API_CancelArchival_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARN](#API_CancelArchival_ResponseSyntax) **   <a name="StorageGateway-CancelArchival-response-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$` 

## Errors
<a name="API_CancelArchival_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_CancelArchival_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CancelArchival) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CancelArchival) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CancelArchival) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CancelArchival) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CancelArchival) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CancelArchival) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CancelArchival) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CancelArchival) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CancelArchival) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CancelArchival) 

# CancelCacheReport
<a name="API_CancelCacheReport"></a>

Cancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.

## Request Syntax
<a name="API_CancelCacheReport_RequestSyntax"></a>

```
{
   "CacheReportARN": "string"
}
```

## Request Parameters
<a name="API_CancelCacheReport_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CacheReportARN](#API_CancelCacheReport_RequestSyntax) **   <a name="StorageGateway-CancelCacheReport-request-CacheReportARN"></a>
The Amazon Resource Name (ARN) of the cache report you want to cancel.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_CancelCacheReport_ResponseSyntax"></a>

```
{
   "CacheReportARN": "string"
}
```

## Response Elements
<a name="API_CancelCacheReport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CacheReportARN](#API_CancelCacheReport_ResponseSyntax) **   <a name="StorageGateway-CancelCacheReport-response-CacheReportARN"></a>
The Amazon Resource Name (ARN) of the cache report you want to cancel.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_CancelCacheReport_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CancelCacheReport_Examples"></a>

### Cancel a cache report
<a name="API_CancelCacheReport_Example_1"></a>

The following example cancels the cache report with the specified ARN.

#### Sample Request
<a name="API_CancelCacheReport_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.CancelCacheReport

{
    "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234/cache-report/report-ABCD1234"
}
```

#### Sample Response
<a name="API_CancelCacheReport_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234/cache-report/report-ABCD1234"
}
```

## See Also
<a name="API_CancelCacheReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CancelCacheReport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CancelCacheReport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CancelCacheReport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CancelCacheReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CancelCacheReport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CancelCacheReport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CancelCacheReport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CancelCacheReport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CancelCacheReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CancelCacheReport) 

# CancelRetrieval
<a name="API_CancelRetrieval"></a>

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

## Request Syntax
<a name="API_CancelRetrieval_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "TapeARN": "string"
}
```

## Request Parameters
<a name="API_CancelRetrieval_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_CancelRetrieval_RequestSyntax) **   <a name="StorageGateway-CancelRetrieval-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [TapeARN](#API_CancelRetrieval_RequestSyntax) **   <a name="StorageGateway-CancelRetrieval-request-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: Yes

## Response Syntax
<a name="API_CancelRetrieval_ResponseSyntax"></a>

```
{
   "TapeARN": "string"
}
```

## Response Elements
<a name="API_CancelRetrieval_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARN](#API_CancelRetrieval_ResponseSyntax) **   <a name="StorageGateway-CancelRetrieval-response-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$` 

## Errors
<a name="API_CancelRetrieval_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_CancelRetrieval_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CancelRetrieval) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CancelRetrieval) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CancelRetrieval) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CancelRetrieval) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CancelRetrieval) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CancelRetrieval) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CancelRetrieval) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CancelRetrieval) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CancelRetrieval) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CancelRetrieval) 

# CreateCachediSCSIVolume
<a name="API_CreateCachediSCSIVolume"></a>

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

**Note**  
Cache storage must be allocated to the gateway before you can create a cached volume. Use the [AddCache](API_AddCache.md) operation to add cache storage to a gateway.

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

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

## Request Syntax
<a name="API_CreateCachediSCSIVolume_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "GatewayARN": "string",
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "NetworkInterfaceId": "string",
   "SnapshotId": "string",
   "SourceVolumeARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TargetName": "string",
   "VolumeSizeInBytes": number
}
```

## Request Parameters
<a name="API_CreateCachediSCSIVolume_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-ClientToken"></a>
A unique identifier that you use to retry a request. If you retry a request, use the same `ClientToken` you specified in the initial request.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 100.  
Required: Yes

 ** [GatewayARN](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [KMSEncrypted](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-KMSEncrypted"></a>
Set to `true` to use Amazon S3 server-side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSKey](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-KMSKey"></a>
The Amazon Resource Name (ARN) of a symmetric AWS KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value can only be set when `KMSEncrypted` is `true`. Optional.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** [NetworkInterfaceId](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-NetworkInterfaceId"></a>
The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use [DescribeGatewayInformation](API_DescribeGatewayInformation.md) to get a list of the network interfaces available on a gateway.  
Valid Values: A valid IP address.  
Type: String  
Required: Yes

 ** [SnapshotId](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-SnapshotId"></a>
The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use [DescribeSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) in the *Amazon Elastic Compute Cloud API Reference*.  
Type: String  
Pattern: `\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z`   
Required: No

 ** [SourceVolumeARN](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-SourceVolumeARN"></a>
The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The `VolumeSizeInBytes` value for this new volume must be equal to or larger than the size of the existing volume, in bytes.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: No

 ** [Tags](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-Tags"></a>
A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [TargetName](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-TargetName"></a>
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying `TargetName` as *myvolume* results in the target ARN of `arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume`. The target name must be unique across all volumes on a gateway.  
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[-\.;a-z0-9]+$`   
Required: Yes

 ** [VolumeSizeInBytes](#API_CreateCachediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-request-VolumeSizeInBytes"></a>
The size of the volume in bytes.  
Type: Long  
Required: Yes

## Response Syntax
<a name="API_CreateCachediSCSIVolume_ResponseSyntax"></a>

```
{
   "TargetARN": "string",
   "VolumeARN": "string"
}
```

## Response Elements
<a name="API_CreateCachediSCSIVolume_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TargetARN](#API_CreateCachediSCSIVolume_ResponseSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-response-TargetARN"></a>
The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.

 ** [VolumeARN](#API_CreateCachediSCSIVolume_ResponseSyntax) **   <a name="StorageGateway-CreateCachediSCSIVolume-response-VolumeARN"></a>
The Amazon Resource Name (ARN) of the configured volume.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

## Errors
<a name="API_CreateCachediSCSIVolume_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CreateCachediSCSIVolume_Examples"></a>

### Example request
<a name="API_CreateCachediSCSIVolume_Example_1"></a>

The following example shows a request that specifies that a local disk of a gateway be configured as a cached volume.

#### Sample Request
<a name="API_CreateCachediSCSIVolume_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20130630.CreateCachediSCSIVolume

{
    "ClientToken": "cachedvol112233",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "NetworkInterfaceId": "10.1.1.1",
    "TargetName": "myvolume",
    "VolumeSizeInBytes": "536870912000"
}
```

#### Sample Response
<a name="API_CreateCachediSCSIVolume_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 263

{
    "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

## See Also
<a name="API_CreateCachediSCSIVolume_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateCachediSCSIVolume) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateCachediSCSIVolume) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateCachediSCSIVolume) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateCachediSCSIVolume) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateCachediSCSIVolume) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateCachediSCSIVolume) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateCachediSCSIVolume) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateCachediSCSIVolume) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateCachediSCSIVolume) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateCachediSCSIVolume) 

# CreateNFSFileShare
<a name="API_CreateNFSFileShare"></a>

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

**Important**  
S3 File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure AWS STS is activated in the AWS Region you are creating your S3 File Gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see [Activating and deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the * AWS Identity and Access Management User Guide*.  
S3 File Gateways do not support creating hard or symbolic links on a file share.

## Request Syntax
<a name="API_CreateNFSFileShare_RequestSyntax"></a>

```
{
   "AuditDestinationARN": "string",
   "BucketRegion": "string",
   "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": number
   },
   "ClientList": [ "string" ],
   "ClientToken": "string",
   "DefaultStorageClass": "string",
   "EncryptionType": "string",
   "FileShareName": "string",
   "GatewayARN": "string",
   "GuessMIMETypeEnabled": boolean,
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "LocationARN": "string",
   "NFSFileShareDefaults": { 
      "DirectoryMode": "string",
      "FileMode": "string",
      "GroupId": number,
      "OwnerId": number
   },
   "NotificationPolicy": "string",
   "ObjectACL": "string",
   "ReadOnly": boolean,
   "RequesterPays": boolean,
   "Role": "string",
   "Squash": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VPCEndpointDNSName": "string"
}
```

## Request Parameters
<a name="API_CreateNFSFileShare_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AuditDestinationARN](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-AuditDestinationARN"></a>
The Amazon Resource Name (ARN) of the storage used for audit logs.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [BucketRegion](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-BucketRegion"></a>
Specifies the Region of the S3 bucket where the NFS file share stores files.  
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Required: No

 ** [CacheAttributes](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-CacheAttributes"></a>
Specifies refresh cache information for the file share.  
Type: [CacheAttributes](API_CacheAttributes.md) object  
Required: No

 ** [ClientList](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-ClientList"></a>
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IPv4/IPv6 addresses or valid CIDR blocks.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Pattern: `^(?:(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(?:\/(?:[0-9]|[1-2][0-9]|3[0-2]))?$|^(?:(?:(?:[A-Fa-f0-9]{1,4}:){6}|(?=(?:[A-Fa-f0-9]{0,4}:){0,6}(?:[0-9]{1,3}\.){3}[0-9]{1,3}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){0,5}|:)(?:(?::[0-9A-Fa-f]{1,4}){1,5}:|:)|::(?:[A-Fa-f0-9]{1,4}:){5})(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}|(?=(?:[A-Fa-f0-9]{0,4}:){0,7}[A-Fa-f0-9]{0,4}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){1,7}|:)(?:(:[0-9A-Fa-f]{1,4}){1,7}|:)|(?:[A-Fa-f0-9]{1,4}:){7}:|:(:[A-Fa-f0-9]{1,4}){7})(?:\/(?:12[0-8]|1[01][0-9]|[1-9]?[0-9]))?$`   
Required: No

 ** [ClientToken](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-ClientToken"></a>
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 100.  
Required: Yes

 ** [DefaultStorageClass](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-DefaultStorageClass"></a>
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is `S3_STANDARD`. Optional.  
Valid Values: `S3_STANDARD` \$1 `S3_INTELLIGENT_TIERING` \$1 `S3_STANDARD_IA` \$1 `S3_ONEZONE_IA`   
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 50.  
Required: No

 ** [EncryptionType](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-EncryptionType"></a>
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Type: String  
Valid Values: `SseS3 | SseKms | DsseKms`   
Required: No

 ** [FileShareName](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-FileShareName"></a>
The name of the file share. Optional.  
 `FileShareName` must be set if an S3 prefix name is set in `LocationARN`, or if an access point or access point alias is used.  
A valid NFS file share name can only contain the following characters: `a`-`z`, `A`-`Z`, `0`-`9`, `-`, `.`, and `_`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [GatewayARN](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [GuessMIMETypeEnabled](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-GuessMIMETypeEnabled"></a>
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to `true` to enable MIME type guessing, otherwise set to `false`. The default value is `true`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSEncrypted](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-KMSEncrypted"></a>
 *This parameter has been deprecated.*   
Optional. Set to `true` to use Amazon S3 server-side encryption with your own AWS KMS key (SSE-KMS), or `false` to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the `EncryptionType` parameter instead.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSKey](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric AWS KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** [LocationARN](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-LocationARN"></a>
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).  
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.  
Bucket ARN:  
 `arn:aws:s3:::amzn-s3-demo-bucket/prefix/`   
Access point ARN:  
 `arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/`   
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see [Delegating access control to access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) in the *Amazon S3 User Guide*.  
Access point alias:  
 `test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias` 
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1400.  
Required: Yes

 ** [NFSFileShareDefaults](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-NFSFileShareDefaults"></a>
File share default values. Optional.  
Type: [NFSFileShareDefaults](API_NFSFileShareDefaults.md) object  
Required: No

 ** [NotificationPolicy](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-NotificationPolicy"></a>
The notification policy of the file share. `SettlingTimeInSeconds` controls the number of seconds to wait after the last point in time a client wrote to a file before generating an `ObjectUploaded` notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.  
 `SettlingTimeInSeconds` has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.  
This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.
The following example sets `NotificationPolicy` on with `SettlingTimeInSeconds` set to 60.  
 `{\"Upload\": {\"SettlingTimeInSeconds\": 60}}`   
The following example sets `NotificationPolicy` off.  
 `{}`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `^\{[\w\s:\{\}\[\]"]*}$`   
Required: No

 ** [ObjectACL](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-ObjectACL"></a>
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is `private`.  
Type: String  
Valid Values: `private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read`   
Required: No

 ** [ReadOnly](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-ReadOnly"></a>
A value that sets the write status of a file share. Set this value to `true` to set the write status to read-only, otherwise set to `false`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [RequesterPays](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-RequesterPays"></a>
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to `true`, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.  
 `RequesterPays` is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [Role](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-Role"></a>
The ARN of the AWS Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\S+)$`   
Required: Yes

 ** [Squash](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-Squash"></a>
A value that maps a user to anonymous user.  
Valid values are the following:  
+  `RootSquash`: Only root is mapped to anonymous user.
+  `NoSquash`: No one is mapped to anonymous user.
+  `AllSquash`: Everyone is mapped to anonymous user.
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 15.  
Required: No

 ** [Tags](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-Tags"></a>
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [VPCEndpointDNSName](#API_CreateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-CreateNFSFileShare-request-VPCEndpointDNSName"></a>
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.  
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$`   
Required: No

## Response Syntax
<a name="API_CreateNFSFileShare_ResponseSyntax"></a>

```
{
   "FileShareARN": "string"
}
```

## Response Elements
<a name="API_CreateNFSFileShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileShareARN](#API_CreateNFSFileShare_ResponseSyntax) **   <a name="StorageGateway-CreateNFSFileShare-response-FileShareARN"></a>
The Amazon Resource Name (ARN) of the newly created file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_CreateNFSFileShare_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CreateNFSFileShare_Examples"></a>

### Create an NFS file share
<a name="API_CreateNFSFileShare_Example_1"></a>

In the following request, you create a file share using an existing S3 File Gateway and using your own AWS KMS key to perform server-side encryption of the contents of the file share.

#### Sample Request
<a name="API_CreateNFSFileShare_Example_1_Request"></a>

```
{
    "ClientList": "10.1.1.1",
    "ClientToken": "xy23421",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket",
    "NFSFileShareDefaults": {
        "FileMode": "0777",
        "DirectoryMode": "0777",
        "GroupId": "500",
        "OwnerId": "500"
    },
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "Squash": "RootSquash"
}
```

#### Sample Response
<a name="API_CreateNFSFileShare_Example_1_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

### Create an NFS file share with file upload notification on
<a name="API_CreateNFSFileShare_Example_2"></a>

In the following request, you create an NFS file share using an existing file gateway and with file upload notification turned on and settling time set to 60 seconds.

#### Sample Request
<a name="API_CreateNFSFileShare_Example_2_Request"></a>

```
{
    "ClientList": "10.1.1.1",
    "ClientToken": "xy23421",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket",
    "NFSFileShareDefaults": {
        "FileMode": "0777",
        "DirectoryMode": "0777",
        "GroupId": "500",
        "OwnerId": "500"
    },
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "Squash": "RootSquash",
    "NotificationPolicy": "{\"Upload\": {\"SettlingTimeInSeconds\": 60}}"
}
```

#### Sample Response
<a name="API_CreateNFSFileShare_Example_2_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

### Create an NFS file share with file upload notification off
<a name="API_CreateNFSFileShare_Example_3"></a>

In the following request, you create an NFS file share using an existing file gateway and with file upload notification turned off.

#### Sample Request
<a name="API_CreateNFSFileShare_Example_3_Request"></a>

```
{
    "ClientList": "10.1.1.1",
    "ClientToken": "xy23421",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket",
    "NFSFileShareDefaults": {
        "FileMode": "0777",
        "DirectoryMode": "0777",
        "GroupId": "500",
        "OwnerId": "500"
    },
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "Squash": "RootSquash",
    "NotificationPolicy": "{}"
}
```

#### Sample Response
<a name="API_CreateNFSFileShare_Example_3_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

## See Also
<a name="API_CreateNFSFileShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateNFSFileShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateNFSFileShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateNFSFileShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateNFSFileShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateNFSFileShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateNFSFileShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateNFSFileShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateNFSFileShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateNFSFileShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateNFSFileShare) 

# CreateSMBFileShare
<a name="API_CreateSMBFileShare"></a>

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

**Important**  
S3 File Gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your S3 File Gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see [Activating and deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the * AWS Identity and Access Management User Guide*.  
File gateways don't support creating hard or symbolic links on a file share.

## Request Syntax
<a name="API_CreateSMBFileShare_RequestSyntax"></a>

```
{
   "AccessBasedEnumeration": boolean,
   "AdminUserList": [ "string" ],
   "AuditDestinationARN": "string",
   "Authentication": "string",
   "BucketRegion": "string",
   "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": number
   },
   "CaseSensitivity": "string",
   "ClientToken": "string",
   "DefaultStorageClass": "string",
   "EncryptionType": "string",
   "FileShareName": "string",
   "GatewayARN": "string",
   "GuessMIMETypeEnabled": boolean,
   "InvalidUserList": [ "string" ],
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "LocationARN": "string",
   "NotificationPolicy": "string",
   "ObjectACL": "string",
   "OplocksEnabled": boolean,
   "ReadOnly": boolean,
   "RequesterPays": boolean,
   "Role": "string",
   "SMBACLEnabled": boolean,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ValidUserList": [ "string" ],
   "VPCEndpointDNSName": "string"
}
```

## Request Parameters
<a name="API_CreateSMBFileShare_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AccessBasedEnumeration](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-AccessBasedEnumeration"></a>
The files and folders on this share will only be visible to users with read access.  
Type: Boolean  
Required: No

 ** [AdminUserList](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-AdminUserList"></a>
A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`.  
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [AuditDestinationARN](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-AuditDestinationARN"></a>
The Amazon Resource Name (ARN) of the storage used for audit logs.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [Authentication](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-Authentication"></a>
The authentication method that users use to access the file share. The default is `ActiveDirectory`.  
Valid Values: `ActiveDirectory` \$1 `GuestAccess`   
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 15.  
Required: No

 ** [BucketRegion](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-BucketRegion"></a>
Specifies the Region of the S3 bucket where the SMB file share stores files.  
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Required: No

 ** [CacheAttributes](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-CacheAttributes"></a>
Specifies refresh cache information for the file share.  
Type: [CacheAttributes](API_CacheAttributes.md) object  
Required: No

 ** [CaseSensitivity](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-CaseSensitivity"></a>
The case of an object name in an Amazon S3 bucket. For `ClientSpecified`, the client determines the case sensitivity. For `CaseSensitive`, the gateway determines the case sensitivity. The default value is `ClientSpecified`.  
Type: String  
Valid Values: `ClientSpecified | CaseSensitive`   
Required: No

 ** [ClientToken](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-ClientToken"></a>
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 100.  
Required: Yes

 ** [DefaultStorageClass](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-DefaultStorageClass"></a>
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is `S3_STANDARD`. Optional.  
Valid Values: `S3_STANDARD` \$1 `S3_INTELLIGENT_TIERING` \$1 `S3_STANDARD_IA` \$1 `S3_ONEZONE_IA`   
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 50.  
Required: No

 ** [EncryptionType](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-EncryptionType"></a>
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Type: String  
Valid Values: `SseS3 | SseKms | DsseKms`   
Required: No

 ** [FileShareName](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-FileShareName"></a>
The name of the file share. Optional.  
 `FileShareName` must be set if an S3 prefix name is set in `LocationARN`, or if an access point or access point alias is used.  
A valid SMB file share name cannot contain the following characters: `[`,`]`,`#`,`;`,`<`,`>`,`:`,`"`,`\`,`/`,`|`,`?`,`*`,`+`, or ASCII control characters `1-31`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [GatewayARN](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-GatewayARN"></a>
The ARN of the S3 File Gateway on which you want to create a file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [GuessMIMETypeEnabled](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-GuessMIMETypeEnabled"></a>
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to `true` to enable MIME type guessing, otherwise set to `false`. The default value is `true`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [InvalidUserList](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-InvalidUserList"></a>
A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is set to `ActiveDirectory`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [KMSEncrypted](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-KMSEncrypted"></a>
 *This parameter has been deprecated.*   
Optional. Set to `true` to use Amazon S3 server-side encryption with your own AWS KMS key (SSE-KMS), or `false` to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the `EncryptionType` parameter instead.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSKey](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric AWS KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** [LocationARN](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-LocationARN"></a>
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).  
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.  
Bucket ARN:  
 `arn:aws:s3:::amzn-s3-demo-bucket/prefix/`   
Access point ARN:  
 `arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/`   
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see [Delegating access control to access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) in the *Amazon S3 User Guide*.  
Access point alias:  
 `test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias` 
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1400.  
Required: Yes

 ** [NotificationPolicy](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-NotificationPolicy"></a>
The notification policy of the file share. `SettlingTimeInSeconds` controls the number of seconds to wait after the last point in time a client wrote to a file before generating an `ObjectUploaded` notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.  
 `SettlingTimeInSeconds` has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.  
This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.
The following example sets `NotificationPolicy` on with `SettlingTimeInSeconds` set to 60.  
 `{\"Upload\": {\"SettlingTimeInSeconds\": 60}}`   
The following example sets `NotificationPolicy` off.  
 `{}`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `^\{[\w\s:\{\}\[\]"]*}$`   
Required: No

 ** [ObjectACL](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-ObjectACL"></a>
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is `private`.  
Type: String  
Valid Values: `private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read`   
Required: No

 ** [OplocksEnabled](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-OplocksEnabled"></a>
Specifies whether opportunistic locking is enabled for the SMB file share.  
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [ReadOnly](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-ReadOnly"></a>
A value that sets the write status of a file share. Set this value to `true` to set the write status to read-only, otherwise set to `false`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [RequesterPays](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-RequesterPays"></a>
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to `true`, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.  
 `RequesterPays` is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [Role](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-Role"></a>
The ARN of the AWS Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\S+)$`   
Required: Yes

 ** [SMBACLEnabled](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-SMBACLEnabled"></a>
Set this value to `true` to enable access control list (ACL) on the SMB file share. Set it to `false` to map file and directory permissions to the POSIX permissions.  
For more information, see [Using Windows ACLs to limit SMB file share access](https://docs.aws.amazon.com/filegateway/latest/files3/smb-acl.html) in the *Amazon S3 File Gateway User Guide*.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [Tags](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-Tags"></a>
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [ValidUserList](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-ValidUserList"></a>
A list of users or groups in the Active Directory that are allowed to access the file []() share. A group must be prefixed with the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is set to `ActiveDirectory`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [VPCEndpointDNSName](#API_CreateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-CreateSMBFileShare-request-VPCEndpointDNSName"></a>
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.  
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$`   
Required: No

## Response Syntax
<a name="API_CreateSMBFileShare_ResponseSyntax"></a>

```
{
   "FileShareARN": "string"
}
```

## Response Elements
<a name="API_CreateSMBFileShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileShareARN](#API_CreateSMBFileShare_ResponseSyntax) **   <a name="StorageGateway-CreateSMBFileShare-response-FileShareARN"></a>
The Amazon Resource Name (ARN) of the newly created file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_CreateSMBFileShare_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CreateSMBFileShare_Examples"></a>

### Create an SMB file share
<a name="API_CreateSMBFileShare_Example_1"></a>

In the following request, you create an SMB file share using an existing S3 File Gateway and using your own AWS KMS key to perform server-side encryption of the contents of the file share.

#### Sample Request
<a name="API_CreateSMBFileShare_Example_1_Request"></a>

```
{
    "Authentication": "ActiveDirectory",
    "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": 300
    },
    "CaseSensitivity": "ClientSpecified",
    "ClientToken": "xy23421",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "FileShareName": "my-file-share",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "InvalidList": [
        "user1",
        "user3",
        "@group2"
    ],
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket/prefix-name/",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "ValidUserList": [
        "user2",
        "@group1"
    ]
}
```

#### Sample Response
<a name="API_CreateSMBFileShare_Example_1_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

### Create an SMB file share with file upload notification on
<a name="API_CreateSMBFileShare_Example_2"></a>

In the following request, you create an SMB file share using an existing file gateway and with file upload notification turned on and settling time set to 60 seconds.

#### Sample Request
<a name="API_CreateSMBFileShare_Example_2_Request"></a>

```
{
    "Authentication": "ActiveDirectory",
    "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": 300
    },
    "CaseSensitivity": "ClientSpecified",
    "ClientToken": "xy23421",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "FileShareName": "my-file-share",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "InvalidList": [
        "user1",
        "user3",
        "@group2"
    ],
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket/prefix-name/",
    "NotificationPolicy": "{\"Upload\": {\"SettlingTimeInSeconds\": 60}}",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "ValidUserList": [
        "user2",
        "@group1"
    ]
}
```

#### Sample Response
<a name="API_CreateSMBFileShare_Example_2_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

### Create an SMB file share with file upload notification off
<a name="API_CreateSMBFileShare_Example_3"></a>

In the following request, you create an SMB file share using an existing file gateway and with file upload notification turned off.

#### Sample Request
<a name="API_CreateSMBFileShare_Example_3_Request"></a>

```
{
    "Authentication": "ActiveDirectory",
    "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": 300
    },
    "CaseSensitivity": "ClientSpecified",
    "ClientToken": "xy23421",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "FileShareName": "my-file-share",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "InvalidList": [
        "user1",
        "user3",
        "@group2"
    ],
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket/prefix-name/",
    "NotificationPolicy": "{}",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "ValidUserList": [
        "user2",
        "@group1"
    ]
}
```

#### Sample Response
<a name="API_CreateSMBFileShare_Example_3_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

## See Also
<a name="API_CreateSMBFileShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateSMBFileShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateSMBFileShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateSMBFileShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateSMBFileShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateSMBFileShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateSMBFileShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateSMBFileShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateSMBFileShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateSMBFileShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateSMBFileShare) 

# CreateSnapshot
<a name="API_CreateSnapshot"></a>

Initiates a snapshot of a volume.

Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see [Editing a snapshot schedule](https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot).

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

**Note**  
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see [DescribeSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) or [DeleteSnapshot](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) in the *Amazon Elastic Compute Cloud API Reference*.

**Important**  
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the [Welcome](https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html) page.

## Request Syntax
<a name="API_CreateSnapshot_RequestSyntax"></a>

```
{
   "SnapshotDescription": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VolumeARN": "string"
}
```

## Request Parameters
<a name="API_CreateSnapshot_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [SnapshotDescription](#API_CreateSnapshot_RequestSyntax) **   <a name="StorageGateway-CreateSnapshot-request-SnapshotDescription"></a>
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the **Description** field, and in the Storage Gateway snapshot **Details** pane, **Description** field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [Tags](#API_CreateSnapshot_RequestSyntax) **   <a name="StorageGateway-CreateSnapshot-request-Tags"></a>
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [VolumeARN](#API_CreateSnapshot_RequestSyntax) **   <a name="StorageGateway-CreateSnapshot-request-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume. Use the [ListVolumes](API_ListVolumes.md) operation to return a list of gateway volumes.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_CreateSnapshot_ResponseSyntax"></a>

```
{
   "SnapshotId": "string",
   "VolumeARN": "string"
}
```

## Response Elements
<a name="API_CreateSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SnapshotId](#API_CreateSnapshot_ResponseSyntax) **   <a name="StorageGateway-CreateSnapshot-response-SnapshotId"></a>
The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API `DescribeSnapshots`) or creating a volume from a snapshot ([CreateStorediSCSIVolume](API_CreateStorediSCSIVolume.md)).  
Type: String  
Pattern: `\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z` 

 ** [VolumeARN](#API_CreateSnapshot_ResponseSyntax) **   <a name="StorageGateway-CreateSnapshot-response-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

## Errors
<a name="API_CreateSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** ServiceUnavailableError **   
An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CreateSnapshot_Examples"></a>

### Example request
<a name="API_CreateSnapshot_Example_1"></a>

The following example sends a `CreateSnapshot` request to take snapshot of the specified an example volume.

#### Sample Request
<a name="API_CreateSnapshot_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.CreateSnapshot

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
    "SnapshotDescription": "snapshot description"
}
```

#### Sample Response
<a name="API_CreateSnapshot_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 128

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
    "SnapshotId": "snap-78e22663"
}
```

## See Also
<a name="API_CreateSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateSnapshot) 

# CreateSnapshotFromVolumeRecoveryPoint
<a name="API_CreateSnapshotFromVolumeRecoveryPoint"></a>

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

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

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

**Note**  
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see [DescribeSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) or [DeleteSnapshot](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) in the *Amazon Elastic Compute Cloud API Reference*.

## Request Syntax
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_RequestSyntax"></a>

```
{
   "SnapshotDescription": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VolumeARN": "string"
}
```

## Request Parameters
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [SnapshotDescription](#API_CreateSnapshotFromVolumeRecoveryPoint_RequestSyntax) **   <a name="StorageGateway-CreateSnapshotFromVolumeRecoveryPoint-request-SnapshotDescription"></a>
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the **Description** field, and in the Storage Gateway snapshot **Details** pane, **Description** field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [Tags](#API_CreateSnapshotFromVolumeRecoveryPoint_RequestSyntax) **   <a name="StorageGateway-CreateSnapshotFromVolumeRecoveryPoint-request-Tags"></a>
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [VolumeARN](#API_CreateSnapshotFromVolumeRecoveryPoint_RequestSyntax) **   <a name="StorageGateway-CreateSnapshotFromVolumeRecoveryPoint-request-VolumeARN"></a>
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the [DescribeStorediSCSIVolumes](API_DescribeStorediSCSIVolumes.md) operation to return to retrieve the TargetARN for specified VolumeARN.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_ResponseSyntax"></a>

```
{
   "SnapshotId": "string",
   "VolumeARN": "string",
   "VolumeRecoveryPointTime": "string"
}
```

## Response Elements
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SnapshotId](#API_CreateSnapshotFromVolumeRecoveryPoint_ResponseSyntax) **   <a name="StorageGateway-CreateSnapshotFromVolumeRecoveryPoint-response-SnapshotId"></a>
The ID of the snapshot.  
Type: String  
Pattern: `\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z` 

 ** [VolumeARN](#API_CreateSnapshotFromVolumeRecoveryPoint_ResponseSyntax) **   <a name="StorageGateway-CreateSnapshotFromVolumeRecoveryPoint-response-VolumeARN"></a>
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the [DescribeStorediSCSIVolumes](API_DescribeStorediSCSIVolumes.md) operation to return to retrieve the TargetARN for specified VolumeARN.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

 ** [VolumeRecoveryPointTime](#API_CreateSnapshotFromVolumeRecoveryPoint_ResponseSyntax) **   <a name="StorageGateway-CreateSnapshotFromVolumeRecoveryPoint-response-VolumeRecoveryPointTime"></a>
The time the volume was created from the recovery point.  
Type: String

## Errors
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** ServiceUnavailableError **   
An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_Examples"></a>

### Example request
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_Example_1"></a>

The following example sends a `CreateSnapshotFromVolumeRecoveryPoint` request to take snapshot of the specified an example volume.

#### Sample Request
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20130630.CreateSnapshotFromVolumeRecoveryPoint

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
    "SnapshotDescription": "snapshot description"
}
```

#### Sample Response
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 137

{
    "SnapshotId": "snap-78e22663",
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
    "VolumeRecoveryPointTime": "2012-06-30T10:10:10.000Z"
}
```

## See Also
<a name="API_CreateSnapshotFromVolumeRecoveryPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateSnapshotFromVolumeRecoveryPoint) 

# CreateStorediSCSIVolume
<a name="API_CreateStorediSCSIVolume"></a>

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

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

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

## Request Syntax
<a name="API_CreateStorediSCSIVolume_RequestSyntax"></a>

```
{
   "DiskId": "string",
   "GatewayARN": "string",
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "NetworkInterfaceId": "string",
   "PreserveExistingData": boolean,
   "SnapshotId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TargetName": "string"
}
```

## Request Parameters
<a name="API_CreateStorediSCSIVolume_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DiskId](#API_CreateStorediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-request-DiskId"></a>
The unique identifier for the gateway local disk that is configured as a stored volume. Use [ListLocalDisks](https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html) to list disk IDs for a gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: Yes

 ** [GatewayARN](#API_CreateStorediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [KMSEncrypted](#API_CreateStorediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-request-KMSEncrypted"></a>
Set to `true` to use Amazon S3 server-side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSKey](#API_CreateStorediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-request-KMSKey"></a>
The Amazon Resource Name (ARN) of a symmetric AWS KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value can only be set when `KMSEncrypted` is `true`. Optional.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** [NetworkInterfaceId](#API_CreateStorediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-request-NetworkInterfaceId"></a>
The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use [DescribeGatewayInformation](API_DescribeGatewayInformation.md) to get a list of the network interfaces available on a gateway.  
Valid Values: A valid IP address.  
Type: String  
Required: Yes

 ** [PreserveExistingData](#API_CreateStorediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-request-PreserveExistingData"></a>
Set to `true` if you want to preserve the data on the local disk. Otherwise, set to `false` to create an empty volume.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: Yes

 ** [SnapshotId](#API_CreateStorediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-request-SnapshotId"></a>
The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use [DescribeSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) in the *Amazon Elastic Compute Cloud API Reference*.  
Type: String  
Pattern: `\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z`   
Required: No

 ** [Tags](#API_CreateStorediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-request-Tags"></a>
A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [TargetName](#API_CreateStorediSCSIVolume_RequestSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-request-TargetName"></a>
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying `TargetName` as *myvolume* results in the target ARN of `arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume`. The target name must be unique across all volumes on a gateway.  
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[-\.;a-z0-9]+$`   
Required: Yes

## Response Syntax
<a name="API_CreateStorediSCSIVolume_ResponseSyntax"></a>

```
{
   "TargetARN": "string",
   "VolumeARN": "string",
   "VolumeSizeInBytes": number
}
```

## Response Elements
<a name="API_CreateStorediSCSIVolume_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TargetARN](#API_CreateStorediSCSIVolume_ResponseSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-response-TargetARN"></a>
The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.

 ** [VolumeARN](#API_CreateStorediSCSIVolume_ResponseSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-response-VolumeARN"></a>
The Amazon Resource Name (ARN) of the configured volume.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

 ** [VolumeSizeInBytes](#API_CreateStorediSCSIVolume_ResponseSyntax) **   <a name="StorageGateway-CreateStorediSCSIVolume-response-VolumeSizeInBytes"></a>
The size of the volume in bytes.  
Type: Long

## Errors
<a name="API_CreateStorediSCSIVolume_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CreateStorediSCSIVolume_Examples"></a>

### Example request
<a name="API_CreateStorediSCSIVolume_Example_1"></a>

The following example shows a request that specifies that a local disk of a gateway be configured as a volume.

#### Sample Request
<a name="API_CreateStorediSCSIVolume_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.CreateStorediSCSIVolume

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
    "PreserveExistingData": true,
    "TargetName": "myvolume",
    "NetworkInterfaceId": "10.1.1.1"
}
```

#### Sample Response
<a name="API_CreateStorediSCSIVolume_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 215

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
    "VolumeSizeInBytes": 1099511627776,
    "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
}
```

## See Also
<a name="API_CreateStorediSCSIVolume_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateStorediSCSIVolume) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateStorediSCSIVolume) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateStorediSCSIVolume) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateStorediSCSIVolume) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateStorediSCSIVolume) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateStorediSCSIVolume) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateStorediSCSIVolume) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateStorediSCSIVolume) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateStorediSCSIVolume) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateStorediSCSIVolume) 

# CreateTapePool
<a name="API_CreateTapePool"></a>

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

## Request Syntax
<a name="API_CreateTapePool_RequestSyntax"></a>

```
{
   "PoolName": "string",
   "RetentionLockTimeInDays": number,
   "RetentionLockType": "string",
   "StorageClass": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateTapePool_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [PoolName](#API_CreateTapePool_RequestSyntax) **   <a name="StorageGateway-CreateTapePool-request-PoolName"></a>
The name of the new custom tape pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$`   
Required: Yes

 ** [RetentionLockTimeInDays](#API_CreateTapePool_RequestSyntax) **   <a name="StorageGateway-CreateTapePool-request-RetentionLockTimeInDays"></a>
Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 36500.  
Required: No

 ** [RetentionLockType](#API_CreateTapePool_RequestSyntax) **   <a name="StorageGateway-CreateTapePool-request-RetentionLockType"></a>
Tape retention lock can be configured in two modes. When configured in governance mode, AWS accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root AWS account.  
Type: String  
Valid Values: `COMPLIANCE | GOVERNANCE | NONE`   
Required: No

 ** [StorageClass](#API_CreateTapePool_RequestSyntax) **   <a name="StorageGateway-CreateTapePool-request-StorageClass"></a>
The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.  
Type: String  
Valid Values: `DEEP_ARCHIVE | GLACIER`   
Required: Yes

 ** [Tags](#API_CreateTapePool_RequestSyntax) **   <a name="StorageGateway-CreateTapePool-request-Tags"></a>
A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Syntax
<a name="API_CreateTapePool_ResponseSyntax"></a>

```
{
   "PoolARN": "string"
}
```

## Response Elements
<a name="API_CreateTapePool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PoolARN](#API_CreateTapePool_ResponseSyntax) **   <a name="StorageGateway-CreateTapePool-response-PoolARN"></a>
The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the [ListTapePools](API_ListTapePools.md) operation to return a list of tape pools for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_CreateTapePool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_CreateTapePool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateTapePool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateTapePool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateTapePool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateTapePool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateTapePool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateTapePool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateTapePool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateTapePool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateTapePool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateTapePool) 

# CreateTapes
<a name="API_CreateTapes"></a>

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

**Note**  
Cache storage must be allocated to the gateway before you can create virtual tapes. Use the [AddCache](API_AddCache.md) operation to add cache storage to a gateway.

## Request Syntax
<a name="API_CreateTapes_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "GatewayARN": "string",
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "NumTapesToCreate": number,
   "PoolId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TapeBarcodePrefix": "string",
   "TapeSizeInBytes": number,
   "Worm": boolean
}
```

## Request Parameters
<a name="API_CreateTapes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-ClientToken"></a>
A unique identifier that you use to retry a request. If you retry a request, use the same `ClientToken` you specified in the initial request.  
Using the same `ClientToken` prevents creating the tape multiple times.
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 100.  
Required: Yes

 ** [GatewayARN](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-GatewayARN"></a>
The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [KMSEncrypted](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-KMSEncrypted"></a>
Set to `true` to use Amazon S3 server-side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSKey](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-KMSKey"></a>
The Amazon Resource Name (ARN) of a symmetric AWS KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value can only be set when `KMSEncrypted` is `true`. Optional.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** [NumTapesToCreate](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-NumTapesToCreate"></a>
The number of virtual tapes that you want to create.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: Yes

 ** [PoolId](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-PoolId"></a>
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [Tags](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-Tags"></a>
A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [TapeBarcodePrefix](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-TapeBarcodePrefix"></a>
A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.  
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4.  
Pattern: `^[A-Z]*$`   
Required: Yes

 ** [TapeSizeInBytes](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-TapeSizeInBytes"></a>
The size, in bytes, of the virtual tapes that you want to create.  
The size must be aligned by gigabyte (1024\$11024\$11024 bytes).
Type: Long  
Required: Yes

 ** [Worm](#API_CreateTapes_RequestSyntax) **   <a name="StorageGateway-CreateTapes-request-Worm"></a>
Set to `TRUE` if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_CreateTapes_ResponseSyntax"></a>

```
{
   "TapeARNs": [ "string" ]
}
```

## Response Elements
<a name="API_CreateTapes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARNs](#API_CreateTapes_ResponseSyntax) **   <a name="StorageGateway-CreateTapes-response-TapeARNs"></a>
A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.  
Type: Array of strings  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$` 

## Errors
<a name="API_CreateTapes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CreateTapes_Examples"></a>

### Create tapes in a tape gateway
<a name="API_CreateTapes_Example_1"></a>

In the following request, you add three virtual tape cartridges, 100 GB each in size, to the tape gateway with the ID sgw-12A3456B. The tapes appear in the gateway's virtual tape library. In the request, you set the tape's barcode prefix to "TEST".

#### Sample Request
<a name="API_CreateTapes_Example_1_Request"></a>

```
{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B",
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "TapeSizeInBytes": "107374182400",
    "ClientToken": "77777",
    "NumTapesToCreate": "3",
    "PooId": "Deep_Archive",
    "TapeBarcodePrefix": "TEST"
}
```

#### Sample Response
<a name="API_CreateTapes_Example_1_Response"></a>

```
{
    "TapeARNs": [
        "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST38A29D",
        "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST3AA29F",
        "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST3BA29E"
    ]
}
```

## See Also
<a name="API_CreateTapes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateTapes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateTapes) 

# CreateTapeWithBarcode
<a name="API_CreateTapeWithBarcode"></a>

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

**Note**  
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the [AddCache](API_AddCache.md) operation to add cache storage to a gateway.

## Request Syntax
<a name="API_CreateTapeWithBarcode_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "PoolId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TapeBarcode": "string",
   "TapeSizeInBytes": number,
   "Worm": boolean
}
```

## Request Parameters
<a name="API_CreateTapeWithBarcode_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_CreateTapeWithBarcode_RequestSyntax) **   <a name="StorageGateway-CreateTapeWithBarcode-request-GatewayARN"></a>
The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [KMSEncrypted](#API_CreateTapeWithBarcode_RequestSyntax) **   <a name="StorageGateway-CreateTapeWithBarcode-request-KMSEncrypted"></a>
Set to `true` to use Amazon S3 server-side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSKey](#API_CreateTapeWithBarcode_RequestSyntax) **   <a name="StorageGateway-CreateTapeWithBarcode-request-KMSKey"></a>
The Amazon Resource Name (ARN) of a symmetric AWS KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value can only be set when `KMSEncrypted` is `true`. Optional.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** [PoolId](#API_CreateTapeWithBarcode_RequestSyntax) **   <a name="StorageGateway-CreateTapeWithBarcode-request-PoolId"></a>
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [Tags](#API_CreateTapeWithBarcode_RequestSyntax) **   <a name="StorageGateway-CreateTapeWithBarcode-request-Tags"></a>
A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [TapeBarcode](#API_CreateTapeWithBarcode_RequestSyntax) **   <a name="StorageGateway-CreateTapeWithBarcode-request-TapeBarcode"></a>
The barcode that you want to assign to the tape.  
Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 16.  
Pattern: `^[A-Z0-9]*$`   
Required: Yes

 ** [TapeSizeInBytes](#API_CreateTapeWithBarcode_RequestSyntax) **   <a name="StorageGateway-CreateTapeWithBarcode-request-TapeSizeInBytes"></a>
The size, in bytes, of the virtual tape that you want to create.  
The size must be aligned by gigabyte (1024\$11024\$11024 bytes).
Type: Long  
Required: Yes

 ** [Worm](#API_CreateTapeWithBarcode_RequestSyntax) **   <a name="StorageGateway-CreateTapeWithBarcode-request-Worm"></a>
Set to `TRUE` if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_CreateTapeWithBarcode_ResponseSyntax"></a>

```
{
   "TapeARN": "string"
}
```

## Response Elements
<a name="API_CreateTapeWithBarcode_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARN](#API_CreateTapeWithBarcode_ResponseSyntax) **   <a name="StorageGateway-CreateTapeWithBarcode-response-TapeARN"></a>
A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$` 

## Errors
<a name="API_CreateTapeWithBarcode_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_CreateTapeWithBarcode_Examples"></a>

### Create a tape with your own barcode in a tape gateway
<a name="API_CreateTapeWithBarcode_Example_1"></a>

In the following request, you add a 100 GB tape cartridge to the tape gateway with the ID sgw-12A3456B. The tape appears in the gateway's virtual tape library. In the request, you set the barcode to "TEST12345".

#### Sample Request
<a name="API_CreateTapeWithBarcode_Example_1_Request"></a>

```
{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B",
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "TapeSizeInBytes": "107374182400",
    "PooId": "Deep_Archive",
    "TapeBarcode": "TEST12345"
}
```

#### Sample Response
<a name="API_CreateTapeWithBarcode_Example_1_Response"></a>

```
{
    "TapeARN": [
        "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST12345"
    ]
}
```

## See Also
<a name="API_CreateTapeWithBarcode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/CreateTapeWithBarcode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/CreateTapeWithBarcode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/CreateTapeWithBarcode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/CreateTapeWithBarcode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/CreateTapeWithBarcode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/CreateTapeWithBarcode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/CreateTapeWithBarcode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/CreateTapeWithBarcode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/CreateTapeWithBarcode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/CreateTapeWithBarcode) 

# DeleteAutomaticTapeCreationPolicy
<a name="API_DeleteAutomaticTapeCreationPolicy"></a>

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

## Request Syntax
<a name="API_DeleteAutomaticTapeCreationPolicy_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DeleteAutomaticTapeCreationPolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DeleteAutomaticTapeCreationPolicy_RequestSyntax) **   <a name="StorageGateway-DeleteAutomaticTapeCreationPolicy-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DeleteAutomaticTapeCreationPolicy_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_DeleteAutomaticTapeCreationPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_DeleteAutomaticTapeCreationPolicy_ResponseSyntax) **   <a name="StorageGateway-DeleteAutomaticTapeCreationPolicy-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DeleteAutomaticTapeCreationPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DeleteAutomaticTapeCreationPolicy_Examples"></a>

### Example request
<a name="API_DeleteAutomaticTapeCreationPolicy_Example_1"></a>

The following example shows a request that deletes the automatic tape creation policy of the gateway.

#### Sample Request
<a name="API_DeleteAutomaticTapeCreationPolicy_Example_1_Request"></a>

```
{
    "GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw-tan"
}
```

#### Sample Response
<a name="API_DeleteAutomaticTapeCreationPolicy_Example_1_Response"></a>

```
{
    "GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw-tan"
}
```

## See Also
<a name="API_DeleteAutomaticTapeCreationPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicy) 

# DeleteBandwidthRateLimit
<a name="API_DeleteBandwidthRateLimit"></a>

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

## Request Syntax
<a name="API_DeleteBandwidthRateLimit_RequestSyntax"></a>

```
{
   "BandwidthType": "string",
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DeleteBandwidthRateLimit_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BandwidthType](#API_DeleteBandwidthRateLimit_RequestSyntax) **   <a name="StorageGateway-DeleteBandwidthRateLimit-request-BandwidthType"></a>
One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.  
Valid Values: `UPLOAD` \$1 `DOWNLOAD` \$1 `ALL`   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 25.  
Required: Yes

 ** [GatewayARN](#API_DeleteBandwidthRateLimit_RequestSyntax) **   <a name="StorageGateway-DeleteBandwidthRateLimit-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DeleteBandwidthRateLimit_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_DeleteBandwidthRateLimit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_DeleteBandwidthRateLimit_ResponseSyntax) **   <a name="StorageGateway-DeleteBandwidthRateLimit-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DeleteBandwidthRateLimit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DeleteBandwidthRateLimit_Examples"></a>

### Example request
<a name="API_DeleteBandwidthRateLimit_Example_1"></a>

The following example shows a request that deletes both of the bandwidth rate limits of a gateway.

#### Sample Request
<a name="API_DeleteBandwidthRateLimit_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DeleteBandwidthRateLimit

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "BandwidthType": "All"
}
```

#### Sample Response
<a name="API_DeleteBandwidthRateLimit_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_DeleteBandwidthRateLimit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteBandwidthRateLimit) 

# DeleteCacheReport
<a name="API_DeleteCacheReport"></a>

Deletes the specified cache report and any associated tags from the AWS Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use `CancelCacheReport` to cancel an IN-PROGRESS report.

**Note**  
 `DeleteCacheReport` does not delete the report object from your Amazon S3 bucket.

## Request Syntax
<a name="API_DeleteCacheReport_RequestSyntax"></a>

```
{
   "CacheReportARN": "string"
}
```

## Request Parameters
<a name="API_DeleteCacheReport_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CacheReportARN](#API_DeleteCacheReport_RequestSyntax) **   <a name="StorageGateway-DeleteCacheReport-request-CacheReportARN"></a>
The Amazon Resource Name (ARN) of the cache report you want to delete.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DeleteCacheReport_ResponseSyntax"></a>

```
{
   "CacheReportARN": "string"
}
```

## Response Elements
<a name="API_DeleteCacheReport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CacheReportARN](#API_DeleteCacheReport_ResponseSyntax) **   <a name="StorageGateway-DeleteCacheReport-response-CacheReportARN"></a>
The Amazon Resource Name (ARN) of the cache report you want to delete.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DeleteCacheReport_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DeleteCacheReport_Examples"></a>

### Cancel a cache report
<a name="API_DeleteCacheReport_Example_1"></a>

The following example deletes metadate for the cache report with the specified ARN, without removing the report object from Amazon S3.

#### Sample Request
<a name="API_DeleteCacheReport_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DeleteCacheReport

{
    "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234/cache-report/report-ABCD1234"
}
```

#### Sample Response
<a name="API_DeleteCacheReport_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234/cache-report/report-ABCD1234"
}
```

## See Also
<a name="API_DeleteCacheReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteCacheReport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteCacheReport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteCacheReport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteCacheReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteCacheReport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteCacheReport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteCacheReport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteCacheReport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteCacheReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteCacheReport) 

# DeleteChapCredentials
<a name="API_DeleteChapCredentials"></a>

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

## Request Syntax
<a name="API_DeleteChapCredentials_RequestSyntax"></a>

```
{
   "InitiatorName": "string",
   "TargetARN": "string"
}
```

## Request Parameters
<a name="API_DeleteChapCredentials_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InitiatorName](#API_DeleteChapCredentials_RequestSyntax) **   <a name="StorageGateway-DeleteChapCredentials-request-InitiatorName"></a>
The iSCSI initiator that connects to the target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[0-9a-z:.-]+`   
Required: Yes

 ** [TargetARN](#API_DeleteChapCredentials_RequestSyntax) **   <a name="StorageGateway-DeleteChapCredentials-request-TargetARN"></a>
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the [DescribeStorediSCSIVolumes](API_DescribeStorediSCSIVolumes.md) operation to return to retrieve the TargetARN for specified VolumeARN.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.  
Required: Yes

## Response Syntax
<a name="API_DeleteChapCredentials_ResponseSyntax"></a>

```
{
   "InitiatorName": "string",
   "TargetARN": "string"
}
```

## Response Elements
<a name="API_DeleteChapCredentials_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InitiatorName](#API_DeleteChapCredentials_ResponseSyntax) **   <a name="StorageGateway-DeleteChapCredentials-response-InitiatorName"></a>
The iSCSI initiator that connects to the target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[0-9a-z:.-]+` 

 ** [TargetARN](#API_DeleteChapCredentials_ResponseSyntax) **   <a name="StorageGateway-DeleteChapCredentials-response-TargetARN"></a>
The Amazon Resource Name (ARN) of the target.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.

## Errors
<a name="API_DeleteChapCredentials_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DeleteChapCredentials_Examples"></a>

### Example request
<a name="API_DeleteChapCredentials_Example_1"></a>

The following example shows a request that deletes the CHAP credentials for an iSCSI target `myvolume`.

#### Sample Request
<a name="API_DeleteChapCredentials_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DeleteChapCredentials

{
    "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
    "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com"
}
```

#### Sample Response
<a name="API_DeleteChapCredentials_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 161

{
    "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
    "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com"
}
```

## See Also
<a name="API_DeleteChapCredentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteChapCredentials) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteChapCredentials) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteChapCredentials) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteChapCredentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteChapCredentials) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteChapCredentials) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteChapCredentials) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteChapCredentials) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteChapCredentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteChapCredentials) 

# DeleteFileShare
<a name="API_DeleteFileShare"></a>

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

## Request Syntax
<a name="API_DeleteFileShare_RequestSyntax"></a>

```
{
   "FileShareARN": "string",
   "ForceDelete": boolean
}
```

## Request Parameters
<a name="API_DeleteFileShare_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FileShareARN](#API_DeleteFileShare_RequestSyntax) **   <a name="StorageGateway-DeleteFileShare-request-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share to be deleted.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [ForceDelete](#API_DeleteFileShare_RequestSyntax) **   <a name="StorageGateway-DeleteFileShare-request-ForceDelete"></a>
If this value is set to `true`, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the `FORCE_DELETING` status.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

## Response Syntax
<a name="API_DeleteFileShare_ResponseSyntax"></a>

```
{
   "FileShareARN": "string"
}
```

## Response Elements
<a name="API_DeleteFileShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileShareARN](#API_DeleteFileShare_ResponseSyntax) **   <a name="StorageGateway-DeleteFileShare-response-FileShareARN"></a>
The Amazon Resource Name (ARN) of the deleted file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DeleteFileShare_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DeleteFileShare_Examples"></a>

### Delete a file share
<a name="API_DeleteFileShare_Example_1"></a>

In the following request, you delete a file share from a S3 File Gateway.

#### Sample Request
<a name="API_DeleteFileShare_Example_1_Request"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXXX"
}
```

#### Sample Response
<a name="API_DeleteFileShare_Example_1_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXXX"
}
```

## See Also
<a name="API_DeleteFileShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteFileShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteFileShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteFileShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteFileShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteFileShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteFileShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteFileShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteFileShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteFileShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteFileShare) 

# DeleteGateway
<a name="API_DeleteGateway"></a>

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

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

**Important**  
You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the [Storage Gateway detail page](http://aws.amazon.com/storagegateway).

## Request Syntax
<a name="API_DeleteGateway_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DeleteGateway_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DeleteGateway_RequestSyntax) **   <a name="StorageGateway-DeleteGateway-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DeleteGateway_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_DeleteGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_DeleteGateway_ResponseSyntax) **   <a name="StorageGateway-DeleteGateway-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DeleteGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DeleteGateway_Examples"></a>

### Delete a gateway
<a name="API_DeleteGateway_Example_1"></a>

The following example shows a request that deactivates a gateway.

#### Sample Request
<a name="API_DeleteGateway_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DeleteGateway

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_DeleteGateway_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_DeleteGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteGateway) 

# DeleteSnapshotSchedule
<a name="API_DeleteSnapshotSchedule"></a>

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see [Backing up your volumes](https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html). In the `DeleteSnapshotSchedule` request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.

**Note**  
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to [DescribeSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) in the *Amazon Elastic Compute Cloud API Reference*.

## Request Syntax
<a name="API_DeleteSnapshotSchedule_RequestSyntax"></a>

```
{
   "VolumeARN": "string"
}
```

## Request Parameters
<a name="API_DeleteSnapshotSchedule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [VolumeARN](#API_DeleteSnapshotSchedule_RequestSyntax) **   <a name="StorageGateway-DeleteSnapshotSchedule-request-VolumeARN"></a>
The volume which snapshot schedule to delete.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_DeleteSnapshotSchedule_ResponseSyntax"></a>

```
{
   "VolumeARN": "string"
}
```

## Response Elements
<a name="API_DeleteSnapshotSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VolumeARN](#API_DeleteSnapshotSchedule_ResponseSyntax) **   <a name="StorageGateway-DeleteSnapshotSchedule-response-VolumeARN"></a>
The volume which snapshot schedule was deleted.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

## Errors
<a name="API_DeleteSnapshotSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DeleteSnapshotSchedule_Examples"></a>

### Example request
<a name="API_DeleteSnapshotSchedule_Example_1"></a>

The following example shows a request that deletes a snapshot schedule.

#### Sample Request
<a name="API_DeleteSnapshotSchedule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20130630.DeleteSnapshotSchedule

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

#### Sample Response
<a name="API_DeleteSnapshotSchedule_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 137

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

## See Also
<a name="API_DeleteSnapshotSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteSnapshotSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteSnapshotSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteSnapshotSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteSnapshotSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteSnapshotSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteSnapshotSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteSnapshotSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteSnapshotSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteSnapshotSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteSnapshotSchedule) 

# DeleteTape
<a name="API_DeleteTape"></a>

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

## Request Syntax
<a name="API_DeleteTape_RequestSyntax"></a>

```
{
   "BypassGovernanceRetention": boolean,
   "GatewayARN": "string",
   "TapeARN": "string"
}
```

## Request Parameters
<a name="API_DeleteTape_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BypassGovernanceRetention](#API_DeleteTape_RequestSyntax) **   <a name="StorageGateway-DeleteTape-request-BypassGovernanceRetention"></a>
Set to `TRUE` to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to `governance` can be deleted. Archived tapes with tape retention lock set to `compliance` can't be deleted.  
Type: Boolean  
Required: No

 ** [GatewayARN](#API_DeleteTape_RequestSyntax) **   <a name="StorageGateway-DeleteTape-request-GatewayARN"></a>
The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [TapeARN](#API_DeleteTape_RequestSyntax) **   <a name="StorageGateway-DeleteTape-request-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape to delete.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: Yes

## Response Syntax
<a name="API_DeleteTape_ResponseSyntax"></a>

```
{
   "TapeARN": "string"
}
```

## Response Elements
<a name="API_DeleteTape_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARN](#API_DeleteTape_ResponseSyntax) **   <a name="StorageGateway-DeleteTape-response-TapeARN"></a>
The Amazon Resource Name (ARN) of the deleted virtual tape.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$` 

## Errors
<a name="API_DeleteTape_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DeleteTape_Examples"></a>

### Delete a tape from a gateway
<a name="API_DeleteTape_Example_1"></a>

The following example deletes a tape from a tape gateway with ID sgw-12A3456B. The request identifies the tape by its ARN. The operation deletes the tapes from the specified gateway's virtual tape library (VTL). In the response, tape gateway returns the ARN of deleted tape.

#### Sample Request
<a name="API_DeleteTape_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20131025T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9EXAMPLE
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DeleteTape

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:123456789012:gateway/sgw-12A3456B",
    "TapeARN": "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST05A2A0"
}
```

#### Sample Response
<a name="API_DeleteTape_Example_1_Response"></a>

```
{
    "TapeARN": "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST05A2A0"
}
```

## See Also
<a name="API_DeleteTape_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteTape) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteTape) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteTape) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteTape) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteTape) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteTape) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteTape) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteTape) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteTape) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteTape) 

# DeleteTapeArchive
<a name="API_DeleteTapeArchive"></a>

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

## Request Syntax
<a name="API_DeleteTapeArchive_RequestSyntax"></a>

```
{
   "BypassGovernanceRetention": boolean,
   "TapeARN": "string"
}
```

## Request Parameters
<a name="API_DeleteTapeArchive_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BypassGovernanceRetention](#API_DeleteTapeArchive_RequestSyntax) **   <a name="StorageGateway-DeleteTapeArchive-request-BypassGovernanceRetention"></a>
Set to `TRUE` to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to `governance` can be deleted. Archived tapes with tape retention lock set to `compliance` can't be deleted.  
Type: Boolean  
Required: No

 ** [TapeARN](#API_DeleteTapeArchive_RequestSyntax) **   <a name="StorageGateway-DeleteTapeArchive-request-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: Yes

## Response Syntax
<a name="API_DeleteTapeArchive_ResponseSyntax"></a>

```
{
   "TapeARN": "string"
}
```

## Response Elements
<a name="API_DeleteTapeArchive_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARN](#API_DeleteTapeArchive_ResponseSyntax) **   <a name="StorageGateway-DeleteTapeArchive-response-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$` 

## Errors
<a name="API_DeleteTapeArchive_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_DeleteTapeArchive_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteTapeArchive) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteTapeArchive) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteTapeArchive) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteTapeArchive) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteTapeArchive) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteTapeArchive) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteTapeArchive) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteTapeArchive) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteTapeArchive) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteTapeArchive) 

# DeleteTapePool
<a name="API_DeleteTapePool"></a>

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

## Request Syntax
<a name="API_DeleteTapePool_RequestSyntax"></a>

```
{
   "PoolARN": "string"
}
```

## Request Parameters
<a name="API_DeleteTapePool_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [PoolARN](#API_DeleteTapePool_RequestSyntax) **   <a name="StorageGateway-DeleteTapePool-request-PoolARN"></a>
The Amazon Resource Name (ARN) of the custom tape pool to delete.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DeleteTapePool_ResponseSyntax"></a>

```
{
   "PoolARN": "string"
}
```

## Response Elements
<a name="API_DeleteTapePool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PoolARN](#API_DeleteTapePool_ResponseSyntax) **   <a name="StorageGateway-DeleteTapePool-response-PoolARN"></a>
The Amazon Resource Name (ARN) of the custom tape pool being deleted.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DeleteTapePool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_DeleteTapePool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteTapePool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteTapePool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteTapePool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteTapePool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteTapePool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteTapePool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteTapePool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteTapePool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteTapePool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteTapePool) 

# DeleteVolume
<a name="API_DeleteVolume"></a>

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

Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to [DescribeSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) in the *Amazon Elastic Compute Cloud API Reference*.

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

## Request Syntax
<a name="API_DeleteVolume_RequestSyntax"></a>

```
{
   "VolumeARN": "string"
}
```

## Request Parameters
<a name="API_DeleteVolume_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [VolumeARN](#API_DeleteVolume_RequestSyntax) **   <a name="StorageGateway-DeleteVolume-request-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume. Use the [ListVolumes](API_ListVolumes.md) operation to return a list of gateway volumes.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_DeleteVolume_ResponseSyntax"></a>

```
{
   "VolumeARN": "string"
}
```

## Response Elements
<a name="API_DeleteVolume_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VolumeARN](#API_DeleteVolume_ResponseSyntax) **   <a name="StorageGateway-DeleteVolume-response-VolumeARN"></a>
The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

## Errors
<a name="API_DeleteVolume_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DeleteVolume_Examples"></a>

### Example request
<a name="API_DeleteVolume_Example_1"></a>

The following example shows a request that deletes a volume.

#### Sample Request
<a name="API_DeleteVolume_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DeleteVolume

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

#### Sample Response
<a name="API_DeleteVolume_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 99

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

## See Also
<a name="API_DeleteVolume_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DeleteVolume) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DeleteVolume) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DeleteVolume) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DeleteVolume) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DeleteVolume) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DeleteVolume) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DeleteVolume) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DeleteVolume) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DeleteVolume) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DeleteVolume) 

# DescribeAvailabilityMonitorTest
<a name="API_DescribeAvailabilityMonitorTest"></a>

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.

## Request Syntax
<a name="API_DescribeAvailabilityMonitorTest_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DescribeAvailabilityMonitorTest_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeAvailabilityMonitorTest_RequestSyntax) **   <a name="StorageGateway-DescribeAvailabilityMonitorTest-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeAvailabilityMonitorTest_ResponseSyntax"></a>

```
{
   "GatewayARN": "string",
   "StartTime": number,
   "Status": "string"
}
```

## Response Elements
<a name="API_DescribeAvailabilityMonitorTest_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_DescribeAvailabilityMonitorTest_ResponseSyntax) **   <a name="StorageGateway-DescribeAvailabilityMonitorTest-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [StartTime](#API_DescribeAvailabilityMonitorTest_ResponseSyntax) **   <a name="StorageGateway-DescribeAvailabilityMonitorTest-response-StartTime"></a>
The time the high availability monitoring test was started. If a test hasn't been performed, the value of this field is null.  
Type: Timestamp

 ** [Status](#API_DescribeAvailabilityMonitorTest_ResponseSyntax) **   <a name="StorageGateway-DescribeAvailabilityMonitorTest-response-Status"></a>
The status of the high availability monitoring test. If a test hasn't been performed, the value of this field is null.  
Type: String  
Valid Values: `COMPLETE | FAILED | PENDING` 

## Errors
<a name="API_DescribeAvailabilityMonitorTest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_DescribeAvailabilityMonitorTest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeAvailabilityMonitorTest) 

# DescribeBandwidthRateLimit
<a name="API_DescribeBandwidthRateLimit"></a>

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

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

## Request Syntax
<a name="API_DescribeBandwidthRateLimit_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DescribeBandwidthRateLimit_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeBandwidthRateLimit_RequestSyntax) **   <a name="StorageGateway-DescribeBandwidthRateLimit-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeBandwidthRateLimit_ResponseSyntax"></a>

```
{
   "AverageDownloadRateLimitInBitsPerSec": number,
   "AverageUploadRateLimitInBitsPerSec": number,
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_DescribeBandwidthRateLimit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AverageDownloadRateLimitInBitsPerSec](#API_DescribeBandwidthRateLimit_ResponseSyntax) **   <a name="StorageGateway-DescribeBandwidthRateLimit-response-AverageDownloadRateLimitInBitsPerSec"></a>
The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.  
Type: Long  
Valid Range: Minimum value of 102400.

 ** [AverageUploadRateLimitInBitsPerSec](#API_DescribeBandwidthRateLimit_ResponseSyntax) **   <a name="StorageGateway-DescribeBandwidthRateLimit-response-AverageUploadRateLimitInBitsPerSec"></a>
The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.  
Type: Long  
Valid Range: Minimum value of 51200.

 ** [GatewayARN](#API_DescribeBandwidthRateLimit_ResponseSyntax) **   <a name="StorageGateway-DescribeBandwidthRateLimit-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DescribeBandwidthRateLimit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeBandwidthRateLimit_Examples"></a>

### Example request
<a name="API_DescribeBandwidthRateLimit_Example_1"></a>

The following example shows a request that returns the bandwidth throttle properties of a gateway.

#### Sample Request
<a name="API_DescribeBandwidthRateLimit_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeBandwidthRateLimit

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_DescribeBandwidthRateLimit_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 169

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "AverageUploadRateLimitInBitsPerSec": "102400",
    "AverageDownloadRateLimitInBitsPerSec": "51200"
}
```

## See Also
<a name="API_DescribeBandwidthRateLimit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeBandwidthRateLimit) 

# DescribeBandwidthRateLimitSchedule
<a name="API_DescribeBandwidthRateLimitSchedule"></a>

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

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

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

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

## Request Syntax
<a name="API_DescribeBandwidthRateLimitSchedule_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DescribeBandwidthRateLimitSchedule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeBandwidthRateLimitSchedule_RequestSyntax) **   <a name="StorageGateway-DescribeBandwidthRateLimitSchedule-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeBandwidthRateLimitSchedule_ResponseSyntax"></a>

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageDownloadRateLimitInBitsPerSec": number,
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_DescribeBandwidthRateLimitSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BandwidthRateLimitIntervals](#API_DescribeBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="StorageGateway-DescribeBandwidthRateLimitSchedule-response-BandwidthRateLimitIntervals"></a>
 An array that contains the bandwidth rate limit intervals for a tape or volume gateway.   
Type: Array of [BandwidthRateLimitInterval](API_BandwidthRateLimitInterval.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

 ** [GatewayARN](#API_DescribeBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="StorageGateway-DescribeBandwidthRateLimitSchedule-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DescribeBandwidthRateLimitSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_DescribeBandwidthRateLimitSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeBandwidthRateLimitSchedule) 

# DescribeCache
<a name="API_DescribeCache"></a>

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

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

## Request Syntax
<a name="API_DescribeCache_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DescribeCache_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeCache_RequestSyntax) **   <a name="StorageGateway-DescribeCache-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeCache_ResponseSyntax"></a>

```
{
   "CacheAllocatedInBytes": number,
   "CacheDirtyPercentage": number,
   "CacheHitPercentage": number,
   "CacheMissPercentage": number,
   "CacheUsedPercentage": number,
   "DiskIds": [ "string" ],
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_DescribeCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CacheAllocatedInBytes](#API_DescribeCache_ResponseSyntax) **   <a name="StorageGateway-DescribeCache-response-CacheAllocatedInBytes"></a>
The amount of cache in bytes allocated to a gateway.  
Type: Long

 ** [CacheDirtyPercentage](#API_DescribeCache_ResponseSyntax) **   <a name="StorageGateway-DescribeCache-response-CacheDirtyPercentage"></a>
The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to AWS. The sample is taken at the end of the reporting period.  
Type: Double

 ** [CacheHitPercentage](#API_DescribeCache_ResponseSyntax) **   <a name="StorageGateway-DescribeCache-response-CacheHitPercentage"></a>
Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.  
Type: Double

 ** [CacheMissPercentage](#API_DescribeCache_ResponseSyntax) **   <a name="StorageGateway-DescribeCache-response-CacheMissPercentage"></a>
Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.  
Type: Double

 ** [CacheUsedPercentage](#API_DescribeCache_ResponseSyntax) **   <a name="StorageGateway-DescribeCache-response-CacheUsedPercentage"></a>
Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.  
Type: Double

 ** [DiskIds](#API_DescribeCache_ResponseSyntax) **   <a name="StorageGateway-DescribeCache-response-DiskIds"></a>
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the [ListLocalDisks](API_ListLocalDisks.md) API.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 300.

 ** [GatewayARN](#API_DescribeCache_ResponseSyntax) **   <a name="StorageGateway-DescribeCache-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DescribeCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeCache_Examples"></a>

### Return information about a gateway's cache
<a name="API_DescribeCache_Example_1"></a>

The following example shows a request to obtain a description of a gateway's working storage.

#### Sample Request
<a name="API_DescribeCache_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20130630.DescribeCache

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_DescribeCache_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 271

{
    "CacheAllocationInBytes": "2199023255552",
    "CacheDirtyPercentage": "0.07",
    "CacheHitPercentage": "99.68",
    "CacheMissPercentage": "0.32",
    "CacheUsedPercentage": "0.07",
    "DiskIds": [
        "pci-0000:03:00.0-scsi-0:0:0:0",
        "pci-0000:04:00.0-scsi-0:1:0:0"
    ],
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_DescribeCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeCache) 

# DescribeCachediSCSIVolumes
<a name="API_DescribeCachediSCSIVolumes"></a>

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

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

## Request Syntax
<a name="API_DescribeCachediSCSIVolumes_RequestSyntax"></a>

```
{
   "VolumeARNs": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeCachediSCSIVolumes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [VolumeARNs](#API_DescribeCachediSCSIVolumes_RequestSyntax) **   <a name="StorageGateway-DescribeCachediSCSIVolumes-request-VolumeARNs"></a>
An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use [ListVolumes](API_ListVolumes.md) to get volume ARNs for a gateway.  
Type: Array of strings  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_DescribeCachediSCSIVolumes_ResponseSyntax"></a>

```
{
   "CachediSCSIVolumes": [ 
      { 
         "CreatedDate": number,
         "KMSKey": "string",
         "SourceSnapshotId": "string",
         "TargetName": "string",
         "VolumeARN": "string",
         "VolumeAttachmentStatus": "string",
         "VolumeId": "string",
         "VolumeiSCSIAttributes": { 
            "ChapEnabled": boolean,
            "LunNumber": number,
            "NetworkInterfaceId": "string",
            "NetworkInterfacePort": number,
            "TargetARN": "string"
         },
         "VolumeProgress": number,
         "VolumeSizeInBytes": number,
         "VolumeStatus": "string",
         "VolumeType": "string",
         "VolumeUsedInBytes": number
      }
   ]
}
```

## Response Elements
<a name="API_DescribeCachediSCSIVolumes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CachediSCSIVolumes](#API_DescribeCachediSCSIVolumes_ResponseSyntax) **   <a name="StorageGateway-DescribeCachediSCSIVolumes-response-CachediSCSIVolumes"></a>
An array of objects where each object contains metadata about one cached volume.  
Type: Array of [CachediSCSIVolume](API_CachediSCSIVolume.md) objects

## Errors
<a name="API_DescribeCachediSCSIVolumes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeCachediSCSIVolumes_Examples"></a>

### Example request
<a name="API_DescribeCachediSCSIVolumes_Example_1"></a>

The following example shows a request that returns a description of a volume.

#### Sample Request
<a name="API_DescribeCachediSCSIVolumes_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20130630.DescribeCachediSCSIVolumes

{
    "VolumeARNs": [
        "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
    ]
}
```

#### Sample Response
<a name="API_DescribeCachediSCSIVolumes_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 664

{
    "CachediSCSIVolumes": [
        {
            "VolumeiSCSIAttributes": {
                "ChapEnabled": "true",
                "LunNumber": "0",
                "NetworkInterfaceId": "10.243.43.207",
                "NetworkInterfacePort": "3260",
                "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
            },
            "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
            "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
            "VolumeDiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
            "VolumeId": "vol-1122AABB",
            "VolumeSizeInBytes": "1099511627776",
            "VolumeStatus": "AVAILABLE",
            "VolumeType": "CACHED iSCSI",
            "VolumeUsedInBytes": "1090000000000"
        }
    ]
}
```

## See Also
<a name="API_DescribeCachediSCSIVolumes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeCachediSCSIVolumes) 

# DescribeCacheReport
<a name="API_DescribeCacheReport"></a>

Returns information about the specified cache report, including completion status and generation progress.

## Request Syntax
<a name="API_DescribeCacheReport_RequestSyntax"></a>

```
{
   "CacheReportARN": "string"
}
```

## Request Parameters
<a name="API_DescribeCacheReport_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CacheReportARN](#API_DescribeCacheReport_RequestSyntax) **   <a name="StorageGateway-DescribeCacheReport-request-CacheReportARN"></a>
The Amazon Resource Name (ARN) of the cache report you want to describe.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeCacheReport_ResponseSyntax"></a>

```
{
   "CacheReportInfo": { 
      "CacheReportARN": "string",
      "CacheReportStatus": "string",
      "EndTime": number,
      "ExclusionFilters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ],
      "FileShareARN": "string",
      "InclusionFilters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ],
      "LocationARN": "string",
      "ReportCompletionPercent": number,
      "ReportName": "string",
      "Role": "string",
      "StartTime": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DescribeCacheReport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CacheReportInfo](#API_DescribeCacheReport_ResponseSyntax) **   <a name="StorageGateway-DescribeCacheReport-response-CacheReportInfo"></a>
Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.  
Type: [CacheReportInfo](API_CacheReportInfo.md) object

## Errors
<a name="API_DescribeCacheReport_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeCacheReport_Examples"></a>

### Get information about a cache report
<a name="API_DescribeCacheReport_Example_1"></a>

The following example gets information about the cache report with the specified ARN.

#### Sample Request
<a name="API_DescribeCacheReport_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeCacheReport

{
    "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234/cache-report/report-ABCD1234"
}
```

#### Sample Response
<a name="API_DescribeCacheReport_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "CacheReportInfo": {
        "CacheReportARN": "arn:aws:storagegateway:us-east-1:0123456789012:share/share-ABCD1234/cache-report/report-ABCD1234",
        "CacheReportStatus": "COMPLETED",
        "ReportCompletionPercent": 100,
        "EndTime": "2025-02-11T21:32:09.535000+00:00",
        "Role": "arn:aws:iam::123456789012:role/bucket-access-role",
        "FileShareARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234",
        "LocationARN": "arn:aws:s3:::bucket-name",
        "StartTime": "2025-02-11T21:31:42.081000+00:00",
        "InclusionFilters": [
            {
                "Name": "UploadFailureReason",
                "Values": [
                    "InaccessibleStorageClass",
                    "ObjectMissing"
                ]
            }
        ],
        "ReportName": "cache_report-ABCD1234_1739309502081.csv",
        "Tags": []
    }
}
```

## See Also
<a name="API_DescribeCacheReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeCacheReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeCacheReport) 

# DescribeChapCredentials
<a name="API_DescribeChapCredentials"></a>

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.

## Request Syntax
<a name="API_DescribeChapCredentials_RequestSyntax"></a>

```
{
   "TargetARN": "string"
}
```

## Request Parameters
<a name="API_DescribeChapCredentials_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TargetARN](#API_DescribeChapCredentials_RequestSyntax) **   <a name="StorageGateway-DescribeChapCredentials-request-TargetARN"></a>
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the [DescribeStorediSCSIVolumes](API_DescribeStorediSCSIVolumes.md) operation to return to retrieve the TargetARN for specified VolumeARN.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.  
Required: Yes

## Response Syntax
<a name="API_DescribeChapCredentials_ResponseSyntax"></a>

```
{
   "ChapCredentials": [ 
      { 
         "InitiatorName": "string",
         "SecretToAuthenticateInitiator": "string",
         "SecretToAuthenticateTarget": "string",
         "TargetARN": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeChapCredentials_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChapCredentials](#API_DescribeChapCredentials_ResponseSyntax) **   <a name="StorageGateway-DescribeChapCredentials-response-ChapCredentials"></a>
An array of [ChapInfo](API_ChapInfo.md) objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:  
+  **InitiatorName**: The iSCSI initiator that connects to the target.
+  **SecretToAuthenticateInitiator**: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
+  **SecretToAuthenticateTarget**: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
+  **TargetARN**: The Amazon Resource Name (ARN) of the storage volume.
Type: Array of [ChapInfo](API_ChapInfo.md) objects

## Errors
<a name="API_DescribeChapCredentials_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeChapCredentials_Examples"></a>

### Example request
<a name="API_DescribeChapCredentials_Example_1"></a>

The following example shows a request that returns the CHAP credentials of an iSCSI target.

#### Sample Request
<a name="API_DescribeChapCredentials_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeChapCredentials

{
    "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
}
```

#### Sample Response
<a name="API_DescribeChapCredentials_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 235

{
    "ChapCredentials": {
        "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
        "SecretToAuthenticateInitiator": "111111111111",
        "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
        "SecretToAuthenticateTarget": "222222222222"
    }
}
```

## See Also
<a name="API_DescribeChapCredentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeChapCredentials) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeChapCredentials) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeChapCredentials) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeChapCredentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeChapCredentials) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeChapCredentials) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeChapCredentials) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeChapCredentials) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeChapCredentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeChapCredentials) 

# DescribeFileSystemAssociations
<a name="API_DescribeFileSystemAssociations"></a>

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

## Request Syntax
<a name="API_DescribeFileSystemAssociations_RequestSyntax"></a>

```
{
   "FileSystemAssociationARNList": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeFileSystemAssociations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FileSystemAssociationARNList](#API_DescribeFileSystemAssociations_RequestSyntax) **   <a name="StorageGateway-DescribeFileSystemAssociations-request-FileSystemAssociationARNList"></a>
An array containing the Amazon Resource Name (ARN) of each file system association to be described.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeFileSystemAssociations_ResponseSyntax"></a>

```
{
   "FileSystemAssociationInfoList": [ 
      { 
         "AuditDestinationARN": "string",
         "CacheAttributes": { 
            "CacheStaleTimeoutInSeconds": number
         },
         "EndpointNetworkConfiguration": { 
            "IpAddresses": [ "string" ]
         },
         "FileSystemAssociationARN": "string",
         "FileSystemAssociationStatus": "string",
         "FileSystemAssociationStatusDetails": [ 
            { 
               "ErrorCode": "string"
            }
         ],
         "GatewayARN": "string",
         "LocationARN": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_DescribeFileSystemAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileSystemAssociationInfoList](#API_DescribeFileSystemAssociations_ResponseSyntax) **   <a name="StorageGateway-DescribeFileSystemAssociations-response-FileSystemAssociationInfoList"></a>
An array containing the `FileSystemAssociationInfo` data type of each file system association to be described.   
Type: Array of [FileSystemAssociationInfo](API_FileSystemAssociationInfo.md) objects

## Errors
<a name="API_DescribeFileSystemAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeFileSystemAssociations_Examples"></a>

### Example
<a name="API_DescribeFileSystemAssociations_Example_1"></a>

This example illustrates one usage of DescribeFileSystemAssociations.

```
__Sample Request__
{
  "FileSystemAssociationARNList": ["arn:aws:storagegateway:us-east-1:111122223333:fs-association/fsa-1122AABBCCDDEEFFG"]
}
```

### Example
<a name="API_DescribeFileSystemAssociations_Example_2"></a>

This example illustrates one usage of DescribeFileSystemAssociations.

```
__Sample Response__
{
  "FileSystemAssociationInfoList":
  [
    
     "FileSystemAssociationARN": "arn:aws:storagegateway:us-east-1:111122223333:fs-association/fsa-1122AABBCCDDEEFFG",
     "FileSystemAssociationStatus": " AVAILABLE", 
     "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-7A8D6313",
     "LocationARN": "arn:aws:fsx:us-east-1:111122223333:file-system/fs-0bb4bf5cedebd814f",
     "Tags":
      []
    }
  ]
}
```

## See Also
<a name="API_DescribeFileSystemAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeFileSystemAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeFileSystemAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeFileSystemAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeFileSystemAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeFileSystemAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeFileSystemAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeFileSystemAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeFileSystemAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeFileSystemAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeFileSystemAssociations) 

# DescribeGatewayInformation
<a name="API_DescribeGatewayInformation"></a>

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

## Request Syntax
<a name="API_DescribeGatewayInformation_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DescribeGatewayInformation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeGatewayInformation_RequestSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeGatewayInformation_ResponseSyntax"></a>

```
{
   "CloudWatchLogGroupARN": "string",
   "DeprecationDate": "string",
   "Ec2InstanceId": "string",
   "Ec2InstanceRegion": "string",
   "EndpointType": "string",
   "GatewayARN": "string",
   "GatewayCapacity": "string",
   "GatewayId": "string",
   "GatewayName": "string",
   "GatewayNetworkInterfaces": [ 
      { 
         "Ipv4Address": "string",
         "Ipv6Address": "string",
         "MacAddress": "string"
      }
   ],
   "GatewayState": "string",
   "GatewayTimezone": "string",
   "GatewayType": "string",
   "HostEnvironment": "string",
   "HostEnvironmentId": "string",
   "LastSoftwareUpdate": "string",
   "NextUpdateAvailabilityDate": "string",
   "SoftwareUpdatesEndDate": "string",
   "SoftwareVersion": "string",
   "SupportedGatewayCapacities": [ "string" ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VPCEndpoint": "string"
}
```

## Response Elements
<a name="API_DescribeGatewayInformation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CloudWatchLogGroupARN](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-CloudWatchLogGroupARN"></a>
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM  
Type: String  
Length Constraints: Maximum length of 562.

 ** [DeprecationDate](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-DeprecationDate"></a>
Date after which this gateway will not receive software updates for new features and bug fixes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.

 ** [Ec2InstanceId](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-Ec2InstanceId"></a>
The ID of the Amazon EC2 instance that was used to launch the gateway.  
Type: String

 ** [Ec2InstanceRegion](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-Ec2InstanceRegion"></a>
The AWS Region where the Amazon EC2 instance is located.  
Type: String

 ** [EndpointType](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-EndpointType"></a>
The type of endpoint for your gateway.  
Valid Values: `STANDARD` \$1 `FIPS`   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 8.

 ** [GatewayARN](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [GatewayCapacity](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-GatewayCapacity"></a>
Specifies the size of the gateway's metadata cache.  
Type: String  
Valid Values: `Small | Medium | Large` 

 ** [GatewayId](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-GatewayId"></a>
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 30.

 ** [GatewayName](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-GatewayName"></a>
The name you configured for your gateway.  
Type: String

 ** [GatewayNetworkInterfaces](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-GatewayNetworkInterfaces"></a>
A [NetworkInterface](API_NetworkInterface.md) array that contains descriptions of the gateway network interfaces.  
Type: Array of [NetworkInterface](API_NetworkInterface.md) objects

 ** [GatewayState](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-GatewayState"></a>
A value that indicates the operating state of the gateway.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 25.

 ** [GatewayTimezone](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-GatewayTimezone"></a>
A value that indicates the time zone configured for the gateway.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 10.

 ** [GatewayType](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-GatewayType"></a>
The type of the gateway.  
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit [this blog post](https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/).
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 20.

 ** [HostEnvironment](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-HostEnvironment"></a>
The type of hardware or software platform on which the gateway is running.  
Tape Gateway is no longer available on Snow Family devices.
Type: String  
Valid Values: `VMWARE | HYPER-V | EC2 | KVM | OTHER | SNOWBALL` 

 ** [HostEnvironmentId](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-HostEnvironmentId"></a>
A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [LastSoftwareUpdate](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-LastSoftwareUpdate"></a>
The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.

 ** [NextUpdateAvailabilityDate](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-NextUpdateAvailabilityDate"></a>
The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.

 ** [SoftwareUpdatesEndDate](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-SoftwareUpdatesEndDate"></a>
Date after which this gateway will not receive software updates for new features.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.

 ** [SoftwareVersion](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-SoftwareVersion"></a>
The version number of the software running on the gateway appliance.  
Type: String

 ** [SupportedGatewayCapacities](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-SupportedGatewayCapacities"></a>
A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.  
Type: Array of strings  
Valid Values: `Small | Medium | Large` 

 ** [Tags](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-Tags"></a>
A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the `ListTagsForResource` API operation.  
Type: Array of [Tag](API_Tag.md) objects

 ** [VPCEndpoint](#API_DescribeGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-DescribeGatewayInformation-response-VPCEndpoint"></a>
The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.  
Type: String

## Errors
<a name="API_DescribeGatewayInformation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeGatewayInformation_Examples"></a>

### Return metadata about a gateway
<a name="API_DescribeGatewayInformation_Example_1"></a>

The following example shows a request for describing a gateway.

#### Sample Request
<a name="API_DescribeGatewayInformation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeGatewayInformation

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_DescribeGatewayInformation_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 227

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "GatewayId": "sgw-AABB1122",
    "GatewayNetworkInterfaces": [
        {
            "Ipv4Address": "10.35.69.216"
        }
    ],
    "GatewayState": "STATE_RUNNING",
    "GatewayTimezone": "GMT-8:00",
    "LastSoftwareUpdate": "2015-01-02T16:00:00",
    "NextUpdateAvailabilityDate": "2016-01-02T16:00:00"
}
```

## See Also
<a name="API_DescribeGatewayInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeGatewayInformation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeGatewayInformation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeGatewayInformation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeGatewayInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeGatewayInformation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeGatewayInformation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeGatewayInformation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeGatewayInformation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeGatewayInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeGatewayInformation) 

# DescribeMaintenanceStartTime
<a name="API_DescribeMaintenanceStartTime"></a>

Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time values returned are for the gateway's time zone.

## Request Syntax
<a name="API_DescribeMaintenanceStartTime_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DescribeMaintenanceStartTime_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeMaintenanceStartTime_RequestSyntax) **   <a name="StorageGateway-DescribeMaintenanceStartTime-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeMaintenanceStartTime_ResponseSyntax"></a>

```
{
   "DayOfMonth": number,
   "DayOfWeek": number,
   "GatewayARN": "string",
   "HourOfDay": number,
   "MinuteOfHour": number,
   "SoftwareUpdatePreferences": { 
      "AutomaticUpdatePolicy": "string"
   },
   "Timezone": "string"
}
```

## Response Elements
<a name="API_DescribeMaintenanceStartTime_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DayOfMonth](#API_DescribeMaintenanceStartTime_ResponseSyntax) **   <a name="StorageGateway-DescribeMaintenanceStartTime-response-DayOfMonth"></a>
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 28.

 ** [DayOfWeek](#API_DescribeMaintenanceStartTime_ResponseSyntax) **   <a name="StorageGateway-DescribeMaintenanceStartTime-response-DayOfWeek"></a>
An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 6.

 ** [GatewayARN](#API_DescribeMaintenanceStartTime_ResponseSyntax) **   <a name="StorageGateway-DescribeMaintenanceStartTime-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [HourOfDay](#API_DescribeMaintenanceStartTime_ResponseSyntax) **   <a name="StorageGateway-DescribeMaintenanceStartTime-response-HourOfDay"></a>
The hour component of the maintenance start time represented as *hh*, where *hh* is the hour (0 to 23). The hour of the day is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.

 ** [MinuteOfHour](#API_DescribeMaintenanceStartTime_ResponseSyntax) **   <a name="StorageGateway-DescribeMaintenanceStartTime-response-MinuteOfHour"></a>
The minute component of the maintenance start time represented as *mm*, where *mm* is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 59.

 ** [SoftwareUpdatePreferences](#API_DescribeMaintenanceStartTime_ResponseSyntax) **   <a name="StorageGateway-DescribeMaintenanceStartTime-response-SoftwareUpdatePreferences"></a>
A set of variables indicating the software update preferences for the gateway.  
Includes `AutomaticUpdatePolicy` parameter with the following inputs:  
 `ALL_VERSIONS` - Enables regular gateway maintenance updates.  
 `EMERGENCY_VERSIONS_ONLY` - Disables regular gateway maintenance updates. The gateway will still receive emergency version updates on rare occasions if necessary to remedy highly critical security or durability issues. You will be notified before an emergency version update is applied. These updates are applied during your gateway's scheduled maintenance window.  
Type: [SoftwareUpdatePreferences](API_SoftwareUpdatePreferences.md) object

 ** [Timezone](#API_DescribeMaintenanceStartTime_ResponseSyntax) **   <a name="StorageGateway-DescribeMaintenanceStartTime-response-Timezone"></a>
A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 10.

## Errors
<a name="API_DescribeMaintenanceStartTime_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeMaintenanceStartTime_Examples"></a>

### Return information about a gateway's maintenance window
<a name="API_DescribeMaintenanceStartTime_Example_1"></a>

The following example shows a request that describes a gateway's maintenance window.

#### Sample Request
<a name="API_DescribeMaintenanceStartTime_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeMaintenanceStartTime

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_DescribeMaintenanceStartTime_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 136

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "DayOfMonth": "28",
    "DayOfWeek": "2",
    "HourOfDay": "15",
    "MinuteOfHour": "35",
    "Timezone": "GMT+7:00"
}
```

## See Also
<a name="API_DescribeMaintenanceStartTime_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeMaintenanceStartTime) 

# DescribeNFSFileShares
<a name="API_DescribeNFSFileShares"></a>

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.

## Request Syntax
<a name="API_DescribeNFSFileShares_RequestSyntax"></a>

```
{
   "FileShareARNList": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeNFSFileShares_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FileShareARNList](#API_DescribeNFSFileShares_RequestSyntax) **   <a name="StorageGateway-DescribeNFSFileShares-request-FileShareARNList"></a>
An array containing the Amazon Resource Name (ARN) of each file share to be described.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeNFSFileShares_ResponseSyntax"></a>

```
{
   "NFSFileShareInfoList": [ 
      { 
         "AuditDestinationARN": "string",
         "BucketRegion": "string",
         "CacheAttributes": { 
            "CacheStaleTimeoutInSeconds": number
         },
         "ClientList": [ "string" ],
         "DefaultStorageClass": "string",
         "EncryptionType": "string",
         "FileShareARN": "string",
         "FileShareId": "string",
         "FileShareName": "string",
         "FileShareStatus": "string",
         "GatewayARN": "string",
         "GuessMIMETypeEnabled": boolean,
         "KMSEncrypted": boolean,
         "KMSKey": "string",
         "LocationARN": "string",
         "NFSFileShareDefaults": { 
            "DirectoryMode": "string",
            "FileMode": "string",
            "GroupId": number,
            "OwnerId": number
         },
         "NotificationPolicy": "string",
         "ObjectACL": "string",
         "Path": "string",
         "ReadOnly": boolean,
         "RequesterPays": boolean,
         "Role": "string",
         "Squash": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "VPCEndpointDNSName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeNFSFileShares_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NFSFileShareInfoList](#API_DescribeNFSFileShares_ResponseSyntax) **   <a name="StorageGateway-DescribeNFSFileShares-response-NFSFileShareInfoList"></a>
An array containing a description for each requested file share.  
Type: Array of [NFSFileShareInfo](API_NFSFileShareInfo.md) objects

## Errors
<a name="API_DescribeNFSFileShares_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeNFSFileShares_Examples"></a>

### Describe an NFS file share
<a name="API_DescribeNFSFileShares_Example_1"></a>

In the following request, you get the description for a single file share identified by its Amazon Resource Name (ARN).

#### Sample Request
<a name="API_DescribeNFSFileShares_Example_1_Request"></a>

```
{
    "FileShareARNList": [
        "arn:aws:storagegateway:us-east-2:204469490176:share/share-XXXXXX"
    ]
}
```

#### Sample Response
<a name="API_DescribeNFSFileShares_Example_1_Response"></a>

```
{
    "NFSFileShareInfoList": [
        {
            "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
            "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXXX",
            "FileShareId": "share-XXXXXXXX",
            "FileShareStatus": "AVAILABLE",
            "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-YYYYYYYY",
            "GuessMIMETypeEnabled": "true",
            "KMSEncrypted": "true",
            "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
            "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket",
            "NFSFileShareDefaults": {
                "DirectoryMode": "0777",
                "FileMode": "0777",
                "GroupId": "500",
                "OwnerId": "500"
            },
            "ObjectACL": "bucket-owner-full-control",
            "ReadOnly": "false",
            "Path": "/my-path-alpha",
            "RequesterPays": "false",
            "Role": "arn:aws:iam::111122223333:role/my-role"
        }
    ]
}
```

## See Also
<a name="API_DescribeNFSFileShares_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeNFSFileShares) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeNFSFileShares) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeNFSFileShares) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeNFSFileShares) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeNFSFileShares) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeNFSFileShares) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeNFSFileShares) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeNFSFileShares) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeNFSFileShares) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeNFSFileShares) 

# DescribeSMBFileShares
<a name="API_DescribeSMBFileShares"></a>

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.

## Request Syntax
<a name="API_DescribeSMBFileShares_RequestSyntax"></a>

```
{
   "FileShareARNList": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeSMBFileShares_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FileShareARNList](#API_DescribeSMBFileShares_RequestSyntax) **   <a name="StorageGateway-DescribeSMBFileShares-request-FileShareARNList"></a>
An array containing the Amazon Resource Name (ARN) of each file share to be described.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeSMBFileShares_ResponseSyntax"></a>

```
{
   "SMBFileShareInfoList": [ 
      { 
         "AccessBasedEnumeration": boolean,
         "AdminUserList": [ "string" ],
         "AuditDestinationARN": "string",
         "Authentication": "string",
         "BucketRegion": "string",
         "CacheAttributes": { 
            "CacheStaleTimeoutInSeconds": number
         },
         "CaseSensitivity": "string",
         "DefaultStorageClass": "string",
         "EncryptionType": "string",
         "FileShareARN": "string",
         "FileShareId": "string",
         "FileShareName": "string",
         "FileShareStatus": "string",
         "GatewayARN": "string",
         "GuessMIMETypeEnabled": boolean,
         "InvalidUserList": [ "string" ],
         "KMSEncrypted": boolean,
         "KMSKey": "string",
         "LocationARN": "string",
         "NotificationPolicy": "string",
         "ObjectACL": "string",
         "OplocksEnabled": boolean,
         "Path": "string",
         "ReadOnly": boolean,
         "RequesterPays": boolean,
         "Role": "string",
         "SMBACLEnabled": boolean,
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "ValidUserList": [ "string" ],
         "VPCEndpointDNSName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeSMBFileShares_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SMBFileShareInfoList](#API_DescribeSMBFileShares_ResponseSyntax) **   <a name="StorageGateway-DescribeSMBFileShares-response-SMBFileShareInfoList"></a>
An array containing a description for each requested file share.  
Type: Array of [SMBFileShareInfo](API_SMBFileShareInfo.md) objects

## Errors
<a name="API_DescribeSMBFileShares_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeSMBFileShares_Examples"></a>

### Describe an SMB file share
<a name="API_DescribeSMBFileShares_Example_1"></a>

In the following request, you get the description for a single SMB file share identified by its Amazon Resource Name (ARN).

#### Sample Request
<a name="API_DescribeSMBFileShares_Example_1_Request"></a>

```
{
    "FileShareARNList": [
        "arn:aws:storagegateway:us-east-2:204469490176:share/share-XXXXXX"
    ]
}
```

#### Sample Response
<a name="API_DescribeSMBFileShares_Example_1_Response"></a>

```
{
    "SMBFileShareInfoList": [
        {
            "Authentication": "ActiveDirectory",
            "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
            "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXXX",
            "FileShareId": "share-XXXXXXXX",
            "FileShareStatus": "AVAILABLE",
            "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-YYYYYYYY",
            "GuessMIMETypeEnabled": "true",
            "InvalidUserList": [
                "user1",
                "user2"
            ],
            "KMSEncrypted": "false",
            "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket",
            "ObjectACL": "bucket-owner-full-control",
            "Path": "/my-path-alpha",
            "ReadOnly": "false",
            "RequesterPays": "false",
            "Role": "arn:aws:iam::111122223333:role/my-role",
            "ValidUserList": [
                "user3",
                "user4"
            ]
        }
    ]
}
```

## See Also
<a name="API_DescribeSMBFileShares_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeSMBFileShares) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeSMBFileShares) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeSMBFileShares) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeSMBFileShares) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeSMBFileShares) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeSMBFileShares) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeSMBFileShares) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeSMBFileShares) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeSMBFileShares) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeSMBFileShares) 

# DescribeSMBSettings
<a name="API_DescribeSMBSettings"></a>

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

## Request Syntax
<a name="API_DescribeSMBSettings_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DescribeSMBSettings_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeSMBSettings_RequestSyntax) **   <a name="StorageGateway-DescribeSMBSettings-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeSMBSettings_ResponseSyntax"></a>

```
{
   "ActiveDirectoryStatus": "string",
   "DomainName": "string",
   "FileSharesVisible": boolean,
   "GatewayARN": "string",
   "SMBGuestPasswordSet": boolean,
   "SMBLocalGroups": { 
      "GatewayAdmins": [ "string" ]
   },
   "SMBSecurityStrategy": "string"
}
```

## Response Elements
<a name="API_DescribeSMBSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ActiveDirectoryStatus](#API_DescribeSMBSettings_ResponseSyntax) **   <a name="StorageGateway-DescribeSMBSettings-response-ActiveDirectoryStatus"></a>
Indicates the status of a gateway that is a member of the Active Directory domain.  
This field is only used as part of a `JoinDomain` request. It is not affected by Active Directory connectivity changes that occur after the `JoinDomain` request succeeds.
+  `ACCESS_DENIED`: Indicates that the `JoinDomain` operation failed due to an authentication error.
+  `DETACHED`: Indicates that gateway is not joined to a domain.
+  `JOINED`: Indicates that the gateway has successfully joined a domain.
+  `JOINING`: Indicates that a `JoinDomain` operation is in progress.
+  `NETWORK_ERROR`: Indicates that `JoinDomain` operation failed due to a network or connectivity error.
+  `TIMEOUT`: Indicates that the `JoinDomain` operation failed because the operation didn't complete within the allotted time.
+  `UNKNOWN_ERROR`: Indicates that the `JoinDomain` operation failed due to another type of error.
Type: String  
Valid Values: `ACCESS_DENIED | DETACHED | JOINED | JOINING | NETWORK_ERROR | TIMEOUT | UNKNOWN_ERROR | INSUFFICIENT_PERMISSIONS` 

 ** [DomainName](#API_DescribeSMBSettings_ResponseSyntax) **   <a name="StorageGateway-DescribeSMBSettings-response-DomainName"></a>
The name of the domain that the gateway is joined to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$` 

 ** [FileSharesVisible](#API_DescribeSMBSettings_ResponseSyntax) **   <a name="StorageGateway-DescribeSMBSettings-response-FileSharesVisible"></a>
The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.   
Type: Boolean

 ** [GatewayARN](#API_DescribeSMBSettings_ResponseSyntax) **   <a name="StorageGateway-DescribeSMBSettings-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [SMBGuestPasswordSet](#API_DescribeSMBSettings_ResponseSyntax) **   <a name="StorageGateway-DescribeSMBSettings-response-SMBGuestPasswordSet"></a>
This value is `true` if a password for the guest user `smbguest` is set, otherwise `false`. Only supported for S3 File Gateways.  
Valid Values: `true` \$1 `false`   
Type: Boolean

 ** [SMBLocalGroups](#API_DescribeSMBSettings_ResponseSyntax) **   <a name="StorageGateway-DescribeSMBSettings-response-SMBLocalGroups"></a>
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.  
Type: [SMBLocalGroups](API_SMBLocalGroups.md) object

 ** [SMBSecurityStrategy](#API_DescribeSMBSettings_ResponseSyntax) **   <a name="StorageGateway-DescribeSMBSettings-response-SMBSecurityStrategy"></a>
The type of security strategy that was specified for file gateway.  
+  `ClientSpecified`: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.
+  `MandatorySigning`: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later. 
+  `MandatoryEncryption`: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.
+  `MandatoryEncryptionNoAes128`: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.
Type: String  
Valid Values: `ClientSpecified | MandatorySigning | MandatoryEncryption | MandatoryEncryptionNoAes128` 

## Errors
<a name="API_DescribeSMBSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_DescribeSMBSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeSMBSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeSMBSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeSMBSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeSMBSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeSMBSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeSMBSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeSMBSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeSMBSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeSMBSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeSMBSettings) 

# DescribeSnapshotSchedule
<a name="API_DescribeSnapshotSchedule"></a>

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

## Request Syntax
<a name="API_DescribeSnapshotSchedule_RequestSyntax"></a>

```
{
   "VolumeARN": "string"
}
```

## Request Parameters
<a name="API_DescribeSnapshotSchedule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [VolumeARN](#API_DescribeSnapshotSchedule_RequestSyntax) **   <a name="StorageGateway-DescribeSnapshotSchedule-request-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume. Use the [ListVolumes](API_ListVolumes.md) operation to return a list of gateway volumes.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_DescribeSnapshotSchedule_ResponseSyntax"></a>

```
{
   "Description": "string",
   "RecurrenceInHours": number,
   "StartAt": number,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Timezone": "string",
   "VolumeARN": "string"
}
```

## Response Elements
<a name="API_DescribeSnapshotSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Description](#API_DescribeSnapshotSchedule_ResponseSyntax) **   <a name="StorageGateway-DescribeSnapshotSchedule-response-Description"></a>
The snapshot description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [RecurrenceInHours](#API_DescribeSnapshotSchedule_ResponseSyntax) **   <a name="StorageGateway-DescribeSnapshotSchedule-response-RecurrenceInHours"></a>
The number of hours between snapshots.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 24.

 ** [StartAt](#API_DescribeSnapshotSchedule_ResponseSyntax) **   <a name="StorageGateway-DescribeSnapshotSchedule-response-StartAt"></a>
The hour of the day at which the snapshot schedule begins represented as *hh*, where *hh* is the hour (0 to 23). The hour of the day is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.

 ** [Tags](#API_DescribeSnapshotSchedule_ResponseSyntax) **   <a name="StorageGateway-DescribeSnapshotSchedule-response-Tags"></a>
A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the `ListTagsForResource` API operation.  
Type: Array of [Tag](API_Tag.md) objects

 ** [Timezone](#API_DescribeSnapshotSchedule_ResponseSyntax) **   <a name="StorageGateway-DescribeSnapshotSchedule-response-Timezone"></a>
A value that indicates the time zone of the gateway.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 10.

 ** [VolumeARN](#API_DescribeSnapshotSchedule_ResponseSyntax) **   <a name="StorageGateway-DescribeSnapshotSchedule-response-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume that was specified in the request.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

## Errors
<a name="API_DescribeSnapshotSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeSnapshotSchedule_Examples"></a>

### Example request
<a name="API_DescribeSnapshotSchedule_Example_1"></a>

The following example shows a request that retrieves the snapshot schedule for a volume.

#### Sample Request
<a name="API_DescribeSnapshotSchedule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeSnapshotSchedule

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

#### Sample Response
<a name="API_DescribeSnapshotSchedule_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 211

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
    "StartAt": "6",
    "RecurrenceInHours": "24",
    "Description": "sgw-AABB1122:vol-AABB1122:Schedule",
    "Timezone": "GMT+7:00"
}
```

## See Also
<a name="API_DescribeSnapshotSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeSnapshotSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeSnapshotSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeSnapshotSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeSnapshotSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeSnapshotSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeSnapshotSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeSnapshotSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeSnapshotSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeSnapshotSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeSnapshotSchedule) 

# DescribeStorediSCSIVolumes
<a name="API_DescribeStorediSCSIVolumes"></a>

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

## Request Syntax
<a name="API_DescribeStorediSCSIVolumes_RequestSyntax"></a>

```
{
   "VolumeARNs": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeStorediSCSIVolumes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [VolumeARNs](#API_DescribeStorediSCSIVolumes_RequestSyntax) **   <a name="StorageGateway-DescribeStorediSCSIVolumes-request-VolumeARNs"></a>
An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use [ListVolumes](API_ListVolumes.md) to get volume ARNs for a gateway.  
Type: Array of strings  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_DescribeStorediSCSIVolumes_ResponseSyntax"></a>

```
{
   "StorediSCSIVolumes": [ 
      { 
         "CreatedDate": number,
         "KMSKey": "string",
         "PreservedExistingData": boolean,
         "SourceSnapshotId": "string",
         "TargetName": "string",
         "VolumeARN": "string",
         "VolumeAttachmentStatus": "string",
         "VolumeDiskId": "string",
         "VolumeId": "string",
         "VolumeiSCSIAttributes": { 
            "ChapEnabled": boolean,
            "LunNumber": number,
            "NetworkInterfaceId": "string",
            "NetworkInterfacePort": number,
            "TargetARN": "string"
         },
         "VolumeProgress": number,
         "VolumeSizeInBytes": number,
         "VolumeStatus": "string",
         "VolumeType": "string",
         "VolumeUsedInBytes": number
      }
   ]
}
```

## Response Elements
<a name="API_DescribeStorediSCSIVolumes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [StorediSCSIVolumes](#API_DescribeStorediSCSIVolumes_ResponseSyntax) **   <a name="StorageGateway-DescribeStorediSCSIVolumes-response-StorediSCSIVolumes"></a>
Describes a single unit of output from [DescribeStorediSCSIVolumes](#API_DescribeStorediSCSIVolumes). The following fields are returned:  
+  `ChapEnabled`: Indicates whether mutual CHAP is enabled for the iSCSI target.
+  `LunNumber`: The logical disk number.
+  `NetworkInterfaceId`: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.
+  `NetworkInterfacePort`: The port used to communicate with iSCSI targets.
+  `PreservedExistingData`: Indicates when the stored volume was created, existing data on the underlying local disk was preserved.
+  `SourceSnapshotId`: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. `snap-1122aabb`. Otherwise, this field is not included.
+  `StorediSCSIVolumes`: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.
+  `TargetARN`: The Amazon Resource Name (ARN) of the volume target.
+  `VolumeARN`: The Amazon Resource Name (ARN) of the stored volume.
+  `VolumeDiskId`: The disk ID of the local disk that was specified in the [CreateStorediSCSIVolume](API_CreateStorediSCSIVolume.md) operation.
+  `VolumeId`: The unique identifier of the storage volume, e.g. `vol-1122AABB`.
+  `VolumeiSCSIAttributes`: An [VolumeiSCSIAttributes](API_VolumeiSCSIAttributes.md) object that represents a collection of iSCSI attributes for one stored volume.
+  `VolumeProgress`: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.
+  `VolumeSizeInBytes`: The size of the volume in bytes.
+  `VolumeStatus`: One of the `VolumeStatus` values that indicates the state of the volume.
+  `VolumeType`: One of the enumeration values describing the type of the volume. Currently, only `STORED` volumes are supported.
Type: Array of [StorediSCSIVolume](API_StorediSCSIVolume.md) objects

## Errors
<a name="API_DescribeStorediSCSIVolumes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeStorediSCSIVolumes_Examples"></a>

### Example request
<a name="API_DescribeStorediSCSIVolumes_Example_1"></a>

The following example shows a request that returns a description of a volume.

#### Sample Request
<a name="API_DescribeStorediSCSIVolumes_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeStorediSCSIVolumes

{
    "VolumeARNs": [
        "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
    ]
}
```

#### Sample Response
<a name="API_DescribeStorediSCSIVolumes_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 507

{
    "StorediSCSIVolumes": [
        {
            "VolumeiSCSIAttributes": {
                "ChapEnabled": "true",
                "NetworkInterfaceId": "10.243.43.207",
                "NetworkInterfacePort": "3260",
                "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
            },
            "KMSEncrypted": "false",
            "PreservedExistingData": "false",
            "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
            "VolumeDiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
            "VolumeId": "vol-1122AABB",
            "VolumeProgress": "23.7",
            "VolumeSizeInBytes": "1099511627776",
            "VolumeStatus": "BOOTSTRAPPING",
            "VolumeUsedInBytes": "1090000000000"
        }
    ]
}
```

## See Also
<a name="API_DescribeStorediSCSIVolumes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeStorediSCSIVolumes) 

# DescribeTapeArchives
<a name="API_DescribeTapeArchives"></a>

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

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

## Request Syntax
<a name="API_DescribeTapeArchives_RequestSyntax"></a>

```
{
   "Limit": number,
   "Marker": "string",
   "TapeARNs": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeTapeArchives_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Limit](#API_DescribeTapeArchives_RequestSyntax) **   <a name="StorageGateway-DescribeTapeArchives-request-Limit"></a>
Specifies that the number of virtual tapes described be limited to the specified number.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_DescribeTapeArchives_RequestSyntax) **   <a name="StorageGateway-DescribeTapeArchives-request-Marker"></a>
An opaque string that indicates the position at which to begin describing virtual tapes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [TapeARNs](#API_DescribeTapeArchives_RequestSyntax) **   <a name="StorageGateway-DescribeTapeArchives-request-TapeARNs"></a>
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.  
Type: Array of strings  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: No

## Response Syntax
<a name="API_DescribeTapeArchives_ResponseSyntax"></a>

```
{
   "Marker": "string",
   "TapeArchives": [ 
      { 
         "CompletionTime": number,
         "KMSKey": "string",
         "PoolEntryDate": number,
         "PoolId": "string",
         "RetentionStartDate": number,
         "RetrievedTo": "string",
         "TapeARN": "string",
         "TapeBarcode": "string",
         "TapeCreatedDate": number,
         "TapeSizeInBytes": number,
         "TapeStatus": "string",
         "TapeUsedInBytes": number,
         "Worm": boolean
      }
   ]
}
```

## Response Elements
<a name="API_DescribeTapeArchives_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Marker](#API_DescribeTapeArchives_ResponseSyntax) **   <a name="StorageGateway-DescribeTapeArchives-response-Marker"></a>
An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [TapeArchives](#API_DescribeTapeArchives_ResponseSyntax) **   <a name="StorageGateway-DescribeTapeArchives-response-TapeArchives"></a>
An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.  
Type: Array of [TapeArchive](API_TapeArchive.md) objects

## Errors
<a name="API_DescribeTapeArchives_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeTapeArchives_Examples"></a>

### Retrieve description tapes in VTS
<a name="API_DescribeTapeArchives_Example_1"></a>

The following example shows a request that retrieves description of two tapes archived to VTS in the AWS Region specified in the request. The request identifies the tapes by their ARN value. The trailing string in the ARN is the tape barcode. If you don't provide the tape ARN, the tape gateway returns information about all tapes archived to VTS.

#### Sample Request
<a name="API_DescribeTapeArchives_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20131028T120000Z
x-amz-target: StorageGateway_20130630.DescribeTapeArchives

{
    "TapeARNs": [
        "arn:aws:storagegateway:us-east-2:999999999999:tape/AM08A1AD",
        "arn:aws:storagegateway:us-east-2:999999999999:tape/AMZN01A2A4"
    ]
}
```

#### Sample Response
<a name="API_DescribeTapeArchives_Example_1_Response"></a>

```
{
    "TapeArchives": [
        {
            "CompletionTime": "1380308527.236",
            "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
            "TapeARN": "arn:aws:storagegateway:us-east-2:999999999:tape/AM08A1AD",
            "TapeBarcode": "AM08A1AD",
            "TapeSizeInBytes": "107374182400",
            "TapeStatus": "ARCHIVED"
        },
        {
            "CompletionTime": "1382918022.647",
            "TapeARN": "arn:aws:storagegateway:us-east-2:999999999:tape/AMZN01A2A4",
            "TapeBarcode": "AMZN01A2A4",
            "TapeSizeInBytes": "429496729600",
            "TapeStatus": "ARCHIVED"
        }
    ]
}
```

## See Also
<a name="API_DescribeTapeArchives_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeTapeArchives) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeTapeArchives) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeTapeArchives) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeTapeArchives) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeTapeArchives) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeTapeArchives) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeTapeArchives) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeTapeArchives) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeTapeArchives) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeTapeArchives) 

# DescribeTapeRecoveryPoints
<a name="API_DescribeTapeRecoveryPoints"></a>

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

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

## Request Syntax
<a name="API_DescribeTapeRecoveryPoints_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "Limit": number,
   "Marker": "string"
}
```

## Request Parameters
<a name="API_DescribeTapeRecoveryPoints_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeTapeRecoveryPoints_RequestSyntax) **   <a name="StorageGateway-DescribeTapeRecoveryPoints-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [Limit](#API_DescribeTapeRecoveryPoints_RequestSyntax) **   <a name="StorageGateway-DescribeTapeRecoveryPoints-request-Limit"></a>
Specifies that the number of virtual tape recovery points that are described be limited to the specified number.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_DescribeTapeRecoveryPoints_RequestSyntax) **   <a name="StorageGateway-DescribeTapeRecoveryPoints-request-Marker"></a>
An opaque string that indicates the position at which to begin describing the virtual tape recovery points.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_DescribeTapeRecoveryPoints_ResponseSyntax"></a>

```
{
   "GatewayARN": "string",
   "Marker": "string",
   "TapeRecoveryPointInfos": [ 
      { 
         "TapeARN": "string",
         "TapeRecoveryPointTime": number,
         "TapeSizeInBytes": number,
         "TapeStatus": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeTapeRecoveryPoints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_DescribeTapeRecoveryPoints_ResponseSyntax) **   <a name="StorageGateway-DescribeTapeRecoveryPoints-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [Marker](#API_DescribeTapeRecoveryPoints_ResponseSyntax) **   <a name="StorageGateway-DescribeTapeRecoveryPoints-response-Marker"></a>
An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.  
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [TapeRecoveryPointInfos](#API_DescribeTapeRecoveryPoints_ResponseSyntax) **   <a name="StorageGateway-DescribeTapeRecoveryPoints-response-TapeRecoveryPointInfos"></a>
An array of TapeRecoveryPointInfos that are available for the specified gateway.  
Type: Array of [TapeRecoveryPointInfo](API_TapeRecoveryPointInfo.md) objects

## Errors
<a name="API_DescribeTapeRecoveryPoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_DescribeTapeRecoveryPoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeTapeRecoveryPoints) 

# DescribeTapes
<a name="API_DescribeTapes"></a>

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

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

## Request Syntax
<a name="API_DescribeTapes_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "Limit": number,
   "Marker": "string",
   "TapeARNs": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeTapes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeTapes_RequestSyntax) **   <a name="StorageGateway-DescribeTapes-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [Limit](#API_DescribeTapes_RequestSyntax) **   <a name="StorageGateway-DescribeTapes-request-Limit"></a>
Specifies that the number of virtual tapes described be limited to the specified number.  
Amazon Web Services may impose its own limit, if this field is not set.
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_DescribeTapes_RequestSyntax) **   <a name="StorageGateway-DescribeTapes-request-Marker"></a>
A marker value, obtained in a previous call to `DescribeTapes`. This marker indicates which page of results to retrieve.  
If not specified, the first page of results is retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [TapeARNs](#API_DescribeTapes_RequestSyntax) **   <a name="StorageGateway-DescribeTapes-request-TapeARNs"></a>
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.  
Type: Array of strings  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: No

## Response Syntax
<a name="API_DescribeTapes_ResponseSyntax"></a>

```
{
   "Marker": "string",
   "Tapes": [ 
      { 
         "KMSKey": "string",
         "PoolEntryDate": number,
         "PoolId": "string",
         "Progress": number,
         "RetentionStartDate": number,
         "TapeARN": "string",
         "TapeBarcode": "string",
         "TapeCreatedDate": number,
         "TapeSizeInBytes": number,
         "TapeStatus": "string",
         "TapeUsedInBytes": number,
         "VTLDevice": "string",
         "Worm": boolean
      }
   ]
}
```

## Response Elements
<a name="API_DescribeTapes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Marker](#API_DescribeTapes_ResponseSyntax) **   <a name="StorageGateway-DescribeTapes-response-Marker"></a>
An opaque string that can be used as part of a subsequent `DescribeTapes` call to retrieve the next page of results.  
If a response does not contain a marker, then there are no more results to be retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [Tapes](#API_DescribeTapes_ResponseSyntax) **   <a name="StorageGateway-DescribeTapes-response-Tapes"></a>
An array of virtual tape descriptions.  
Type: Array of [Tape](API_Tape.md) objects

## Errors
<a name="API_DescribeTapes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeTapes_Examples"></a>

### Get descriptions of specific tapes
<a name="API_DescribeTapes_Example_1"></a>

In the following request you obtain descriptions of tapes in the tape gateway with ID sgw-12A3456B. The request identifies specific tapes by specifying ARNs for the tapes. In the ARN, the trailing string, for example "TEST04A2A1"- is the tape barcode value. The string 999999999999 is your account number.

#### Sample Request
<a name="API_DescribeTapes_Example_1_Request"></a>

```
{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B",
    "TapeARNs": [
        "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST04A2A1",
        "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST05A2A0"
    ]
}
```

#### Sample Response
<a name="API_DescribeTapes_Example_1_Response"></a>

```
{
    "Tapes": [
        {
            "TapeARN": "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST04A2A1",
            "TapeBarcode": "TEST04A2A1",
            "TapeSizeInBytes": "107374182400",
            "TapeStatus": "AVAILABLE"
        },
        {
            "TapeARN": "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST05A2A0",
            "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
            "TapeBarcode": "TEST05A2A0",
            "TapeSizeInBytes": "107374182400",
            "TapeStatus": "AVAILABLE"
        }
    ]
}
```

## See Also
<a name="API_DescribeTapes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeTapes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeTapes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeTapes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeTapes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeTapes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeTapes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeTapes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeTapes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeTapes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeTapes) 

# DescribeUploadBuffer
<a name="API_DescribeUploadBuffer"></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 includes the amount of upload buffer space allocated and used.

## Request Syntax
<a name="API_DescribeUploadBuffer_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DescribeUploadBuffer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeUploadBuffer_RequestSyntax) **   <a name="StorageGateway-DescribeUploadBuffer-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeUploadBuffer_ResponseSyntax"></a>

```
{
   "DiskIds": [ "string" ],
   "GatewayARN": "string",
   "UploadBufferAllocatedInBytes": number,
   "UploadBufferUsedInBytes": number
}
```

## Response Elements
<a name="API_DescribeUploadBuffer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DiskIds](#API_DescribeUploadBuffer_ResponseSyntax) **   <a name="StorageGateway-DescribeUploadBuffer-response-DiskIds"></a>
An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 300.

 ** [GatewayARN](#API_DescribeUploadBuffer_ResponseSyntax) **   <a name="StorageGateway-DescribeUploadBuffer-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [UploadBufferAllocatedInBytes](#API_DescribeUploadBuffer_ResponseSyntax) **   <a name="StorageGateway-DescribeUploadBuffer-response-UploadBufferAllocatedInBytes"></a>
The total number of bytes allocated in the gateway's as upload buffer.  
Type: Long

 ** [UploadBufferUsedInBytes](#API_DescribeUploadBuffer_ResponseSyntax) **   <a name="StorageGateway-DescribeUploadBuffer-response-UploadBufferUsedInBytes"></a>
The total number of bytes being used in the gateway's upload buffer.  
Type: Long

## Errors
<a name="API_DescribeUploadBuffer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeUploadBuffer_Examples"></a>

### Example request
<a name="API_DescribeUploadBuffer_Example_1"></a>

The following example shows a request to obtain a description of a gateway's working storage.

#### Sample Request
<a name="API_DescribeUploadBuffer_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20130630.DescribeUploadBuffer

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_DescribeUploadBuffer_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 271

{
    "DiskIds": [
        "pci-0000:03:00.0-scsi-0:0:0:0",
        "pci-0000:04:00.0-scsi-0:1:0:0"
    ],
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "UploadBufferAllocatedInBytes": "161061273600",
    "UploadBufferUsedInBytes": "0"
}
```

## See Also
<a name="API_DescribeUploadBuffer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeUploadBuffer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeUploadBuffer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeUploadBuffer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeUploadBuffer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeUploadBuffer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeUploadBuffer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeUploadBuffer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeUploadBuffer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeUploadBuffer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeUploadBuffer) 

# DescribeVTLDevices
<a name="API_DescribeVTLDevices"></a>

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.

## Request Syntax
<a name="API_DescribeVTLDevices_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "Limit": number,
   "Marker": "string",
   "VTLDeviceARNs": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeVTLDevices_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeVTLDevices_RequestSyntax) **   <a name="StorageGateway-DescribeVTLDevices-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [Limit](#API_DescribeVTLDevices_RequestSyntax) **   <a name="StorageGateway-DescribeVTLDevices-request-Limit"></a>
Specifies that the number of VTL devices described be limited to the specified number.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_DescribeVTLDevices_RequestSyntax) **   <a name="StorageGateway-DescribeVTLDevices-request-Marker"></a>
An opaque string that indicates the position at which to begin describing the VTL devices.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [VTLDeviceARNs](#API_DescribeVTLDevices_RequestSyntax) **   <a name="StorageGateway-DescribeVTLDevices-request-VTLDeviceARNs"></a>
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.  
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
Type: Array of strings  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_DescribeVTLDevices_ResponseSyntax"></a>

```
{
   "GatewayARN": "string",
   "Marker": "string",
   "VTLDevices": [ 
      { 
         "DeviceiSCSIAttributes": { 
            "ChapEnabled": boolean,
            "NetworkInterfaceId": "string",
            "NetworkInterfacePort": number,
            "TargetARN": "string"
         },
         "VTLDeviceARN": "string",
         "VTLDeviceProductIdentifier": "string",
         "VTLDeviceType": "string",
         "VTLDeviceVendor": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeVTLDevices_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_DescribeVTLDevices_ResponseSyntax) **   <a name="StorageGateway-DescribeVTLDevices-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [Marker](#API_DescribeVTLDevices_ResponseSyntax) **   <a name="StorageGateway-DescribeVTLDevices-response-Marker"></a>
An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [VTLDevices](#API_DescribeVTLDevices_ResponseSyntax) **   <a name="StorageGateway-DescribeVTLDevices-response-VTLDevices"></a>
An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.  
Type: Array of [VTLDevice](API_VTLDevice.md) objects

## Errors
<a name="API_DescribeVTLDevices_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeVTLDevices_Examples"></a>

### Get descriptions of the VTL devices on a gateway
<a name="API_DescribeVTLDevices_Example_1"></a>

The following example gets descriptions of all the VTL devices on a gateway with ID sgw-12A3456B. The request identifies the gateway by ARN. In the request, string 999999999999 is the account number associated with the AWS account sending the request. Note that the response shown is truncated, it shows the media changer and only two tape drives. The trailing string in each device ARN is the device ID.

#### Sample Request
<a name="API_DescribeVTLDevices_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20131025T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9EXAMPLE
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeVTLDevices

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_DescribeVTLDevices_Example_1_Response"></a>

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

## See Also
<a name="API_DescribeVTLDevices_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeVTLDevices) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeVTLDevices) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeVTLDevices) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeVTLDevices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeVTLDevices) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeVTLDevices) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeVTLDevices) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeVTLDevices) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeVTLDevices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeVTLDevices) 

# DescribeWorkingStorage
<a name="API_DescribeWorkingStorage"></a>

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.

**Note**  
Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

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

## Request Syntax
<a name="API_DescribeWorkingStorage_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DescribeWorkingStorage_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DescribeWorkingStorage_RequestSyntax) **   <a name="StorageGateway-DescribeWorkingStorage-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DescribeWorkingStorage_ResponseSyntax"></a>

```
{
   "DiskIds": [ "string" ],
   "GatewayARN": "string",
   "WorkingStorageAllocatedInBytes": number,
   "WorkingStorageUsedInBytes": number
}
```

## Response Elements
<a name="API_DescribeWorkingStorage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DiskIds](#API_DescribeWorkingStorage_ResponseSyntax) **   <a name="StorageGateway-DescribeWorkingStorage-response-DiskIds"></a>
An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 300.

 ** [GatewayARN](#API_DescribeWorkingStorage_ResponseSyntax) **   <a name="StorageGateway-DescribeWorkingStorage-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [WorkingStorageAllocatedInBytes](#API_DescribeWorkingStorage_ResponseSyntax) **   <a name="StorageGateway-DescribeWorkingStorage-response-WorkingStorageAllocatedInBytes"></a>
The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.  
Type: Long

 ** [WorkingStorageUsedInBytes](#API_DescribeWorkingStorage_ResponseSyntax) **   <a name="StorageGateway-DescribeWorkingStorage-response-WorkingStorageUsedInBytes"></a>
The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.  
Type: Long

## Errors
<a name="API_DescribeWorkingStorage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeWorkingStorage_Examples"></a>

### Example request
<a name="API_DescribeWorkingStorage_Example_1"></a>

The following example shows a request to obtain a description of a gateway's working storage.

#### Sample Request
<a name="API_DescribeWorkingStorage_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DescribeWorkingStorage

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_DescribeWorkingStorage_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 241

{
    "DiskIds": [
        "pci-0000:03:00.0-scsi-0:0:0:0",
        "pci-0000:03:00.0-scsi-0:0:1:0"
    ],
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "WorkingStorageAllocatedInBytes": "2199023255552",
    "WorkingStorageUsedInBytes": "789207040"
}
```

## See Also
<a name="API_DescribeWorkingStorage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DescribeWorkingStorage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DescribeWorkingStorage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DescribeWorkingStorage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DescribeWorkingStorage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DescribeWorkingStorage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DescribeWorkingStorage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DescribeWorkingStorage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DescribeWorkingStorage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DescribeWorkingStorage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DescribeWorkingStorage) 

# DetachVolume
<a name="API_DetachVolume"></a>

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

## Request Syntax
<a name="API_DetachVolume_RequestSyntax"></a>

```
{
   "ForceDetach": boolean,
   "VolumeARN": "string"
}
```

## Request Parameters
<a name="API_DetachVolume_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ForceDetach](#API_DetachVolume_RequestSyntax) **   <a name="StorageGateway-DetachVolume-request-ForceDetach"></a>
Set to `true` to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is `false`. If this value is set to `false`, you must manually disconnect the iSCSI connection from the target volume.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [VolumeARN](#API_DetachVolume_RequestSyntax) **   <a name="StorageGateway-DetachVolume-request-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume to detach from the gateway.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_DetachVolume_ResponseSyntax"></a>

```
{
   "VolumeARN": "string"
}
```

## Response Elements
<a name="API_DetachVolume_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VolumeARN](#API_DetachVolume_ResponseSyntax) **   <a name="StorageGateway-DetachVolume-response-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume that was detached.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

## Errors
<a name="API_DetachVolume_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DetachVolume_Examples"></a>

### Example request
<a name="API_DetachVolume_Example_1"></a>

The following example shows a request that detaches a volume from a gateway.

#### Sample Request
<a name="API_DetachVolume_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20181025T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DetachVolume

{
    "ForceDetach": "false",
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

#### Sample Response
<a name="API_DetachVolume_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Thu, 25 Oct 2018 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

## See Also
<a name="API_DetachVolume_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DetachVolume) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DetachVolume) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DetachVolume) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DetachVolume) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DetachVolume) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DetachVolume) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DetachVolume) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DetachVolume) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DetachVolume) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DetachVolume) 

# DisableGateway
<a name="API_DisableGateway"></a>

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

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

**Important**  
After a gateway is disabled, it cannot be enabled.

## Request Syntax
<a name="API_DisableGateway_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_DisableGateway_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_DisableGateway_RequestSyntax) **   <a name="StorageGateway-DisableGateway-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DisableGateway_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_DisableGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_DisableGateway_ResponseSyntax) **   <a name="StorageGateway-DisableGateway-response-GatewayARN"></a>
The unique Amazon Resource Name (ARN) of the disabled gateway.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DisableGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_DisableGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DisableGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DisableGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DisableGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DisableGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DisableGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DisableGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DisableGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DisableGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DisableGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DisableGateway) 

# DisassociateFileSystem
<a name="API_DisassociateFileSystem"></a>

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.

## Request Syntax
<a name="API_DisassociateFileSystem_RequestSyntax"></a>

```
{
   "FileSystemAssociationARN": "string",
   "ForceDelete": boolean
}
```

## Request Parameters
<a name="API_DisassociateFileSystem_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FileSystemAssociationARN](#API_DisassociateFileSystem_RequestSyntax) **   <a name="StorageGateway-DisassociateFileSystem-request-FileSystemAssociationARN"></a>
The Amazon Resource Name (ARN) of the file system association to be deleted.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [ForceDelete](#API_DisassociateFileSystem_RequestSyntax) **   <a name="StorageGateway-DisassociateFileSystem-request-ForceDelete"></a>
If this value is set to true, the operation disassociates an Amazon FSx file system immediately. It ends all data uploads to the file system, and the file system association enters the `FORCE_DELETING` status. If this value is set to false, the Amazon FSx file system does not disassociate until all data is uploaded.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_DisassociateFileSystem_ResponseSyntax"></a>

```
{
   "FileSystemAssociationARN": "string"
}
```

## Response Elements
<a name="API_DisassociateFileSystem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileSystemAssociationARN](#API_DisassociateFileSystem_ResponseSyntax) **   <a name="StorageGateway-DisassociateFileSystem-response-FileSystemAssociationARN"></a>
The Amazon Resource Name (ARN) of the deleted file system association.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_DisassociateFileSystem_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_DisassociateFileSystem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/DisassociateFileSystem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/DisassociateFileSystem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/DisassociateFileSystem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/DisassociateFileSystem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/DisassociateFileSystem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/DisassociateFileSystem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/DisassociateFileSystem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/DisassociateFileSystem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/DisassociateFileSystem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/DisassociateFileSystem) 

# EvictFilesFailingUpload
<a name="API_EvictFilesFailingUpload"></a>

Starts a process that cleans the specified file share's cache of file entries that are failing upload to Amazon S3. This API operation reports success if the request is received with valid arguments, and there are no other cache clean operations currently in-progress for the specified file share. After a successful request, the cache clean operation occurs asynchronously and reports progress using CloudWatch logs and notifications.

**Important**  
If `ForceRemove` is set to `True`, the cache clean operation will delete file data from the gateway which might otherwise be recoverable. We recommend using this operation only after all other methods to clear files failing upload have been exhausted, and if your business need outweighs the potential data loss.

## Request Syntax
<a name="API_EvictFilesFailingUpload_RequestSyntax"></a>

```
{
   "FileShareARN": "string",
   "ForceRemove": boolean
}
```

## Request Parameters
<a name="API_EvictFilesFailingUpload_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FileShareARN](#API_EvictFilesFailingUpload_RequestSyntax) **   <a name="StorageGateway-EvictFilesFailingUpload-request-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share for which you want to start the cache clean operation.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [ForceRemove](#API_EvictFilesFailingUpload_RequestSyntax) **   <a name="StorageGateway-EvictFilesFailingUpload-request-ForceRemove"></a>
Specifies whether cache entries with full or partial file data currently stored on the gateway will be forcibly removed by the cache clean operation.  
Valid arguments:  
+  `False` - The cache clean operation skips cache entries failing upload if they are associated with data currently stored on the gateway. This preserves the cached data.
+  `True` - The cache clean operation removes cache entries failing upload even if they are associated with data currently stored on the gateway. This deletes the cached data.
**Important**  
If `ForceRemove` is set to `True`, the cache clean operation will delete file data from the gateway which might otherwise be recoverable.
Type: Boolean  
Required: No

## Response Syntax
<a name="API_EvictFilesFailingUpload_ResponseSyntax"></a>

```
{
   "NotificationId": "string"
}
```

## Response Elements
<a name="API_EvictFilesFailingUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NotificationId](#API_EvictFilesFailingUpload_ResponseSyntax) **   <a name="StorageGateway-EvictFilesFailingUpload-response-NotificationId"></a>
The randomly generated ID of the CloudWatch notification associated with the cache clean operation. This ID is in UUID format.  
Type: String

## Errors
<a name="API_EvictFilesFailingUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_EvictFilesFailingUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/EvictFilesFailingUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/EvictFilesFailingUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/EvictFilesFailingUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/EvictFilesFailingUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/EvictFilesFailingUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/EvictFilesFailingUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/EvictFilesFailingUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/EvictFilesFailingUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/EvictFilesFailingUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/EvictFilesFailingUpload) 

# JoinDomain
<a name="API_JoinDomain"></a>

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

**Note**  
Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's **Gateway ID** as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.  
To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.

## Request Syntax
<a name="API_JoinDomain_RequestSyntax"></a>

```
{
   "DomainControllers": [ "string" ],
   "DomainName": "string",
   "GatewayARN": "string",
   "OrganizationalUnit": "string",
   "Password": "string",
   "TimeoutInSeconds": number,
   "UserName": "string"
}
```

## Request Parameters
<a name="API_JoinDomain_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainControllers](#API_JoinDomain_RequestSyntax) **   <a name="StorageGateway-JoinDomain-request-DomainControllers"></a>
List of IP addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, `mydc.mydomain.com:389`.  
S3 File Gateway supports IPv6 addresses in addition to IPv4 and other existing formats.  
FSx File Gateway does not support IPv6.
Type: Array of strings  
Length Constraints: Minimum length of 2. Maximum length of 1024.  
Pattern: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(:(\d+))?$|^(?:\[(?:(?:(?:[A-Fa-f0-9]{1,4}:){6}|(?=(?:[A-Fa-f0-9]{0,4}:){0,6}(?:[0-9]{1,3}\.){3}[0-9]{1,3}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){0,5}|:)(?:(?::[0-9A-Fa-f]{1,4}){1,5}:|:)|::(?:[A-Fa-f0-9]{1,4}:){5})(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}|(?=(?:[A-Fa-f0-9]{0,4}:){0,7}[A-Fa-f0-9]{0,4}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){1,7}|:)(?:(:[0-9A-Fa-f]{1,4}){1,7}|:)|(?:[A-Fa-f0-9]{1,4}:){7}:|:(:[A-Fa-f0-9]{1,4}){7})\]:\d+$|^(?:(?:(?:[A-Fa-f0-9]{1,4}:){6}|(?=(?:[A-Fa-f0-9]{0,4}:){0,6}(?:[0-9]{1,3}\.){3}[0-9]{1,3}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){0,5}|:)(?:(?::[0-9A-Fa-f]{1,4}){1,5}:|:)|::(?:[A-Fa-f0-9]{1,4}:){5})(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}|(?=(?:[A-Fa-f0-9]{0,4}:){0,7}[A-Fa-f0-9]{0,4}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){1,7}|:)(?:(:[0-9A-Fa-f]{1,4}){1,7}|:)|(?:[A-Fa-f0-9]{1,4}:){7}:|:(:[A-Fa-f0-9]{1,4}){7})$)`   
Required: No

 ** [DomainName](#API_JoinDomain_RequestSyntax) **   <a name="StorageGateway-JoinDomain-request-DomainName"></a>
The name of the domain that you want the gateway to join.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$`   
Required: Yes

 ** [GatewayARN](#API_JoinDomain_RequestSyntax) **   <a name="StorageGateway-JoinDomain-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the `ListGateways` operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [OrganizationalUnit](#API_JoinDomain_RequestSyntax) **   <a name="StorageGateway-JoinDomain-request-OrganizationalUnit"></a>
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [Password](#API_JoinDomain_RequestSyntax) **   <a name="StorageGateway-JoinDomain-request-Password"></a>
Sets the password of the user who has permission to add the gateway to the Active Directory domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[ -~]+$`   
Required: Yes

 ** [TimeoutInSeconds](#API_JoinDomain_RequestSyntax) **   <a name="StorageGateway-JoinDomain-request-TimeoutInSeconds"></a>
Specifies the time in seconds, in which the `JoinDomain` operation must complete. The default is 20 seconds.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 3600.  
Required: No

 ** [UserName](#API_JoinDomain_RequestSyntax) **   <a name="StorageGateway-JoinDomain-request-UserName"></a>
Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^\w[\w\.\- ]*$`   
Required: Yes

## Response Syntax
<a name="API_JoinDomain_ResponseSyntax"></a>

```
{
   "ActiveDirectoryStatus": "string",
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_JoinDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ActiveDirectoryStatus](#API_JoinDomain_ResponseSyntax) **   <a name="StorageGateway-JoinDomain-response-ActiveDirectoryStatus"></a>
Indicates the status of the gateway as a member of the Active Directory domain.  
This field is only used as part of a `JoinDomain` request. It is not affected by Active Directory connectivity changes that occur after the `JoinDomain` request succeeds.
+  `ACCESS_DENIED`: Indicates that the `JoinDomain` operation failed due to an authentication error.
+  `DETACHED`: Indicates that gateway is not joined to a domain.
+  `JOINED`: Indicates that the gateway has successfully joined a domain.
+  `JOINING`: Indicates that a `JoinDomain` operation is in progress.
+  `INSUFFICIENT_PERMISSIONS`: Indicates that the `JoinDomain` operation failed because the specified user lacks the necessary permissions to join the domain.
+  `NETWORK_ERROR`: Indicates that `JoinDomain` operation failed due to a network or connectivity error.
+  `TIMEOUT`: Indicates that the `JoinDomain` operation failed because the operation didn't complete within the allotted time.
+  `UNKNOWN_ERROR`: Indicates that the `JoinDomain` operation failed due to another type of error.
Type: String  
Valid Values: `ACCESS_DENIED | DETACHED | JOINED | JOINING | NETWORK_ERROR | TIMEOUT | UNKNOWN_ERROR | INSUFFICIENT_PERMISSIONS` 

 ** [GatewayARN](#API_JoinDomain_ResponseSyntax) **   <a name="StorageGateway-JoinDomain-response-GatewayARN"></a>
The unique Amazon Resource Name (ARN) of the gateway that joined the domain.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_JoinDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_JoinDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/JoinDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/JoinDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/JoinDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/JoinDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/JoinDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/JoinDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/JoinDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/JoinDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/JoinDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/JoinDomain) 

# ListAutomaticTapeCreationPolicies
<a name="API_ListAutomaticTapeCreationPolicies"></a>

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.

## Request Syntax
<a name="API_ListAutomaticTapeCreationPolicies_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_ListAutomaticTapeCreationPolicies_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_ListAutomaticTapeCreationPolicies_RequestSyntax) **   <a name="StorageGateway-ListAutomaticTapeCreationPolicies-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_ListAutomaticTapeCreationPolicies_ResponseSyntax"></a>

```
{
   "AutomaticTapeCreationPolicyInfos": [ 
      { 
         "AutomaticTapeCreationRules": [ 
            { 
               "MinimumNumTapes": number,
               "PoolId": "string",
               "TapeBarcodePrefix": "string",
               "TapeSizeInBytes": number,
               "Worm": boolean
            }
         ],
         "GatewayARN": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListAutomaticTapeCreationPolicies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AutomaticTapeCreationPolicyInfos](#API_ListAutomaticTapeCreationPolicies_ResponseSyntax) **   <a name="StorageGateway-ListAutomaticTapeCreationPolicies-response-AutomaticTapeCreationPolicyInfos"></a>
Gets a listing of information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.  
Type: Array of [AutomaticTapeCreationPolicyInfo](API_AutomaticTapeCreationPolicyInfo.md) objects

## Errors
<a name="API_ListAutomaticTapeCreationPolicies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListAutomaticTapeCreationPolicies_Examples"></a>

### List automatic tape creation policies for a tape gateway
<a name="API_ListAutomaticTapeCreationPolicies_Example_1"></a>

In the following request, you get a listing of the automatic tape creation policies for a tape gateway with the ARN of "`sgw-tan`".

#### Sample Request
<a name="API_ListAutomaticTapeCreationPolicies_Example_1_Request"></a>

```
{
    "GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw-tan"
}
```

#### Sample Response
<a name="API_ListAutomaticTapeCreationPolicies_Example_1_Response"></a>

```
{
    "AutomaticTapeCreationPolicyInfos": [
        {
            "AutomaticTapeCreationRules": [
                {
                    "MinimumNumTapes": "1",
                    "PoolId": "GLACIER",
                    "TapeBarcodePrefix": "TAN",
                    "TapeSizeInBytes": "107374182400"
                }
            ],
            "GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw-tan"
        }
    ]
}
```

## See Also
<a name="API_ListAutomaticTapeCreationPolicies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies) 

# ListCacheReports
<a name="API_ListCacheReports"></a>

Returns a list of existing cache reports for all file shares associated with your AWS account. This list includes all information provided by the `DescribeCacheReport` action, such as report name, status, completion progress, start time, end time, filters, and tags.

## Request Syntax
<a name="API_ListCacheReports_RequestSyntax"></a>

```
{
   "Marker": "string"
}
```

## Request Parameters
<a name="API_ListCacheReports_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Marker](#API_ListCacheReports_RequestSyntax) **   <a name="StorageGateway-ListCacheReports-request-Marker"></a>
Opaque pagination token returned from a previous `ListCacheReports` operation. If present, `Marker` specifies where to continue the list from after a previous call to `ListCacheReports`. Optional.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListCacheReports_ResponseSyntax"></a>

```
{
   "CacheReportList": [ 
      { 
         "CacheReportARN": "string",
         "CacheReportStatus": "string",
         "EndTime": number,
         "ExclusionFilters": [ 
            { 
               "Name": "string",
               "Values": [ "string" ]
            }
         ],
         "FileShareARN": "string",
         "InclusionFilters": [ 
            { 
               "Name": "string",
               "Values": [ "string" ]
            }
         ],
         "LocationARN": "string",
         "ReportCompletionPercent": number,
         "ReportName": "string",
         "Role": "string",
         "StartTime": number,
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "Marker": "string"
}
```

## Response Elements
<a name="API_ListCacheReports_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CacheReportList](#API_ListCacheReports_ResponseSyntax) **   <a name="StorageGateway-ListCacheReports-response-CacheReportList"></a>
A list of existing cache reports for all file shares associated with your AWS account. This list includes all information provided by the `DescribeCacheReport` action, such as report status, completion progress, start time, end time, filters, and tags.  
Type: Array of [CacheReportInfo](API_CacheReportInfo.md) objects

 ** [Marker](#API_ListCacheReports_ResponseSyntax) **   <a name="StorageGateway-ListCacheReports-response-Marker"></a>
If the request includes `Marker`, the response returns that value in this field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

## Errors
<a name="API_ListCacheReports_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListCacheReports_Examples"></a>

### Get information about all cache reports
<a name="API_ListCacheReports_Example_1"></a>

The following example gets information about all existing cache reports.

#### Sample Request
<a name="API_ListCacheReports_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.ListCacheReports

{}
```

#### Sample Response
<a name="API_ListCacheReports_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "CacheReportList": [
        {
            "CacheReportARN": "arn:aws:storagegateway:us-east-1:0123456789012:share/share-ABCD1234/cache-report/report-ABCD1234",
            "CacheReportStatus": "COMPLETED",
            "ReportCompletionPercent": 100,
            "EndTime": "2025-02-11T21:32:09.535000+00:00",
            "Role": "arn:aws:iam::123456789012:role/bucket-access-role",
            "FileShareARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234",
            "LocationARN": "arn:aws:s3:::bucket-name",
            "StartTime": "2025-02-11T21:31:42.081000+00:00",
            "InclusionFilters": [
                {
                    "Name": "UploadFailureReason",
                    "Values": [
                        "InaccessibleStorageClass",
                        "ObjectMissing"
                    ]
                }
            ],
            "ReportName": "cache_report-ABCD1234_1739309502081.csv",
            "Tags": []
        }
    ]
}
```

## See Also
<a name="API_ListCacheReports_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListCacheReports) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListCacheReports) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListCacheReports) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListCacheReports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListCacheReports) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListCacheReports) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListCacheReports) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListCacheReports) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListCacheReports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListCacheReports) 

# ListFileShares
<a name="API_ListFileShares"></a>

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

## Request Syntax
<a name="API_ListFileShares_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "Limit": number,
   "Marker": "string"
}
```

## Request Parameters
<a name="API_ListFileShares_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_ListFileShares_RequestSyntax) **   <a name="StorageGateway-ListFileShares-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** [Limit](#API_ListFileShares_RequestSyntax) **   <a name="StorageGateway-ListFileShares-request-Limit"></a>
The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_ListFileShares_RequestSyntax) **   <a name="StorageGateway-ListFileShares-request-Marker"></a>
Opaque pagination token returned from a previous ListFileShares operation. If present, `Marker` specifies where to continue the list from after a previous call to ListFileShares. Optional.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListFileShares_ResponseSyntax"></a>

```
{
   "FileShareInfoList": [ 
      { 
         "FileShareARN": "string",
         "FileShareId": "string",
         "FileShareStatus": "string",
         "FileShareType": "string",
         "GatewayARN": "string"
      }
   ],
   "Marker": "string",
   "NextMarker": "string"
}
```

## Response Elements
<a name="API_ListFileShares_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileShareInfoList](#API_ListFileShares_ResponseSyntax) **   <a name="StorageGateway-ListFileShares-response-FileShareInfoList"></a>
An array of information about the S3 File Gateway's file shares.  
Type: Array of [FileShareInfo](API_FileShareInfo.md) objects

 ** [Marker](#API_ListFileShares_ResponseSyntax) **   <a name="StorageGateway-ListFileShares-response-Marker"></a>
If the request includes `Marker`, the response returns that value in this field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [NextMarker](#API_ListFileShares_ResponseSyntax) **   <a name="StorageGateway-ListFileShares-response-NextMarker"></a>
If a value is present, there are more file shares to return. In a subsequent request, use `NextMarker` as the value for `Marker` to retrieve the next set of file shares.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

## Errors
<a name="API_ListFileShares_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListFileShares_Examples"></a>

### Get a list of file shares for a specific S3 File Gateway.
<a name="API_ListFileShares_Example_1"></a>

In the following request, you get information about the first file share exposed by a S3 File Gateway; the `Limit` field restricts the number of file share descriptions returned. To get the remaining file share descriptions, use the `NextMarker` field value in the response JSON as the value for `Marker` in subsequent calls to `ListFileShares`.

#### Sample Request
<a name="API_ListFileShares_Example_1_Request"></a>

```
{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-xxxxxxx",
    "Limit": "1"
}
```

#### Sample Response
<a name="API_ListFileShares_Example_1_Response"></a>

```
{
    "FileShareInfos": [
        {
            "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXXX",
            "FileShareId": "share-XXXXXXXX",
            "FileShareStatus": "AVAILABLE",
            "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-YYYYYYYY"
        }
    ],
    "NextMarker": "c2hhcmUtMUU0MjIwNzU="
}
```

## See Also
<a name="API_ListFileShares_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListFileShares) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListFileShares) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListFileShares) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListFileShares) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListFileShares) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListFileShares) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListFileShares) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListFileShares) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListFileShares) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListFileShares) 

# ListFileSystemAssociations
<a name="API_ListFileSystemAssociations"></a>

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

## Request Syntax
<a name="API_ListFileSystemAssociations_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "Limit": number,
   "Marker": "string"
}
```

## Request Parameters
<a name="API_ListFileSystemAssociations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_ListFileSystemAssociations_RequestSyntax) **   <a name="StorageGateway-ListFileSystemAssociations-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** [Limit](#API_ListFileSystemAssociations_RequestSyntax) **   <a name="StorageGateway-ListFileSystemAssociations-request-Limit"></a>
The maximum number of file system associations to return in the response. If present, `Limit` must be an integer with a value greater than zero. Optional.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_ListFileSystemAssociations_RequestSyntax) **   <a name="StorageGateway-ListFileSystemAssociations-request-Marker"></a>
Opaque pagination token returned from a previous `ListFileSystemAssociations` operation. If present, `Marker` specifies where to continue the list from after a previous call to `ListFileSystemAssociations`. Optional.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListFileSystemAssociations_ResponseSyntax"></a>

```
{
   "FileSystemAssociationSummaryList": [ 
      { 
         "FileSystemAssociationARN": "string",
         "FileSystemAssociationId": "string",
         "FileSystemAssociationStatus": "string",
         "GatewayARN": "string"
      }
   ],
   "Marker": "string",
   "NextMarker": "string"
}
```

## Response Elements
<a name="API_ListFileSystemAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileSystemAssociationSummaryList](#API_ListFileSystemAssociations_ResponseSyntax) **   <a name="StorageGateway-ListFileSystemAssociations-response-FileSystemAssociationSummaryList"></a>
An array of information about the Amazon FSx gateway's file system associations.  
Type: Array of [FileSystemAssociationSummary](API_FileSystemAssociationSummary.md) objects

 ** [Marker](#API_ListFileSystemAssociations_ResponseSyntax) **   <a name="StorageGateway-ListFileSystemAssociations-response-Marker"></a>
If the request includes `Marker`, the response returns that value in this field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [NextMarker](#API_ListFileSystemAssociations_ResponseSyntax) **   <a name="StorageGateway-ListFileSystemAssociations-response-NextMarker"></a>
If a value is present, there are more file system associations to return. In a subsequent request, use `NextMarker` as the value for `Marker` to retrieve the next set of file system associations.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

## Errors
<a name="API_ListFileSystemAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_ListFileSystemAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListFileSystemAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListFileSystemAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListFileSystemAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListFileSystemAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListFileSystemAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListFileSystemAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListFileSystemAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListFileSystemAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListFileSystemAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListFileSystemAssociations) 

# ListGateways
<a name="API_ListGateways"></a>

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

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

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

## Request Syntax
<a name="API_ListGateways_RequestSyntax"></a>

```
{
   "Limit": number,
   "Marker": "string"
}
```

## Request Parameters
<a name="API_ListGateways_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Limit](#API_ListGateways_RequestSyntax) **   <a name="StorageGateway-ListGateways-request-Limit"></a>
Specifies that the list of gateways returned be limited to the specified number of items.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_ListGateways_RequestSyntax) **   <a name="StorageGateway-ListGateways-request-Marker"></a>
An opaque string that indicates the position at which to begin the returned list of gateways.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListGateways_ResponseSyntax"></a>

```
{
   "Gateways": [ 
      { 
         "DeprecationDate": "string",
         "Ec2InstanceId": "string",
         "Ec2InstanceRegion": "string",
         "GatewayARN": "string",
         "GatewayId": "string",
         "GatewayName": "string",
         "GatewayOperationalState": "string",
         "GatewayType": "string",
         "HostEnvironment": "string",
         "HostEnvironmentId": "string",
         "SoftwareVersion": "string"
      }
   ],
   "Marker": "string"
}
```

## Response Elements
<a name="API_ListGateways_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Gateways](#API_ListGateways_ResponseSyntax) **   <a name="StorageGateway-ListGateways-response-Gateways"></a>
An array of [GatewayInfo](API_GatewayInfo.md) objects.  
Type: Array of [GatewayInfo](API_GatewayInfo.md) objects

 ** [Marker](#API_ListGateways_ResponseSyntax) **   <a name="StorageGateway-ListGateways-response-Marker"></a>
Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

## Errors
<a name="API_ListGateways_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListGateways_Examples"></a>

### List of gateways owned by an in a specified
<a name="API_ListGateways_Example_1"></a>

The following example does not specify any criteria for the returned list. Note that the request body is "\$1\$1". The response returns gateways (or up to the first 100) in the specified AWS Region owned by the AWS account.

#### Sample Request
<a name="API_ListGateways_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.ListGateways
```

#### Sample Response
<a name="API_ListGateways_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 178

{
    "GatewayList": [
        {
            "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-23A4567C"
        }
    ]
}
```

## See Also
<a name="API_ListGateways_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListGateways) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListGateways) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListGateways) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListGateways) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListGateways) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListGateways) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListGateways) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListGateways) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListGateways) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListGateways) 

# ListLocalDisks
<a name="API_ListLocalDisks"></a>

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

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

## Request Syntax
<a name="API_ListLocalDisks_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_ListLocalDisks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_ListLocalDisks_RequestSyntax) **   <a name="StorageGateway-ListLocalDisks-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_ListLocalDisks_ResponseSyntax"></a>

```
{
   "Disks": [ 
      { 
         "DiskAllocationResource": "string",
         "DiskAllocationType": "string",
         "DiskAttributeList": [ "string" ],
         "DiskId": "string",
         "DiskNode": "string",
         "DiskPath": "string",
         "DiskSizeInBytes": number,
         "DiskStatus": "string"
      }
   ],
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_ListLocalDisks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Disks](#API_ListLocalDisks_ResponseSyntax) **   <a name="StorageGateway-ListLocalDisks-response-Disks"></a>
A JSON object containing the following fields:  
+  [ListLocalDisks:Disks](#StorageGateway-ListLocalDisks-response-Disks) 
Type: Array of [Disk](API_Disk.md) objects

 ** [GatewayARN](#API_ListLocalDisks_ResponseSyntax) **   <a name="StorageGateway-ListLocalDisks-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_ListLocalDisks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListLocalDisks_Examples"></a>

### Return information about a gateway's local disks
<a name="API_ListLocalDisks_Example_1"></a>

The following example shows a request that returns information about a gateway's local disks.

#### Sample Request
<a name="API_ListLocalDisks_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.ListLocalDisks

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_ListLocalDisks_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 398

{
    "Disks": [
        {
            "DiskAllocationType": "CACHE_STORAGE",
            "DiskAttributeList": [
                "AttributeOne",
                "AttributeTwo"
            ],
            "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
            "DiskNode": "SCSI(0:0)",
            "DiskPath": "/dev/sda",
            "DiskSizeInBytes": "1099511627776",
            "DiskStatus": "missing"
        },
        {
            "DiskAllocationType": "UPLOAD_BUFFER",
            "DiskAttributeList": "[]",
            "DiskAllocationResource": "",
            "DiskId": "pci-0000:03:00.0-scsi-0:0:1:0",
            "DiskNode": "SCSI(0:1)",
            "DiskPath": "/dev/sdb",
            "DiskSizeInBytes": "1099511627776",
            "DiskStatus": "present"
        }
    ],
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_ListLocalDisks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListLocalDisks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListLocalDisks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListLocalDisks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListLocalDisks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListLocalDisks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListLocalDisks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListLocalDisks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListLocalDisks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListLocalDisks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListLocalDisks) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

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

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "Limit": number,
   "Marker": "string",
   "ResourceARN": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Limit](#API_ListTagsForResource_RequestSyntax) **   <a name="StorageGateway-ListTagsForResource-request-Limit"></a>
Specifies that the list of tags returned be limited to the specified number of items.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_ListTagsForResource_RequestSyntax) **   <a name="StorageGateway-ListTagsForResource-request-Marker"></a>
An opaque string that indicates the position at which to begin returning the list of tags.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="StorageGateway-ListTagsForResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource for which you want to list tags.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Marker": "string",
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Marker](#API_ListTagsForResource_ResponseSyntax) **   <a name="StorageGateway-ListTagsForResource-response-Marker"></a>
An opaque string that indicates the position at which to stop returning the list of tags.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [ResourceARN](#API_ListTagsForResource_ResponseSyntax) **   <a name="StorageGateway-ListTagsForResource-response-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource for which you want to list tags.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="StorageGateway-ListTagsForResource-response-Tags"></a>
An array that contains the tags for the specified resource.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListTagsForResource) 

# ListTapePools
<a name="API_ListTapePools"></a>

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

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

## Request Syntax
<a name="API_ListTapePools_RequestSyntax"></a>

```
{
   "Limit": number,
   "Marker": "string",
   "PoolARNs": [ "string" ]
}
```

## Request Parameters
<a name="API_ListTapePools_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Limit](#API_ListTapePools_RequestSyntax) **   <a name="StorageGateway-ListTapePools-request-Limit"></a>
An optional number limit for the tape pools in the list returned by this call.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_ListTapePools_RequestSyntax) **   <a name="StorageGateway-ListTapePools-request-Marker"></a>
A string that indicates the position at which to begin the returned list of tape pools.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [PoolARNs](#API_ListTapePools_RequestSyntax) **   <a name="StorageGateway-ListTapePools-request-PoolARNs"></a>
The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools.   
Type: Array of strings  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_ListTapePools_ResponseSyntax"></a>

```
{
   "Marker": "string",
   "PoolInfos": [ 
      { 
         "PoolARN": "string",
         "PoolName": "string",
         "PoolStatus": "string",
         "RetentionLockTimeInDays": number,
         "RetentionLockType": "string",
         "StorageClass": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTapePools_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Marker](#API_ListTapePools_ResponseSyntax) **   <a name="StorageGateway-ListTapePools-response-Marker"></a>
A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [PoolInfos](#API_ListTapePools_ResponseSyntax) **   <a name="StorageGateway-ListTapePools-response-PoolInfos"></a>
An array of `PoolInfo` objects, where each object describes a single custom tape pool. If there are no custom tape pools, the `PoolInfos` is an empty array.   
Type: Array of [PoolInfo](API_PoolInfo.md) objects

## Errors
<a name="API_ListTapePools_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_ListTapePools_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListTapePools) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListTapePools) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListTapePools) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListTapePools) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListTapePools) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListTapePools) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListTapePools) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListTapePools) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListTapePools) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListTapePools) 

# ListTapes
<a name="API_ListTapes"></a>

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

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

## Request Syntax
<a name="API_ListTapes_RequestSyntax"></a>

```
{
   "Limit": number,
   "Marker": "string",
   "TapeARNs": [ "string" ]
}
```

## Request Parameters
<a name="API_ListTapes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Limit](#API_ListTapes_RequestSyntax) **   <a name="StorageGateway-ListTapes-request-Limit"></a>
An optional number limit for the tapes in the list returned by this call.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_ListTapes_RequestSyntax) **   <a name="StorageGateway-ListTapes-request-Marker"></a>
A string that indicates the position at which to begin the returned list of tapes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [TapeARNs](#API_ListTapes_RequestSyntax) **   <a name="StorageGateway-ListTapes-request-TapeARNs"></a>
The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.  
Type: Array of strings  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: No

## Response Syntax
<a name="API_ListTapes_ResponseSyntax"></a>

```
{
   "Marker": "string",
   "TapeInfos": [ 
      { 
         "GatewayARN": "string",
         "PoolEntryDate": number,
         "PoolId": "string",
         "RetentionStartDate": number,
         "TapeARN": "string",
         "TapeBarcode": "string",
         "TapeSizeInBytes": number,
         "TapeStatus": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTapes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Marker](#API_ListTapes_ResponseSyntax) **   <a name="StorageGateway-ListTapes-response-Marker"></a>
A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [TapeInfos](#API_ListTapes_ResponseSyntax) **   <a name="StorageGateway-ListTapes-response-TapeInfos"></a>
An array of [TapeInfo](API_TapeInfo.md) objects, where each object describes a single tape. If there are no tapes in the tape library or VTS, then the `TapeInfos` is an empty array.  
Type: Array of [TapeInfo](API_TapeInfo.md) objects

## Errors
<a name="API_ListTapes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListTapes_Examples"></a>

### Example request
<a name="API_ListTapes_Example_1"></a>

The ListTapes request in the following example does not specify a `limit`, `marker`, or `TapeARN` field in the response body. This example lists the only two tapes in the VTL and VTS. The response returns up to the first 100 tapes.

#### Sample Request
<a name="API_ListTapes_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20160425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.ListTapes

{
    "TapeARN": "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST38A29D"
}
```

#### Sample Response
<a name="API_ListTapes_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Mon, 29 Apr 2016 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 346

{
    "Marker": "string",
    "TapeInfos": [
        {
            "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
            "TapeARN": "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST38A29D",
            "TapeBarcode": "TEST38A29D",
            "TapeSizeInBytes": "107374182400",
            "TapeStatus": "AVAILABLE"
        },
        {
            "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-23A4567C",
            "TapeARN": "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST49B39F",
            "TapeBarcode": "TEST49B39F",
            "TapeSizeInBytes": "107374182400",
            "TapeStatus": "ARCHIVED"
        }
    ]
}
```

## See Also
<a name="API_ListTapes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListTapes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListTapes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListTapes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListTapes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListTapes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListTapes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListTapes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListTapes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListTapes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListTapes) 

# ListVolumeInitiators
<a name="API_ListVolumeInitiators"></a>

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.

## Request Syntax
<a name="API_ListVolumeInitiators_RequestSyntax"></a>

```
{
   "VolumeARN": "string"
}
```

## Request Parameters
<a name="API_ListVolumeInitiators_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [VolumeARN](#API_ListVolumeInitiators_RequestSyntax) **   <a name="StorageGateway-ListVolumeInitiators-request-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume. Use the [ListVolumes](API_ListVolumes.md) operation to return a list of gateway volumes for the gateway.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_ListVolumeInitiators_ResponseSyntax"></a>

```
{
   "Initiators": [ "string" ]
}
```

## Response Elements
<a name="API_ListVolumeInitiators_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Initiators](#API_ListVolumeInitiators_ResponseSyntax) **   <a name="StorageGateway-ListVolumeInitiators-response-Initiators"></a>
The host names and port numbers of all iSCSI initiators that are connected to the gateway.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 50.

## Errors
<a name="API_ListVolumeInitiators_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_ListVolumeInitiators_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListVolumeInitiators) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListVolumeInitiators) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListVolumeInitiators) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListVolumeInitiators) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListVolumeInitiators) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListVolumeInitiators) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListVolumeInitiators) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListVolumeInitiators) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListVolumeInitiators) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListVolumeInitiators) 

# ListVolumeRecoveryPoints
<a name="API_ListVolumeRecoveryPoints"></a>

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

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

## Request Syntax
<a name="API_ListVolumeRecoveryPoints_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_ListVolumeRecoveryPoints_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_ListVolumeRecoveryPoints_RequestSyntax) **   <a name="StorageGateway-ListVolumeRecoveryPoints-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_ListVolumeRecoveryPoints_ResponseSyntax"></a>

```
{
   "GatewayARN": "string",
   "VolumeRecoveryPointInfos": [ 
      { 
         "VolumeARN": "string",
         "VolumeRecoveryPointTime": "string",
         "VolumeSizeInBytes": number,
         "VolumeUsageInBytes": number
      }
   ]
}
```

## Response Elements
<a name="API_ListVolumeRecoveryPoints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_ListVolumeRecoveryPoints_ResponseSyntax) **   <a name="StorageGateway-ListVolumeRecoveryPoints-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [VolumeRecoveryPointInfos](#API_ListVolumeRecoveryPoints_ResponseSyntax) **   <a name="StorageGateway-ListVolumeRecoveryPoints-response-VolumeRecoveryPointInfos"></a>
An array of [VolumeRecoveryPointInfo](API_VolumeRecoveryPointInfo.md) objects.  
Type: Array of [VolumeRecoveryPointInfo](API_VolumeRecoveryPointInfo.md) objects

## Errors
<a name="API_ListVolumeRecoveryPoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListVolumeRecoveryPoints_Examples"></a>

### Example request
<a name="API_ListVolumeRecoveryPoints_Example_1"></a>

The following example sends a `ListVolumeRecoveryPoints` request to take a snapshot of the specified example volume.

#### Sample Request
<a name="API_ListVolumeRecoveryPoints_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20130630.ListVolumeRecoveryPoints

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_ListVolumeRecoveryPoints_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 137

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "VolumeRecoveryPointInfos": [
        {
            "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
            "VolumeRecoveryPointTime": "2012-09-04T21:08:44.627Z",
            "VolumeSizeInBytes": "536870912000"
        }
    ]
}
```

## See Also
<a name="API_ListVolumeRecoveryPoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListVolumeRecoveryPoints) 

# ListVolumes
<a name="API_ListVolumes"></a>

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

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

## Request Syntax
<a name="API_ListVolumes_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "Limit": number,
   "Marker": "string"
}
```

## Request Parameters
<a name="API_ListVolumes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_ListVolumes_RequestSyntax) **   <a name="StorageGateway-ListVolumes-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** [Limit](#API_ListVolumes_RequestSyntax) **   <a name="StorageGateway-ListVolumes-request-Limit"></a>
Specifies that the list of volumes returned be limited to the specified number of items.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Marker](#API_ListVolumes_RequestSyntax) **   <a name="StorageGateway-ListVolumes-request-Marker"></a>
A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListVolumes_ResponseSyntax"></a>

```
{
   "GatewayARN": "string",
   "Marker": "string",
   "VolumeInfos": [ 
      { 
         "GatewayARN": "string",
         "GatewayId": "string",
         "VolumeARN": "string",
         "VolumeAttachmentStatus": "string",
         "VolumeId": "string",
         "VolumeSizeInBytes": number,
         "VolumeType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListVolumes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_ListVolumes_ResponseSyntax) **   <a name="StorageGateway-ListVolumes-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [Marker](#API_ListVolumes_ResponseSyntax) **   <a name="StorageGateway-ListVolumes-response-Marker"></a>
Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [VolumeInfos](#API_ListVolumes_ResponseSyntax) **   <a name="StorageGateway-ListVolumes-response-VolumeInfos"></a>
An array of [VolumeInfo](API_VolumeInfo.md) objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then `VolumeInfos` is an empty array "[]".  
Type: Array of [VolumeInfo](API_VolumeInfo.md) objects

## Errors
<a name="API_ListVolumes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListVolumes_Examples"></a>

### Example request
<a name="API_ListVolumes_Example_1"></a>

The ListVolumes request in this example does not specify a `limit` or `marker` field in the response body. If the number of volumes in the gateway is greater than 100, the response returns first 100.

#### Sample Request
<a name="API_ListVolumes_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.ListVolumes

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_ListVolumes_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 346

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "VolumeInfos": [
        {
            "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
            "GatewayId": "sgw-12A3456B",
            "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
            "VolumeId": "vol-1122AABB",
            "VolumeSizeInBytes": "107374182400",
            "VolumeType": "STORED"
        },
        {
            "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-13B4567C",
            "GatewayId": "sgw-gw-13B4567C",
            "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD",
            "VolumeId": "vol-1122AABB",
            "VolumeSizeInBytes": "107374182400",
            "VolumeType": "STORED"
        }
    ]
```

## See Also
<a name="API_ListVolumes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ListVolumes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ListVolumes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ListVolumes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ListVolumes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ListVolumes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ListVolumes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ListVolumes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ListVolumes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ListVolumes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ListVolumes) 

# NotifyWhenUploaded
<a name="API_NotifyWhenUploaded"></a>

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

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

For more information, see [Getting file upload notification](https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) in the *Amazon S3 File Gateway User Guide*.

## Request Syntax
<a name="API_NotifyWhenUploaded_RequestSyntax"></a>

```
{
   "FileShareARN": "string"
}
```

## Request Parameters
<a name="API_NotifyWhenUploaded_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FileShareARN](#API_NotifyWhenUploaded_RequestSyntax) **   <a name="StorageGateway-NotifyWhenUploaded-request-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_NotifyWhenUploaded_ResponseSyntax"></a>

```
{
   "FileShareARN": "string",
   "NotificationId": "string"
}
```

## Response Elements
<a name="API_NotifyWhenUploaded_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileShareARN](#API_NotifyWhenUploaded_ResponseSyntax) **   <a name="StorageGateway-NotifyWhenUploaded-response-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [NotificationId](#API_NotifyWhenUploaded_ResponseSyntax) **   <a name="StorageGateway-NotifyWhenUploaded-response-NotificationId"></a>
The randomly generated ID of the notification that was sent. This ID is in UUID format.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_NotifyWhenUploaded_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_NotifyWhenUploaded_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/NotifyWhenUploaded) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/NotifyWhenUploaded) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/NotifyWhenUploaded) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/NotifyWhenUploaded) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/NotifyWhenUploaded) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/NotifyWhenUploaded) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/NotifyWhenUploaded) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/NotifyWhenUploaded) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/NotifyWhenUploaded) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/NotifyWhenUploaded) 

# RefreshCache
<a name="API_RefreshCache"></a>

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

You can subscribe to be notified through an Amazon CloudWatch event when your `RefreshCache` operation completes. For more information, see [Getting notified about file operations](https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) in the *Amazon S3 File Gateway User Guide*. This operation is Only supported for S3 File Gateways.

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

Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see [Getting notified about file operations](https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) in the *Amazon S3 File Gateway User Guide*.

**Important**  
Wait at least 60 seconds between consecutive RefreshCache API requests.
If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an `InvalidGatewayRequestException` error because too many requests were sent to the server.

**Note**  
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.

For more information, see [Getting notified about file operations](https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) in the *Amazon S3 File Gateway User Guide*.

## Request Syntax
<a name="API_RefreshCache_RequestSyntax"></a>

```
{
   "FileShareARN": "string",
   "FolderList": [ "string" ],
   "Recursive": boolean
}
```

## Request Parameters
<a name="API_RefreshCache_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FileShareARN](#API_RefreshCache_RequestSyntax) **   <a name="StorageGateway-RefreshCache-request-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share you want to refresh.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [FolderList](#API_RefreshCache_RequestSyntax) **   <a name="StorageGateway-RefreshCache-request-FolderList"></a>
A comma-separated list of the paths of folders to refresh in the cache. The default is [`"/"`]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If `Recursive` is set to `true`, the entire S3 bucket that the file share has access to is refreshed.  
Do not include `/` when specifying folder names. For example, you would specify `samplefolder` rather than `samplefolder/`.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [Recursive](#API_RefreshCache_RequestSyntax) **   <a name="StorageGateway-RefreshCache-request-Recursive"></a>
A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to `true`, each folder that is listed in `FolderList` is recursively updated. Otherwise, subfolders listed in `FolderList` are not refreshed. Only objects that are in folders listed directly under `FolderList` are found and used for the update. The default is `true`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

## Response Syntax
<a name="API_RefreshCache_ResponseSyntax"></a>

```
{
   "FileShareARN": "string",
   "NotificationId": "string"
}
```

## Response Elements
<a name="API_RefreshCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileShareARN](#API_RefreshCache_ResponseSyntax) **   <a name="StorageGateway-RefreshCache-response-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [NotificationId](#API_RefreshCache_ResponseSyntax) **   <a name="StorageGateway-RefreshCache-response-NotificationId"></a>
The randomly generated ID of the notification that was sent. This ID is in UUID format.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_RefreshCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_RefreshCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/RefreshCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/RefreshCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/RefreshCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/RefreshCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/RefreshCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/RefreshCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/RefreshCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/RefreshCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/RefreshCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/RefreshCache) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.

## Request Syntax
<a name="API_RemoveTagsFromResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_RemoveTagsFromResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_RemoveTagsFromResource_RequestSyntax) **   <a name="StorageGateway-RemoveTagsFromResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource you want to remove the tags from.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [TagKeys](#API_RemoveTagsFromResource_RequestSyntax) **   <a name="StorageGateway-RemoveTagsFromResource-request-TagKeys"></a>
The keys of the tags you want to remove from the specified resource. A tag is composed of a key-value pair.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Syntax
<a name="API_RemoveTagsFromResource_ResponseSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## Response Elements
<a name="API_RemoveTagsFromResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ResourceARN](#API_RemoveTagsFromResource_ResponseSyntax) **   <a name="StorageGateway-RemoveTagsFromResource-response-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource that the tags were removed from.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_RemoveTagsFromResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_RemoveTagsFromResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/RemoveTagsFromResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/RemoveTagsFromResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/RemoveTagsFromResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/RemoveTagsFromResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/RemoveTagsFromResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/RemoveTagsFromResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/RemoveTagsFromResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/RemoveTagsFromResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/RemoveTagsFromResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/RemoveTagsFromResource) 

# ResetCache
<a name="API_ResetCache"></a>

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 gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

**Important**  
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

## Request Syntax
<a name="API_ResetCache_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_ResetCache_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_ResetCache_RequestSyntax) **   <a name="StorageGateway-ResetCache-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_ResetCache_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_ResetCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_ResetCache_ResponseSyntax) **   <a name="StorageGateway-ResetCache-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_ResetCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_ResetCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ResetCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ResetCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ResetCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ResetCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ResetCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ResetCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ResetCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ResetCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ResetCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ResetCache) 

# RetrieveTapeArchive
<a name="API_RetrieveTapeArchive"></a>

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 though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.

## Request Syntax
<a name="API_RetrieveTapeArchive_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "TapeARN": "string"
}
```

## Request Parameters
<a name="API_RetrieveTapeArchive_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_RetrieveTapeArchive_RequestSyntax) **   <a name="StorageGateway-RetrieveTapeArchive-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [TapeARN](#API_RetrieveTapeArchive_RequestSyntax) **   <a name="StorageGateway-RetrieveTapeArchive-request-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: Yes

## Response Syntax
<a name="API_RetrieveTapeArchive_ResponseSyntax"></a>

```
{
   "TapeARN": "string"
}
```

## Response Elements
<a name="API_RetrieveTapeArchive_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARN](#API_RetrieveTapeArchive_ResponseSyntax) **   <a name="StorageGateway-RetrieveTapeArchive-response-TapeARN"></a>
The Amazon Resource Name (ARN) of the retrieved virtual tape.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$` 

## Errors
<a name="API_RetrieveTapeArchive_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_RetrieveTapeArchive_Examples"></a>

### Retrieve a tape
<a name="API_RetrieveTapeArchive_Example_1"></a>

The following example request retrieves an archived tape from VTS to a gateway with the ID sgw-12A3456B. In the request, the tape is identified by its ARN. In the ARN the trailing string is the tape barcode. The string 999999999999 is your AWS account number. It takes about 24 hours for retrieval to complete. After the operation is complete, the tape appears in the specified gateway's virtual tape library (VTL).

#### Sample Request
<a name="API_RetrieveTapeArchive_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.RetrieveTapeArchive

{
    "TapeARN": "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST0AA2AF",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_RetrieveTapeArchive_Example_1_Response"></a>

```
{
    "TapeARN": "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST0AA2AF"
}
```

## See Also
<a name="API_RetrieveTapeArchive_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/RetrieveTapeArchive) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/RetrieveTapeArchive) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/RetrieveTapeArchive) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/RetrieveTapeArchive) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/RetrieveTapeArchive) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/RetrieveTapeArchive) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/RetrieveTapeArchive) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/RetrieveTapeArchive) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/RetrieveTapeArchive) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/RetrieveTapeArchive) 

# RetrieveTapeRecoveryPoint
<a name="API_RetrieveTapeRecoveryPoint"></a>

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 your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

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

## Request Syntax
<a name="API_RetrieveTapeRecoveryPoint_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "TapeARN": "string"
}
```

## Request Parameters
<a name="API_RetrieveTapeRecoveryPoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_RetrieveTapeRecoveryPoint_RequestSyntax) **   <a name="StorageGateway-RetrieveTapeRecoveryPoint-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [TapeARN](#API_RetrieveTapeRecoveryPoint_RequestSyntax) **   <a name="StorageGateway-RetrieveTapeRecoveryPoint-request-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: Yes

## Response Syntax
<a name="API_RetrieveTapeRecoveryPoint_ResponseSyntax"></a>

```
{
   "TapeARN": "string"
}
```

## Response Elements
<a name="API_RetrieveTapeRecoveryPoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TapeARN](#API_RetrieveTapeRecoveryPoint_ResponseSyntax) **   <a name="StorageGateway-RetrieveTapeRecoveryPoint-response-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$` 

## Errors
<a name="API_RetrieveTapeRecoveryPoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_RetrieveTapeRecoveryPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/RetrieveTapeRecoveryPoint) 

# SetLocalConsolePassword
<a name="API_SetLocalConsolePassword"></a>

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 to set a new password.

## Request Syntax
<a name="API_SetLocalConsolePassword_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "LocalConsolePassword": "string"
}
```

## Request Parameters
<a name="API_SetLocalConsolePassword_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_SetLocalConsolePassword_RequestSyntax) **   <a name="StorageGateway-SetLocalConsolePassword-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [LocalConsolePassword](#API_SetLocalConsolePassword_RequestSyntax) **   <a name="StorageGateway-SetLocalConsolePassword-request-LocalConsolePassword"></a>
The password you want to set for your VM local console.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 512.  
Pattern: `^[ -~]+$`   
Required: Yes

## Response Syntax
<a name="API_SetLocalConsolePassword_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_SetLocalConsolePassword_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_SetLocalConsolePassword_ResponseSyntax) **   <a name="StorageGateway-SetLocalConsolePassword-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_SetLocalConsolePassword_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_SetLocalConsolePassword_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/SetLocalConsolePassword) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/SetLocalConsolePassword) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/SetLocalConsolePassword) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/SetLocalConsolePassword) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/SetLocalConsolePassword) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/SetLocalConsolePassword) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/SetLocalConsolePassword) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/SetLocalConsolePassword) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/SetLocalConsolePassword) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/SetLocalConsolePassword) 

# SetSMBGuestPassword
<a name="API_SetSMBGuestPassword"></a>

Sets the password for the guest user `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

## Request Syntax
<a name="API_SetSMBGuestPassword_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "Password": "string"
}
```

## Request Parameters
<a name="API_SetSMBGuestPassword_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_SetSMBGuestPassword_RequestSyntax) **   <a name="StorageGateway-SetSMBGuestPassword-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share is associated with.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [Password](#API_SetSMBGuestPassword_RequestSyntax) **   <a name="StorageGateway-SetSMBGuestPassword-request-Password"></a>
The password that you want to set for your SMB server.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 512.  
Pattern: `^[ -~]+$`   
Required: Yes

## Response Syntax
<a name="API_SetSMBGuestPassword_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_SetSMBGuestPassword_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_SetSMBGuestPassword_ResponseSyntax) **   <a name="StorageGateway-SetSMBGuestPassword-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_SetSMBGuestPassword_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_SetSMBGuestPassword_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/SetSMBGuestPassword) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/SetSMBGuestPassword) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/SetSMBGuestPassword) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/SetSMBGuestPassword) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/SetSMBGuestPassword) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/SetSMBGuestPassword) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/SetSMBGuestPassword) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/SetSMBGuestPassword) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/SetSMBGuestPassword) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/SetSMBGuestPassword) 

# ShutdownGateway
<a name="API_ShutdownGateway"></a>

Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

**Note**  
This API action cannot be used to shut down S3 File Gateway or FSx File Gateway.

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

**Note**  
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except [StartGateway](API_StartGateway.md), [DescribeGatewayInformation](API_DescribeGatewayInformation.md), and [ListGateways](API_ListGateways.md). For more information, see [ActivateGateway](API_ActivateGateway.md). Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

**Note**  
When you make a shutdown request, you will get a `200 OK` success response immediately. However, it might take some time for the gateway to shut down. You can call the [DescribeGatewayInformation](API_DescribeGatewayInformation.md) API to check the status. For more information, see [ActivateGateway](API_ActivateGateway.md).

If do not intend to use the gateway again, you must delete the gateway (using [DeleteGateway](API_DeleteGateway.md)) to no longer pay software charges associated with the gateway.

## Request Syntax
<a name="API_ShutdownGateway_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_ShutdownGateway_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_ShutdownGateway_RequestSyntax) **   <a name="StorageGateway-ShutdownGateway-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_ShutdownGateway_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_ShutdownGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_ShutdownGateway_ResponseSyntax) **   <a name="StorageGateway-ShutdownGateway-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_ShutdownGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ShutdownGateway_Examples"></a>

### Shut down a gateway
<a name="API_ShutdownGateway_Example_1"></a>

The following example shows a request that shuts down a gateway.

#### Sample Request
<a name="API_ShutdownGateway_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.ShutdownGateway

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_ShutdownGateway_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_ShutdownGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/ShutdownGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/ShutdownGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/ShutdownGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/ShutdownGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/ShutdownGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/ShutdownGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/ShutdownGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/ShutdownGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/ShutdownGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/ShutdownGateway) 

# StartAvailabilityMonitorTest
<a name="API_StartAvailabilityMonitorTest"></a>

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. It doesn't indicate that the test passed. For the status of the test, invoke the `DescribeAvailabilityMonitorTest` API.

**Note**  
Starting this test will cause your gateway to go offline for a brief period.

## Request Syntax
<a name="API_StartAvailabilityMonitorTest_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_StartAvailabilityMonitorTest_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_StartAvailabilityMonitorTest_RequestSyntax) **   <a name="StorageGateway-StartAvailabilityMonitorTest-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_StartAvailabilityMonitorTest_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_StartAvailabilityMonitorTest_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_StartAvailabilityMonitorTest_ResponseSyntax) **   <a name="StorageGateway-StartAvailabilityMonitorTest-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_StartAvailabilityMonitorTest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_StartAvailabilityMonitorTest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/StartAvailabilityMonitorTest) 

# StartCacheReport
<a name="API_StartCacheReport"></a>

Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve issues if you have files failing upload from your gateway to Amazon S3. The report is a CSV file containing a list of files which match the set of filter parameters you specify in the request.

**Note**  
The **Files Failing Upload** flag is reset every 24 hours and during gateway reboot. If this report captures the files after the reset, but before they become flagged again, they will not be reported as **Files Failing Upload**.

The following requirements must be met to successfully generate a cache report:
+ You must have `s3:PutObject` and `s3:AbortMultipartUpload` permissions for the Amazon S3 bucket where you want to store the cache report.
+ No other cache reports can currently be in-progress for the specified file share.
+ There must be fewer than 10 existing cache reports for the specified file share.
+ The gateway must be online and connected to AWS.
+ The root disk must have at least 20GB of free space when report generation starts.
+ You must specify at least one value for `InclusionFilters` or `ExclusionFilters` in the request.

## Request Syntax
<a name="API_StartCacheReport_RequestSyntax"></a>

```
{
   "BucketRegion": "string",
   "ClientToken": "string",
   "ExclusionFilters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "FileShareARN": "string",
   "InclusionFilters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "LocationARN": "string",
   "Role": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VPCEndpointDNSName": "string"
}
```

## Request Parameters
<a name="API_StartCacheReport_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BucketRegion](#API_StartCacheReport_RequestSyntax) **   <a name="StorageGateway-StartCacheReport-request-BucketRegion"></a>
The AWS Region of the Amazon S3 bucket where you want to save the cache report.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Required: Yes

 ** [ClientToken](#API_StartCacheReport_RequestSyntax) **   <a name="StorageGateway-StartCacheReport-request-ClientToken"></a>
A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful `StartCacheReport` request. If you retry a request, use the same `ClientToken` you specified in the initial request.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 100.  
Required: Yes

 ** [ExclusionFilters](#API_StartCacheReport_RequestSyntax) **   <a name="StorageGateway-StartCacheReport-request-ExclusionFilters"></a>
The list of filters and parameters that determine which files are excluded from the report. You must specify at least one value for `InclusionFilters` or `ExclusionFilters` in a `StartCacheReport` request.  
Type: Array of [CacheReportFilter](API_CacheReportFilter.md) objects  
Required: No

 ** [FileShareARN](#API_StartCacheReport_RequestSyntax) **   <a name="StorageGateway-StartCacheReport-request-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [InclusionFilters](#API_StartCacheReport_RequestSyntax) **   <a name="StorageGateway-StartCacheReport-request-InclusionFilters"></a>
The list of filters and parameters that determine which files are included in the report. You must specify at least one value for `InclusionFilters` or `ExclusionFilters` in a `StartCacheReport` request.  
Type: Array of [CacheReportFilter](API_CacheReportFilter.md) objects  
Required: No

 ** [LocationARN](#API_StartCacheReport_RequestSyntax) **   <a name="StorageGateway-StartCacheReport-request-LocationARN"></a>
The ARN of the Amazon S3 bucket where you want to save the cache report.  
We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report.  
This field does not accept access point ARNs.
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1400.  
Required: Yes

 ** [Role](#API_StartCacheReport_RequestSyntax) **   <a name="StorageGateway-StartCacheReport-request-Role"></a>
The ARN of the IAM role used when saving the cache report to Amazon S3.  
The IAM role you specify must have the following permissions to write objects and stop multipart uploads to the report bucket:  
+  `s3:PutObject` 
+  `s3:AbortMultipartUpload` 
The role must also allow the `storagegateway.amazonaws.com` service to assume the role using the `sts:AssumeRole` action.
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\S+)$`   
Required: Yes

 ** [Tags](#API_StartCacheReport_RequestSyntax) **   <a name="StorageGateway-StartCacheReport-request-Tags"></a>
A list of up to 50 key/value tags that you can assign to the cache report. Using tags can help you categorize your reports and more easily locate them in search results.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [VPCEndpointDNSName](#API_StartCacheReport_RequestSyntax) **   <a name="StorageGateway-StartCacheReport-request-VPCEndpointDNSName"></a>
The DNS name of the VPC endpoint associated with the Amazon S3 bucket where you want to save the cache report. Optional.  
If your file share uses a VPC endpoint to connect to Amazon S3 for normal operations, we recommend using the same VPC in your `StartCacheReport` request. Cache report creation will fail if the gateway can't connect to the Amazon S3 bucket for any reason, including invalid VPC configuration.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$`   
Required: No

## Response Syntax
<a name="API_StartCacheReport_ResponseSyntax"></a>

```
{
   "CacheReportARN": "string"
}
```

## Response Elements
<a name="API_StartCacheReport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CacheReportARN](#API_StartCacheReport_ResponseSyntax) **   <a name="StorageGateway-StartCacheReport-response-CacheReportARN"></a>
The Amazon Resource Name (ARN) of the cache report generated by the `StartCacheReport` request.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_StartCacheReport_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_StartCacheReport_Examples"></a>

### Start a cache report
<a name="API_StartCacheReport_Example_1"></a>

The following example starts a cache report that includes information about files that fail to upload, whose error causes are either `InaccessibleStorageClass` or `ObjectMissing`.

#### Sample Request
<a name="API_StartCacheReport_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.StartCacheReport

{
    "FileShareARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234",
    "Role": "arn:aws:iam::123456789012:role/bucket-access-role",
    "LocationARN": "arn:aws:s3:::bucket-name",
    "BucketRegion": "us-east-1",
    "ClientToken": "abcdefgh",
    "InclusionFilters": [
        {
            "Name": "UploadFailureReason",
            "Values": [
                "InaccessibleStorageClass",
                "ObjectMissing"
            ]
        }
    ]
}
```

#### Sample Response
<a name="API_StartCacheReport_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "CacheReportARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-ABCD1234/cache-report/report-ABCD1234"
}
```

## See Also
<a name="API_StartCacheReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/StartCacheReport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/StartCacheReport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/StartCacheReport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/StartCacheReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/StartCacheReport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/StartCacheReport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/StartCacheReport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/StartCacheReport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/StartCacheReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/StartCacheReport) 

# StartGateway
<a name="API_StartGateway"></a>

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

**Note**  
When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call [DescribeGatewayInformation](API_DescribeGatewayInformation.md) and check the status before making any additional API calls. For more information, see [ActivateGateway](API_ActivateGateway.md).

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

## Request Syntax
<a name="API_StartGateway_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_StartGateway_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_StartGateway_RequestSyntax) **   <a name="StorageGateway-StartGateway-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_StartGateway_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_StartGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_StartGateway_ResponseSyntax) **   <a name="StorageGateway-StartGateway-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_StartGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_StartGateway_Examples"></a>

### Start a gateway that was previously shut down
<a name="API_StartGateway_Example_1"></a>

The following example shows a request that starts a gateway.

#### Sample Request
<a name="API_StartGateway_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.StartGateway

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_StartGateway_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_StartGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/StartGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/StartGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/StartGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/StartGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/StartGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/StartGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/StartGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/StartGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/StartGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/StartGateway) 

# UpdateAutomaticTapeCreationPolicy
<a name="API_UpdateAutomaticTapeCreationPolicy"></a>

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

**Note**  
A gateway can have only one automatic tape creation policy.

## Request Syntax
<a name="API_UpdateAutomaticTapeCreationPolicy_RequestSyntax"></a>

```
{
   "AutomaticTapeCreationRules": [ 
      { 
         "MinimumNumTapes": number,
         "PoolId": "string",
         "TapeBarcodePrefix": "string",
         "TapeSizeInBytes": number,
         "Worm": boolean
      }
   ],
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_UpdateAutomaticTapeCreationPolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AutomaticTapeCreationRules](#API_UpdateAutomaticTapeCreationPolicy_RequestSyntax) **   <a name="StorageGateway-UpdateAutomaticTapeCreationPolicy-request-AutomaticTapeCreationRules"></a>
An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.  
Type: Array of [AutomaticTapeCreationRule](API_AutomaticTapeCreationRule.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

 ** [GatewayARN](#API_UpdateAutomaticTapeCreationPolicy_RequestSyntax) **   <a name="StorageGateway-UpdateAutomaticTapeCreationPolicy-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_UpdateAutomaticTapeCreationPolicy_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_UpdateAutomaticTapeCreationPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_UpdateAutomaticTapeCreationPolicy_ResponseSyntax) **   <a name="StorageGateway-UpdateAutomaticTapeCreationPolicy-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateAutomaticTapeCreationPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_UpdateAutomaticTapeCreationPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicy) 

# UpdateBandwidthRateLimit
<a name="API_UpdateBandwidthRateLimit"></a>

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 supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use [UpdateBandwidthRateLimitSchedule](API_UpdateBandwidthRateLimitSchedule.md).

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

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

## Request Syntax
<a name="API_UpdateBandwidthRateLimit_RequestSyntax"></a>

```
{
   "AverageDownloadRateLimitInBitsPerSec": number,
   "AverageUploadRateLimitInBitsPerSec": number,
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_UpdateBandwidthRateLimit_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AverageDownloadRateLimitInBitsPerSec](#API_UpdateBandwidthRateLimit_RequestSyntax) **   <a name="StorageGateway-UpdateBandwidthRateLimit-request-AverageDownloadRateLimitInBitsPerSec"></a>
The average download bandwidth rate limit in bits per second.  
Type: Long  
Valid Range: Minimum value of 102400.  
Required: No

 ** [AverageUploadRateLimitInBitsPerSec](#API_UpdateBandwidthRateLimit_RequestSyntax) **   <a name="StorageGateway-UpdateBandwidthRateLimit-request-AverageUploadRateLimitInBitsPerSec"></a>
The average upload bandwidth rate limit in bits per second.  
Type: Long  
Valid Range: Minimum value of 51200.  
Required: No

 ** [GatewayARN](#API_UpdateBandwidthRateLimit_RequestSyntax) **   <a name="StorageGateway-UpdateBandwidthRateLimit-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_UpdateBandwidthRateLimit_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_UpdateBandwidthRateLimit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_UpdateBandwidthRateLimit_ResponseSyntax) **   <a name="StorageGateway-UpdateBandwidthRateLimit-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateBandwidthRateLimit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_UpdateBandwidthRateLimit_Examples"></a>

### Example request
<a name="API_UpdateBandwidthRateLimit_Example_1"></a>

The following example shows a request that returns the bandwidth throttle properties of a gateway.

#### Sample Request
<a name="API_UpdateBandwidthRateLimit_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.UpdateBandwidthRateLimit

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "AverageUploadRateLimitInBitsPerSec": "51200",
    "AverageDownloadRateLimitInBitsPerSec": "102400"
}
```

#### Sample Response
<a name="API_UpdateBandwidthRateLimit_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_UpdateBandwidthRateLimit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateBandwidthRateLimit) 

# UpdateBandwidthRateLimitSchedule
<a name="API_UpdateBandwidthRateLimitSchedule"></a>

 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 rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.

## Request Syntax
<a name="API_UpdateBandwidthRateLimitSchedule_RequestSyntax"></a>

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageDownloadRateLimitInBitsPerSec": number,
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_UpdateBandwidthRateLimitSchedule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BandwidthRateLimitIntervals](#API_UpdateBandwidthRateLimitSchedule_RequestSyntax) **   <a name="StorageGateway-UpdateBandwidthRateLimitSchedule-request-BandwidthRateLimitIntervals"></a>
 An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.   
Type: Array of [BandwidthRateLimitInterval](API_BandwidthRateLimitInterval.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: Yes

 ** [GatewayARN](#API_UpdateBandwidthRateLimitSchedule_RequestSyntax) **   <a name="StorageGateway-UpdateBandwidthRateLimitSchedule-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_UpdateBandwidthRateLimitSchedule_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_UpdateBandwidthRateLimitSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_UpdateBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="StorageGateway-UpdateBandwidthRateLimitSchedule-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateBandwidthRateLimitSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_UpdateBandwidthRateLimitSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateBandwidthRateLimitSchedule) 

# UpdateChapCredentials
<a name="API_UpdateChapCredentials"></a>

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 volume and tape gateway types.

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

## Request Syntax
<a name="API_UpdateChapCredentials_RequestSyntax"></a>

```
{
   "InitiatorName": "string",
   "SecretToAuthenticateInitiator": "string",
   "SecretToAuthenticateTarget": "string",
   "TargetARN": "string"
}
```

## Request Parameters
<a name="API_UpdateChapCredentials_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InitiatorName](#API_UpdateChapCredentials_RequestSyntax) **   <a name="StorageGateway-UpdateChapCredentials-request-InitiatorName"></a>
The iSCSI initiator that connects to the target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[0-9a-z:.-]+`   
Required: Yes

 ** [SecretToAuthenticateInitiator](#API_UpdateChapCredentials_RequestSyntax) **   <a name="StorageGateway-UpdateChapCredentials-request-SecretToAuthenticateInitiator"></a>
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.  
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [SecretToAuthenticateTarget](#API_UpdateChapCredentials_RequestSyntax) **   <a name="StorageGateway-UpdateChapCredentials-request-SecretToAuthenticateTarget"></a>
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).  
Byte constraints: Minimum bytes of 12. Maximum bytes of 16.  
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [TargetARN](#API_UpdateChapCredentials_RequestSyntax) **   <a name="StorageGateway-UpdateChapCredentials-request-TargetARN"></a>
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the [DescribeStorediSCSIVolumes](API_DescribeStorediSCSIVolumes.md) operation to return the TargetARN for specified VolumeARN.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.  
Required: Yes

## Response Syntax
<a name="API_UpdateChapCredentials_ResponseSyntax"></a>

```
{
   "InitiatorName": "string",
   "TargetARN": "string"
}
```

## Response Elements
<a name="API_UpdateChapCredentials_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InitiatorName](#API_UpdateChapCredentials_ResponseSyntax) **   <a name="StorageGateway-UpdateChapCredentials-response-InitiatorName"></a>
The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[0-9a-z:.-]+` 

 ** [TargetARN](#API_UpdateChapCredentials_ResponseSyntax) **   <a name="StorageGateway-UpdateChapCredentials-response-TargetARN"></a>
The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.

## Errors
<a name="API_UpdateChapCredentials_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_UpdateChapCredentials_Examples"></a>

### Example request
<a name="API_UpdateChapCredentials_Example_1"></a>

The following example shows a request that updates CHAP credentials for an iSCSI target.

#### Sample Request
<a name="API_UpdateChapCredentials_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.UpdateChapCredentials

{
    "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
    "SecretToAuthenticateInitiator": "111111111111",
    "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
    "SecretToAuthenticateTarget": "222222222222"
}
```

#### Sample Response
<a name="API_UpdateChapCredentials_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 161

{
    "TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
    "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com"
}
```

## See Also
<a name="API_UpdateChapCredentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateChapCredentials) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateChapCredentials) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateChapCredentials) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateChapCredentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateChapCredentials) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateChapCredentials) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateChapCredentials) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateChapCredentials) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateChapCredentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateChapCredentials) 

# UpdateFileSystemAssociation
<a name="API_UpdateFileSystemAssociation"></a>

Updates a file system association. This operation is only supported in the FSx File Gateways.

## Request Syntax
<a name="API_UpdateFileSystemAssociation_RequestSyntax"></a>

```
{
   "AuditDestinationARN": "string",
   "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": number
   },
   "FileSystemAssociationARN": "string",
   "Password": "string",
   "UserName": "string"
}
```

## Request Parameters
<a name="API_UpdateFileSystemAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AuditDestinationARN](#API_UpdateFileSystemAssociation_RequestSyntax) **   <a name="StorageGateway-UpdateFileSystemAssociation-request-AuditDestinationARN"></a>
The Amazon Resource Name (ARN) of the storage used for the audit logs.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [CacheAttributes](#API_UpdateFileSystemAssociation_RequestSyntax) **   <a name="StorageGateway-UpdateFileSystemAssociation-request-CacheAttributes"></a>
The refresh cache information for the file share or FSx file systems.  
Type: [CacheAttributes](API_CacheAttributes.md) object  
Required: No

 ** [FileSystemAssociationARN](#API_UpdateFileSystemAssociation_RequestSyntax) **   <a name="StorageGateway-UpdateFileSystemAssociation-request-FileSystemAssociationARN"></a>
The Amazon Resource Name (ARN) of the file system association that you want to update.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [Password](#API_UpdateFileSystemAssociation_RequestSyntax) **   <a name="StorageGateway-UpdateFileSystemAssociation-request-Password"></a>
The password of the user credential.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[ -~]+$`   
Required: No

 ** [UserName](#API_UpdateFileSystemAssociation_RequestSyntax) **   <a name="StorageGateway-UpdateFileSystemAssociation-request-UserName"></a>
The user name of the user credential that has permission to access the root share D\$1 of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^\w[\w\.\- ]*$`   
Required: No

## Response Syntax
<a name="API_UpdateFileSystemAssociation_ResponseSyntax"></a>

```
{
   "FileSystemAssociationARN": "string"
}
```

## Response Elements
<a name="API_UpdateFileSystemAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileSystemAssociationARN](#API_UpdateFileSystemAssociation_ResponseSyntax) **   <a name="StorageGateway-UpdateFileSystemAssociation-response-FileSystemAssociationARN"></a>
The ARN of the updated file system association.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateFileSystemAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_UpdateFileSystemAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateFileSystemAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateFileSystemAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateFileSystemAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateFileSystemAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateFileSystemAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateFileSystemAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateFileSystemAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateFileSystemAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateFileSystemAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateFileSystemAssociation) 

# UpdateGatewayInformation
<a name="API_UpdateGatewayInformation"></a>

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

**Note**  
For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

## Request Syntax
<a name="API_UpdateGatewayInformation_RequestSyntax"></a>

```
{
   "CloudWatchLogGroupARN": "string",
   "GatewayARN": "string",
   "GatewayCapacity": "string",
   "GatewayName": "string",
   "GatewayTimezone": "string"
}
```

## Request Parameters
<a name="API_UpdateGatewayInformation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CloudWatchLogGroupARN](#API_UpdateGatewayInformation_RequestSyntax) **   <a name="StorageGateway-UpdateGatewayInformation-request-CloudWatchLogGroupARN"></a>
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.  
For more information, see [What is Amazon CloudWatch Logs?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html)   
Type: String  
Length Constraints: Maximum length of 562.  
Required: No

 ** [GatewayARN](#API_UpdateGatewayInformation_RequestSyntax) **   <a name="StorageGateway-UpdateGatewayInformation-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [GatewayCapacity](#API_UpdateGatewayInformation_RequestSyntax) **   <a name="StorageGateway-UpdateGatewayInformation-request-GatewayCapacity"></a>
Specifies the size of the gateway's metadata cache. This setting impacts gateway performance and hardware recommendations. For more information, see [Performance guidance for gateways with multiple file shares](https://docs.aws.amazon.com/filegateway/latest/files3/performance-multiple-file-shares.html) in the *Amazon S3 File Gateway User Guide*.  
Type: String  
Valid Values: `Small | Medium | Large`   
Required: No

 ** [GatewayName](#API_UpdateGatewayInformation_RequestSyntax) **   <a name="StorageGateway-UpdateGatewayInformation-request-GatewayName"></a>
The name you configured for your gateway.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 255.  
Pattern: `^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$`   
Required: No

 ** [GatewayTimezone](#API_UpdateGatewayInformation_RequestSyntax) **   <a name="StorageGateway-UpdateGatewayInformation-request-GatewayTimezone"></a>
A value that indicates the time zone of the gateway.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 10.  
Required: No

## Response Syntax
<a name="API_UpdateGatewayInformation_ResponseSyntax"></a>

```
{
   "GatewayARN": "string",
   "GatewayName": "string"
}
```

## Response Elements
<a name="API_UpdateGatewayInformation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_UpdateGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-UpdateGatewayInformation-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

 ** [GatewayName](#API_UpdateGatewayInformation_ResponseSyntax) **   <a name="StorageGateway-UpdateGatewayInformation-response-GatewayName"></a>
The name you configured for your gateway.  
Type: String

## Errors
<a name="API_UpdateGatewayInformation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_UpdateGatewayInformation_Examples"></a>

### Update a gateway's name
<a name="API_UpdateGatewayInformation_Example_1"></a>

The following example shows a request that updates the name of a gateway.

#### Sample Request
<a name="API_UpdateGatewayInformation_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.GatewayInformation

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "GatewayName": "mygateway2"
}
```

#### Sample Response
<a name="API_UpdateGatewayInformation_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 81

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_UpdateGatewayInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateGatewayInformation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateGatewayInformation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateGatewayInformation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateGatewayInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateGatewayInformation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateGatewayInformation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateGatewayInformation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateGatewayInformation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateGatewayInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateGatewayInformation) 

# UpdateGatewaySoftwareNow
<a name="API_UpdateGatewaySoftwareNow"></a>

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

**Note**  
When you make this request, you get a `200 OK` success response immediately. However, it might take some time for the update to complete. You can call [DescribeGatewayInformation](API_DescribeGatewayInformation.md) to verify the gateway is in the `STATE_RUNNING` state.

**Important**  
A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see [Customizing your Windows iSCSI settings](https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings) and [Customizing your Linux iSCSI settings](https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings), respectively.

## Request Syntax
<a name="API_UpdateGatewaySoftwareNow_RequestSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_UpdateGatewaySoftwareNow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_UpdateGatewaySoftwareNow_RequestSyntax) **   <a name="StorageGateway-UpdateGatewaySoftwareNow-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_UpdateGatewaySoftwareNow_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_UpdateGatewaySoftwareNow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_UpdateGatewaySoftwareNow_ResponseSyntax) **   <a name="StorageGateway-UpdateGatewaySoftwareNow-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateGatewaySoftwareNow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_UpdateGatewaySoftwareNow_Examples"></a>

### Initiate a gateway VM update
<a name="API_UpdateGatewaySoftwareNow_Example_1"></a>

The following example shows a request that initiates a gateway VM update.

#### Sample Request
<a name="API_UpdateGatewaySoftwareNow_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.UpdateGatewaySoftwareNow

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

#### Sample Response
<a name="API_UpdateGatewaySoftwareNow_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
```

## See Also
<a name="API_UpdateGatewaySoftwareNow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateGatewaySoftwareNow) 

# UpdateMaintenanceStartTime
<a name="API_UpdateMaintenanceStartTime"></a>

Updates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time configuration uses the gateway's time zone. You can pass values for a complete maintenance schedule, or update policy, or both. Previous values will persist for whichever setting you choose not to modify. If an incomplete or invalid maintenance schedule is passed, the entire request will be rejected with an error and no changes will occur.

A complete maintenance schedule must include values for *both* `MinuteOfHour` and `HourOfDay`, and *either* `DayOfMonth` *or* `DayOfWeek`.

**Note**  
We recommend keeping maintenance updates turned on, except in specific use cases where the brief disruptions caused by updating the gateway could critically impact your deployment.

## Request Syntax
<a name="API_UpdateMaintenanceStartTime_RequestSyntax"></a>

```
{
   "DayOfMonth": number,
   "DayOfWeek": number,
   "GatewayARN": "string",
   "HourOfDay": number,
   "MinuteOfHour": number,
   "SoftwareUpdatePreferences": { 
      "AutomaticUpdatePolicy": "string"
   }
}
```

## Request Parameters
<a name="API_UpdateMaintenanceStartTime_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DayOfMonth](#API_UpdateMaintenanceStartTime_RequestSyntax) **   <a name="StorageGateway-UpdateMaintenanceStartTime-request-DayOfMonth"></a>
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 28.  
Required: No

 ** [DayOfWeek](#API_UpdateMaintenanceStartTime_RequestSyntax) **   <a name="StorageGateway-UpdateMaintenanceStartTime-request-DayOfWeek"></a>
The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 represents Saturday.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 6.  
Required: No

 ** [GatewayARN](#API_UpdateMaintenanceStartTime_RequestSyntax) **   <a name="StorageGateway-UpdateMaintenanceStartTime-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [HourOfDay](#API_UpdateMaintenanceStartTime_RequestSyntax) **   <a name="StorageGateway-UpdateMaintenanceStartTime-request-HourOfDay"></a>
The hour component of the maintenance start time represented as *hh*, where *hh* is the hour (00 to 23). The hour of the day is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: No

 ** [MinuteOfHour](#API_UpdateMaintenanceStartTime_RequestSyntax) **   <a name="StorageGateway-UpdateMaintenanceStartTime-request-MinuteOfHour"></a>
The minute component of the maintenance start time represented as *mm*, where *mm* is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 59.  
Required: No

 ** [SoftwareUpdatePreferences](#API_UpdateMaintenanceStartTime_RequestSyntax) **   <a name="StorageGateway-UpdateMaintenanceStartTime-request-SoftwareUpdatePreferences"></a>
A set of variables indicating the software update preferences for the gateway.  
Includes `AutomaticUpdatePolicy` field with the following inputs:  
 `ALL_VERSIONS` - Enables regular gateway maintenance updates.  
 `EMERGENCY_VERSIONS_ONLY` - Disables regular gateway maintenance updates. The gateway will still receive emergency version updates on rare occasions if necessary to remedy highly critical security or durability issues. You will be notified before an emergency version update is applied. These updates are applied during your gateway's scheduled maintenance window.  
Type: [SoftwareUpdatePreferences](API_SoftwareUpdatePreferences.md) object  
Required: No

## Response Syntax
<a name="API_UpdateMaintenanceStartTime_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_UpdateMaintenanceStartTime_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_UpdateMaintenanceStartTime_ResponseSyntax) **   <a name="StorageGateway-UpdateMaintenanceStartTime-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateMaintenanceStartTime_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_UpdateMaintenanceStartTime_Examples"></a>

### Update a gateway's maintenance start time
<a name="API_UpdateMaintenanceStartTime_Example_1"></a>

The following example shows a request that enables automatic maintenance updates and sets a maintenance start time on the 28th day of each month for gateway ID sgw-12A3456B.

#### Sample Request
<a name="API_UpdateMaintenanceStartTime_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.UpdateMaintenanceStartTime
{
    "SoftwareUpdatePreferences": {
        "AutomaticUpdatePolicy": "ALL_VERSIONS"
     },
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "DayOfMonth": "28",
    "HourOfDay": "15",
    "MinuteOfHour": "35"
}
```

## See Also
<a name="API_UpdateMaintenanceStartTime_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateMaintenanceStartTime) 

# UpdateNFSFileShare
<a name="API_UpdateNFSFileShare"></a>

Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.

**Note**  
To leave a file share field unchanged, set the corresponding input field to null.

Updates the following file share settings:
+ Default storage class for your S3 bucket
+ Metadata defaults for your S3 bucket
+ Allowed NFS clients for your file share
+ Squash settings
+ Write status of your file share

## Request Syntax
<a name="API_UpdateNFSFileShare_RequestSyntax"></a>

```
{
   "AuditDestinationARN": "string",
   "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": number
   },
   "ClientList": [ "string" ],
   "DefaultStorageClass": "string",
   "EncryptionType": "string",
   "FileShareARN": "string",
   "FileShareName": "string",
   "GuessMIMETypeEnabled": boolean,
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "NFSFileShareDefaults": { 
      "DirectoryMode": "string",
      "FileMode": "string",
      "GroupId": number,
      "OwnerId": number
   },
   "NotificationPolicy": "string",
   "ObjectACL": "string",
   "ReadOnly": boolean,
   "RequesterPays": boolean,
   "Squash": "string"
}
```

## Request Parameters
<a name="API_UpdateNFSFileShare_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AuditDestinationARN](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-AuditDestinationARN"></a>
The Amazon Resource Name (ARN) of the storage used for audit logs.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [CacheAttributes](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-CacheAttributes"></a>
Specifies refresh cache information for the file share.  
Type: [CacheAttributes](API_CacheAttributes.md) object  
Required: No

 ** [ClientList](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-ClientList"></a>
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IPv4/IPv6 addresses or valid CIDR blocks.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Pattern: `^(?:(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(?:\/(?:[0-9]|[1-2][0-9]|3[0-2]))?$|^(?:(?:(?:[A-Fa-f0-9]{1,4}:){6}|(?=(?:[A-Fa-f0-9]{0,4}:){0,6}(?:[0-9]{1,3}\.){3}[0-9]{1,3}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){0,5}|:)(?:(?::[0-9A-Fa-f]{1,4}){1,5}:|:)|::(?:[A-Fa-f0-9]{1,4}:){5})(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}|(?=(?:[A-Fa-f0-9]{0,4}:){0,7}[A-Fa-f0-9]{0,4}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){1,7}|:)(?:(:[0-9A-Fa-f]{1,4}){1,7}|:)|(?:[A-Fa-f0-9]{1,4}:){7}:|:(:[A-Fa-f0-9]{1,4}){7})(?:\/(?:12[0-8]|1[01][0-9]|[1-9]?[0-9]))?$`   
Required: No

 ** [DefaultStorageClass](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-DefaultStorageClass"></a>
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is `S3_STANDARD`. Optional.  
Valid Values: `S3_STANDARD` \$1 `S3_INTELLIGENT_TIERING` \$1 `S3_STANDARD_IA` \$1 `S3_ONEZONE_IA`   
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 50.  
Required: No

 ** [EncryptionType](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-EncryptionType"></a>
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Type: String  
Valid Values: `SseS3 | SseKms | DsseKms`   
Required: No

 ** [FileShareARN](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share to be updated.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [FileShareName](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-FileShareName"></a>
The name of the file share. Optional.  
 `FileShareName` must be set if an S3 prefix name is set in `LocationARN`, or if an access point or access point alias is used.  
A valid NFS file share name can only contain the following characters: `a`-`z`, `A`-`Z`, `0`-`9`, `-`, `.`, and `_`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [GuessMIMETypeEnabled](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-GuessMIMETypeEnabled"></a>
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to `true` to enable MIME type guessing, otherwise set to `false`. The default value is `true`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSEncrypted](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-KMSEncrypted"></a>
 *This parameter has been deprecated.*   
Optional. Set to `true` to use Amazon S3 server-side encryption with your own AWS KMS key (SSE-KMS), or `false` to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the `EncryptionType` parameter instead.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSKey](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric AWS KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** [NFSFileShareDefaults](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-NFSFileShareDefaults"></a>
The default values for the file share. Optional.  
Type: [NFSFileShareDefaults](API_NFSFileShareDefaults.md) object  
Required: No

 ** [NotificationPolicy](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-NotificationPolicy"></a>
The notification policy of the file share. `SettlingTimeInSeconds` controls the number of seconds to wait after the last point in time a client wrote to a file before generating an `ObjectUploaded` notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.  
 `SettlingTimeInSeconds` has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.  
This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.
The following example sets `NotificationPolicy` on with `SettlingTimeInSeconds` set to 60.  
 `{\"Upload\": {\"SettlingTimeInSeconds\": 60}}`   
The following example sets `NotificationPolicy` off.  
 `{}`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `^\{[\w\s:\{\}\[\]"]*}$`   
Required: No

 ** [ObjectACL](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-ObjectACL"></a>
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is `private`.  
Type: String  
Valid Values: `private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read`   
Required: No

 ** [ReadOnly](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-ReadOnly"></a>
A value that sets the write status of a file share. Set this value to `true` to set the write status to read-only, otherwise set to `false`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [RequesterPays](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-RequesterPays"></a>
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to `true`, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.  
 `RequesterPays` is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [Squash](#API_UpdateNFSFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-request-Squash"></a>
The user mapped to anonymous user.  
Valid values are the following:  
+  `RootSquash`: Only root is mapped to anonymous user.
+  `NoSquash`: No one is mapped to anonymous user.
+  `AllSquash`: Everyone is mapped to anonymous user.
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 15.  
Required: No

## Response Syntax
<a name="API_UpdateNFSFileShare_ResponseSyntax"></a>

```
{
   "FileShareARN": "string"
}
```

## Response Elements
<a name="API_UpdateNFSFileShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileShareARN](#API_UpdateNFSFileShare_ResponseSyntax) **   <a name="StorageGateway-UpdateNFSFileShare-response-FileShareARN"></a>
The Amazon Resource Name (ARN) of the updated file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateNFSFileShare_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_UpdateNFSFileShare_Examples"></a>

### Update an NFS file share's file mode
<a name="API_UpdateNFSFileShare_Example_1"></a>

In the following request, you update the file mode for an NFS file share.

#### Sample Request
<a name="API_UpdateNFSFileShare_Example_1_Request"></a>

```
{
    "ClientToken": "xy23421",
    "NFSFileShareDefaults": {
        "FileMode": "0777",
        "DirectoryMode": "0777",
        "GroupId": "500",
        "OwnerId": "500"
    },
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "KMSEncrypted": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "Squash": "RootSquash"
}
```

#### Sample Response
<a name="API_UpdateNFSFileShare_Example_1_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXX"
}
```

### Update an NFS file share with file upload notification turned on
<a name="API_UpdateNFSFileShare_Example_2"></a>

In the following request, you update an NFS file share with file upload notification turned on and settling time set to 60 seconds.

#### Sample Request
<a name="API_UpdateNFSFileShare_Example_2_Request"></a>

```
{
    "ClientToken": "xy23421",
    "NFSFileShareDefaults": {
        "FileMode": "0777",
        "DirectoryMode": "0777",
        "GroupId": "500",
        "OwnerId": "500"
    },
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "KMSEncrypted": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "Squash": "RootSquash",
    "NotificationPolicy": "{\"Upload\": {\"SettlingTimeInSeconds\": 60}}"
}
```

#### Sample Response
<a name="API_UpdateNFSFileShare_Example_2_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

### Update an NFS file share with file upload notification turned off
<a name="API_UpdateNFSFileShare_Example_3"></a>

In the following request, you update an NFS file share with file upload notification turned off.

#### Sample Request
<a name="API_UpdateNFSFileShare_Example_3_Request"></a>

```
{
    "ClientToken": "xy23421",
    "NFSFileShareDefaults": {
        "FileMode": "0777",
        "DirectoryMode": "0777",
        "GroupId": "500",
        "OwnerId": "500"
    },
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "KMSEncrypted": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "Squash": "RootSquash",
    "NotificationPolicy": "{}"
}
```

#### Sample Response
<a name="API_UpdateNFSFileShare_Example_3_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

## See Also
<a name="API_UpdateNFSFileShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateNFSFileShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateNFSFileShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateNFSFileShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateNFSFileShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateNFSFileShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateNFSFileShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateNFSFileShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateNFSFileShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateNFSFileShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateNFSFileShare) 

# UpdateSMBFileShare
<a name="API_UpdateSMBFileShare"></a>

Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.

**Note**  
To leave a file share field unchanged, set the corresponding input field to null.

**Important**  
File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see [Activating and deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the * AWS Identity and Access Management User Guide*.  
File gateways don't support creating hard or symbolic links on a file share.

## Request Syntax
<a name="API_UpdateSMBFileShare_RequestSyntax"></a>

```
{
   "AccessBasedEnumeration": boolean,
   "AdminUserList": [ "string" ],
   "AuditDestinationARN": "string",
   "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": number
   },
   "CaseSensitivity": "string",
   "DefaultStorageClass": "string",
   "EncryptionType": "string",
   "FileShareARN": "string",
   "FileShareName": "string",
   "GuessMIMETypeEnabled": boolean,
   "InvalidUserList": [ "string" ],
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "NotificationPolicy": "string",
   "ObjectACL": "string",
   "OplocksEnabled": boolean,
   "ReadOnly": boolean,
   "RequesterPays": boolean,
   "SMBACLEnabled": boolean,
   "ValidUserList": [ "string" ]
}
```

## Request Parameters
<a name="API_UpdateSMBFileShare_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AccessBasedEnumeration](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-AccessBasedEnumeration"></a>
The files and folders on this share will only be visible to users with read access.  
Type: Boolean  
Required: No

 ** [AdminUserList](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-AdminUserList"></a>
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is set to `ActiveDirectory`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [AuditDestinationARN](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-AuditDestinationARN"></a>
The Amazon Resource Name (ARN) of the storage used for audit logs.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [CacheAttributes](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-CacheAttributes"></a>
Specifies refresh cache information for the file share.  
Type: [CacheAttributes](API_CacheAttributes.md) object  
Required: No

 ** [CaseSensitivity](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-CaseSensitivity"></a>
The case of an object name in an Amazon S3 bucket. For `ClientSpecified`, the client determines the case sensitivity. For `CaseSensitive`, the gateway determines the case sensitivity. The default value is `ClientSpecified`.  
Type: String  
Valid Values: `ClientSpecified | CaseSensitive`   
Required: No

 ** [DefaultStorageClass](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-DefaultStorageClass"></a>
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is `S3_STANDARD`. Optional.  
Valid Values: `S3_STANDARD` \$1 `S3_INTELLIGENT_TIERING` \$1 `S3_STANDARD_IA` \$1 `S3_ONEZONE_IA`   
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 50.  
Required: No

 ** [EncryptionType](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-EncryptionType"></a>
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Type: String  
Valid Values: `SseS3 | SseKms | DsseKms`   
Required: No

 ** [FileShareARN](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-FileShareARN"></a>
The Amazon Resource Name (ARN) of the SMB file share that you want to update.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [FileShareName](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-FileShareName"></a>
The name of the file share. Optional.  
 `FileShareName` must be set if an S3 prefix name is set in `LocationARN`, or if an access point or access point alias is used.  
A valid SMB file share name cannot contain the following characters: `[`,`]`,`#`,`;`,`<`,`>`,`:`,`"`,`\`,`/`,`|`,`?`,`*`,`+`, or ASCII control characters `1-31`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [GuessMIMETypeEnabled](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-GuessMIMETypeEnabled"></a>
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to `true` to enable MIME type guessing, otherwise set to `false`. The default value is `true`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [InvalidUserList](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-InvalidUserList"></a>
A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is set to `ActiveDirectory`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [KMSEncrypted](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-KMSEncrypted"></a>
 *This parameter has been deprecated.*   
Optional. Set to `true` to use Amazon S3 server-side encryption with your own AWS KMS key (SSE-KMS), or `false` to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the `EncryptionType` parameter instead.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [KMSKey](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric AWS KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** [NotificationPolicy](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-NotificationPolicy"></a>
The notification policy of the file share. `SettlingTimeInSeconds` controls the number of seconds to wait after the last point in time a client wrote to a file before generating an `ObjectUploaded` notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.  
 `SettlingTimeInSeconds` has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.  
This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.
The following example sets `NotificationPolicy` on with `SettlingTimeInSeconds` set to 60.  
 `{\"Upload\": {\"SettlingTimeInSeconds\": 60}}`   
The following example sets `NotificationPolicy` off.  
 `{}`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `^\{[\w\s:\{\}\[\]"]*}$`   
Required: No

 ** [ObjectACL](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-ObjectACL"></a>
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is `private`.  
Type: String  
Valid Values: `private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read`   
Required: No

 ** [OplocksEnabled](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-OplocksEnabled"></a>
Specifies whether opportunistic locking is enabled for the SMB file share.  
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [ReadOnly](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-ReadOnly"></a>
A value that sets the write status of a file share. Set this value to `true` to set write status to read-only, otherwise set to `false`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [RequesterPays](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-RequesterPays"></a>
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to `true`, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.  
 `RequesterPays` is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [SMBACLEnabled](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-SMBACLEnabled"></a>
Set this value to `true` to enable access control list (ACL) on the SMB file share. Set it to `false` to map file and directory permissions to the POSIX permissions.  
For more information, see [Using Windows ACLs to limit SMB file share access](https://docs.aws.amazon.com/filegateway/latest/files3/smb-acl.html) in the *Amazon S3 File Gateway User Guide*.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** [ValidUserList](#API_UpdateSMBFileShare_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-request-ValidUserList"></a>
A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is set to `ActiveDirectory`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_UpdateSMBFileShare_ResponseSyntax"></a>

```
{
   "FileShareARN": "string"
}
```

## Response Elements
<a name="API_UpdateSMBFileShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FileShareARN](#API_UpdateSMBFileShare_ResponseSyntax) **   <a name="StorageGateway-UpdateSMBFileShare-response-FileShareARN"></a>
The Amazon Resource Name (ARN) of the updated SMB file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateSMBFileShare_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_UpdateSMBFileShare_Examples"></a>

### Update an SMB file share
<a name="API_UpdateSMBFileShare_Example_1"></a>

In the following request, you update an SMB file share using an existing file gateway and using your own AWS KMS key to perform server-side encryption of the contents of the file share.

#### Sample Request
<a name="API_UpdateSMBFileShare_Example_1_Request"></a>

```
{
    "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": 600
    },
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY",
    "FileShareName": "my-file-share",
    "GuessMIMETypeEnabled": "true",
    "InvalidList": [
        "user2",
        "user3",
        "@group1"
    ],
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "ValidList": [
        "user1",
        "user4",
        "@group2"
    ]
}
```

#### Sample Response
<a name="API_UpdateSMBFileShare_Example_1_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

### Update an SMB file share with file upload notification turned on
<a name="API_UpdateSMBFileShare_Example_2"></a>

In the following request, you update an SMB file share with file upload notification turned on and settling time set to 60 seconds.

#### Sample Request
<a name="API_UpdateSMBFileShare_Example_2_Request"></a>

```
{
    "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": 600
    },
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY",
    "FileShareName": "my-file-share",
    "GuessMIMETypeEnabled": "true",
    "InvalidList": [
        "user2",
        "user3",
        "@group1"
    ],
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "NotificationPolicy": "{\"Upload\": {\"SettlingTimeInSeconds\": 60}}",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "ValidList": [
        "user1",
        "user4",
        "@group2"
    ]
}
```

#### Sample Response
<a name="API_UpdateSMBFileShare_Example_2_Response"></a>

```
{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"
}
```

### Update an SMB file share with file upload notification turned off
<a name="API_UpdateSMBFileShare_Example_3"></a>

In the following request, you update an SMB file share with file upload notification turned off.

#### Sample Request
<a name="API_UpdateSMBFileShare_Example_3_Request"></a>

```
{
    "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": 600
    },
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY",
    "FileShareName": "my-file-share",
    "GuessMIMETypeEnabled": "true",
    "InvalidList": [
        "user2",
        "user3",
        "@group1"
    ],
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "NotificationPolicy": "{}",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "ValidList": [
        "user1",
        "user4",
        "@group2"
    ]
}
```

## See Also
<a name="API_UpdateSMBFileShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateSMBFileShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateSMBFileShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateSMBFileShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateSMBFileShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateSMBFileShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateSMBFileShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateSMBFileShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateSMBFileShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateSMBFileShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateSMBFileShare) 

# UpdateSMBFileShareVisibility
<a name="API_UpdateSMBFileShareVisibility"></a>

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.

## Request Syntax
<a name="API_UpdateSMBFileShareVisibility_RequestSyntax"></a>

```
{
   "FileSharesVisible": boolean,
   "GatewayARN": "string"
}
```

## Request Parameters
<a name="API_UpdateSMBFileShareVisibility_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FileSharesVisible](#API_UpdateSMBFileShareVisibility_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShareVisibility-request-FileSharesVisible"></a>
The shares on this gateway appear when listing shares.  
Type: Boolean  
Required: Yes

 ** [GatewayARN](#API_UpdateSMBFileShareVisibility_RequestSyntax) **   <a name="StorageGateway-UpdateSMBFileShareVisibility-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_UpdateSMBFileShareVisibility_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_UpdateSMBFileShareVisibility_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_UpdateSMBFileShareVisibility_ResponseSyntax) **   <a name="StorageGateway-UpdateSMBFileShareVisibility-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateSMBFileShareVisibility_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_UpdateSMBFileShareVisibility_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateSMBFileShareVisibility) 

# UpdateSMBLocalGroups
<a name="API_UpdateSMBLocalGroups"></a>

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

## Request Syntax
<a name="API_UpdateSMBLocalGroups_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "SMBLocalGroups": { 
      "GatewayAdmins": [ "string" ]
   }
}
```

## Request Parameters
<a name="API_UpdateSMBLocalGroups_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_UpdateSMBLocalGroups_RequestSyntax) **   <a name="StorageGateway-UpdateSMBLocalGroups-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [SMBLocalGroups](#API_UpdateSMBLocalGroups_RequestSyntax) **   <a name="StorageGateway-UpdateSMBLocalGroups-request-SMBLocalGroups"></a>
A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway.  
Type: [SMBLocalGroups](API_SMBLocalGroups.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateSMBLocalGroups_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_UpdateSMBLocalGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_UpdateSMBLocalGroups_ResponseSyntax) **   <a name="StorageGateway-UpdateSMBLocalGroups-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateSMBLocalGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_UpdateSMBLocalGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateSMBLocalGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateSMBLocalGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateSMBLocalGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateSMBLocalGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateSMBLocalGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateSMBLocalGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateSMBLocalGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateSMBLocalGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateSMBLocalGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateSMBLocalGroups) 

# UpdateSMBSecurityStrategy
<a name="API_UpdateSMBSecurityStrategy"></a>

Updates the SMB security strategy level for an Amazon S3 file gateway. This action is only supported for Amazon S3 file gateways.

**Note**  
For information about configuring this setting using the AWS console, see [Setting a security level for your gateway](https://docs.aws.amazon.com/filegateway/latest/files3/security-strategy.html) in the *Amazon S3 File Gateway User Guide*.  
A higher security strategy level can affect performance of the gateway.

## Request Syntax
<a name="API_UpdateSMBSecurityStrategy_RequestSyntax"></a>

```
{
   "GatewayARN": "string",
   "SMBSecurityStrategy": "string"
}
```

## Request Parameters
<a name="API_UpdateSMBSecurityStrategy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayARN](#API_UpdateSMBSecurityStrategy_RequestSyntax) **   <a name="StorageGateway-UpdateSMBSecurityStrategy-request-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

 ** [SMBSecurityStrategy](#API_UpdateSMBSecurityStrategy_RequestSyntax) **   <a name="StorageGateway-UpdateSMBSecurityStrategy-request-SMBSecurityStrategy"></a>
Specifies the type of security strategy.  
 `ClientSpecified`: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.  
 `MandatorySigning`: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.  
 `MandatoryEncryption`: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption enabled. This option is recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.  
 `MandatoryEncryptionNoAes128`: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.  
Type: String  
Valid Values: `ClientSpecified | MandatorySigning | MandatoryEncryption | MandatoryEncryptionNoAes128`   
Required: Yes

## Response Syntax
<a name="API_UpdateSMBSecurityStrategy_ResponseSyntax"></a>

```
{
   "GatewayARN": "string"
}
```

## Response Elements
<a name="API_UpdateSMBSecurityStrategy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayARN](#API_UpdateSMBSecurityStrategy_ResponseSyntax) **   <a name="StorageGateway-UpdateSMBSecurityStrategy-response-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateSMBSecurityStrategy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_UpdateSMBSecurityStrategy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateSMBSecurityStrategy) 

# UpdateSnapshotSchedule
<a name="API_UpdateSnapshotSchedule"></a>

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 creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

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

## Request Syntax
<a name="API_UpdateSnapshotSchedule_RequestSyntax"></a>

```
{
   "Description": "string",
   "RecurrenceInHours": number,
   "StartAt": number,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VolumeARN": "string"
}
```

## Request Parameters
<a name="API_UpdateSnapshotSchedule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateSnapshotSchedule_RequestSyntax) **   <a name="StorageGateway-UpdateSnapshotSchedule-request-Description"></a>
Optional description of the snapshot that overwrites the existing description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [RecurrenceInHours](#API_UpdateSnapshotSchedule_RequestSyntax) **   <a name="StorageGateway-UpdateSnapshotSchedule-request-RecurrenceInHours"></a>
Frequency of snapshots. Specify the number of hours between snapshots.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 24.  
Required: Yes

 ** [StartAt](#API_UpdateSnapshotSchedule_RequestSyntax) **   <a name="StorageGateway-UpdateSnapshotSchedule-request-StartAt"></a>
The hour of the day at which the snapshot schedule begins represented as *hh*, where *hh* is the hour (0 to 23). The hour of the day is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: Yes

 ** [Tags](#API_UpdateSnapshotSchedule_RequestSyntax) **   <a name="StorageGateway-UpdateSnapshotSchedule-request-Tags"></a>
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.  
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: \$1 - = . \$1 : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [VolumeARN](#API_UpdateSnapshotSchedule_RequestSyntax) **   <a name="StorageGateway-UpdateSnapshotSchedule-request-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume. Use the [ListVolumes](API_ListVolumes.md) operation to return a list of gateway volumes.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: Yes

## Response Syntax
<a name="API_UpdateSnapshotSchedule_ResponseSyntax"></a>

```
{
   "VolumeARN": "string"
}
```

## Response Elements
<a name="API_UpdateSnapshotSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VolumeARN](#API_UpdateSnapshotSchedule_ResponseSyntax) **   <a name="StorageGateway-UpdateSnapshotSchedule-response-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume. Use the [ListVolumes](API_ListVolumes.md) operation to return a list of gateway volumes.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)` 

## Errors
<a name="API_UpdateSnapshotSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_UpdateSnapshotSchedule_Examples"></a>

### Example request
<a name="API_UpdateSnapshotSchedule_Example_1"></a>

The following example shows a request that updates a snapshot schedule.

#### Sample Request
<a name="API_UpdateSnapshotSchedule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.UpdateSnapshotSchedule

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
    "StartAt": "0",
    "RecurrenceInHours": "1",
    "Description": "hourly snapshot"
}
```

#### Sample Response
<a name="API_UpdateSnapshotSchedule_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 99

{
    "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
```

## See Also
<a name="API_UpdateSnapshotSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateSnapshotSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateSnapshotSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateSnapshotSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateSnapshotSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateSnapshotSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateSnapshotSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateSnapshotSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateSnapshotSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateSnapshotSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateSnapshotSchedule) 

# UpdateVTLDeviceType
<a name="API_UpdateVTLDeviceType"></a>

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 activated. This operation is only supported in the tape gateway type.

## Request Syntax
<a name="API_UpdateVTLDeviceType_RequestSyntax"></a>

```
{
   "DeviceType": "string",
   "VTLDeviceARN": "string"
}
```

## Request Parameters
<a name="API_UpdateVTLDeviceType_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DeviceType](#API_UpdateVTLDeviceType_RequestSyntax) **   <a name="StorageGateway-UpdateVTLDeviceType-request-DeviceType"></a>
The type of medium changer you want to select.  
Valid Values: `STK-L700` \$1 `AWS-Gateway-VTL` \$1 `IBM-03584L32-0402`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Required: Yes

 ** [VTLDeviceARN](#API_UpdateVTLDeviceType_RequestSyntax) **   <a name="StorageGateway-UpdateVTLDeviceType-request-VTLDeviceARN"></a>
The Amazon Resource Name (ARN) of the medium changer you want to select.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_UpdateVTLDeviceType_ResponseSyntax"></a>

```
{
   "VTLDeviceARN": "string"
}
```

## Response Elements
<a name="API_UpdateVTLDeviceType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VTLDeviceARN](#API_UpdateVTLDeviceType_ResponseSyntax) **   <a name="StorageGateway-UpdateVTLDeviceType-response-VTLDeviceARN"></a>
The Amazon Resource Name (ARN) of the medium changer you have selected.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.

## Errors
<a name="API_UpdateVTLDeviceType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
An internal server error has occurred during the request. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more information about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

 ** InvalidGatewayRequestException **   
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.    
 ** error **   
A [StorageGatewayError](API_StorageGatewayError.md) that provides more detail about the cause of the error.  
 ** message **   
A human-readable message describing the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_UpdateVTLDeviceType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/storagegateway-2013-06-30/UpdateVTLDeviceType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/storagegateway-2013-06-30/UpdateVTLDeviceType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/storagegateway-2013-06-30/UpdateVTLDeviceType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/storagegateway-2013-06-30/UpdateVTLDeviceType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/storagegateway-2013-06-30/UpdateVTLDeviceType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/storagegateway-2013-06-30/UpdateVTLDeviceType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/storagegateway-2013-06-30/UpdateVTLDeviceType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/storagegateway-2013-06-30/UpdateVTLDeviceType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/storagegateway-2013-06-30/UpdateVTLDeviceType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/storagegateway-2013-06-30/UpdateVTLDeviceType)