id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
storagegateway-api-059
|
storagegateway-api.pdf
| 59 |
unit when joining the domain. Request Syntax { "DomainControllers": [ "string" ], "DomainName": "string", "GatewayARN": "string", "OrganizationalUnit": "string", "Password": "string", "TimeoutInSeconds": number, "UserName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DomainControllers List of IPv4 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. Type: Array of strings JoinDomain API Version 2013-06-30 272 Storage Gateway API Reference Length Constraints: Minimum length of 6. Maximum length of 1024. Pattern: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(:(\d +))?$ Required: No DomainName 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 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 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 Sets the password of the user who has permission to add the gateway to the Active Directory domain. Request Parameters API Version 2013-06-30 273 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[ -~]+$ Required: Yes TimeoutInSeconds 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 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 { "ActiveDirectoryStatus": "string", "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2013-06-30 274 Storage Gateway API Reference The following data is returned in JSON format by the service. ActiveDirectoryStatus Indicates the status of the gateway as a member of the Active Directory domain. Note 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 GatewayARN 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. Response Elements API Version 2013-06-30 275 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-06-30 276 Storage Gateway API Reference ListAutomaticTapeCreationPolicies 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
|
storagegateway-api-060
|
storagegateway-api.pdf
| 60 |
one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-06-30 276 Storage Gateway API Reference ListAutomaticTapeCreationPolicies 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 { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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: No Response Syntax { "AutomaticTapeCreationPolicyInfos": [ { "AutomaticTapeCreationRules": [ { "MinimumNumTapes": number, "PoolId": "string", ListAutomaticTapeCreationPolicies API Version 2013-06-30 277 Storage Gateway API Reference "TapeBarcodePrefix": "string", "TapeSizeInBytes": number, "Worm": boolean } ], "GatewayARN": "string" } ] } Response Elements 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 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 objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Response Elements API Version 2013-06-30 278 Storage Gateway Examples API Reference List automatic tape creation policies for a tape gateway 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 { "GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw-tan" } Sample Response { "AutomaticTapeCreationPolicyInfos": [ { "AutomaticTapeCreationRules": [ { "MinimumNumTapes": "1", "PoolId": "GLACIER", "TapeBarcodePrefix": "TAN", "TapeSizeInBytes": "107374182400" } ], "GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw- tan" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Examples API Version 2013-06-30 279 API Reference Storage Gateway • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 280 Storage Gateway ListCacheReports API Reference 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 { "Marker": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Marker 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 1000. Required: No Response Syntax { "CacheReportList": [ { "CacheReportARN": "string", "CacheReportStatus": "string", "EndTime": number, "ExclusionFilters": [ { ListCacheReports API Version 2013-06-30 281 Storage Gateway API Reference "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 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 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 objects Marker If the request includes Marker, the response returns that value in this field. Response Elements API Version 2013-06-30 282 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1000. Errors For information about the errors that are common to
|
storagegateway-api-061
|
storagegateway-api.pdf
| 61 |
following data is returned in JSON format by the service. CacheReportList 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 objects Marker If the request includes Marker, the response returns that value in this field. Response Elements API Version 2013-06-30 282 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1000. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples Get information about all cache reports The following example gets information about all existing cache reports. Sample Request 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 HTTP/1.1 200 OK Errors API Version 2013-06-30 283 Storage Gateway API Reference 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-bane", "StartTime": "2025-02-11T21:31:42.081000+00:00", "InclusionFilters": [ { "Name": "UploadFailureReason", "Values": [ "InaccessibleStorageClass", "ObjectMissing" ] } ], "ReportName": "cache_report-ABCD1234_1739309502081.csv", "Tags": [] } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2013-06-30 284 Storage Gateway • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 285 Storage Gateway ListFileShares API Reference 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 { "GatewayARN": "string", "Limit": number, "Marker": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 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 ListFileShares API Version 2013-06-30 286 Storage Gateway Marker API Reference 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 1000. Required: No Response Syntax { "FileShareInfoList": [ { "FileShareARN": "string", "FileShareId": "string", "FileShareStatus": "string", "FileShareType": "string", "GatewayARN": "string" } ], "Marker": "string", "NextMarker": "string" } Response Elements 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 An array of information about the S3 File Gateway's file shares. Type: Array of FileShareInfo objects Marker If the request includes Marker, the response returns that value in this field. Response Syntax API Version 2013-06-30 287 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1000. NextMarker 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 1000. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples Get a list of file shares for a specific S3 File Gateway. 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
|
storagegateway-api-062
|
storagegateway-api.pdf
| 62 |
the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples Get a list of file shares for a specific S3 File Gateway. 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 { Errors API Version 2013-06-30 288 Storage Gateway API Reference "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-xxxxxxx", "Limit": "1" } Sample Response { "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 For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 289 Storage Gateway API Reference ListFileSystemAssociations 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 { "GatewayARN": "string", "Limit": number, "Marker": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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: No Limit 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 ListFileSystemAssociations API Version 2013-06-30 290 Storage Gateway Marker API Reference 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 1000. Required: No Response Syntax { "FileSystemAssociationSummaryList": [ { "FileSystemAssociationARN": "string", "FileSystemAssociationId": "string", "FileSystemAssociationStatus": "string", "GatewayARN": "string" } ], "Marker": "string", "NextMarker": "string" } Response Elements 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 An array of information about the Amazon FSx gateway's file system associations. Type: Array of FileSystemAssociationSummary objects Marker If the request includes Marker, the response returns that value in this field. Response Syntax API Version 2013-06-30 291 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1000. NextMarker 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 1000. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2013-06-30 292 Storage Gateway • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 293 Storage Gateway ListGateways API Reference 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
|
storagegateway-api-063
|
storagegateway-api.pdf
| 63 |
for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 293 Storage Gateway ListGateways API Reference 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 { "Limit": number, "Marker": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Limit 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 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 1000. ListGateways API Version 2013-06-30 294 API Reference Storage Gateway Required: No Response Syntax { "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 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 An array of GatewayInfo objects. Type: Array of GatewayInfo objects Marker 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 1000. Response Syntax API Version 2013-06-30 295 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples List of gateways owned by an in a specified The following example does not specify any criteria for the returned list. Note that the request body is "{}". The response returns gateways (or up to the first 100) in the specified AWS Region owned by the AWS account. Sample Request 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 HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Errors API Version 2013-06-30 296 Storage Gateway API Reference 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 For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 297 Storage Gateway ListLocalDisks API Reference 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 { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 Response Syntax { "Disks": [ { "DiskAllocationResource": "string",
|
storagegateway-api-064
|
storagegateway-api.pdf
| 64 |
the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 Response Syntax { "Disks": [ { "DiskAllocationResource": "string", ListLocalDisks API Version 2013-06-30 298 Storage Gateway API Reference "DiskAllocationType": "string", "DiskAttributeList": [ "string" ], "DiskId": "string", "DiskNode": "string", "DiskPath": "string", "DiskSizeInBytes": number, "DiskStatus": "string" } ], "GatewayARN": "string" } Response Elements 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 A JSON object containing the following fields: • ListLocalDisks:Disks Type: Array of Disk objects GatewayARN 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. Response Elements API Version 2013-06-30 299 Storage Gateway API Reference 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. HTTP Status Code: 400 Examples Return information about a gateway's local disks The following example shows a request that returns information about a gateway's local disks. Sample Request 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 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", Examples API Version 2013-06-30 300 Storage Gateway API Reference "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 For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 301 Storage Gateway API Reference ListTagsForResource Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types. Request Syntax { "Limit": number, "Marker": "string", "ResourceARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Limit 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 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 1000. Required: No ResourceARN The Amazon Resource Name (ARN) of the resource for which you want to list tags. Type: String ListTagsForResource API Version 2013-06-30 302 Storage Gateway API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "Marker": "string", "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Response Elements 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 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 1000. ResourceARN 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 An array that contains the tags for the specified resource. Response Syntax API Version 2013-06-30 303 Storage Gateway Type: Array of Tag objects Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred
|
storagegateway-api-065
|
storagegateway-api.pdf
| 65 |
Maximum length of 1000. ResourceARN 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 An array that contains the tags for the specified resource. Response Syntax API Version 2013-06-30 303 Storage Gateway Type: Array of Tag objects Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-06-30 304 Storage Gateway ListTapePools API Reference 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 { "Limit": number, "Marker": "string", "PoolARNs": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Limit 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 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 1000. ListTapePools API Version 2013-06-30 305 Storage Gateway Required: No PoolARNs API Reference 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 { "Marker": "string", "PoolInfos": [ { "PoolARN": "string", "PoolName": "string", "PoolStatus": "string", "RetentionLockTimeInDays": number, "RetentionLockType": "string", "StorageClass": "string" } ] } Response Elements 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 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 Response Syntax API Version 2013-06-30 306 Storage Gateway API Reference Length Constraints: Minimum length of 1. Maximum length of 1000. PoolInfos 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 objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin Errors API Version 2013-06-30 307 Storage Gateway • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 308 Storage Gateway ListTapes API Reference 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
|
storagegateway-api-066
|
storagegateway-api.pdf
| 66 |
for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin Errors API Version 2013-06-30 307 Storage Gateway • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 308 Storage Gateway ListTapes API Reference 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 { "Limit": number, "Marker": "string", "TapeARNs": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Limit 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 A string that indicates the position at which to begin the returned list of tapes. Type: String ListTapes API Version 2013-06-30 309 Storage Gateway API Reference Length Constraints: Minimum length of 1. Maximum length of 1000. Required: No TapeARNs 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 { "Marker": "string", "TapeInfos": [ { "GatewayARN": "string", "PoolEntryDate": number, "PoolId": "string", "RetentionStartDate": number, "TapeARN": "string", "TapeBarcode": "string", "TapeSizeInBytes": number, "TapeStatus": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2013-06-30 310 Storage Gateway Marker API Reference 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 1000. TapeInfos An array of TapeInfo 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 objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples Example request 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. Errors API Version 2013-06-30 311 API Reference Storage Gateway Sample Request 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 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" } ] } Examples API Version 2013-06-30 312 Storage Gateway See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 313 Storage Gateway API Reference ListVolumeInitiators Lists iSCSI initiators that are connected to a volume. You can use this operation
|
storagegateway-api-067
|
storagegateway-api.pdf
| 67 |
Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 313 Storage Gateway API Reference ListVolumeInitiators 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 { "VolumeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VolumeARN The Amazon Resource Name (ARN) of the volume. Use the ListVolumes 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 { "Initiators": [ "string" ] } ListVolumeInitiators API Version 2013-06-30 314 Storage Gateway Response Elements API Reference 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 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 For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Response Elements API Version 2013-06-30 315 Storage Gateway • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 316 Storage Gateway API Reference ListVolumeRecoveryPoints Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 Response Syntax { "GatewayARN": "string", "VolumeRecoveryPointInfos": [ { "VolumeARN": "string", ListVolumeRecoveryPoints API Version 2013-06-30 317 Storage Gateway API Reference "VolumeRecoveryPointTime": "string", "VolumeSizeInBytes": number, "VolumeUsageInBytes": number } ] } Response Elements 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 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. VolumeRecoveryPointInfos An array of VolumeRecoveryPointInfo objects. Type: Array of VolumeRecoveryPointInfo objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. Response Elements API Version 2013-06-30 318 Storage Gateway HTTP Status Code: 400 Examples Example request API Reference The following example sends a ListVolumeRecoveryPoints request to take a snapshot of the specified example volume. Sample Request 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 HTTP/1.1 200 OK x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
|
storagegateway-api-068
|
storagegateway-api.pdf
| 68 |
request. For more information, see the error and message fields. 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. Response Elements API Version 2013-06-30 318 Storage Gateway HTTP Status Code: 400 Examples Example request API Reference The following example sends a ListVolumeRecoveryPoints request to take a snapshot of the specified example volume. Sample Request 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 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" } ] Examples API Version 2013-06-30 319 Storage Gateway } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 320 Storage Gateway ListVolumes API Reference Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API. The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types. Request Syntax { "GatewayARN": "string", "Limit": number, "Marker": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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: No Limit Specifies that the list of volumes returned be limited to the specified number of items. ListVolumes API Version 2013-06-30 321 Storage Gateway Type: Integer Valid Range: Minimum value of 1. Required: No Marker API Reference 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 1000. Required: No Response Syntax { "GatewayARN": "string", "Marker": "string", "VolumeInfos": [ { "GatewayARN": "string", "GatewayId": "string", "VolumeARN": "string", "VolumeAttachmentStatus": "string", "VolumeId": "string", "VolumeSizeInBytes": number, "VolumeType": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2013-06-30 322 Storage Gateway GatewayARN API Reference 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. Marker 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 1000. VolumeInfos An array of VolumeInfo 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 objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Errors API Version 2013-06-30 323 Storage Gateway Examples Example request API Reference 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 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 HTTP/1.1
|
storagegateway-api-069
|
storagegateway-api.pdf
| 69 |
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. HTTP Status Code: 400 Errors API Version 2013-06-30 323 Storage Gateway Examples Example request API Reference 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 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 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" }, { Examples API Version 2013-06-30 324 Storage Gateway API Reference "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 For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 325 Storage Gateway API Reference NotifyWhenUploaded 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 in the Amazon S3 File Gateway User Guide. Request Syntax { "FileShareARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileShareARN 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 { NotifyWhenUploaded API Version 2013-06-30 326 Storage Gateway API Reference "FileShareARN": "string", "NotificationId": "string" } Response Elements 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 The Amazon Resource Name (ARN) of the file share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. NotificationId 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 For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Response Elements API Version 2013-06-30 327 Storage Gateway See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 328 Storage Gateway RefreshCache API Reference Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. This operation is Only supported
|
storagegateway-api-070
|
storagegateway-api.pdf
| 70 |
bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. This operation is Only supported for S3 File Gateways. When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache operation completes. Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. 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. RefreshCache API Version 2013-06-30 329 Storage Gateway API Reference For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. Request Syntax { "FileShareARN": "string", "FolderList": [ "string" ], "Recursive": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileShareARN 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 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 Request Syntax API Version 2013-06-30 330 Storage Gateway Recursive API Reference 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 | false Type: Boolean Required: No Response Syntax { "FileShareARN": "string", "NotificationId": "string" } Response Elements 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 The Amazon Resource Name (ARN) of the file share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. NotificationId 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. Response Syntax API Version 2013-06-30 331 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for
|
storagegateway-api-071
|
storagegateway-api.pdf
| 71 |
400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-06-30 332 Storage Gateway API Reference RemoveTagsFromResource Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types. Request Syntax { "ResourceARN": "string", "TagKeys": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceARN 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 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 RemoveTagsFromResource API Version 2013-06-30 333 Storage Gateway Response Syntax { "ResourceARN": "string" } Response Elements API Reference 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 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 For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Response Syntax API Version 2013-06-30 334 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 335 Storage Gateway ResetCache API Reference 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 { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 ResetCache API Version 2013-06-30 336 Storage Gateway Response Syntax { "GatewayARN": "string" } Response Elements API Reference 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because
|
storagegateway-api-072
|
storagegateway-api.pdf
| 72 |
successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 337 Storage Gateway See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 338 Storage Gateway API Reference RetrieveTapeArchive 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 { "GatewayARN": "string", "TapeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways 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 The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS). RetrieveTapeArchive API Version 2013-06-30 339 Storage Gateway Type: String API Reference 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 { "TapeARN": "string" } Response Elements 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 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 For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 340 Storage Gateway API Reference InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields. HTTP Status Code: 400 Examples Retrieve a tape 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 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 { "TapeARN": "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST0AA2AF" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Examples API Version 2013-06-30 341 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 342 Storage Gateway API Reference RetrieveTapeRecoveryPoint Retrieves the recovery point for the specified virtual tape. This
|
storagegateway-api-073
|
storagegateway-api.pdf
| 73 |
information about using this API in one of the language-specific AWS SDKs, see the following: Examples API Version 2013-06-30 341 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 342 Storage Gateway API Reference RetrieveTapeRecoveryPoint 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 { "GatewayARN": "string", "TapeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 RetrieveTapeRecoveryPoint API Version 2013-06-30 343 Storage Gateway TapeARN API Reference 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 { "TapeARN": "string" } Response Elements 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 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 For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2013-06-30 344 Storage Gateway InternalServerError API Reference An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 345 Storage Gateway API Reference SetLocalConsolePassword 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 { "GatewayARN": "string", "LocalConsolePassword": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 LocalConsolePassword 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 SetLocalConsolePassword API Version 2013-06-30 346 Storage Gateway Response Syntax { "GatewayARN": "string" } Response Elements API Reference 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid
|
storagegateway-api-074
|
storagegateway-api.pdf
| 74 |
service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 347 Storage Gateway See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 348 Storage Gateway API Reference SetSMBGuestPassword 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 { "GatewayARN": "string", "Password": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 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 SetSMBGuestPassword API Version 2013-06-30 349 Storage Gateway Response Syntax { "GatewayARN": "string" } Response Elements API Reference 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 350 Storage Gateway See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 351 Storage Gateway ShutdownGateway API Reference 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, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. 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 to check the status. For more information, see ActivateGateway. If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway. Request Syntax { ShutdownGateway API Version 2013-06-30 352 Storage Gateway "GatewayARN": "string" } Request Parameters API Reference
|
storagegateway-api-075
|
storagegateway-api.pdf
| 75 |
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 to check the status. For more information, see ActivateGateway. If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway. Request Syntax { ShutdownGateway API Version 2013-06-30 352 Storage Gateway "GatewayARN": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 Response Syntax { "GatewayARN": "string" } Response Elements 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 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. Request Parameters API Version 2013-06-30 353 Storage Gateway Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples Shut down a gateway The following example shows a request that shuts down a gateway. Sample Request 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 HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25 Apr 2012 12:00:02 GMT Errors API Version 2013-06-30 354 Storage Gateway API Reference Content-type: application/x-amz-json-1.1 Content-length: 80 { "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 355 Storage Gateway API Reference StartAvailabilityMonitorTest 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 { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 Response Syntax { "GatewayARN": "string" StartAvailabilityMonitorTest API Version 2013-06-30 356 Storage Gateway } Response Elements API Reference 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2013-06-30 357 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript
|
storagegateway-api-076
|
storagegateway-api.pdf
| 76 |
more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2013-06-30 357 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 358 Storage Gateway StartCacheReport API Reference 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 { "BucketRegion": "string", "ClientToken": "string", "ExclusionFilters": [ { "Name": "string", "Values": [ "string" ] } ], "FileShareARN": "string", StartCacheReport API Version 2013-06-30 359 Storage Gateway API Reference "InclusionFilters": [ { "Name": "string", "Values": [ "string" ] } ], "LocationARN": "string", "Role": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VPCEndpointDNSName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BucketRegion 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 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 Request Parameters API Version 2013-06-30 360 Storage Gateway ExclusionFilters API Reference 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 objects Required: No FileShareARN The Amazon Resource Name (ARN) of the file share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes InclusionFilters 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 objects Required: No LocationARN The ARN of the Amazon S3 bucket where you want to save the cache report. Note 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 Request Parameters API Version 2013-06-30 361 Storage Gateway API Reference Length Constraints: Minimum length of 16. Maximum length of 1400. Required: Yes Role The ARN of the IAM role used when saving the cache report to Amazon S3. 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 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 objects Required: No VPCEndpointDNSName The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional. 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 { "CacheReportARN": "string" Response
|
storagegateway-api-077
|
storagegateway-api.pdf
| 77 |
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 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 objects Required: No VPCEndpointDNSName The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional. 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 { "CacheReportARN": "string" Response Syntax API Version 2013-06-30 362 Storage Gateway } Response Elements API Reference 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 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 For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples Start a cache report The following example starts a cache report that includes information about files that fail to upload, whose error causes are either InaccessibleStorageClass or ObjectMissing. Response Elements API Version 2013-06-30 363 Storage Gateway Sample Request POST / HTTP/1.1 API Reference 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", "Value": [ "InaccessibleStorageClass", "ObjectMissing" ] ] } Sample Response 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 For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2013-06-30 364 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 365 Storage Gateway StartGateway API Reference Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to 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 and check the status before making any additional API calls. For more information, see ActivateGateway. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 StartGateway API Version 2013-06-30 366 Storage Gateway Response Syntax { "GatewayARN": "string" } Response Elements API Reference 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 367 API Reference Storage Gateway Examples Start a gateway that was previously shut down The following example shows a request that starts a gateway. Sample Request 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 HTTP/1.1 200 OK x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Date: Wed, 25
|
storagegateway-api-078
|
storagegateway-api.pdf
| 78 |
the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 367 API Reference Storage Gateway Examples Start a gateway that was previously shut down The following example shows a request that starts a gateway. Sample Request 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 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 For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Examples API Version 2013-06-30 368 Storage Gateway • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 369 Storage Gateway API Reference UpdateAutomaticTapeCreationPolicy 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 { "AutomaticTapeCreationRules": [ { "MinimumNumTapes": number, "PoolId": "string", "TapeBarcodePrefix": "string", "TapeSizeInBytes": number, "Worm": boolean } ], "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AutomaticTapeCreationRules 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 objects Array Members: Minimum number of 1 item. Maximum number of 10 items. UpdateAutomaticTapeCreationPolicy API Version 2013-06-30 370 Storage Gateway Required: Yes GatewayARN API Reference 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 Response Syntax { "GatewayARN": "string" } Response Elements 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. Response Syntax API Version 2013-06-30 371 Storage Gateway API Reference 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 372 Storage Gateway API Reference UpdateBandwidthRateLimit 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. 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 { "AverageDownloadRateLimitInBitsPerSec": number, "AverageUploadRateLimitInBitsPerSec": number, "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AverageDownloadRateLimitInBitsPerSec The average download bandwidth rate limit in bits per second. Type: Long Valid Range: Minimum value of 102400. Required: No AverageUploadRateLimitInBitsPerSec
|
storagegateway-api-079
|
storagegateway-api.pdf
| 79 |
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 { "AverageDownloadRateLimitInBitsPerSec": number, "AverageUploadRateLimitInBitsPerSec": number, "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AverageDownloadRateLimitInBitsPerSec The average download bandwidth rate limit in bits per second. Type: Long Valid Range: Minimum value of 102400. Required: No AverageUploadRateLimitInBitsPerSec The average upload bandwidth rate limit in bits per second. UpdateBandwidthRateLimit API Version 2013-06-30 373 Storage Gateway Type: Long Valid Range: Minimum value of 51200. Required: No GatewayARN API Reference 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 Response Syntax { "GatewayARN": "string" } Response Elements 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 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. Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2013-06-30 374 Storage Gateway InternalServerError API Reference An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples Example request The following example shows a request that returns the bandwidth throttle properties of a gateway. Sample Request 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 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 Examples API Version 2013-06-30 375 Storage Gateway Content-length: 80 { API Reference "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 376 Storage Gateway API Reference UpdateBandwidthRateLimitSchedule 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 { "BandwidthRateLimitIntervals": [ { "AverageDownloadRateLimitInBitsPerSec": number, "AverageUploadRateLimitInBitsPerSec": number, "DaysOfWeek": [ number ], "EndHourOfDay": number, "EndMinuteOfHour": number, "StartHourOfDay": number, "StartMinuteOfHour": number } ], "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. BandwidthRateLimitIntervals 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 objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: Yes UpdateBandwidthRateLimitSchedule API Version 2013-06-30 377 Storage Gateway GatewayARN API Reference 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 Response Syntax { "GatewayARN": "string" } Response Elements 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. Response Syntax API Version 2013-06-30 378 Storage Gateway API Reference HTTP Status Code:
|
storagegateway-api-080
|
storagegateway-api.pdf
| 80 |
back an HTTP 200 response. The following data is returned in JSON format by the service. GatewayARN 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. Response Syntax API Version 2013-06-30 378 Storage Gateway API Reference 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 379 Storage Gateway API Reference UpdateChapCredentials 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 { "InitiatorName": "string", "SecretToAuthenticateInitiator": "string", "SecretToAuthenticateTarget": "string", "TargetARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. InitiatorName 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 UpdateChapCredentials API Version 2013-06-30 380 Storage Gateway SecretToAuthenticateInitiator API Reference The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. Note 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 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. Note 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 The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 800. Required: Yes Request Parameters API Version 2013-06-30 381 Storage Gateway Response Syntax { "InitiatorName": "string", "TargetARN": "string" } Response Elements API Reference 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 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 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 For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. Response Syntax API Version 2013-06-30 382 Storage Gateway API Reference 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. HTTP Status Code: 400 Examples Example request The following example shows a request that updates CHAP credentials for an iSCSI target. Sample Request 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 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", Examples API Version 2013-06-30 383 Storage Gateway API Reference "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK
|
storagegateway-api-081
|
storagegateway-api.pdf
| 81 |
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 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", Examples API Version 2013-06-30 383 Storage Gateway API Reference "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 384 Storage Gateway API Reference UpdateFileSystemAssociation Updates a file system association. This operation is only supported in the FSx File Gateways. Request Syntax { "AuditDestinationARN": "string", "CacheAttributes": { "CacheStaleTimeoutInSeconds": number }, "FileSystemAssociationARN": "string", "Password": "string", "UserName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AuditDestinationARN The Amazon Resource Name (ARN) of the storage used for the audit logs. Type: String Length Constraints: Maximum length of 1024. Required: No CacheAttributes The refresh cache information for the file share or FSx file systems. Type: CacheAttributes object Required: No FileSystemAssociationARN The Amazon Resource Name (ARN) of the file system association that you want to update. UpdateFileSystemAssociation API Version 2013-06-30 385 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Password The password of the user credential. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[ -~]+$ Required: No UserName The user name of the user credential that has permission to access the root share D$ 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 { "FileSystemAssociationARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2013-06-30 386 Storage Gateway FileSystemAssociationARN The ARN of the updated file system association. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. API Reference Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Errors API Version 2013-06-30 387 Storage Gateway • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 388 Storage Gateway API Reference UpdateGatewayInformation 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 { "CloudWatchLogGroupARN": "string", "GatewayARN": "string", "GatewayCapacity": "string", "GatewayName": "string", "GatewayTimezone": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CloudWatchLogGroupARN 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? Type: String Length Constraints: Maximum length of 562. Required: No UpdateGatewayInformation API Version 2013-06-30 389 Storage Gateway GatewayARN API Reference 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 GatewayCapacity 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
|
storagegateway-api-082
|
storagegateway-api.pdf
| 82 |
events in the gateway. For more information, see What is Amazon CloudWatch Logs? Type: String Length Constraints: Maximum length of 562. Required: No UpdateGatewayInformation API Version 2013-06-30 389 Storage Gateway GatewayARN API Reference 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 GatewayCapacity 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 in the Amazon S3 File Gateway User Guide. Type: String Valid Values: Small | Medium | Large Required: No GatewayName 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 A value that indicates the time zone of the gateway. Type: String Length Constraints: Minimum length of 3. Maximum length of 10. Required: No Request Parameters API Version 2013-06-30 390 Storage Gateway Response Syntax { "GatewayARN": "string", "GatewayName": "string" } Response Elements API Reference 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 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. GatewayName The name you configured for your gateway. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. Response Syntax API Version 2013-06-30 391 Storage Gateway HTTP Status Code: 400 Examples Update a gateway's name API Reference The following example shows a request that updates the name of a gateway. Sample Request 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 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 For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Examples API Version 2013-06-30 392 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 393 Storage Gateway API Reference UpdateGatewaySoftwareNow 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 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 and Customizing your Linux iSCSI settings, respectively. Request Syntax { "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 UpdateGatewaySoftwareNow API Version 2013-06-30 394 Storage Gateway API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: Yes Response Syntax { "GatewayARN": "string" } Response Elements 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. HTTP Status Code: 400 InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see
|
storagegateway-api-083
|
storagegateway-api.pdf
| 83 |
returned in JSON format by the service. GatewayARN 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. Response Syntax API Version 2013-06-30 395 Storage Gateway HTTP Status Code: 400 Examples Initiate a gateway VM update API Reference The following example shows a request that initiates a gateway VM update. Sample Request 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 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 For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Examples API Version 2013-06-30 396 API Reference Storage Gateway • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 397 Storage Gateway API Reference UpdateMaintenanceStartTime 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 { "DayOfMonth": number, "DayOfWeek": number, "GatewayARN": "string", "HourOfDay": number, "MinuteOfHour": number, "SoftwareUpdatePreferences": { "AutomaticUpdatePolicy": "string" } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. UpdateMaintenanceStartTime API Version 2013-06-30 398 Storage Gateway DayOfMonth API Reference 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 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 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 HourOfDay 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. Request Parameters API Version 2013-06-30 399 Storage Gateway Required: No MinuteOfHour API Reference 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 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 object Required: No Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200
|
storagegateway-api-084
|
storagegateway-api.pdf
| 84 |
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 object Required: No Response Syntax { "GatewayARN": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2013-06-30 400 Storage Gateway GatewayARN API Reference 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples Update a gateway's maintenance start time 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 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 Errors API Version 2013-06-30 401 Storage Gateway API Reference 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 For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 402 Storage Gateway API Reference UpdateNFSFileShare 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 { "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 }, UpdateNFSFileShare API Version 2013-06-30 403 Storage Gateway API Reference "NotificationPolicy": "string", "ObjectACL": "string", "ReadOnly": boolean, "RequesterPays": boolean, "Squash": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AuditDestinationARN The Amazon Resource Name (ARN) of the storage used for audit logs. Type: String Length Constraints: Maximum length of 1024. Required: No CacheAttributes Specifies refresh cache information for the file share. Type: CacheAttributes object Required: No ClientList The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP 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]))?$ Required: No Request Parameters API Version 2013-06-30 404 Storage Gateway DefaultStorageClass API Reference 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 | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA Type: String Length Constraints: Minimum length of 5. Maximum length of 50. Required: No EncryptionType 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. Note 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 The Amazon Resource Name (ARN) of the file share to be updated. Type: String Length Constraints: Minimum length of
|
storagegateway-api-085
|
storagegateway-api.pdf
| 85 |
stores in Amazon S3. Note 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 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 Request Parameters API Version 2013-06-30 405 Storage Gateway FileShareName The name of the file share. Optional. Note API Reference 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 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 | false Type: Boolean Required: No KMSEncrypted 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. Note We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters. Request Parameters API Version 2013-06-30 406 Storage Gateway API Reference 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 | false Type: Boolean Required: No KMSKey Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 The default values for the file share. Optional. Type: NFSFileShareDefaults object Required: No NotificationPolicy 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. Request Parameters API Version 2013-06-30 407 Storage Gateway Note API Reference 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 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 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. Request Parameters API Version 2013-06-30 408 Storage Gateway Valid Values: true | false Type: Boolean Required: No RequesterPays API Reference 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. Note 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 | false Type: Boolean Required: No Squash The user mapped to anonymous user. Valid values are
|
storagegateway-api-086
|
storagegateway-api.pdf
| 86 |
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. Note 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 | false Type: Boolean Required: No Squash 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 { Response Syntax API Version 2013-06-30 409 API Reference Storage Gateway "FileShareARN": "string" } Response Elements 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 The Amazon Resource Name (ARN) of the updated file share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Examples Update an NFS file share's file mode In the following request, you update the file mode for an NFS file share. Response Elements API Version 2013-06-30 410 API Reference Storage Gateway Sample Request { "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 { "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXX" } Update an NFS file share with file upload notification turned on 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 { "ClientToken": "xy23421", "NFSFileShareDefaults": { "FileMode": "0777", "DirectoryMode": "0777", "GroupId": "500", "OwnerId": "500" Examples API Version 2013-06-30 411 Storage Gateway }, API Reference "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 { "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" } Update an NFS file share with file upload notification turned off In the following request, you update an NFS file share with file upload notification turned off. Sample Request { "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", Examples API Version 2013-06-30 412 Storage Gateway API Reference "Squash": "RootSquash", "NotificationPolicy": "{}" } Sample Response { "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 413 Storage Gateway API Reference UpdateSMBFileShare 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 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 { "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", UpdateSMBFileShare API Version 2013-06-30 414 Storage Gateway API Reference "OplocksEnabled": boolean, "ReadOnly": boolean, "RequesterPays": boolean, "SMBACLEnabled": boolean, "ValidUserList": [ "string" ] } Request Parameters For information about the parameters that are common to all
|
storagegateway-api-087
|
storagegateway-api.pdf
| 87 |
in an AWS Region 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 { "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", UpdateSMBFileShare API Version 2013-06-30 414 Storage Gateway API Reference "OplocksEnabled": boolean, "ReadOnly": boolean, "RequesterPays": boolean, "SMBACLEnabled": boolean, "ValidUserList": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AccessBasedEnumeration The files and folders on this share will only be visible to users with read access. Type: Boolean Required: No AdminUserList 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 The Amazon Resource Name (ARN) of the storage used for audit logs. Type: String Length Constraints: Maximum length of 1024. Required: No Request Parameters API Version 2013-06-30 415 Storage Gateway CacheAttributes Specifies refresh cache information for the file share. Type: CacheAttributes object Required: No CaseSensitivity API Reference 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 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 | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA Type: String Length Constraints: Minimum length of 5. Maximum length of 50. Required: No EncryptionType 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. Note 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 Request Parameters API Version 2013-06-30 416 Storage Gateway API Reference 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 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 The name of the file share. Optional. Note 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 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. Request Parameters API Version 2013-06-30 417 Storage Gateway Valid Values: true | false Type: Boolean Required: No InvalidUserList API Reference 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 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. Note 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 | false Type: Boolean Request Parameters API
|
storagegateway-api-088
|
storagegateway-api.pdf
| 88 |
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. Note 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 | false Type: Boolean Request Parameters API Version 2013-06-30 418 Storage Gateway Required: No KMSKey API Reference Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 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. Note 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. Request Parameters API Version 2013-06-30 419 Storage Gateway {} Type: String API Reference Length Constraints: Minimum length of 2. Maximum length of 100. Pattern: ^\{[\w\s:\{\}\[\]"]*}$ Required: No ObjectACL 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 Specifies whether opportunistic locking is enabled for the SMB file share. Note 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 | false Type: Boolean Required: No ReadOnly 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 | false Request Parameters API Version 2013-06-30 420 Storage Gateway Type: Boolean Required: No RequesterPays API Reference 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. Note 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 | false Type: Boolean Required: No SMBACLEnabled 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 in the Amazon S3 File Gateway User Guide. Valid Values: true | false Type: Boolean Required: No ValidUserList 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 Request Parameters API Version 2013-06-30 421 Storage Gateway API Reference 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 { "FileShareARN": "string" } Response Elements 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 The Amazon Resource Name (ARN) of the updated SMB file share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request.
|
storagegateway-api-089
|
storagegateway-api.pdf
| 89 |
0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax { "FileShareARN": "string" } Response Elements 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 The Amazon Resource Name (ARN) of the updated SMB file share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. Response Syntax API Version 2013-06-30 422 Storage Gateway HTTP Status Code: 400 Examples Update an SMB file share API Reference 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 { "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 { "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" Examples API Version 2013-06-30 423 Storage Gateway } API Reference Update an SMB file share with file upload notification turned on 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 { "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 { "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY" } Examples API Version 2013-06-30 424 Storage Gateway API Reference Update an SMB file share with file upload notification turned off In the following request, you update an SMB file share with file upload notification turned off. Sample Request { "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 For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2013-06-30 425 Storage Gateway • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 426 Storage Gateway API Reference UpdateSMBFileShareVisibility 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 { "FileSharesVisible": boolean, "GatewayARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. FileSharesVisible The shares on this gateway appear when listing shares. Type: Boolean Required: Yes GatewayARN 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 Response Syntax { "GatewayARN": "string" UpdateSMBFileShareVisibility API Version 2013-06-30 427 Storage Gateway } Response Elements API Reference 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2013-06-30 428 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for
|
storagegateway-api-090
|
storagegateway-api.pdf
| 90 |
common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2013-06-30 428 API Reference Storage Gateway • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 429 Storage Gateway API Reference UpdateSMBLocalGroups Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway. Request Syntax { "GatewayARN": "string", "SMBLocalGroups": { "GatewayAdmins": [ "string" ] } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 SMBLocalGroups A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway. Type: SMBLocalGroups object Required: Yes UpdateSMBLocalGroups API Version 2013-06-30 430 Storage Gateway Response Syntax { "GatewayARN": "string" } Response Elements API Reference 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 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. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 431 Storage Gateway See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 432 Storage Gateway API Reference UpdateSMBSecurityStrategy 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 in the Amazon S3 File Gateway User Guide. A higher security strategy level can affect performance of the gateway. Request Syntax { "GatewayARN": "string", "SMBSecurityStrategy": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GatewayARN 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 SMBSecurityStrategy Specifies the type of security strategy. UpdateSMBSecurityStrategy API Version 2013-06-30 433 Storage Gateway API Reference 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.
|
storagegateway-api-091
|
storagegateway-api.pdf
| 91 |
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 { "GatewayARN": "string" } Response Elements 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 The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region. Response Syntax API Version 2013-06-30 434 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2013-06-30 435 Storage Gateway API Reference See Also API Version 2013-06-30 436 Storage Gateway API Reference UpdateSnapshotSchedule 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 { "Description": "string", "RecurrenceInHours": number, "StartAt": number, "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description Optional description of the snapshot that overwrites the existing description. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No UpdateSnapshotSchedule API Version 2013-06-30 437 Storage Gateway RecurrenceInHours API Reference 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 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 A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair. Note Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. 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 objects Required: No VolumeARN The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Request Parameters API Version 2013-06-30 438 Storage Gateway API Reference 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 { "VolumeARN": "string" } Response Elements 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 The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return
|
storagegateway-api-092
|
storagegateway-api.pdf
| 92 |
Array of Tag objects Required: No VolumeARN The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Request Parameters API Version 2013-06-30 438 Storage Gateway API Reference 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 { "VolumeARN": "string" } Response Elements 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 The Amazon Resource Name (ARN) of the volume. Use the ListVolumes 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 For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. HTTP Status Code: 400 Response Syntax API Version 2013-06-30 439 Storage Gateway API Reference InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields. HTTP Status Code: 400 Examples Example request The following example shows a request that updates a snapshot schedule. Sample Request 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 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" Examples API Version 2013-06-30 440 Storage Gateway } See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 441 Storage Gateway API Reference UpdateVTLDeviceType 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 { "DeviceType": "string", "VTLDeviceARN": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeviceType The type of medium changer you want to select. Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402 Type: String Length Constraints: Minimum length of 2. Maximum length of 50. Required: Yes VTLDeviceARN 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 UpdateVTLDeviceType API Version 2013-06-30 442 Storage Gateway Response Syntax { "VTLDeviceARN": "string" } Response Elements API Reference 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 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 For information about the errors that are common to all actions, see Common Errors. InternalServerError An internal server error has occurred during the request. For more information, see the error and message fields. 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. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Response Syntax API Version 2013-06-30 443 API Reference Storage Gateway • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 444 Storage Gateway Data Types API Reference The Storage Gateway API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AutomaticTapeCreationPolicyInfo • AutomaticTapeCreationRule • BandwidthRateLimitInterval • CacheAttributes • CachediSCSIVolume • CacheReportFilter • CacheReportInfo • ChapInfo • DeviceiSCSIAttributes • Disk • EndpointNetworkConfiguration • FileShareInfo • FileSystemAssociationInfo •
|
storagegateway-api-093
|
storagegateway-api.pdf
| 93 |
for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2013-06-30 444 Storage Gateway Data Types API Reference The Storage Gateway API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AutomaticTapeCreationPolicyInfo • AutomaticTapeCreationRule • BandwidthRateLimitInterval • CacheAttributes • CachediSCSIVolume • CacheReportFilter • CacheReportInfo • ChapInfo • DeviceiSCSIAttributes • Disk • EndpointNetworkConfiguration • FileShareInfo • FileSystemAssociationInfo • FileSystemAssociationStatusDetail • FileSystemAssociationSummary • GatewayInfo • NetworkInterface • NFSFileShareDefaults • NFSFileShareInfo • PoolInfo API Version 2013-06-30 445 Storage Gateway • SMBFileShareInfo • SMBLocalGroups • SoftwareUpdatePreferences • StorageGatewayError • StorediSCSIVolume • Tag • Tape • TapeArchive • TapeInfo • TapeRecoveryPointInfo • VolumeInfo • VolumeiSCSIAttributes • VolumeRecoveryPointInfo • VTLDevice API Reference API Version 2013-06-30 446 Storage Gateway API Reference AutomaticTapeCreationPolicyInfo Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies. Contents AutomaticTapeCreationRules An automatic tape creation policy consists of a list of automatic tape creation rules. This returns the rules that determine when and how to automatically create new tapes. Type: Array of AutomaticTapeCreationRule objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: No GatewayARN 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: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AutomaticTapeCreationPolicyInfo API Version 2013-06-30 447 Storage Gateway API Reference AutomaticTapeCreationRule An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically. Contents MinimumNumTapes The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway. For more information about automatic tape creation, see Creating Tapes Automatically. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. Required: Yes PoolId The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon 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 TapeBarcodePrefix A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique. AutomaticTapeCreationRule API Version 2013-06-30 448 Storage Gateway Note API Reference 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 The size, in bytes, of the virtual tape capacity. Type: Long Required: Yes Worm Set to true to indicate that tapes are to be archived as write-once-read-many (WORM). Set to false when WORM is not enabled for tapes. Type: Boolean Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 449 Storage Gateway API Reference BandwidthRateLimitInterval Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both. Note FSx File Gateway does not support this feature. Contents DaysOfWeek The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday. Type: Array of integers Array Members: Minimum number of 1 item. Maximum number of 7 items. Valid Range: Minimum value of 0. Maximum value of 6. Required: Yes EndHourOfDay The hour of the day to end the bandwidth rate limit interval. Type: Integer Valid Range: Minimum value of 0. Maximum value of 23.
|
storagegateway-api-094
|
storagegateway-api.pdf
| 94 |
limits are specified for uploading, downloading, or both. Note FSx File Gateway does not support this feature. Contents DaysOfWeek The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday. Type: Array of integers Array Members: Minimum number of 1 item. Maximum number of 7 items. Valid Range: Minimum value of 0. Maximum value of 6. Required: Yes EndHourOfDay The hour of the day to end the bandwidth rate limit interval. Type: Integer Valid Range: Minimum value of 0. Maximum value of 23. Required: Yes EndMinuteOfHour The minute of the hour to end the bandwidth rate limit interval. BandwidthRateLimitInterval API Version 2013-06-30 450 Storage Gateway API Reference Important The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59. Type: Integer Valid Range: Minimum value of 0. Maximum value of 59. Required: Yes StartHourOfDay The hour of the day to start the bandwidth rate limit interval. Type: Integer Valid Range: Minimum value of 0. Maximum value of 23. Required: Yes StartMinuteOfHour The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0. Type: Integer Valid Range: Minimum value of 0. Maximum value of 59. Required: Yes AverageDownloadRateLimitInBitsPerSec The average download rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the download rate limit is not set. Note S3 File Gateway does not support this feature. Type: Long Contents API Version 2013-06-30 451 Storage Gateway API Reference Valid Range: Minimum value of 102400. Required: No AverageUploadRateLimitInBitsPerSec The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set. Note For Tape Gateway and Volume Gateway, the minimum value is 51200. This field is required for S3 File Gateway, and the minimum value is 104857600. Type: Long Valid Range: Minimum value of 51200. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 452 Storage Gateway CacheAttributes API Reference The refresh cache information for the file share or FSx file systems. Contents CacheStaleTimeoutInSeconds Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds. Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days) Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CacheAttributes API Version 2013-06-30 453 Storage Gateway API Reference CachediSCSIVolume Describes an iSCSI cached volume. Contents CreatedDate The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp. Type: Timestamp Required: No KMSKey Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 SourceSnapshotId If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g., snap-78e22663. Otherwise, this field is not included. Type: String Pattern: \Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z Required: No CachediSCSIVolume API Version 2013-06-30 454 Storage Gateway TargetName API Reference 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 The Amazon Resource Name (ARN) of the storage 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+) Required: No VolumeAttachmentStatus A value that indicates whether
|
storagegateway-api-095
|
storagegateway-api.pdf
| 95 |
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 The Amazon Resource Name (ARN) of the storage 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+) Required: No VolumeAttachmentStatus A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving your volumes to a different gateway. Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No VolumeId The unique identifier of the volume, e.g., vol-AE4B946D. Contents API Version 2013-06-30 455 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 12. Maximum length of 30. Required: No VolumeiSCSIAttributes An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume. Type: VolumeiSCSIAttributes object Required: No 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 cached volume is not restoring or bootstrapping. Type: Double Required: No VolumeSizeInBytes The size, in bytes, of the volume capacity. Type: Long Required: No VolumeStatus One of the VolumeStatus values that indicates the state of the storage volume. Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No VolumeType One of the VolumeType enumeration values that describes the type of the volume. Contents API Version 2013-06-30 456 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 100. Required: No VolumeUsedInBytes The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill. Note This value is not available for volumes created prior to May 13, 2015, until you store data on the volume. If you use a delete tool that overwrites the data on your volume with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage. Type: Long Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 457 Storage Gateway CacheReportFilter API Reference A list of filter parameters and associated values that determine which files are included or excluded from a cache report created by a StartCacheReport request. Multiple instances of the same filter parameter are combined with an OR operation, while different parameters are combined with an AND operation. Contents Name The parameter name for a filter that determines which files are included or excluded from a cache report. Valid Names: UploadFailureReason | UploadState Type: String Valid Values: UploadState | UploadFailureReason Required: Yes Values The parameter value for a filter that determines which files are included or excluded from a cache report. Valid UploadFailureReason Values: InaccessibleStorageClass | InvalidObjectState | ObjectMissing | S3AccessDenied Valid UploadState Values: FailingUpload Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 25. Required: Yes CacheReportFilter API Version 2013-06-30 458 Storage Gateway See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 459 Storage Gateway CacheReportInfo API Reference Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time. Contents CacheReportARN 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: No CacheReportStatus The status of the specified cache report. Type: String Valid Values: IN_PROGRESS | COMPLETED | CANCELED | FAILED | ERROR Required: No EndTime The time at which the gateway stopped generating the cache report. Type: Timestamp Required: No ExclusionFilters The list of filters and parameters that determine which files are excluded from the
|
storagegateway-api-096
|
storagegateway-api.pdf
| 96 |
associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time. Contents CacheReportARN 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: No CacheReportStatus The status of the specified cache report. Type: String Valid Values: IN_PROGRESS | COMPLETED | CANCELED | FAILED | ERROR Required: No EndTime The time at which the gateway stopped generating the cache report. Type: Timestamp Required: No ExclusionFilters The list of filters and parameters that determine which files are excluded from the report. Type: Array of CacheReportFilter objects Required: No FileShareARN The Amazon Resource Name (ARN) of the file share. CacheReportInfo API Version 2013-06-30 460 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: No InclusionFilters The list of filters and parameters that determine which files are included in the report. Type: Array of CacheReportFilter objects Required: No LocationARN The ARN of the Amazon S3 bucket location where the cache report is saved. Type: String Length Constraints: Minimum length of 16. Maximum length of 1400. Required: No ReportCompletionPercent The percentage of the report generation process that has been completed at time of inquiry. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ReportName The file name of the completed cache report object stored in Amazon S3. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No Role The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage. Contents API Version 2013-06-30 461 Storage Gateway Type: String API Reference 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: No StartTime The time at which the gateway started generating the cache report. Type: Timestamp Required: No Tags The list of key/value tags associated with the report. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 462 Storage Gateway ChapInfo API Reference Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators. Contents InitiatorName 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: No SecretToAuthenticateInitiator The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No SecretToAuthenticateTarget The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g., Windows client). Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No TargetARN The Amazon Resource Name (ARN) of the volume. ChapInfo API Version 2013-06-30 463 Storage Gateway API Reference Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). Type: String Length Constraints: Minimum length of 50. Maximum length of 800. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 464 Storage Gateway API Reference DeviceiSCSIAttributes Lists iSCSI information about a VTL device. Contents ChapEnabled Indicates whether mutual CHAP is enabled for the iSCSI target. Type: Boolean Required: No NetworkInterfaceId The network interface identifier of the VTL device. Type: String Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)) {3}\z Required: No NetworkInterfacePort The port used to communicate with iSCSI VTL device targets. Type: Integer Required: No TargetARN Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target. Type: String Length Constraints: Minimum length of 50. Maximum length of 800. Required: No DeviceiSCSIAttributes API Version 2013-06-30 465 Storage Gateway See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 466 Storage Gateway Disk Represents a gateway's local disk. Contents DiskAllocationResource API Reference The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId. Type: String Required: No DiskAllocationType One of the DiskAllocationType enumeration values that identifies how a local disk is used. Valid Values: UPLOAD_BUFFER | CACHE_STORAGE Type: String Length Constraints: Minimum length of
|
storagegateway-api-097
|
storagegateway-api.pdf
| 97 |
for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 466 Storage Gateway Disk Represents a gateway's local disk. Contents DiskAllocationResource API Reference The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId. Type: String Required: No DiskAllocationType One of the DiskAllocationType enumeration values that identifies how a local disk is used. Valid Values: UPLOAD_BUFFER | CACHE_STORAGE Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No DiskAttributeList A list of values that represents attributes of a local disk. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 64. Required: No DiskId The unique device ID or other distinguishing data that identifies a local disk. Type: String Disk API Version 2013-06-30 467 Storage Gateway API Reference Length Constraints: Minimum length of 1. Maximum length of 300. Required: No DiskNode The device node of a local disk as assigned by the virtualization environment. Type: String Required: No DiskPath The path of a local disk in the gateway virtual machine (VM). Type: String Required: No DiskSizeInBytes The local disk size in bytes. Type: Long Required: No DiskStatus A value that represents the status of a local disk. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 468 Storage Gateway API Reference See Also API Version 2013-06-30 469 Storage Gateway API Reference EndpointNetworkConfiguration Specifies network configuration information for the gateway associated with the Amazon FSx file system. Contents IpAddresses A list of gateway IP addresses on which the associated Amazon FSx file system is available. Note If multiple file systems are associated with this gateway, this field is required. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1 item. Length Constraints: Minimum length of 7. Maximum length of 15. Pattern: ^((25[0-5]|(2[0-4]|1[0-9]|[1-9]|)[0-9])(\.(?!$)|$)){4} Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 EndpointNetworkConfiguration API Version 2013-06-30 470 API Reference Storage Gateway FileShareInfo Describes a file share. Only supported S3 File Gateway. Contents FileShareARN The Amazon Resource Name (ARN) of the file share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: No FileShareId The ID of the file share. Type: String Length Constraints: Minimum length of 12. Maximum length of 30. Required: No FileShareStatus The status of the file share. Valid Values: CREATING | UPDATING | AVAILABLE | DELETING Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No FileShareType The type of the file share. Type: String Valid Values: NFS | SMB FileShareInfo API Version 2013-06-30 471 Storage Gateway Required: No GatewayARN API Reference 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: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 472 Storage Gateway API Reference FileSystemAssociationInfo Describes the object returned by DescribeFileSystemAssociations that describes a created file system association. Contents AuditDestinationARN The Amazon Resource Name (ARN) of the storage used for the audit logs. Type: String Length Constraints: Maximum length of 1024. Required: No CacheAttributes The refresh cache information for the file share or FSx file systems. Type: CacheAttributes object Required: No EndpointNetworkConfiguration Specifies network configuration information for the gateway associated with the Amazon FSx file system. Note If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required. Type: EndpointNetworkConfiguration object Required: No FileSystemAssociationARN The Amazon Resource Name (ARN) of the file system association. FileSystemAssociationInfo API Version 2013-06-30 473 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: No FileSystemAssociationStatus The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No FileSystemAssociationStatusDetails An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status. Type: Array
|
storagegateway-api-098
|
storagegateway-api.pdf
| 98 |
gateway, this parameter's IpAddresses field is required. Type: EndpointNetworkConfiguration object Required: No FileSystemAssociationARN The Amazon Resource Name (ARN) of the file system association. FileSystemAssociationInfo API Version 2013-06-30 473 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: No FileSystemAssociationStatus The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No FileSystemAssociationStatusDetails An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status. Type: Array of FileSystemAssociationStatusDetail objects Required: No GatewayARN 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: No LocationARN The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference. Type: String Length Constraints: Minimum length of 8. Maximum length of 512. Contents API Version 2013-06-30 474 Storage Gateway Required: No Tags API Reference A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 475 Storage Gateway API Reference FileSystemAssociationStatusDetail Detailed information on file system association status. Contents ErrorCode The error code for a given file system association status. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FileSystemAssociationStatusDetail API Version 2013-06-30 476 Storage Gateway API Reference FileSystemAssociationSummary Gets the summary returned by ListFileSystemAssociation, which is a summary of a created file system association. Contents FileSystemAssociationARN The Amazon Resource Name (ARN) of the file system association. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: No FileSystemAssociationId The ID of the file system association. Type: String Length Constraints: Minimum length of 10. Maximum length of 30. Required: No FileSystemAssociationStatus The status of the file share. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No GatewayARN 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 FileSystemAssociationSummary API Version 2013-06-30 477 Storage Gateway API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 478 Storage Gateway GatewayInfo Describes a gateway object. Contents DeprecationDate API Reference 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. Required: No Ec2InstanceId The ID of the Amazon EC2 instance that was used to launch the gateway. Type: String Required: No Ec2InstanceRegion The AWS Region where the Amazon EC2 instance is located. Type: String Required: No GatewayARN 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: No GatewayId 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. GatewayInfo API Version 2013-06-30 479 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 12. Maximum length of 30. Required: No GatewayName The name of the gateway. Type: String Required: No GatewayOperationalState The state of the gateway. Valid Values: DISABLED | ACTIVE Type: String Length Constraints: Minimum length of 2. Maximum length of 25. Required: No GatewayType The type of the gateway. Important 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. Type: String Length Constraints: Minimum length of 2. Maximum length of 20. Required: No HostEnvironment The type of hardware or software platform on which the gateway is running. Contents
|
storagegateway-api-099
|
storagegateway-api.pdf
| 99 |
Type: String Required: No GatewayOperationalState The state of the gateway. Valid Values: DISABLED | ACTIVE Type: String Length Constraints: Minimum length of 2. Maximum length of 25. Required: No GatewayType The type of the gateway. Important 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. Type: String Length Constraints: Minimum length of 2. Maximum length of 20. Required: No HostEnvironment The type of hardware or software platform on which the gateway is running. Contents API Version 2013-06-30 480 Storage Gateway Note Tape Gateway is no longer available on Snow Family devices. API Reference Type: String Valid Values: VMWARE | HYPER-V | EC2 | KVM | OTHER | SNOWBALL Required: No HostEnvironmentId 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. Required: No SoftwareVersion The version number of the software running on the gateway appliance. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 481 Storage Gateway NetworkInterface Describes a gateway's network interface. Contents Ipv4Address API Reference The Internet Protocol version 4 (IPv4) address of the interface. Type: String Required: No Ipv6Address The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported. Type: String Required: No MacAddress The Media Access Control (MAC) address of the interface. Note This is currently unsupported and will not be returned in output. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 NetworkInterface API Version 2013-06-30 482 Storage Gateway • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 483 Storage Gateway API Reference NFSFileShareDefaults Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for S3 File Gateways. Contents DirectoryMode The Unix directory mode in the form "nnnn". For example, 0666 represents the default access mode for all directories inside the file share. The default value is 0777. Type: String Length Constraints: Minimum length of 1. Maximum length of 4. Pattern: ^[0-7]{4}$ Required: No FileMode The Unix file mode in the form "nnnn". For example, 0666 represents the default file mode inside the file share. The default value is 0666. Type: String Length Constraints: Minimum length of 1. Maximum length of 4. Pattern: ^[0-7]{4}$ Required: No GroupId The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody. Type: Long Valid Range: Minimum value of 0. Maximum value of 4294967294. NFSFileShareDefaults API Version 2013-06-30 484 Storage Gateway Required: No OwnerId API Reference The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody. Type: Long Valid Range: Minimum value of 0. Maximum value of 4294967294. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 485 Storage Gateway NFSFileShareInfo API Reference The Unix file permissions and ownership information assigned, by default, to native S3 objects when an S3 File Gateway discovers them in S3 buckets. This operation is only supported in S3 File Gateways. Contents AuditDestinationARN The Amazon Resource Name (ARN) of the storage used for audit logs. Type: String Length Constraints: Maximum length of 1024. Required: No BucketRegion Specifies the Region of the S3 bucket where the NFS file share stores files. Note 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 Refresh cache information for the file share. Type: CacheAttributes object Required: No NFSFileShareInfo API Version 2013-06-30 486 Storage Gateway ClientList API Reference The list of clients that are allowed to access the
|
storagegateway-api-100
|
storagegateway-api.pdf
| 100 |
of 1024. Required: No BucketRegion Specifies the Region of the S3 bucket where the NFS file share stores files. Note 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 Refresh cache information for the file share. Type: CacheAttributes object Required: No NFSFileShareInfo API Version 2013-06-30 486 Storage Gateway ClientList API Reference The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP 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]))?$ Required: No DefaultStorageClass 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 | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA Type: String Length Constraints: Minimum length of 5. Maximum length of 50. Required: No EncryptionType 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. Note 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. Contents API Version 2013-06-30 487 API Reference Storage Gateway Type: String Valid Values: SseS3 | SseKms | DsseKms Required: No FileShareARN The Amazon Resource Name (ARN) of the file share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: No FileShareId The ID of the file share. Type: String Length Constraints: Minimum length of 12. Maximum length of 30. Required: No FileShareName The name of the file share. Optional. Note FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No FileShareStatus The status of the file share. Contents API Version 2013-06-30 488 Storage Gateway API Reference Valid Values: CREATING | UPDATING | AVAILABLE | DELETING Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No GatewayARN 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: No GuessMIMETypeEnabled 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 | false Type: Boolean Required: No KMSEncrypted This member 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. Note We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters. Contents API Version 2013-06-30 489 Storage Gateway API Reference 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 | false Type: Boolean Required: No KMSKey Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 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 (/). Note 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/ Contents API Version 2013-06-30 490 Storage Gateway API Reference 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 in the Amazon S3
|
storagegateway-api-101
|
storagegateway-api.pdf
| 101 |
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 (/). Note 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/ Contents API Version 2013-06-30 490 Storage Gateway API Reference 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 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: No NFSFileShareDefaults Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for S3 File Gateways. Type: NFSFileShareDefaults object Required: No NotificationPolicy 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. Note 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. Contents API Version 2013-06-30 491 Storage Gateway API Reference 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 A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private. Type: String Valid Values: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read Required: No Path The file share path used by the NFS client to identify the mount point. Type: String Required: No ReadOnly 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 | false Type: Boolean Contents API Version 2013-06-30 492 Storage Gateway Required: No RequesterPays API Reference 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. Note 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 | false Type: Boolean Required: No Role The ARN of the 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: No Squash The user mapped to anonymous user. Valid options 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 Contents API Version 2013-06-30 493 Storage Gateway API Reference Length Constraints: Minimum length of 5. Maximum length of 15. Required: No Tags A list of up to 50 tags assigned to the NFS file share, 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 objects Required: No VPCEndpointDNSName Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3. Note 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see
|
storagegateway-api-102
|
storagegateway-api.pdf
| 102 |
tags using the ListTagsForResource API operation. Type: Array of Tag objects Required: No VPCEndpointDNSName Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3. Note 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 494 Storage Gateway API Reference See Also API Version 2013-06-30 495 Storage Gateway PoolInfo Describes a custom tape pool. Contents PoolARN API Reference The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and AWS Region. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: No PoolName The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$ Required: No PoolStatus Status of the custom tape pool. Pool can be ACTIVE or DELETED. Type: String Valid Values: ACTIVE | DELETED Required: No RetentionLockTimeInDays Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days). Type: Integer PoolInfo API Version 2013-06-30 496 Storage Gateway API Reference Valid Range: Minimum value of 0. Maximum value of 36500. Required: No RetentionLockType Tape retention lock type, which 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 The storage class that is associated with the 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: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 497 Storage Gateway SMBFileShareInfo API Reference The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways. Contents AccessBasedEnumeration Indicates whether AccessBasedEnumeration is enabled. Type: Boolean Required: No AdminUserList 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 The Amazon Resource Name (ARN) of the storage used for audit logs. Type: String Length Constraints: Maximum length of 1024. Required: No Authentication The authentication method of the file share. The default is ActiveDirectory. SMBFileShareInfo API Version 2013-06-30 498 Storage Gateway API Reference Valid Values: ActiveDirectory | GuestAccess Type: String Length Constraints: Minimum length of 5. Maximum length of 15. Required: No BucketRegion Specifies the Region of the S3 bucket where the SMB file share stores files. Note 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 Refresh cache information for the file share. Type: CacheAttributes object Required: No CaseSensitivity 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 Contents API Version 2013-06-30 499 Storage Gateway DefaultStorageClass API Reference 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 | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA Type: String Length
|
storagegateway-api-103
|
storagegateway-api.pdf
| 103 |
CacheAttributes Refresh cache information for the file share. Type: CacheAttributes object Required: No CaseSensitivity 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 Contents API Version 2013-06-30 499 Storage Gateway DefaultStorageClass API Reference 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 | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA Type: String Length Constraints: Minimum length of 5. Maximum length of 50. Required: No EncryptionType 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. Note 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 The Amazon Resource Name (ARN) of the file share. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Contents API Version 2013-06-30 500 Storage Gateway Required: No FileShareId The ID of the file share. Type: String API Reference Length Constraints: Minimum length of 12. Maximum length of 30. Required: No FileShareName The name of the file share. Optional. Note FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No FileShareStatus The status of the file share. Valid Values: CREATING | UPDATING | AVAILABLE | DELETING Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No GatewayARN 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 Contents API Version 2013-06-30 501 Storage Gateway API Reference Length Constraints: Minimum length of 50. Maximum length of 500. Required: No GuessMIMETypeEnabled 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 | false Type: Boolean Required: No InvalidUserList 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 This member 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. Note We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters. Contents API Version 2013-06-30 502 Storage Gateway API Reference 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 | false Type: Boolean Required: No KMSKey Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 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 (/). Note 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/ Contents API Version 2013-06-30 503 Storage Gateway API Reference 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
|
storagegateway-api-104
|
storagegateway-api.pdf
| 104 |
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 (/). Note 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/ Contents API Version 2013-06-30 503 Storage Gateway API Reference 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 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: No NotificationPolicy 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. Note 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 Contents API Version 2013-06-30 504 Storage Gateway API Reference Length Constraints: Minimum length of 2. Maximum length of 100. Pattern: ^\{[\w\s:\{\}\[\]"]*}$ Required: No ObjectACL A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private. 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 Specifies whether opportunistic locking is enabled for the SMB file share. Note 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 | false Type: Boolean Required: No Path The file share path used by the SMB client to identify the mount point. Type: String Required: No ReadOnly 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. Contents API Version 2013-06-30 505 Storage Gateway Valid Values: true | false Type: Boolean Required: No RequesterPays API Reference 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. Note 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 | false Type: Boolean Required: No Role The ARN of the 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: No SMBACLEnabled If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false, it indicates that file and directory permissions are mapped to the POSIX permission. Contents API Version 2013-06-30 506 Storage Gateway API Reference For more information, see Using Windows ACLs to limit SMB file share access in the Amazon S3 File Gateway User Guide. Type: Boolean Required: No Tags A list of up to 50 tags assigned to the SMB file share, 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 objects Required: No ValidUserList 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 Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect
|
storagegateway-api-105
|
storagegateway-api.pdf
| 105 |
operation. Type: Array of Tag objects Required: No ValidUserList 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 Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3. Note 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 Contents API Version 2013-06-30 507 Storage Gateway API Reference 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 508 Storage Gateway SMBLocalGroups API Reference A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway. Contents GatewayAdmins A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats include: DOMAIN\User1, user1, DOMAIN\group1, and group1. Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force- close files that are open and locked. 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SMBLocalGroups API Version 2013-06-30 509 Storage Gateway API Reference SoftwareUpdatePreferences A set of variables indicating the software update preferences for the gateway. Contents AutomaticUpdatePolicy Indicates the automatic update policy for a gateway. 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: String Valid Values: ALL_VERSIONS | EMERGENCY_VERSIONS_ONLY Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SoftwareUpdatePreferences API Version 2013-06-30 510 Storage Gateway API Reference StorageGatewayError Provides additional information about an error that was returned by the service. See the errorCode and errorDetails members for more information about the error. Contents errorCode Additional information about the error. Type: String Valid Values: ActivationKeyExpired | ActivationKeyInvalid | ActivationKeyNotFound | GatewayInternalError | GatewayNotConnected | GatewayNotFound | GatewayProxyNetworkConnectionBusy | AuthenticationFailure | BandwidthThrottleScheduleNotFound | Blocked | CannotExportSnapshot | ChapCredentialNotFound | DiskAlreadyAllocated | DiskDoesNotExist | DiskSizeGreaterThanVolumeMaxSize | DiskSizeLessThanVolumeSize | DiskSizeNotGigAligned | DuplicateCertificateInfo | DuplicateSchedule | EndpointNotFound | IAMNotSupported | InitiatorInvalid | InitiatorNotFound | InternalError | InvalidGateway | InvalidEndpoint | InvalidParameters | InvalidSchedule | LocalStorageLimitExceeded | LunAlreadyAllocated | LunInvalid | JoinDomainInProgress | MaximumContentLengthExceeded | MaximumTapeCartridgeCountExceeded | MaximumVolumeCountExceeded | NetworkConfigurationChanged | NoDisksAvailable | NotImplemented | NotSupported | OperationAborted | OutdatedGateway | ParametersNotImplemented | RegionInvalid | RequestTimeout | ServiceUnavailable | SnapshotDeleted | SnapshotIdInvalid | SnapshotInProgress | SnapshotNotFound | SnapshotScheduleNotFound | StagingAreaFull | StorageFailure | TapeCartridgeNotFound | TargetAlreadyExists | TargetInvalid | TargetNotFound | UnauthorizedOperation | VolumeAlreadyExists | VolumeIdInvalid | VolumeInUse | VolumeNotFound | VolumeNotReady Required: No StorageGatewayError API Version 2013-06-30 511 Storage Gateway errorDetails API Reference Human-readable text that provides detail about the error that occurred. Type: String to string map Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 512 Storage Gateway StorediSCSIVolume Describes an iSCSI stored volume. Contents CreatedDate API Reference The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp. Type: Timestamp Required: No KMSKey Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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:
|
storagegateway-api-106
|
storagegateway-api.pdf
| 106 |
Ruby V3 See Also API Version 2013-06-30 512 Storage Gateway StorediSCSIVolume Describes an iSCSI stored volume. Contents CreatedDate API Reference The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp. Type: Timestamp Required: No KMSKey Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 PreservedExistingData Indicates if when the stored volume was created, existing data on the underlying local disk was preserved. Valid Values: true | false Type: Boolean Required: No StorediSCSIVolume API Version 2013-06-30 513 Storage Gateway SourceSnapshotId API Reference If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included. Type: String Pattern: \Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z Required: No TargetName 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 The Amazon Resource Name (ARN) of the storage 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+) Required: No Contents API Version 2013-06-30 514 Storage Gateway VolumeAttachmentStatus API Reference A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway. Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No VolumeDiskId The ID of the local disk that was specified in the CreateStorediSCSIVolume operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Required: No VolumeId The unique identifier of the volume, e.g., vol-AE4B946D. Type: String Length Constraints: Minimum length of 12. Maximum length of 30. Required: No VolumeiSCSIAttributes An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume. Type: VolumeiSCSIAttributes object Required: No 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. Contents API Version 2013-06-30 515 API Reference Storage Gateway Type: Double Required: No VolumeSizeInBytes The size of the volume in bytes. Type: Long Required: No VolumeStatus One of the VolumeStatus values that indicates the state of the storage volume. Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No VolumeType One of the VolumeType enumeration values describing the type of the volume. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No VolumeUsedInBytes The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill. Note This value is not available for volumes created prior to May 13, 2015, until you store data on the volume. Contents API Version 2013-06-30 516 Storage Gateway Type: Long Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 517 Storage Gateway Tag API Reference A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /. Contents Key Tag key. The key can't start with aws:. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes Value Value of the tag key. Type: String Length Constraints: Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag API Version 2013-06-30 518 Storage Gateway
|
storagegateway-api-107
|
storagegateway-api.pdf
| 107 |
numbers, representable in UTF-8, and the following characters: + - = . _ : /. Contents Key Tag key. The key can't start with aws:. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes Value Value of the tag key. Type: String Length Constraints: Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag API Version 2013-06-30 518 Storage Gateway Tape Describes a virtual tape object. Contents KMSKey API Reference Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 PoolEntryDate The date that the tape enters a custom tape pool. Type: Timestamp Required: No PoolId The ID of the pool that contains tapes that will be archived. The tapes in this pool are 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 Tape API Version 2013-06-30 519 Storage Gateway Progress API Reference For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete. Range: 0 (not started) to 100 (complete). Type: Double Required: No RetentionStartDate The date that the tape is first archived with tape retention lock enabled. Type: Timestamp Required: No TapeARN The Amazon Resource Name (ARN) of the 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}$ Required: No TapeBarcode The barcode that identifies a specific virtual tape. Type: String Length Constraints: Minimum length of 5. Maximum length of 16. Pattern: ^[A-Z0-9]*$ Required: No TapeCreatedDate The date the virtual tape was created. Contents API Version 2013-06-30 520 API Reference Storage Gateway Type: Timestamp Required: No TapeSizeInBytes The size, in bytes, of the virtual tape capacity. Type: Long Required: No TapeStatus The current state of the virtual tape. Type: String Required: No TapeUsedInBytes The size, in bytes, of data stored on the virtual tape. Note This value is not available for tapes created prior to May 13, 2015. Type: Long Required: No VTLDevice The virtual tape library (VTL) device that the virtual tape is associated with. Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: No Worm If the tape is archived as write-once-read-many (WORM), this value is true. Contents API Version 2013-06-30 521 Storage Gateway Type: Boolean Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 522 Storage Gateway TapeArchive API Reference Represents a virtual tape that is archived in the virtual tape shelf (VTS). Contents CompletionTime The time that the archiving of the virtual tape was completed. The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. Type: Timestamp Required: No KMSKey Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 PoolEntryDate The time that the tape entered the custom tape pool. The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. Type: Timestamp Required: No PoolId The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool. TapeArchive API Version 2013-06-30 523 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 100. Required: No RetentionStartDate If the archived tape is subject to tape retention lock, the date that the archived tape started being retained. Type: Timestamp Required: No RetrievedTo The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to. The virtual tape is retrieved from the virtual tape shelf (VTS). Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: No TapeARN The Amazon Resource Name (ARN) of
|
storagegateway-api-108
|
storagegateway-api.pdf
| 108 |
with the pool. TapeArchive API Version 2013-06-30 523 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 100. Required: No RetentionStartDate If the archived tape is subject to tape retention lock, the date that the archived tape started being retained. Type: Timestamp Required: No RetrievedTo The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to. The virtual tape is retrieved from the virtual tape shelf (VTS). Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: No TapeARN The Amazon Resource Name (ARN) of an archived 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}$ Required: No TapeBarcode The barcode that identifies the archived virtual tape. Type: String Contents API Version 2013-06-30 524 Storage Gateway API Reference Length Constraints: Minimum length of 5. Maximum length of 16. Pattern: ^[A-Z0-9]*$ Required: No TapeCreatedDate The date the virtual tape was created. Type: Timestamp Required: No TapeSizeInBytes The size, in bytes, of the archived virtual tape. Type: Long Required: No TapeStatus The current state of the archived virtual tape. Type: String Required: No TapeUsedInBytes The size, in bytes, of data stored on the virtual tape. Note This value is not available for tapes created prior to May 13, 2015. Type: Long Required: No Worm Set to true if the archived tape is stored as write-once-read-many (WORM). Contents API Version 2013-06-30 525 Storage Gateway Type: Boolean Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 526 Storage Gateway TapeInfo Describes a virtual tape. Contents GatewayARN API Reference 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: No PoolEntryDate The date that the tape entered the custom tape pool with tape retention lock enabled. Type: Timestamp Required: No PoolId 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 RetentionStartDate The date that the tape became subject to tape retention lock. Type: Timestamp Required: No TapeInfo API Version 2013-06-30 527 Storage Gateway TapeARN The Amazon Resource Name (ARN) of a virtual tape. Type: String API Reference 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 TapeBarcode The barcode that identifies a specific virtual tape. Type: String Length Constraints: Minimum length of 5. Maximum length of 16. Pattern: ^[A-Z0-9]*$ Required: No TapeSizeInBytes The size, in bytes, of a virtual tape. Type: Long Required: No TapeStatus The status of the tape. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2013-06-30 528 Storage Gateway • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2013-06-30 529 Storage Gateway API Reference TapeRecoveryPointInfo Describes a recovery point. Contents TapeARN The Amazon Resource Name (ARN) of the 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}$ Required: No TapeRecoveryPointTime The time when the point-in-time view of the virtual tape was replicated for later recovery. The default timestamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. Type: Timestamp Required: No TapeSizeInBytes The size, in bytes, of the virtual tapes to recover. Type: Long Required: No TapeStatus The status of the virtual tapes. Type: String Required: No TapeRecoveryPointInfo API Version 2013-06-30 530 Storage Gateway See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 531 Storage Gateway VolumeInfo Describes a storage volume object. Contents GatewayARN API Reference 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: No GatewayId The unique identifier assigned to your
|
storagegateway-api-109
|
storagegateway-api.pdf
| 109 |
Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 531 Storage Gateway VolumeInfo Describes a storage volume object. Contents GatewayARN API Reference 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: No GatewayId 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. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). Type: String Length Constraints: Minimum length of 12. Maximum length of 30. Required: No VolumeARN The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN: arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABB Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). Type: String Length Constraints: Minimum length of 50. Maximum length of 500. VolumeInfo API Version 2013-06-30 532 Storage Gateway API Reference Pattern: arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z \-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+) Required: No VolumeAttachmentStatus One of the VolumeStatus values that indicates the state of the storage volume. Type: String Length Constraints: Minimum length of 3. Maximum length of 50. Required: No VolumeId The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). Type: String Length Constraints: Minimum length of 12. Maximum length of 30. Required: No VolumeSizeInBytes The size of the volume in bytes. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). Type: Long Required: No VolumeType One of the VolumeType enumeration values describing the type of the volume. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Contents API Version 2013-06-30 533 Storage Gateway Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 534 Storage Gateway API Reference VolumeiSCSIAttributes Lists iSCSI information about a volume. Contents ChapEnabled Indicates whether mutual CHAP is enabled for the iSCSI target. Type: Boolean Required: No LunNumber The logical disk number. Type: Integer Valid Range: Minimum value of 1. Required: No NetworkInterfaceId The network interface identifier. Type: String Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)) {3}\z Required: No NetworkInterfacePort The port used to communicate with iSCSI targets. Type: Integer Required: No TargetARN The Amazon Resource Name (ARN) of the volume target. VolumeiSCSIAttributes API Version 2013-06-30 535 Storage Gateway Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 800. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 536 Storage Gateway API Reference VolumeRecoveryPointInfo Describes a storage volume recovery point object. Contents VolumeARN The Amazon Resource Name (ARN) of the volume target. 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 VolumeRecoveryPointTime The time the recovery point was taken. Type: String Required: No VolumeSizeInBytes The size of the volume in bytes. Type: Long Required: No VolumeUsageInBytes The size of the data stored on the volume in bytes. Note This value is not available for volumes created prior to May 13, 2015, until you store data on the volume. VolumeRecoveryPointInfo API Version 2013-06-30 537 Storage Gateway Type: Long Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 538 API Reference Storage Gateway VTLDevice Represents a device object associated with a tape gateway. Contents DeviceiSCSIAttributes A list of iSCSI information about a VTL device. Type: DeviceiSCSIAttributes object Required: No VTLDeviceARN Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer). Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: No VTLDeviceProductIdentifier Specifies the model number of device that the VTL device emulates. Type: String Required: No VTLDeviceType Specifies the type of device that the VTL device emulates. Type: String Required: No VTLDeviceVendor Specifies the vendor of the device that the VTL device object emulates. Type: String VTLDevice API Version 2013-06-30 539 Storage Gateway
|
storagegateway-api-110
|
storagegateway-api.pdf
| 110 |
gateway. Contents DeviceiSCSIAttributes A list of iSCSI information about a VTL device. Type: DeviceiSCSIAttributes object Required: No VTLDeviceARN Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer). Type: String Length Constraints: Minimum length of 50. Maximum length of 500. Required: No VTLDeviceProductIdentifier Specifies the model number of device that the VTL device emulates. Type: String Required: No VTLDeviceType Specifies the type of device that the VTL device emulates. Type: String Required: No VTLDeviceVendor Specifies the vendor of the device that the VTL device object emulates. Type: String VTLDevice API Version 2013-06-30 539 Storage Gateway Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2013-06-30 540 Storage Gateway API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2013-06-30 541 Storage Gateway API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2013-06-30 542 Storage Gateway Type: string Required: Conditional X-Amz-SignedHeaders API Reference Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2013-06-30 543 Storage Gateway API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 API Version 2013-06-30 544 Storage Gateway RequestExpired API Reference The request reached the service more than 15
|
storagegateway-api-111
|
storagegateway-api.pdf
| 111 |
has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 API Version 2013-06-30 544 Storage Gateway RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 API Version 2013-06-30 545
|
storagegateway-fsxfile-ug-001
|
storagegateway-fsxfile-ug.pdf
| 1 |
Amazon FSx File Gateway User Guide AWS Storage Gateway API Version 2021-03-31 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Storage Gateway Amazon FSx File Gateway User Guide AWS Storage Gateway: Amazon FSx File Gateway User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Storage Gateway Amazon FSx File Gateway User Guide Table of Contents .......................................................................................................................................................... x What is Amazon FSx File Gateway ................................................................................................. 1 How FSx File Gateway works ..................................................................................................................... 1 Getting Started with AWS Storage Gateway ................................................................................. 4 Sign up for Amazon Web Services ........................................................................................................... 4 Create an IAM user with administrator privileges ................................................................................. 5 Accessing AWS Storage Gateway .............................................................................................................. 6 AWS Regions that support Storage Gateway ......................................................................................... 7 File Gateway setup requirements ................................................................................................... 9 Prerequisites .................................................................................................................................................. 9 Hardware and storage requirements ..................................................................................................... 10 Hardware requirements for on-premises VMs ................................................................................ 10 Requirements for Amazon EC2 instance types ............................................................................... 10 Storage requirements .......................................................................................................................... 11 Network and firewall requirements ....................................................................................................... 11 Port requirements ................................................................................................................................. 12 Networking and firewall requirements for the hardware appliance ........................................... 23 Allowing gateway access through firewall and routers ................................................................ 26 Configuring security group ................................................................................................................. 28 Supported hypervisors and host requirements ................................................................................... 28 Supported SMB clients for File Gateway .............................................................................................. 29 Supported file system operations .......................................................................................................... 30 Managing local disks ................................................................................................................................. 30 Deciding the amount of local disk storage ..................................................................................... 31 Add cache storage ................................................................................................................................ 32 Using ephemeral storage with EC2 gateways ................................................................................ 33 Using the hardware appliance ...................................................................................................... 34 Setting up your hardware appliance ...................................................................................................... 35 Physically installing your hardware appliance ..................................................................................... 36 Accessing the hardware appliance console ........................................................................................... 38 Configuring hardware appliance network parameters ....................................................................... 40 Activating your hardware appliance ....................................................................................................... 41 Creating a gateway on your hardware appliance ................................................................................ 43 Configuring a gateway IP address on the hardware appliance ......................................................... 44 API Version 2021-03-31 iii AWS Storage Gateway Amazon FSx File Gateway User Guide Removing gateway software from your hardware appliance ........................................................... 46 Deleting your hardware appliance ......................................................................................................... 47 Creating your gateway .................................................................................................................. 49 Overview - Gateway Activation ............................................................................................................... 49 Set up gateway ..................................................................................................................................... 49 Connect to AWS .................................................................................................................................... 49 Review and activate ............................................................................................................................. 50 Overview - Gateway Configuration ........................................................................................................ 50 Overview - Storage Resources ................................................................................................................ 50 Create an Amazon FSx for Windows File Server file system ............................................................. 50 Create and activate an Amazon FSx File Gateway .............................................................................. 52 Set up an Amazon FSx File Gateway ................................................................................................ 52 Connect your Amazon FSx File Gateway to AWS ........................................................................... 53 Review settings and activate your Amazon FSx File Gateway ..................................................... 54 Configure your Amazon FSx File Gateway ...................................................................................... 55 Activating a gateway in a VPC ................................................................................................................ 58 Create a VPC endpoint for Storage Gateway ................................................................................. 58 Configure Microsoft Active Directory domain access settings .................................................... 60 Attach an Amazon FSx file system ............................................................................................... 62 Mount and use your Amazon FSx file share ................................................................................ 65 Mount your SMB file share on your client ............................................................................................ 65 Test your FSx File Gateway ...................................................................................................................... 67 Managing your Amazon FSx File Gateway resources .................................................................. 68 Gateway status ........................................................................................................................................... 68 Understanding file system status ........................................................................................................... 69 Edit basic gateway information .............................................................................................................. 70 Set gateway security level ....................................................................................................................... 71 Editing Active Directory settings for n FSx File Gateway .................................................................. 72 Editing settings for an Amazon FSx file system .................................................................................. 74 Detaching an Amazon FSx file system .................................................................................................. 75 Monitoring Storage Gateway ........................................................................................................ 76 Understanding CloudWatch alarms ........................................................................................................ 76 Create recommended CloudWatch alarms ........................................................................................... 78 Create a custom CloudWatch alarm ...................................................................................................... 79 Monitoring your FSx File Gateway ......................................................................................................... 81 Getting FSx File Gateway health logs .............................................................................................. 81 API Version 2021-03-31 iv AWS Storage Gateway Amazon FSx File Gateway User Guide Using Amazon CloudWatch metrics .................................................................................................. 83 Understanding gateway metrics ........................................................................................................ 84 Understanding file system metrics ................................................................................................... 90 Understanding FSx File Gateway audit logs ................................................................................... 93 Create a cache report ................................................................................................................................ 97 Manage cache reports ............................................................................................................................. 100 Understanding cache reports ................................................................................................................ 101 Maintaining your gateway .......................................................................................................... 104 Managing gateway updates ................................................................................................................... 104 Update frequency and expected behavior .................................................................................... 105 Turn maintenance updates on or off ............................................................................................. 106 Modify the gateway maintenance window schedule .................................................................. 107 Apply an update manually ............................................................................................................... 108 Performing maintenance tasks using the local console .................................................................. 109 Accessing the gateway local console ............................................................................................. 109 Performing tasks on the virtual machine local console ............................................................. 112 Performing tasks on the EC2 local console .................................................................................. 128 Shutting down your gateway VM ......................................................................................................... 135 Replacing your existing FSx File Gateway with a new instance ..................................................... 136
|
storagegateway-fsxfile-ug-002
|
storagegateway-fsxfile-ug.pdf
| 2 |
............................................................................................................................. 100 Understanding cache reports ................................................................................................................ 101 Maintaining your gateway .......................................................................................................... 104 Managing gateway updates ................................................................................................................... 104 Update frequency and expected behavior .................................................................................... 105 Turn maintenance updates on or off ............................................................................................. 106 Modify the gateway maintenance window schedule .................................................................. 107 Apply an update manually ............................................................................................................... 108 Performing maintenance tasks using the local console .................................................................. 109 Accessing the gateway local console ............................................................................................. 109 Performing tasks on the virtual machine local console ............................................................. 112 Performing tasks on the EC2 local console .................................................................................. 128 Shutting down your gateway VM ......................................................................................................... 135 Replacing your existing FSx File Gateway with a new instance ..................................................... 136 Deleting your gateway and removing resources ............................................................................... 138 Deleting Your Gateway by Using the Storage Gateway Console .............................................. 138 Performance and optimization ................................................................................................... 140 Basic performance guidance for FSx File Gateway ........................................................................... 140 FSx File Gateway performance on Windows clients .................................................................... 141 Optimizing gateway performance ........................................................................................................ 141 Add Resources to Your Gateway ..................................................................................................... 142 Add Resources to Your Application Environment ........................................................................ 144 Maximizing S3 File Gateway throughput ............................................................................................ 144 Deploy your gateway in the same location as your clients ........................................................ 145 Reduce bottlenecks caused by slow disks ..................................................................................... 145 Adjust virtual machine resource allocation for CPU, RAM, and cache disks ........................... 146 Adjust the SMB security level .......................................................................................................... 148 Use multiple threads and clients to parallelize write operations ............................................. 148 Turn off automated cache refresh .................................................................................................. 150 Increase the number of Amazon S3 uploader threads ............................................................... 151 Increase SMB timeout settings ........................................................................................................ 152 API Version 2021-03-31 v AWS Storage Gateway Amazon FSx File Gateway User Guide Turn on opportunistic locking for compatible applications ....................................................... 152 Adjust gateway capacity according to the size of the working file set .................................... 152 Deploy multiple gateways for larger workloads .......................................................................... 153 Security ........................................................................................................................................ 155 Data protection ........................................................................................................................................ 155 Data encryption .................................................................................................................................. 156 Identity and access management ......................................................................................................... 157 Audience ............................................................................................................................................... 157 Authenticating with identities ......................................................................................................... 158 Managing access using policies ....................................................................................................... 161 How AWS Storage Gateway works with IAM ................................................................................ 164 Identity-based policy examples ....................................................................................................... 170 Troubleshooting .................................................................................................................................. 173 Using tags to control access to resources ..................................................................................... 175 Compliance validation ............................................................................................................................ 178 Resilience ................................................................................................................................................... 178 Infrastructure security ............................................................................................................................. 179 AWS Security Best Practices .................................................................................................................. 180 Logging and monitoring ........................................................................................................................ 180 Storage Gateway information in CloudTrail ................................................................................. 180 Understanding Storage Gateway log file entries ......................................................................... 181 Troubleshooting ........................................................................................................................... 184 Troubleshooting: gateway offline issues ............................................................................................. 185 Check the associated firewall or proxy .......................................................................................... 185 Check for an ongoing SSL or deep-packet inspection of your gateway's traffic .................... 185 Check the IOWaitPercent metric after a reboot or software update ....................................... 185 Check for a power outage or hardware failure on the hypervisor host ................................... 186 Check for issues with an associated cache disk ........................................................................... 186 Troubleshooting: Active Directory issues ............................................................................................ 186 Confirm that the gateway can reach the domain controller by running an nping test ......... 187 Check the DHCP options set for the VPC of your Amazon EC2 gateway instance ................. 188 Confirm that the gateway can resolve the domain by running a dig query ........................... 188 Check the domain controller settings and roles .......................................................................... 189 Check that the gateway is joined to the nearest domain controller ........................................ 189 Confirm that Active Directory creates new computer objects in the default organizational unit (OU) ............................................................................................................................................... 190 API Version 2021-03-31 vi AWS Storage Gateway Amazon FSx File Gateway User Guide Check your domain controller event logs ..................................................................................... 190 Troubleshooting: gateway activation issues ....................................................................................... 190 Resolve errors when activating your gateway using a public endpoint ................................... 191 Resolve errors when activating your gateway using an Amazon VPC endpoint .................... 194 Resolve errors when activating your gateway using a public endpoint and there is a Storage Gateway VPC endpoint in the same VPC ....................................................................... 198 Troubleshooting: on-premises gateway issues .................................................................................. 199 Turning on Support access to help troubleshoot your gateway ............................................... 202 Troubleshooting: Microsoft Hyper-V setup issues ............................................................................ 203 Troubleshooting: Amazon EC2 gateway issues .................................................................................. 207 Gateway activation hasn't occurred after a few moments ........................................................ 207 Can't find the EC2 gateway instance in the instance list ........................................................... 208 Connect to your Amazon EC2 gateway using the serial console .............................................. 208 Turning on Support access to help troubleshoot the gateway ................................................. 208 Troubleshooting: hardware appliance issues ..................................................................................... 210 How to determine service IP address ............................................................................................. 210 How to perform a factory reset ...................................................................................................... 211 How to perform a remote restart ................................................................................................... 211 How to obtain Dell iDRAC support ................................................................................................. 211 How to find the hardware appliance serial number ................................................................... 211 How to get hardware appliance support ....................................................................................... 212 Troubleshooting: File Gateway issues .................................................................................................. 212 Error: FileMissing ................................................................................................................................ 213 Error: FsxFileSystemAuthenticationFailure .................................................................................... 213 Error: FsxFileSystemConnectionFailure .......................................................................................... 214 Error: FsxFileSystemFull .................................................................................................................... 214 Error: GatewayClockOutOfSync ....................................................................................................... 214 Error: InvalidFileState ........................................................................................................................ 214 Error: ObjectMissing ........................................................................................................................... 215 Error: DroppedNotifications ............................................................................................................. 215 Notification: HardReboot .................................................................................................................. 216 Notification: Reboot ........................................................................................................................... 216 Troubleshooting Active Directory domain issues ......................................................................... 216
|
storagegateway-fsxfile-ug-003
|
storagegateway-fsxfile-ug.pdf
| 3 |
service IP address ............................................................................................. 210 How to perform a factory reset ...................................................................................................... 211 How to perform a remote restart ................................................................................................... 211 How to obtain Dell iDRAC support ................................................................................................. 211 How to find the hardware appliance serial number ................................................................... 211 How to get hardware appliance support ....................................................................................... 212 Troubleshooting: File Gateway issues .................................................................................................. 212 Error: FileMissing ................................................................................................................................ 213 Error: FsxFileSystemAuthenticationFailure .................................................................................... 213 Error: FsxFileSystemConnectionFailure .......................................................................................... 214 Error: FsxFileSystemFull .................................................................................................................... 214 Error: GatewayClockOutOfSync ....................................................................................................... 214 Error: InvalidFileState ........................................................................................................................ 214 Error: ObjectMissing ........................................................................................................................... 215 Error: DroppedNotifications ............................................................................................................. 215 Notification: HardReboot .................................................................................................................. 216 Notification: Reboot ........................................................................................................................... 216 Troubleshooting Active Directory domain issues ......................................................................... 216 Troubleshooting with CloudWatch metrics ................................................................................... 218 High Availability Health Notifications ................................................................................................. 221 Troubleshooting: high availability issues ............................................................................................ 221 API Version 2021-03-31 vii AWS Storage Gateway Amazon FSx File Gateway User Guide Health notifications ............................................................................................................................ 221 Metrics ................................................................................................................................................... 223 Best practices ............................................................................................................................... 224 Recovering your data .............................................................................................................................. 224 Recovering from an unexpected VM shutdown ........................................................................... 224 Recovering data from a malfunctioning cache disk .................................................................... 225 Recovering data from an inaccessible data center ...................................................................... 225 Restore data on Amazon FSx ................................................................................................................ 225 Clean up unnecessary resources ........................................................................................................... 226 Additional resources .................................................................................................................... 227 Host setup ................................................................................................................................................. 227 Deploy a default Amazon EC2 host for File Gateway ................................................................. 228 Deploy a customized Amazon EC2 host for File Gateway ......................................................... 230 Modify Amazon EC2 instance metadata options ......................................................................... 234 Synchronize VM time with Hyper-V or Linux KVM host time .................................................... 235 Synchronize VM time with VMware host time ............................................................................. 235 Configuring network adapters for your gateway ......................................................................... 237 Using Storage Gateway with VMware HA ..................................................................................... 240 Getting activation key ............................................................................................................................ 244 Linux (curl) ........................................................................................................................................... 245 Linux (bash/zsh) .................................................................................................................................. 246 Microsoft Windows PowerShell ....................................................................................................... 246 Using your local console ................................................................................................................... 247 Using AWS Direct Connect ..................................................................................................................... 247 Active Directory permissions ................................................................................................................. 248 Getting the gateway IP address ........................................................................................................... 249 Getting an IP Address from an Amazon EC2 Host ...................................................................... 250 Understanding resources and resource IDs ........................................................................................ 251 Working with Resource IDs ............................................................................................................... 251 Tagging your resources ........................................................................................................................... 252 Working with tags .............................................................................................................................. 253 Open-source components ...................................................................................................................... 254 Open-source components for Storage Gateway .......................................................................... 254 Open-source components for Amazon FSx File Gateway .......................................................... 255 Quotas ........................................................................................................................................................ 255 Quotas for Amazon FSx file systems ............................................................................................. 255 API Version 2021-03-31 viii AWS Storage Gateway Amazon FSx File Gateway User Guide Recommended local disk sizes for your gateway ........................................................................ 256 API Reference ............................................................................................................................... 257 Required Request Headers ..................................................................................................................... 257 Signing Requests ...................................................................................................................................... 259 Example Signature Calculation ........................................................................................................ 260 Error Responses ........................................................................................................................................ 262 Exceptions ............................................................................................................................................ 263 Operation Error Codes ....................................................................................................................... 265 Error Responses .................................................................................................................................. 285 Actions ........................................................................................................................................................ 287 Document history ........................................................................................................................ 288 Earlier updates .......................................................................................................................................... 298 API Version 2021-03-31 ix AWS Storage Gateway Amazon FSx File Gateway User Guide 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. API Version 2021-03-31 x AWS Storage Gateway Amazon FSx File Gateway User Guide What is Amazon FSx File Gateway Amazon FSx File Gateway (FSx File Gateway) is a new File Gateway type that provides low latency and efficient access to in-cloud FSx for Windows File Server file shares from your on-premises facility. If you maintain on-premises file storage because of latency or bandwidth requirements, you can instead use FSx File Gateway for seamless access to fully managed, highly reliable, and virtually unlimited Windows file shares provided in the AWS Cloud by FSx for Windows File Server. Benefits of using Amazon FSx File Gateway FSx File Gateway provides the following benefits: • Helps eliminate on-premises file servers and consolidates all their data in AWS to take advantage of the scale and economics of cloud storage. • Provides options that you can use for all your file workloads, including those that require on- premises access to cloud data. • Applications that need to stay on premises can now experience the same low latency and high performance that they have in AWS, without taxing your networks or impacting the latencies experienced by your most demanding applications. How Amazon FSx File Gateway works To use Amazon FSx File Gateway (FSx File Gateway), you must have at least one Amazon FSx for Windows File Server file system. You must also have on-premises access to FSx for Windows File Server, either through a VPN or through an AWS Direct Connect connection. For more information about using Amazon FSx file systems, see What is Amazon FSx for Windows File Server? You deploy the gateway into your on-premises environment as a virtual machine (VM) running on VMware ESXi, Microsoft Hyper-V, or Linux Kernel-based Virtual Machine (KVM), or as a hardware appliance that you order from your preferred reseller. You can also deploy the Storage Gateway VM in VMware Cloud on AWS, or as an AMI
|
storagegateway-fsxfile-ug-004
|
storagegateway-fsxfile-ug.pdf
| 4 |
Windows File Server file system. You must also have on-premises access to FSx for Windows File Server, either through a VPN or through an AWS Direct Connect connection. For more information about using Amazon FSx file systems, see What is Amazon FSx for Windows File Server? You deploy the gateway into your on-premises environment as a virtual machine (VM) running on VMware ESXi, Microsoft Hyper-V, or Linux Kernel-based Virtual Machine (KVM), or as a hardware appliance that you order from your preferred reseller. You can also deploy the Storage Gateway VM in VMware Cloud on AWS, or as an AMI in Amazon EC2. After deploying your appliance, you activate the FSx File Gateway from the Storage Gateway console or through the Storage Gateway API. After the Amazon FSx File Gateway is activated and can access FSx for Windows File Server, use the Storage Gateway console to join it to your Microsoft Active Directory domain. After the How FSx File Gateway works API Version 2021-03-31 1 AWS Storage Gateway Amazon FSx File Gateway User Guide gateway successfully joins a domain, you use the Storage Gateway console to attach the gateway to an existing FSx for Windows File Server. FSx for Windows File Server makes all the shares on the server available as shares on your Amazon FSx File Gateway. You can then use a client to browse and connect to the file shares on FSx File Gateway that correspond to the selected FSx File Gateway. When the file shares are connected, you can read and write your files locally, while benefiting from all the features available on FSx for Windows File Server. FSx File Gateway maps local file shares and their contents to file shares stored remotely in FSx for Windows File Server. There is a 1:1 correspondence between the remote and locally visible files and their shares. The following diagram provides an overview of file storage deployment for Storage Gateway. Note the following in the diagram: • AWS Direct Connect or a VPN is needed to allow the FSx File Gateway to access the Amazon FSx file share using SMB and to allow the FSx for Windows File Server to join your on-premises Active Directory domain. How FSx File Gateway works API Version 2021-03-31 2 AWS Storage Gateway Amazon FSx File Gateway User Guide • Amazon Virtual Private Cloud (Amazon VPC) is needed to connect to the FSx for Windows File Server service VPC and the Storage Gateway service VPC using private endpoints. The FSx File Gateway can also connect to the public endpoints. You can use Amazon FSx File Gateway in all AWS Regions where FSx for Windows File Server is available. How FSx File Gateway works API Version 2021-03-31 3 AWS Storage Gateway Amazon FSx File Gateway User Guide Getting Started with AWS Storage Gateway This section provides instructions for getting started with AWS. You need an AWS account before you can start using AWS Storage Gateway. You can use an existing AWS account, or sign up for a new account. You also need an IAM user in your AWS account that belongs to a group with the necessary administrative permissions to perform Storage Gateway tasks. Users with the appropriate privileges can access the Storage Gateway console and Storage Gateway API to perform gateway deployment, configuration, and maintenance tasks. If you are a first-time user, we recommend that you review the Supported AWS regions and File Gateway setup requirements sections before you being working with Storage Gateway. This section contains the following topics, which provide additional information about getting started with AWS Storage Gateway: Topics • Sign up for Amazon Web Services - Learn how to sign up for AWS and create an AWS account. • Create an IAM user with administrator privileges - Learn how to create an IAM user with administrative privileges for your AWS account. • Accessing AWS Storage Gateway - Learn how to access AWS Storage Gateway through the Storage Gateway console or programmatically using the AWS SDKs. • AWS Regions that support Storage Gateway - Learn which AWS Regions you can use to store your data when you activate your gateway in Storage Gateway. Sign up for Amazon Web Services An AWS account is a fundamental requirement for accessing AWS services. Your AWS account is the basic container for all of the AWS resources you create as an AWS user. Your AWS account is also the basic security boundary for your AWS resources. Any resources that you create in your account are available to users who have credentials for the account. Before you can start using AWS Storage Gateway, you need to sign up for an AWS account. If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup.
|
storagegateway-fsxfile-ug-005
|
storagegateway-fsxfile-ug.pdf
| 5 |
is a fundamental requirement for accessing AWS services. Your AWS account is the basic container for all of the AWS resources you create as an AWS user. Your AWS account is also the basic security boundary for your AWS resources. Any resources that you create in your account are available to users who have credentials for the account. Before you can start using AWS Storage Gateway, you need to sign up for an AWS account. If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. Sign up for Amazon Web Services API Version 2021-03-31 4 AWS Storage Gateway Amazon FSx File Gateway User Guide 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. We also recommend that you require your users to use temporary credentials when accessing AWS. To provide temporary credentials, you can use federation and an identity provider, such as AWS IAM Identity Center. If your company already uses an identity provider, you can use it with federation to simplify how you provide access to the resources in your AWS account. Create an IAM user with administrator privileges After you create your AWS account, use the following steps to create an AWS Identity and Access Management (IAM) user for yourself, and then add that user to a group that has administrative permissions. For more information about using the AWS Identity and Access Management service to control access to Storage Gateway resources, see Identity and access management for AWS Storage Gateway. To create an administrator user, choose one of the following options. To By You can also Choose one way to manage your administr ator In IAM Identity Use short-term credentials to access Following the instructions in Getting started in the Configure programmatic access by Configuring the Center AWS. AWS IAM Identity Center AWS CLI to use AWS IAM User Guide. Identity Center in the AWS Create an IAM user with administrator privileges API Version 2021-03-31 5 AWS Storage Gateway Amazon FSx File Gateway User Guide To By You can also Choose one way to manage your administr ator (Recommen This aligns with the Command Line Interface User ded) security best practices . For information about best practices , see Security best practices in IAM in the IAM User Guide. Guide. In IAM (Not Use long-term credentials to access Following the instructions in Create an IAM user for Configure programmatic access by Manage access keys AWS. emergency access in the for IAM users in the IAM User IAM User Guide. Guide. recommend ed) Warning IAM users have long-term credentials which present a security risk. To help mitigate this risk, we recommend that you provide these users with only the permissions they require to perform the task and that you remove these users when they are no longer needed. Accessing AWS Storage Gateway You can use the AWS Storage Gateway console to perform various gateway configuration and maintenance tasks, including activating or removing Storage Gateway hardware appliances from your deployment, creating, managing, and deleting the different types of gateways, attaching, managing, and detaching file systems, and monitoring the health and status of various elements of the Storage Gateway service. For simplicity and ease of use, this guide focuses on performing tasks Accessing AWS Storage Gateway API Version 2021-03-31 6 AWS Storage Gateway Amazon FSx File Gateway User Guide using the Storage Gateway console web interface. You can access the Storage Gateway console through your web browser at: https://console.aws.amazon.com/storagegateway/home/. If you prefer a programmatic approach, you can use the AWS Storage Gateway Application Programming Interface (API) or Command Line Interface (CLI) to set up and manage the resources in your Storage Gateway deployment. For more information about actions, data types, and required syntax for the Storage Gateway API, see the Storage Gateway API Reference. For more information about the Storage Gateway CLI, see the AWS CLI Command Reference. You can also use the AWS SDKs to develop applications that interact with Storage Gateway. The AWS SDKs for Java, .NET, and PHP wrap the underlying Storage Gateway API to simplify your programming tasks. For information about downloading the SDK libraries, see the AWS Developer Center. For information about pricing, see AWS Storage Gateway pricing. AWS Regions that support Storage Gateway An AWS Region is a physical location in the world where AWS has multiple Availability Zones. Availability Zones
|
storagegateway-fsxfile-ug-006
|
storagegateway-fsxfile-ug.pdf
| 6 |
API, see the Storage Gateway API Reference. For more information about the Storage Gateway CLI, see the AWS CLI Command Reference. You can also use the AWS SDKs to develop applications that interact with Storage Gateway. The AWS SDKs for Java, .NET, and PHP wrap the underlying Storage Gateway API to simplify your programming tasks. For information about downloading the SDK libraries, see the AWS Developer Center. For information about pricing, see AWS Storage Gateway pricing. AWS Regions that support Storage Gateway An AWS Region is a physical location in the world where AWS has multiple Availability Zones. Availability Zones consist of one or more discrete AWS data centers, each with redundant power, networking, and connectivity, housed in separate facilities. This means that each AWS Region is physically isolated and independent of the other Regions. Regions provide fault tolerance, stability, and resilience, and can also reduce latency. The resources that you create in one Region do not exist in any other Region unless you explicitly use a replication feature offered by an AWS service. For example, Amazon S3 and Amazon EC2 support cross-Region replication. Some services, such as AWS Identity and Access Management, do not have Regional resources. You can launch AWS resources in locations that meet your business requirements. For example, you might want to launch Amazon EC2 instances to host your AWS Storage Gateway appliances in an AWS Region in Europe to be closer to your European users, or to meet legal requirements. Your AWS account determines which of the Regions supported by a specific service are available for you to use. Amazon FSx File Gateway stores file data in the AWS Region where your Amazon FSx file system is located. Before you start deploying your gateway, choose a Region in the upper-right corner of the Storage Gateway console. • Amazon FSx File Gateway — For supported AWS Regions and a list of AWS service endpoints that you can use with Amazon FSx File Gateway, see Amazon FSx File Gateway endpoints and quotas in the AWS General Reference. AWS Regions that support Storage Gateway API Version 2021-03-31 7 AWS Storage Gateway Amazon FSx File Gateway User Guide • Storage Gateway — For supported AWS Regions and a list of AWS service endpoints that you can use with Storage Gateway, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. • Storage Gateway Hardware Appliance — For supported Regions that you can use with the hardware appliance, see AWS Storage Gateway Hardware Appliance Regions in the AWS General Reference. AWS Regions that support Storage Gateway API Version 2021-03-31 8 AWS Storage Gateway Amazon FSx File Gateway User Guide File Gateway setup requirements Unless otherwise noted, the following requirements are common to all File Gateway types in AWS Storage Gateway. Your setup must meet the requirements in this section. Review the requirements that apply to your gateway setup before you deploy your gateway. Topics • Prerequisites • Hardware and storage requirements • Network and firewall requirements • Supported hypervisors and host requirements • Supported SMB clients for File Gateway • Supported file system operations for File Gateway • Managing local disks for your gateway Prerequisites Before you set up your Amazon FSx File Gateway (FSx File Gateway), you must meet the following prerequisites: • Create and configure an FSx for Windows File Server file system. For instructions, see Step 1: Create Your File System in the Amazon FSx for Windows File Server User Guide. • Configure Microsoft Active Directory (AD) and create an Active Directory service account with the requisite permissions. For more information, see Active Directory service account permission requirements. • Ensure that there is sufficient network bandwidth between the gateway and AWS. A minimum of 100 Mbps is required to successfully download, activate, and update the gateway. • Configure the connection you want to use for network traffic between AWS and the on-premises environment where you are deploying your gateway. You can connect using the public internet, private networking, a VPN, or AWS Direct Connect. If you want your gateway to communicate AWS through a private connection to an Amazon Virtual Private Cloud, set up the Amazon VPC before you set up your gateway. Prerequisites API Version 2021-03-31 9 AWS Storage Gateway Amazon FSx File Gateway User Guide • Make sure your gateway can resolve the name of your Active Directory Domain Controller. You can use DHCP in your Active Directory domain to handle resolution, or specify a DNS server manually from the Network Configuration settings menu in the gateway local console. Hardware and storage requirements The following sections provide information about the minimum required hardware and storage configurations for your gateway, and the minimum amount of disk space to allocate for the required storage. Hardware requirements for on-premises VMs When deploying your gateway on-premises, ensure
|
storagegateway-fsxfile-ug-007
|
storagegateway-fsxfile-ug.pdf
| 7 |
Version 2021-03-31 9 AWS Storage Gateway Amazon FSx File Gateway User Guide • Make sure your gateway can resolve the name of your Active Directory Domain Controller. You can use DHCP in your Active Directory domain to handle resolution, or specify a DNS server manually from the Network Configuration settings menu in the gateway local console. Hardware and storage requirements The following sections provide information about the minimum required hardware and storage configurations for your gateway, and the minimum amount of disk space to allocate for the required storage. Hardware requirements for on-premises VMs When deploying your gateway on-premises, ensure that the underlying hardware on which you deploy the gateway virtual machine (VM) can dedicate the following minimum resources: • Four virtual processors assigned to the VM • 16 GiB of reserved RAM for File Gateways • 80 GiB of disk space for installation of VM image and system data Requirements for Amazon EC2 instance types When deploying your gateway on Amazon Elastic Compute Cloud (Amazon EC2), the instance size must be at least xlarge for your gateway to function. However, for the compute-optimized instance family the size must be at least 2xlarge. Note The Storage Gateway AMI is only compatible with x86-based instances that use Intel or AMD processors. ARM-based instances that use Graviton processors are not supported. Use one of the following instance types recommended for your gateway type. Recommended for File Gateway types • General-purpose instance family – m4, m5, m6, or m7 instance type. Choose the xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. Hardware and storage requirements API Version 2021-03-31 10 AWS Storage Gateway Amazon FSx File Gateway User Guide • Compute-optimized instance family – c4, c5, c6, or c7 instance types. Choose the 2xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. • Memory-optimized instance family – r3, r5, r6, or r7 instance types. Choose the xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. • Storage-optimized instance family – i3, i4 or i7 instance types. Choose the xlarge instance size or higher to meet the Storage Gateway processor and RAM requirements. Note When you launch your gateway in Amazon EC2 and the instance type you choose supports ephemeral storage, the disks are listed automatically. For more information about Amazon EC2 instance storage, see Instance storage in the Amazon EC2 User Guide. Storage requirements In addition to 80 GiB of disk space for the VM, you also need additional disks for your gateway. Gateway type Cache (minimum) Cache (maximum) File Gateway 150 GiB 64 TiB Note You can configure one or more local drives for your cache, up to the maximum capacity. When adding cache to an existing gateway, it's important to create new disks in your host (hypervisor or Amazon EC2 instance). Don't change the size of existing disks if the disks have been previously allocated as a cache. Network and firewall requirements Your gateway requires access to the internet, local networks, Domain Name Service (DNS) servers, firewalls, routers, and so on. Storage requirements API Version 2021-03-31 11 AWS Storage Gateway Amazon FSx File Gateway User Guide Network bandwidth requirements vary based on the quantity of data that is uploaded and downloaded by the gateway. A minimum of 100Mbps is required to successfully download, activate, and update the gateway. Your data transfer patterns will determine the bandwidth necessary to support your workload. Following, you can find information about required ports and how to allow access through firewalls and routers. Note In some cases, you might deploy your gateway on Amazon EC2 or use other types of deployment (including on-premises) with network security policies that restrict AWS IP address ranges. In these cases, your gateway might experience service connectivity issues when the AWS IP range values changes. The AWS IP address range values that you need to use are in the Amazon service subset for the AWS Region that you activate your gateway in. For the current IP range values, see AWS IP address ranges in the AWS General Reference. Topics • Port requirements • Networking and firewall requirements for the Storage Gateway Hardware Appliance • Allowing AWS Storage Gateway access through firewalls and routers • Configuring security groups for your Amazon EC2 gateway instance Port requirements FSx File Gateway requires specific ports to be allowed through your network security for successful deployment and operation. Some ports are required for all gateways, while others are required only for specific configurations, such as when connecting to VPC endpoints. For FSx File Gateway, you must use Microsoft Active Directory to allow domain users to access a Server Message Block (SMB) file share. You can join your File Gateway to any valid Microsoft Windows domain (resolvable by DNS). You can also
|
storagegateway-fsxfile-ug-008
|
storagegateway-fsxfile-ug.pdf
| 8 |
Storage Gateway access through firewalls and routers • Configuring security groups for your Amazon EC2 gateway instance Port requirements FSx File Gateway requires specific ports to be allowed through your network security for successful deployment and operation. Some ports are required for all gateways, while others are required only for specific configurations, such as when connecting to VPC endpoints. For FSx File Gateway, you must use Microsoft Active Directory to allow domain users to access a Server Message Block (SMB) file share. You can join your File Gateway to any valid Microsoft Windows domain (resolvable by DNS). You can also use the AWS Directory Service to create an AWS Managed Microsoft AD in the Amazon Web Services Cloud. For most AWS Managed Microsoft AD deployments, you need to configure the Dynamic Host Configuration Protocol (DHCP) service for your VPC. For information about creating Port requirements API Version 2021-03-31 12 AWS Storage Gateway Amazon FSx File Gateway User Guide a DHCP options set, see Create a DHCP options set in the AWS Directory Service Administration Guide. The following table lists the necessary ports and describes conditional requirements in the Notes column. Port requirements for FSx File Gateway Network Element From To Protocol Port Inbound Outbound Required Notes Web browser Your web Storage Gateway TCP HTTP browser VM 80 ✓ ✓ ✓ Used by local systems to obtain the Storage Gateway activatio n key. Port 80 is used only during activatio n of a Storage Gateway appliance . A Storage Gateway VM doesn't require port 80 Port requirements API Version 2021-03-31 13 AWS Storage Gateway Amazon FSx File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes to be publicly accessibl e. The required level of access to port 80 depends on your network configura tion. If you activate your gateway from the Storage Gateway Managemen t Console, the host from which you connect to the console must Port requirements API Version 2021-03-31 14 AWS Storage Gateway Amazon FSx File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Web browser Storage Gateway AWS TCP HTTPS VM 443 ✓ ✓ ✓ DNS Storage Gateway Domain Name TCP & UDP VM Service DNS (DNS) server 53 ✓ ✓ ✓ have access to your gateway's port 80. AWS Managemen t Console (all other operation s) Used for communica tion between a Storage Gateway VM and the DNS server for IP name resolutio n. Port requirements API Version 2021-03-31 15 AWS Storage Gateway Amazon FSx File Gateway User Guide Network Element NTP From To Protocol Port Inbound Outbound Required Notes 123 ✓ ✓ ✓ Storage Gateway Network Time TCP & UDP VM Protocol NTP (NTP) server Used by on- premis es systems to synchroni ze VM time to the host time. A Storage Gateway VM is configure d to use the following NTP servers: • 0.amazon. pool.ntp. org • 1.amazon. pool.ntp. org • 2.amazon. pool.ntp. org Port requirements API Version 2021-03-31 16 AWS Storage Gateway Amazon FSx File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes • 3.amazon. pool.ntp. org Note Not required for gateways hosted on Amazon EC2. Port requirements API Version 2021-03-31 17 AWS Storage Gateway Amazon FSx File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Storage Gateway Storage Gateway Support Endpoint TCP SSH VM 22 ✓ ✓ ✓ Allows Support to access your gateway to help you with troublesh ooting gateway issues. You don't need this port open for the normal operation of your gateway, but it is required for troublesh ooting. For a list of support endpoints Port requirements API Version 2021-03-31 18 AWS Storage Gateway Amazon FSx File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Storage Gateway Storage Gateway AWS TCP HTTPS 443 VM Amazon CloudFron t Storage Gateway VM VPC Storage Gateway VM AWS AWS TCP HTTPS 443 TCP HTTPS 443 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 1026 ✓ ✓* , see Support endpoints . Managemen t control For activatio n Managemen t control *Required only when using VPC endpoints Control Plane endpoint *Required only when using VPC endpoints Port requirements API Version 2021-03-31 19 AWS Storage Gateway Amazon FSx File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element VPC AWS Storage Gateway VM TCP HTTPS 1027 ✓ ✓* Anon Control Plane (for activatio n) *Required only when using VPC endpoints Proxy endpoint *Required only when using VPC endpoints Data Plane *Required only when using VPC endpoints VPC AWS Storage Gateway VM TCP HTTPS 1028 ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 1031 ✓ ✓* Port requirements API Version 2021-03-31 20 AWS Storage Gateway Amazon FSx File
|
storagegateway-fsxfile-ug-009
|
storagegateway-fsxfile-ug.pdf
| 9 |
only when using VPC endpoints Port requirements API Version 2021-03-31 19 AWS Storage Gateway Amazon FSx File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element VPC AWS Storage Gateway VM TCP HTTPS 1027 ✓ ✓* Anon Control Plane (for activatio n) *Required only when using VPC endpoints Proxy endpoint *Required only when using VPC endpoints Data Plane *Required only when using VPC endpoints VPC AWS Storage Gateway VM TCP HTTPS 1028 ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 1031 ✓ ✓* Port requirements API Version 2021-03-31 20 AWS Storage Gateway Amazon FSx File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element VPC AWS Storage Gateway VM TCP HTTPS 2222 ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 443 ✓ ✓ ✓* SSH Support Channel for VPCe *Required only for opening support channel when using VPC endpoints Managemen t control *Required only when using VPC endpoints Port requirements API Version 2021-03-31 21 AWS Storage Gateway Amazon FSx File Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element File share client SMB Client Storage Gateway VM TCP or UDP SMBv3 445 ✓ ✓ ✓ File sharing data transfer session service. Replaces ports 137– 139 for Microsoft Windows NT and later. Name service Datagram service Directory System Agent (DSA) client connectio n Microsoft Active Storage Gateway Active Directory UDP NetBIOS 137 Directory VM server Microsoft Active Storage Gateway Active Directory UDP NetBIOS 138 Directory VM server Microsoft Active Directory Storage Gateway VM Active Directory server TCP & UDP LDAP 389 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ Microsoft Active Storage Gateway Active Directory TCP & UDP Directory VM server Kerberos 88 ✓ ✓ ✓ Kerberos Port requirements API Version 2021-03-31 22 AWS Storage Gateway Amazon FSx File Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Microsoft Active Storage Gateway Active Directory TCP Distribut Directory VM server ed 135 ✓ ✓ ✓ RPC Computing Environme nt/End Point Mapper (DCE/ EMAP) Amazon FSx Storage Gateway FSx for Windows TCP or UDP connectio VM n File Server SMBv3 445 ✓ ✓ ✓ File sharing data transfer session service Networking and firewall requirements for the Storage Gateway Hardware Appliance Each Storage Gateway Hardware Appliance requires the following network services: • Internet access – an always-on network connection to the internet through any network interface on the server. • DNS services – DNS services for communication between the hardware appliance and DNS server. • Time synchronization – an automatically configured Amazon NTP time service must be reachable. • IP address – A DHCP or static IPv4 address assigned. You cannot assign an IPv6 address. Networking and firewall requirements for the hardware appliance API Version 2021-03-31 23 AWS Storage Gateway Amazon FSx File Gateway User Guide There are five physical network ports at the rear of the Dell PowerEdge R640 server. From left to right (facing the back of the server) these ports are as follows: 1. iDRAC 2. em1 3. em2 4. em3 5. em4 You can use the iDRAC port for remote server management. A hardware appliance requires the following ports to operate. Protocol Port Direction Source Destination Usage SSH DNS 22 53 Outbound Outbound UDP/NTP 123 Outbound Hardware appliance Hardware appliance Hardware appliance 54.201.22 3.107 DNS servers *.amazon. pool.ntp. org Support channel Name resolutio n Time synchroni zation HTTPS 443 Outbound Hardware appliance *.amazona ws.com Data transfer Networking and firewall requirements for the hardware appliance API Version 2021-03-31 24 AWS Storage Gateway Amazon FSx File Gateway User Guide Protocol Port Direction Source Destination Usage HTTP 8080 Inbound AWS Hardware appliance Activatio n (only briefly) To perform as designed, a hardware appliance requires network and firewall settings as follows: • Configure all connected network interfaces in the hardware console. • Make sure that each network interface is on a unique subnet. • Provide all connected network interfaces with outbound access to the endpoints listed in the diagram preceding. • Configure at least one network interface to support the hardware appliance. For more information, see Configuring hardware appliance network parameters. Note For an illustration showing the back of the server with its ports, see Physically installing your hardware appliance. All IP addresses on the same network interface (NIC), whether for a gateway or a host, must be on the same subnet. The following illustration shows the addressing scheme. Networking and firewall requirements for the hardware appliance API Version 2021-03-31 25 AWS Storage Gateway Amazon FSx File Gateway User Guide For more information about activating and configuring a hardware appliance, see Using the AWS Storage Gateway Hardware Appliance. Allowing AWS Storage Gateway access through firewalls and routers Your gateway requires access to the following service endpoints to communicate with AWS. If you use a firewall
|
storagegateway-fsxfile-ug-010
|
storagegateway-fsxfile-ug.pdf
| 10 |
Physically installing your hardware appliance. All IP addresses on the same network interface (NIC), whether for a gateway or a host, must be on the same subnet. The following illustration shows the addressing scheme. Networking and firewall requirements for the hardware appliance API Version 2021-03-31 25 AWS Storage Gateway Amazon FSx File Gateway User Guide For more information about activating and configuring a hardware appliance, see Using the AWS Storage Gateway Hardware Appliance. Allowing AWS Storage Gateway access through firewalls and routers Your gateway requires access to the following service endpoints to communicate with AWS. If you use a firewall or router to filter or limit network traffic, you must configure your firewall and router to allow these service endpoints for outbound communication to AWS. Allowing gateway access through firewall and routers API Version 2021-03-31 26 AWS Storage Gateway Amazon FSx File Gateway User Guide Note If you configure private VPC endpoints for your Storage Gateway to use for connection and data transfer to and from AWS, your gateway does not require access to the public internet. For more information, see Activating a gateway in a virtual private cloud. Important Replace region in the following endpoint examples with the correct AWS Region string for your gateway, such as us-west-2. Replace amzn-s3-demo-bucket with the actual name of the Amazon S3 bucket in your deployment. You can also use an asterisk (*) in place of amzn-s3-demo-bucket to create a wildcard entry in your firewall rules, which will allowlist the service endpoint for all bucket names. If your gateways are deployed in AWS Regions in the United States or Canada and require Federal Information Processing Standard (FIPS) compliant endpoint connections, replace s3 with s3-fips. The following service endpoint is required by all gateways for head-bucket operations. bucket-name.s3.region.amazonaws.com:443 The following service endpoints are required by all gateways for control path (anon-cp, client- cp, proxy-app) and data path (dp-1) operations. anon-cp.storagegateway.region.amazonaws.com:443 client-cp.storagegateway.region.amazonaws.com:443 proxy-app.storagegateway.region.amazonaws.com:443 dp-1.storagegateway.region.amazonaws.com:443 The following gateway service endpoint is required to make API calls. storagegateway.region.amazonaws.com:443 The following example is a gateway service endpoint in the US West (Oregon) Region (us- west-2). Allowing gateway access through firewall and routers API Version 2021-03-31 27 AWS Storage Gateway Amazon FSx File Gateway User Guide storagegateway.us-west-2.amazonaws.com:443 In addition to the Storage Gateway and Amazon S3 service endpoints, Storage Gateway VMs also require network access to the following NTP servers: 0.amazon.pool.ntp.org 1.amazon.pool.ntp.org 2.amazon.pool.ntp.org 3.amazon.pool.ntp.org • For a complete list of supported AWS Regions and AWS service endpoints that you can use with Storage Gateway, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. • For a list supported AWS Regions that you can use with the hardware appliance, see Storage Gateway hardware appliance Regions in the AWS General Reference. Configuring security groups for your Amazon EC2 gateway instance In AWS Storage Gateway, a security group controls traffic to your Amazon EC2 gateway instance. When you configure a security group, we recommend the following: • The security group should not allow incoming connections from the outside internet. It should allow only instances within the gateway security group to communicate with the gateway. If you need to allow instances to connect to the gateway from outside its security group, we recommend that you allow connections only on port 80 (for activation). • If you want to activate your gateway from an Amazon EC2 host outside the gateway security group, allow incoming connections on port 80 from the IP address of that host. If you cannot determine the activating host's IP address, you can open port 80, activate your gateway, and then close access on port 80 after completing activation. • Allow port 22 access only if you are using Support for troubleshooting purposes. For more information, see You want Support to help troubleshoot your Amazon EC2 gateway. Supported hypervisors and host requirements You can run Storage Gateway on-premises as either a virtual machine (VM) appliance or a physical hardware appliance, or in AWS as an Amazon EC2 instance. Configuring security group API Version 2021-03-31 28 AWS Storage Gateway Amazon FSx File Gateway User Guide Storage Gateway supports the following hypervisor versions and hosts: • VMware ESXi Hypervisor (version 7.0 or 8.0) – For this setup, you also need a VMware vSphere client to connect to the host. • Microsoft Hyper-V Hypervisor (version 2012 R2, 2016, 2019, or 2022) – A free, standalone version of Hyper-V is available at the Microsoft Download Center. For this setup, you need a Microsoft Hyper-V Manager on a Microsoft Windows client computer to connect to the host. • Linux Kernel-based Virtual Machine (KVM) – A free, open-source virtualization technology. KVM is included in all versions of Linux version 2.6.20 and newer. Storage Gateway is tested and supported for the CentOS/RHEL 7.7, RHEL 8.6 Ubuntu 16.04 LTS, and Ubuntu 18.04 LTS distributions. Any other
|
storagegateway-fsxfile-ug-011
|
storagegateway-fsxfile-ug.pdf
| 11 |
a VMware vSphere client to connect to the host. • Microsoft Hyper-V Hypervisor (version 2012 R2, 2016, 2019, or 2022) – A free, standalone version of Hyper-V is available at the Microsoft Download Center. For this setup, you need a Microsoft Hyper-V Manager on a Microsoft Windows client computer to connect to the host. • Linux Kernel-based Virtual Machine (KVM) – A free, open-source virtualization technology. KVM is included in all versions of Linux version 2.6.20 and newer. Storage Gateway is tested and supported for the CentOS/RHEL 7.7, RHEL 8.6 Ubuntu 16.04 LTS, and Ubuntu 18.04 LTS distributions. Any other modern Linux distribution may work, but function or performance is not guaranteed. We recommend this option if you already have a KVM environment up and running and you are already familiar with how KVM works. • Amazon EC2 instance – Storage Gateway provides an Amazon Machine Image (AMI) that contains the gateway VM image. For information about how to deploy a gateway on Amazon EC2, see Deploy a default Amazon EC2 host for FSx File Gateway. • Storage Gateway Hardware Appliance – Storage Gateway provides a physical hardware appliance as an on-premises deployment option for locations with limited virtual machine infrastructure. Note Storage Gateway doesn’t support recovering a gateway from a VM that was created from a snapshot or clone of another gateway VM or from your Amazon EC2 AMI. If your gateway VM malfunctions, activate a new gateway and recover your data to that gateway. For more information, see Recovering from an unexpected virtual machine shutdown. Storage Gateway doesn’t support dynamic memory and virtual memory ballooning. Supported SMB clients for File Gateway File Gateway supports the following Service Message Block (SMB) clients: • Microsoft Windows Server 2008 R2 and later • Windows desktop versions: 10, 8, and 7. • Windows Terminal Server running on Windows Server 2008 and later Supported SMB clients for File Gateway API Version 2021-03-31 29 AWS Storage Gateway Amazon FSx File Gateway User Guide Note Server Message Block encryption requires clients that support SMB v3.x dialects. Supported file system operations for File Gateway Your SMB client can write, read, delete, and truncate files. When clients send writes to Storage Gateway, it writes to local cache synchronously. Then it writes to Amazon FSx asynchronously through optimized transfers. Reads are first served through the local cache. If data is not available, it's fetched through Amazon FSx as a read-through cache. Writes and reads are optimized in that only the parts that are changed or requested are transferred through your gateway. Deletes remove files from Amazon FSx. Managing local disks for your gateway The gateway virtual machine (VM) uses the local disks that you allocate on-premises for buffering and storage. A File Gateway that you create on an Amazon EC2 instance will use Amazon EBS volumes as local disks. The number and size of disks that you want to allocate for your gateway is up to you. The gateway uses the cache storage that you allocate to provide low-latency access to your recently accessed data. The cache storage acts as the on-premises durable store for data that is pending upload to Amazon FSx. File Gateways require at least one 150 GiB disk to use as a cache. After the initial configuration and deployment of your gateway, you can add more disks for cache storage as your workload demands increase. This section contains the following topics, which describe concepts and procedures related to managing local disks. Topics • Deciding the amount of local disk storage - Learn how to determine the number and size of local cache disks to allocate for your File Gateway. • Configuring additional cache storage - Learn how to increase the cache storage capacity of your File Gateway as your application needs change. • Using ephemeral storage with EC2 gateways - Learn how to prevent data loss when using ephemeral disk storage with File Gateway. Supported file system operations API Version 2021-03-31 30 AWS Storage Gateway Amazon FSx File Gateway User Guide Deciding the amount of local disk storage When deploying an FSx File Gateway, consider how much cache disk to allocate. FSx File Gateway uses a least recently used algorithm to automatically evict data from the cache. The cache on an FSx File Gateway is shared between all of the file shares on that gateway. If you have multiple active shares, it's important to note that heavy utilization on one share could impact the amount of cache resources that another share has access to, possibly impacting performance. When determining how much cache disk you need for a given workload, it's important to note that you can always add cache disk to your gateway (up to the current quotas on FSx File Gateway), but you can't decrease the cache for a given gateway. You can
|
storagegateway-fsxfile-ug-012
|
storagegateway-fsxfile-ug.pdf
| 12 |
from the cache. The cache on an FSx File Gateway is shared between all of the file shares on that gateway. If you have multiple active shares, it's important to note that heavy utilization on one share could impact the amount of cache resources that another share has access to, possibly impacting performance. When determining how much cache disk you need for a given workload, it's important to note that you can always add cache disk to your gateway (up to the current quotas on FSx File Gateway), but you can't decrease the cache for a given gateway. You can perform a basic analysis on the dataset to determine the right amount of cache disk, but there's not a way to determine exactly how much data is ‘hot,’ and needs to be stored locally, versus ‘cold’ and can be tiered to the cloud. Workloads change over time, and FSx File Gateway provides flexibility and elasticity related to the amount of resources that can be consumed. The amount of cache can always be increased, so starting small and increasing as needed is often the most cost-effective approach. You can use an initial approximation of 150 GiB to provision disks for the cache storage during gateway setup. You can then use Amazon CloudWatch operational metrics to monitor the cache storage usage and provision more storage as needed using the console. For information on using the metrics and setting up alarms, see Performance and optimization. Note Underlying physical storage resources are represented as a data store in VMware. When you deploy the gateway VM, you choose a data store on which to store the VM files. When you provision a local disk (for example, to use as cache storage), you have the option to store the virtual disk in the same data store as the VM or a different data store. If you have more than one data store, we strongly recommend that you choose one data store for the cache storage. A data store that is backed by only one underlying physical disk can lead to poor performance in some situations when it is used to back both the cache storage. This is also true if the backup is a less-performant RAID configuration such as RAID1. Deciding the amount of local disk storage API Version 2021-03-31 31 AWS Storage Gateway Amazon FSx File Gateway User Guide Configuring additional cache storage As your application needs change, you can increase the gateway's cache storage capacity. You can add storage capacity to your gateway without interrupting functionality or causing downtime. When you add more storage, you do so with the gateway VM turned on. Important When adding cache to an existing gateway, you must create new disks on the gateway host hypervisor or Amazon EC2 instance. Do not remove or change the size of existing disks that have already been allocated as cache. To configure additional cache storage for your gateway 1. Provision one or more new disks on your gateway host hypervisor or Amazon EC2 instance. For information about how to provision a disk on a hypervisor, see your hypervisor's documentation. For information about provisioning Amazon EBS volumes for an Amazon EC2 instance, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide for Linux Instances. In the following steps, you will configure this disk as cache storage. 2. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ 3. 4. 5. 6. home. In the navigation pane, choose Gateways. Search for your gateway and select it from the list. From the Actions menu, choose Configure cache storage. In the Configure cache storage section, identify the disks you provisioned. If you don't see your disks, choose the refresh icon to refresh the list. For each disk, choose Cache from the Allocated to drop-down menu. Note Cache is the only available option for allocating disks on a File Gateway. 7. Choose Save changes to save your configuration settings. Add cache storage API Version 2021-03-31 32 AWS Storage Gateway Amazon FSx File Gateway User Guide Using ephemeral storage with EC2 gateways We do not recommend the use of ephemeral disks for cache storage on FSx File Gateways. Ephemeral disks provide temporary block-level storage for your Amazon EC2 instance. When you launch your gateway with an Amazon EC2 Amazon Machine Image and the instance type you select supports ephemeral storage, the ephemeral disks are listed automatically. You can select one of the disks to store your gateway's cache data. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide. Data that applications write to the gateway is stored synchronously in cache on the ephemeral disks, and then asynchronously uploaded to durable storage in FSx for Windows File Server. If the Amazon EC2 instance is stopped after data is written to ephemeral storage, but before
|
storagegateway-fsxfile-ug-013
|
storagegateway-fsxfile-ug.pdf
| 13 |
instance. When you launch your gateway with an Amazon EC2 Amazon Machine Image and the instance type you select supports ephemeral storage, the ephemeral disks are listed automatically. You can select one of the disks to store your gateway's cache data. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide. Data that applications write to the gateway is stored synchronously in cache on the ephemeral disks, and then asynchronously uploaded to durable storage in FSx for Windows File Server. If the Amazon EC2 instance is stopped after data is written to ephemeral storage, but before an asynchronous upload occurs, any data that has not yet been uploaded to FSx for Windows File Server can be lost. Important If you stop and start an Amazon EC2 gateway that uses ephemeral storage, the gateway will be permanently offline. This happens because the physical storage disk is replaced. There is no work-around for this issue. The only resolution is to delete the gateway and activate a new one on a new EC2 instance. Using ephemeral storage with EC2 gateways API Version 2021-03-31 33 AWS Storage Gateway Amazon FSx File Gateway User Guide Using the AWS Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. The AWS Storage Gateway Hardware Appliance is a physical hardware appliance with the Storage Gateway software preinstalled on a validated server configuration. You can manage the hardware appliances in your deployment from the Hardware appliance overview page in the AWS Storage Gateway console. The hardware appliance is a high-performance 1U server that you can deploy in your data center, or on-premises inside your corporate firewall. When you buy and activate your hardware appliance, the activation process associates the hardware appliance with your AWS account. After activation, your hardware appliance appears in the console on the Hardware appliance overview page. You can configure the hardware appliance as an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway type. The procedure that you use to deploy these gateway types on a hardware appliance is same as on a virtual platform. For a list of supported AWS Regions where the AWS Storage Gateway Hardware Appliance is available for activation and use, see AWS Storage Gateway Hardware Appliance Regions in the AWS General Reference. In the sections that follow, you can find instructions about how to set up, rack mount, power, configure, activate, launch, use, and delete an AWS Storage Gateway Hardware Appliance. Topics • Setting up your AWS Storage Gateway Hardware Appliance • Physically installing your hardware appliance • Accessing the hardware appliance console • Configuring hardware appliance network parameters • Activating your AWS Storage Gateway Hardware Appliance API Version 2021-03-31 34 AWS Storage Gateway Amazon FSx File Gateway User Guide • Creating a gateway on your hardware appliance • Configuring a gateway IP address on the hardware appliance • Removing gateway software from your hardware appliance • Deleting your AWS Storage Gateway Hardware Appliance Setting up your AWS Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After you receive your Storage Gateway Hardware Appliance, you use the hardware appliance local console to configure networking to provide an always-on connection to AWS and activate your appliance. Activation associates your appliance with the AWS account that is used during the activation process. After the appliance is activated, you can launch an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway from the Storage Gateway console. To install and configure your hardware appliance 1. Rack-mount the appliance, and plug in power and network connections. For more information, see Physically installing your hardware appliance. 2. Set the Internet Protocol version 4 (IPv4) addresses for the hardware appliance (the host). For more information, see Configuring hardware appliance network parameters. 3. Activate the hardware appliance on the console Hardware appliance overview page in the AWS Region of your choice. For more information, see Activating your AWS Storage Gateway Hardware Appliance. 4. Create a gateway on your hardware appliance. For more information, see Creating your gateway. You set up gateways on your hardware appliance the same way that
|
storagegateway-fsxfile-ug-014
|
storagegateway-fsxfile-ug.pdf
| 14 |
Rack-mount the appliance, and plug in power and network connections. For more information, see Physically installing your hardware appliance. 2. Set the Internet Protocol version 4 (IPv4) addresses for the hardware appliance (the host). For more information, see Configuring hardware appliance network parameters. 3. Activate the hardware appliance on the console Hardware appliance overview page in the AWS Region of your choice. For more information, see Activating your AWS Storage Gateway Hardware Appliance. 4. Create a gateway on your hardware appliance. For more information, see Creating your gateway. You set up gateways on your hardware appliance the same way that you set up gateways on VMware ESXi, Microsoft Hyper-V, Linux Kernel-based Virtual Machine (KVM), or Amazon EC2. Setting up your hardware appliance API Version 2021-03-31 35 AWS Storage Gateway Amazon FSx File Gateway User Guide Increasing the usable cache storage You can increase the usable storage on the hardware appliance from 5 TB to 12 TB. Doing this provides a larger cache for low latency access to data in AWS. If you ordered the 5 TB model, you can increase the usable storage to 12 TB by buying five 1.92 TB SSDs (solid state drives). You can then add them to the hardware appliance before you activate it. If you have already activated the hardware appliance and want to increase the usable storage on the appliance to 12 TB, do the following: 1. Reset the hardware appliance to its factory settings. Contact AWS Support for instructions on how to do this. 2. Add five 1.92 TB SSDs to the appliance. Network interface card options Depending on the model of appliance you ordered, it may come with a 10G-Base-T RJ45 copper, or a 10G DA/SFP+ network card. • 10G-Base-T NIC configuration: • Use CAT6 cables for 10G or CAT5(e) for 1G • 10G DA/SFP+ NIC configuration: • Use Twinax copper Direct Attach Cables up to 5 meters • Dell/Intel compatible SFP+ optical modules (SR or LR) • SFP/SFP+ copper transceiver for 1G-Base-T or 10G-Base-T Physically installing your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. Physically installing your hardware appliance API Version 2021-03-31 36 AWS Storage Gateway Amazon FSx File Gateway User Guide Your appliance has a 1U form factor and fits in a standard International Electrotechnical Commission (IEC) compliant 19-inch rack. Prerequisites To install your hardware appliance, you need the following components: • Power cables: one required, two recommended. • Supported network cabling (depending on which Network Interface Card (NIC) is included in the hardware appliance). Twinax Copper DAC, SFP+ optical module (Intel compatible) or SFP to Base- T copper transceiver. • Keyboard and monitor, or a keyboard, video, and mouse (KVM) switch solution. Note Before you perform the following procedure, make sure that you meet all of the requirements for the Storage Gateway Hardware Appliance as described in Networking and firewall requirements for the Storage Gateway Hardware Appliance. To physically install your hardware appliance 1. Unbox your hardware appliance and follow the instructions contained in the box to rack- mount the server. The following image shows the back of the hardware appliance with ports for connecting power, ethernet, monitor, USB keyboard, and iDRAC. hardware appliance one rear with network and power connector labels. hardware appliance one rear with network and power connector labels. 2. Plug in a power connection to each of the two power supplies. It's possible to plug in to only one power connection, but we recommend power connections to both power supplies for redundancy. Physically installing your hardware appliance API Version 2021-03-31 37 AWS Storage Gateway Amazon FSx File Gateway User Guide 3. Plug an Ethernet cable into the em1 port to provide an always-on internet connection. The em1 port is the first of the four physical network ports on the rear, from left to right. Note The hardware appliance doesn't support VLAN trunking. Set up the switch port to which you are connecting the hardware appliance as a non-trunked VLAN port. 4. Plug in the keyboard and monitor. 5. Power on the server by pressing the Power button on the front panel, as shown in the following image. hardware appliance front with power button label. hardware appliance front with power button label. Next step Accessing the hardware appliance console Accessing the hardware appliance console Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue
|
storagegateway-fsxfile-ug-015
|
storagegateway-fsxfile-ug.pdf
| 15 |
switch port to which you are connecting the hardware appliance as a non-trunked VLAN port. 4. Plug in the keyboard and monitor. 5. Power on the server by pressing the Power button on the front panel, as shown in the following image. hardware appliance front with power button label. hardware appliance front with power button label. Next step Accessing the hardware appliance console Accessing the hardware appliance console Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. Accessing the hardware appliance console API Version 2021-03-31 38 AWS Storage Gateway Amazon FSx File Gateway User Guide When you power on your hardware appliance, the hardware appliance console appears on the monitor. The hardware appliance console presents a user interface specific to AWS that you can use to set an administrator password, configure initial network parameters, and open a support channel to AWS. To work with the hardware appliance console, enter text from the keyboard and use the Up, Down, Right, and Left Arrow keys to move about the screen in the indicated direction. Use the Tab key to move forward in order through items on-screen. On some setups, you can use the Shift +Tab keystroke to move sequentially backward. Use the Enter key to save selections, or to choose a button on the screen. The first time the hardware appliance console appears, the Welcome page is displayed, and you are prompted to set a password for the admin user account before you can access the console. To set an admin password • At the Please set your login password prompt, do the following: a. b. For Set Password, enter a password, and then press Down arrow. For Confirm, re-enter your password, and then choose Save Password. After you set your password, the hardware console Home page appears. The Home page displays network information for the em1, em2, em3, and em4 network interfaces, and has the following menu options: • Configure Network • Open Service Console • Change Password • Logout • Open Support Console Next step Configuring hardware appliance network parameters Accessing the hardware appliance console API Version 2021-03-31 39 AWS Storage Gateway Amazon FSx File Gateway User Guide Configuring hardware appliance network parameters Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After the hardware appliance boots up and you set your admin user password in the hardware console as described in Accessing the hardware appliance console, use the following procedure to configure network parameters so your hardware appliance can connect to AWS. To set a network address 1. From the Home page, choose Configure Network and then press Enter. The Configure Network page appears. The Configure Network page shows IP and DNS information for each of the 4 network interfaces on the hardware appliance, and includes menu options to configure DHCP or Static addresses for each. 2. For the em1 interface, do one of the following: • Choose DHCP and press Enter to use the IPv4 address assigned by your Dynamic Host Configuration Protocol (DHCP) server to your physical network port. Note this address for later use in the activation step. • Choose Static and press Enter to configure a static IPv4 address. Enter a valid IP Address, Subnet Mask, Gateway, and DNS server address for the em1 network interface. When finished, choose Save and then press Enter to save the configuration. Configuring hardware appliance network parameters API Version 2021-03-31 40 AWS Storage Gateway Amazon FSx File Gateway User Guide Note You can use this procedure to configure other network interfaces in addition to em1. If you configure other interfaces, they must provide the same always-on connection to the AWS endpoints listed in the requirements. Network bonding and Link Aggregation Control Protocol (LACP) are not supported by the hardware appliance or by Storage Gateway. We do not recommend configuring multiple network interfaces on the same subnet as this can sometimes cause routing issues. To log out of the hardware console 1. Choose Back and press Enter to return to the Home page. 2. Choose Logout and press Enter to return to the Welcome page. Next step Activating your AWS Storage Gateway Hardware Appliance Activating your AWS Storage
|
storagegateway-fsxfile-ug-016
|
storagegateway-fsxfile-ug.pdf
| 16 |
configure other interfaces, they must provide the same always-on connection to the AWS endpoints listed in the requirements. Network bonding and Link Aggregation Control Protocol (LACP) are not supported by the hardware appliance or by Storage Gateway. We do not recommend configuring multiple network interfaces on the same subnet as this can sometimes cause routing issues. To log out of the hardware console 1. Choose Back and press Enter to return to the Home page. 2. Choose Logout and press Enter to return to the Welcome page. Next step Activating your AWS Storage Gateway Hardware Appliance Activating your AWS Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After configuring your IP address, you enter this IP address on the Hardware page of the AWS Storage Gateway console to activate your hardware appliance. The activation process registers the appliance to your AWS account. Activating your hardware appliance API Version 2021-03-31 41 AWS Storage Gateway Amazon FSx File Gateway User Guide You can choose to activate your hardware appliance in any of the supported AWS Regions. For a list of supported AWS Regions, see Storage Gateway Hardware Appliance Regions in the AWS General Reference. To activate your AWS Storage Gateway Hardware Appliance 1. Open the AWS Storage Gateway Management Console and sign in with the account credentials you want to use to activate your hardware. Note For activation only, the following must be true: • Your browser must be on the same network as your hardware appliance. • Your firewall must allow HTTP access on port 8080 to the appliance for inbound traffic. 2. Choose Hardware from the navigation menu on the left side of the page. 3. Choose Activate appliance. 4. For IP Address, enter the IP address that you configured for your hardware appliance, then choose Connect. 5. 6. For more information about configuring the IP address, see Configuring network parameters. For Name, enter a name for your hardware appliance. Names can be up to 255 characters long and can't include a slash character. For Hardware appliance time zone, enter the local time zone from which most of the workload for the gateway will be generated., then choose Next. The time zone controls when hardware updates take place, with 2 a.m. used as the default scheduled time to perform updates. Ideally, if the time zone is set properly, updates will take place outside of the local working day window by default. 7. Review the activation parameters in the Hardware appliance detail section. You can choose Previous to go back and make changes if necessary. Otherwise, choose Activate to finish the activation. A banner appears on the Hardware appliance overview page, indicating that the hardware appliance has been successfully activated. Activating your hardware appliance API Version 2021-03-31 42 AWS Storage Gateway Amazon FSx File Gateway User Guide At this point, the appliance is associated with your account. The next step is to configure and launch an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway on the new appliance. Next step Creating a gateway on your hardware appliance Creating a gateway on your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. You can create an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway on any AWS Storage Gateway Hardware Appliance in your deployment. To create a gateway on your hardware appliance 1. Sign in to the AWS Management Console and open the Storage Gateway console at https:// console.aws.amazon.com/storagegateway/home. 2. Follow the procedures described in Creating Your Gateway to set up, connect, and configure the type of Storage Gateway that you want to deploy. When you finish creating your gateway in the Storage Gateway console, the Storage Gateway software automatically starts installing on the hardware appliance. If you use Dynamic Host Configuration Protocol (DHCP), it can take 5 to 10 minutes for a gateway to display as online in the console. To assign a static IP address to your installed gateway, see Configuring an IP address for the gateway. To assign a static IP address to your installed gateway, you next configure the gateway's network interfaces so
|
storagegateway-fsxfile-ug-017
|
storagegateway-fsxfile-ug.pdf
| 17 |
Gateway to set up, connect, and configure the type of Storage Gateway that you want to deploy. When you finish creating your gateway in the Storage Gateway console, the Storage Gateway software automatically starts installing on the hardware appliance. If you use Dynamic Host Configuration Protocol (DHCP), it can take 5 to 10 minutes for a gateway to display as online in the console. To assign a static IP address to your installed gateway, see Configuring an IP address for the gateway. To assign a static IP address to your installed gateway, you next configure the gateway's network interfaces so your applications can use it. Creating a gateway on your hardware appliance API Version 2021-03-31 43 AWS Storage Gateway Next step Amazon FSx File Gateway User Guide Configuring a gateway IP address on the hardware appliance Configuring a gateway IP address on the hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. Before you activated your hardware appliance, you assigned an IP address to its physical network interface. Now that you have activated the appliance and launched your Storage Gateway on it, you need to assign another IP address to the Storage Gateway virtual machine that runs on the hardware appliance. To assign a static IP address to a gateway installed on your hardware appliance, configure the IP address from the gateway local console for that gateway. Your applications (such as your NFS or SMB client) connect to this IP address. You can access the gateway local console from the hardware appliance console using the Open Service Console option. To configure an IP address on your appliance to work with applications 1. On the hardware console, choose Open Service Console and then press Enter to open the login page for the gateway local console. 2. The AWS Storage Gateway local console login page prompts you to login to change your network configuration and other settings. The default account is admin and the default password is password. Note We recommend changing the default password by entering the corresponding numeral for Gateway Console from the AWS Appliance Activation - Configuration main menu, then running the passwd command. For information about how to run the command, Configuring a gateway IP address on the hardware appliance API Version 2021-03-31 44 AWS Storage Gateway Amazon FSx File Gateway User Guide see Running Storage Gateway commands on the local console. You can also set the password from the Storage Gateway console. For more information, see Setting the local console password from the Storage Gateway console. 3. The AWS Appliance Activation - Configuration page includes the following menu options: • HTTP/SOCKS Proxy Configuration • Network Configuration • Test Network Connectivity • View System Resource Check • System Time Management • License Information • Command Prompt Note Some options appear only for specific gateway types or host platforms. Enter the corresponding numeral to navigate to the Network Configuration page. 4. Do one of the following to configure the gateway IP address: • To use the IP address assigned by your Dynamic Host Configuration Protocol (DHCP) server, enter the corresponding numeral for Configure DHCP, and then enter valid DHCP configuration information on the following page. • To assign a static IP address, enter the corresponding numeral for Configure Static IP, and then enter valid IP address and DNS information on the following page. Note The IP address you specify here must be on the same subnet as the IP address used during hardware appliance activation. Configuring a gateway IP address on the hardware appliance API Version 2021-03-31 45 AWS Storage Gateway Amazon FSx File Gateway User Guide To exit the gateway local console • Press the Crtl+] (close bracket) keystroke. The hardware console appears. Note The keystroke preceding is the only way to exit the gateway local console. After your hardware appliance has been activated and configured, your appliance appears in the console. Now you can continue the setup and configuration procedure for your gateway in the Storage Gateway console. For instructions, see Configure your Amazon FSx File Gateway. Removing gateway software from your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage.
|
storagegateway-fsxfile-ug-018
|
storagegateway-fsxfile-ug.pdf
| 18 |
the console. Now you can continue the setup and configuration procedure for your gateway in the Storage Gateway console. For instructions, see Configure your Amazon FSx File Gateway. Removing gateway software from your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. If you no longer need a specific Storage Gateway that you have deployed on a hardware appliance, you can remove the gateway software from the hardware appliance. After you remove the gateway software, you can choose to deploy a new gateway in its place, or delete the hardware appliance itself from the Storage Gateway console. To remove gateway software from your hardware appliance, use the following procedure. To remove a gateway from a hardware appliance 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Hardware from the navigation pane on the left side of the console page, and then choose the Hardware appliance name for the appliance from which you want to remove gateway software. 3. From the Actions drop down menu, choose Remove gateway. Removing gateway software from your hardware appliance API Version 2021-03-31 46 AWS Storage Gateway Amazon FSx File Gateway User Guide The confirmation dialog box appears. 4. Verify that you want to remove the gateway software from the specified hardware appliance, and then type the word remove in the confirmation box. 5. Choose Remove to permanently remove the gateway software. Note After you remove the gateway software, you can't undo the action. For certain gateway types, you can lose data on deletion, particularly cached data. For more information on deleting a gateway, see Deleting your gateway and removing associated resources. Removing the gateway doesn't delete the hardware appliance from the console. The hardware appliance remains for future gateway deployments. Deleting your AWS Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. If you no longer need an AWS Storage Gateway Hardware Appliance that you have already activated, you can delete the appliance completely from your AWS account. Note To move your appliance to a different AWS account or AWS Region, you must first delete it using the following procedure, then open the gateway's support channel and contact Support to perform a soft reset. For more information, see Turning on Support access to help troubleshoot your gateway hosted on-premises. Deleting your hardware appliance API Version 2021-03-31 47 AWS Storage Gateway Amazon FSx File Gateway User Guide To delete your hardware appliance 1. If you have installed a gateway on the hardware appliance, you must first remove the gateway before you can delete the appliance. For instructions on how to remove a gateway from your hardware appliance, see Removing gateway software from your hardware appliance. 2. On the Hardware page of the Storage Gateway console, choose the hardware appliance you want to delete. 3. For Actions, choose Delete Appliance. The confirmation dialog box appears. 4. Verify that you want to delete the specified hardware appliance, then type the word delete in the confirmation box and choose Delete. When you delete the hardware appliance, all resources associated with the gateway that is installed on the appliance are deleted, but the data on the hardware appliance itself is not deleted. Deleting your hardware appliance API Version 2021-03-31 48 AWS Storage Gateway Amazon FSx File Gateway User Guide Creating your gateway The overview sections on this page provide a high-level synopsis of how the Storage Gateway creation process works. For step-by-step procedures to create a specific type of gateway using the Storage Gateway console, see the following topics: • Create and activate an Amazon S3 File Gateway • Create and activate an Amazon FSx File Gateway • Create and activate a Tape Gateway • Create and activate a Volume Gateway Important 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. Overview - Gateway Activation Gateway activation involves setting up your gateway, connecting it to AWS, then reviewing your settings and activating it. Set up gateway To set up your Storage Gateway, you first
|
storagegateway-fsxfile-ug-019
|
storagegateway-fsxfile-ug.pdf
| 19 |
Create and activate an Amazon S3 File Gateway • Create and activate an Amazon FSx File Gateway • Create and activate a Tape Gateway • Create and activate a Volume Gateway Important 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. Overview - Gateway Activation Gateway activation involves setting up your gateway, connecting it to AWS, then reviewing your settings and activating it. Set up gateway To set up your Storage Gateway, you first choose the type of gateway you want to create and the host platform on which you will run the gateway virtual appliance. You then download the gateway virtual appliance template for the platform of your choice and deploy it in your on-premises environment. You can also deploy your Storage Gateway as a physical hardware appliance that you order from your preferred reseller, or as an Amazon EC2 instance in your AWS cloud environment. When you deploy the gateway appliance, you allocate local physical disk space on the virtualization host. Connect to AWS The next step is to connect your gateway to AWS. To do this, you first choose the type of service endpoint you want to use for communications between the gateway virtual appliance and AWS Overview - Gateway Activation API Version 2021-03-31 49 AWS Storage Gateway Amazon FSx File Gateway User Guide services in the cloud. This endpoint can be accessible from the public internet, or only from within your Amazon VPC, where you have full control over the network security configuration. You then specify the gateway's IP address or its activation key, which you can obtain by connecting to the local console on the gateway appliance. Review and activate At this point, you'll have an opportunity to review the gateway and connection options you chose, and make changes if necessary. When everything is set up the way you want you can activate the gateway. Before you can start using your activated gateway, you will need to configure some additional settings and create your storage resources. Overview - Gateway Configuration After you activate your Storage Gateway, you need to perform some additional configuration. In this step, you allocate the physical storage you provisioned on the gateway host platform to be used as either the cache or the upload buffer by the gateway appliance. You then configure settings to help monitor the health of your gateway using Amazon CloudWatch Logs and CloudWatch alarms, and add tags to help identify the gateway, if desired. Before you can start using your activated and configured gateway, you will need to create your storage resources. Overview - Storage Resources After you activate and configure your Storage Gateway, you need to create cloud storage resources for it to use. Depending on the type of gateway you created, you will use the Storage Gateway console to create Volumes, Tapes, or Amazon S3 or Amazon FSx files shares to associate with it. Each gateway type uses its respective resources to emulate the related type of network storage infrastructure, and transfers the data you write to it into the AWS cloud. Create an Amazon FSx for Windows File Server file system To create an Amazon FSx File Gateway in AWS Storage Gateway, the first step is to create an Amazon FSx for Windows File Server file system. If you've already created an Amazon FSx file system, go to the next step, Create and activate an Amazon FSx File Gateway. Review and activate API Version 2021-03-31 50 AWS Storage Gateway Amazon FSx File Gateway User Guide Note The following limitations apply when writing to an Amazon FSx file system from an FSx File Gateway: • Your Amazon FSx file system and your FSx File Gateway must be owned by the same AWS account and located in the same AWS Region. • Each gateway can support five attached file systems. When attaching a file system, the Storage Gateway console notifies you if the selected gateway is at capacity. In that case, you must choose a different gateway or detach a file system before you can attach another one. • FSx File Gateway supports soft storage quotas (issuing warnings when users surpass their data limits), but does not support hard quotas (enforcing data limits by denying write access). Soft quotas are supported for all users except the Amazon FSx admin user. For more information about setting up storage quotas, see Storage quotas in the Amazon FSx for Windows File Server User Guide. • We don't recommend using Microsoft Distributed File System (DFS) to redirect users to your Amazon FSx file system through FSx File Gateway. Instead, configure DFS to redirect directly to the Amazon FSx file system in the AWS Cloud
|
storagegateway-fsxfile-ug-020
|
storagegateway-fsxfile-ug.pdf
| 20 |
File Gateway supports soft storage quotas (issuing warnings when users surpass their data limits), but does not support hard quotas (enforcing data limits by denying write access). Soft quotas are supported for all users except the Amazon FSx admin user. For more information about setting up storage quotas, see Storage quotas in the Amazon FSx for Windows File Server User Guide. • We don't recommend using Microsoft Distributed File System (DFS) to redirect users to your Amazon FSx file system through FSx File Gateway. Instead, configure DFS to redirect directly to the Amazon FSx file system in the AWS Cloud as described in Grouping multiple file systems with DFS Namespaces in the Amazon FSx for Windows File Server User Guide. • Some file operations on the FSx File Gateway, such as top-level folder renames or permission changes, can result in multiple file operations that lead to a high I/O load on your FSx for Windows File Server file system. If your file system doesn't have enough performance resources for your workload, the file system might delete shadow copies because it prioritizes availability for ongoing I/O over historical shadow copy retention. In the Amazon FSx console, check the Monitoring and performance page to see if your file system is under-provisioned. If it is, you can switch to SSD storage, increase throughput capacity, or increase SSD IOPS to handle your workload. To create an FSx for Windows File Server file system 1. Open the AWS Management Console at https://console.aws.amazon.com/fsx/home/, and choose the Region that you want to create your gateway in. Create an Amazon FSx for Windows File Server file system API Version 2021-03-31 51 AWS Storage Gateway Amazon FSx File Gateway User Guide 2. Follow the instructions in Getting Started with Amazon FSx in the Amazon FSx for Windows File Server User Guide. Create and activate an Amazon FSx File Gateway In this section, you can find instructions on how to create, deploy, and activate a File Gateway in AWS Storage Gateway. Topics • Set up an Amazon FSx File Gateway • Connect your Amazon FSx File Gateway to AWS • Review settings and activate your Amazon FSx File Gateway • Configure your Amazon FSx File Gateway Set up an Amazon FSx File Gateway To set up a new FSx File Gateway 1. Open the AWS Management Console at https://console.aws.amazon.com/storagegateway/ home/, and choose the AWS Region where you want to create your gateway. 2. Choose Create gateway to open the Set up gateway page. 3. In the Gateway settings section, do the following: a. b. For Gateway name, enter a name for your gateway. After your gateway is created, you can search for this name to find your gateway on the list pages in the AWS Storage Gateway console. For Gateway time zone, choose the local time zone for the part of the world where you want to deploy your gateway. 4. 5. In the Gateway options section, for Gateway type, choose Amazon FSx File Gateway. In the Platform options section, do the following: a. For Host platform, choose the platform on which you want to deploy your gateway. Then follow the platform-specific instructions displayed on the Storage Gateway console page to set up your host platform. You can choose from the following options: Create and activate an Amazon FSx File Gateway API Version 2021-03-31 52 AWS Storage Gateway Amazon FSx File Gateway User Guide • VMware ESXi – Download, deploy, and configure the gateway virtual machine using VMware ESXi. • Microsoft Hyper-V – Download, deploy, and configure the gateway virtual machine using Microsoft Hyper-V. • Linux KVM – Download, deploy, and configure the gateway virtual machine using Linux Kernel-based Virtual Machine (KVM). • Amazon EC2 – Configure and launch an Amazon EC2 instance to host your gateway. • Hardware appliance – Order a dedicated physical hardware appliance from AWS to host your gateway. b. For Confirm set up gateway, select the check box to confirm that you performed the deployment steps for the host platform you chose. This step is not applicable for the Hardware appliance host platform. 6. Now that your gateway is set up, you must choose how you want it to connect and communicate with AWS. Choose Next to proceed. Connect your Amazon FSx File Gateway to AWS To connect a new FSx File Gateway to AWS 1. 2. If you have not done so already, complete the procedure described in Set up an Amazon FSx File Gateway. When finished, choose Next to open the Connect to AWS page in the AWS Storage Gateway console. In the Endpoint options section, for Service endpoint, choose the type of endpoint your gateway will use to communicate with AWS. You can choose from the following options: • Publicly accessible – Your gateway communicates with AWS over the public internet. If
|
storagegateway-fsxfile-ug-021
|
storagegateway-fsxfile-ug.pdf
| 21 |
Next to proceed. Connect your Amazon FSx File Gateway to AWS To connect a new FSx File Gateway to AWS 1. 2. If you have not done so already, complete the procedure described in Set up an Amazon FSx File Gateway. When finished, choose Next to open the Connect to AWS page in the AWS Storage Gateway console. In the Endpoint options section, for Service endpoint, choose the type of endpoint your gateway will use to communicate with AWS. You can choose from the following options: • Publicly accessible – Your gateway communicates with AWS over the public internet. If you select this option, use the FIPS enabled endpoint check box to specify whether the connection must comply with Federal Information Processing Standards (FIPS). Note If you require FIPS 140-2 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS-compliant endpoint. For more information, see Federal Information Processing Standard (FIPS) 140-2. Connect your Amazon FSx File Gateway to AWS API Version 2021-03-31 53 AWS Storage Gateway Amazon FSx File Gateway User Guide The FIPS service endpoint is available only in some AWS Regions. For more information, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. • VPC hosted – Your gateway communicates with AWS through a private connection with your virtual private cloud (VPC), allowing you to control your network settings. If you select this option, you must specify an existing VPC endpoint by choosing its VPC endpoint ID from the dropdown list. You can also provide its VPC endpoint Domain Name System (DNS) name or IP address. 3. In the Gateway connection options section, for Connection options, choose how to identify your gateway to AWS. You can choose from the following options: • IP address – Provide the IP address of your gateway in the corresponding field. This IP address must be public or accessible from within your current network, and you must be able to connect to it from your web browser. You can obtain the gateway IP address by logging into the gateway's local console from your hypervisor client, or by copying it from your Amazon EC2 instance details page. • Activation key – Provide the activation key for your gateway in the corresponding field. You can generate an activation key using the gateway's local console. If your gateway's IP address is unavailable, choose this option. 4. Now that you have chosen how you want your gateway to connect to AWS, you must activate the gateway. Choose Next to proceed. Review settings and activate your Amazon FSx File Gateway To activate a new FSx File Gateway 1. If you have not done so already, complete the procedures described in the following topics: • Set up an Amazon FSx File Gateway • Connect your Amazon FSx File Gateway to AWS When finished, choose Next to open the Review and activate page in the AWS Storage Gateway console. 2. Review the initial gateway details for each section on the page. Review settings and activate your Amazon FSx File Gateway API Version 2021-03-31 54 AWS Storage Gateway Amazon FSx File Gateway User Guide 3. If a section contains errors, choose Edit to return to the corresponding settings page and make changes. Important You cannot modify the gateway options or connection settings after your gateway is activated. 4. Now that you have activated your gateway, you must perform the first-time configuration to allocate local storage disks and configure logging. Choose Next to proceed. Configure your Amazon FSx File Gateway To perform the first-time configuration on a new FSx File Gateway 1. If you have not done so already, complete the procedures described in the following topics: • Set up an Amazon FSx File Gateway • Connect your Amazon FSx File Gateway to AWS • Review settings and activate your Amazon FSx File Gateway When finished, choose Next to open the Configure gateway page in the AWS Storage Gateway console. In the Configure storage section, use the dropdown lists to allocate at least one local disk with at least 150 gibibytes (GiB) capacity to Cache. The local disks listed in this section correspond to the physical storage that you provisioned on your host platform. In the CloudWatch log group section, choose how to set up Amazon CloudWatch Logs to monitor the health of your gateway. You can choose from the following options: 2. 3. • Create a new log group – Set up a new log group to monitor your gateway. • Use an existing log group – Choose an existing log group from the corresponding dropdown list. • Deactivate logging – Do not use Amazon CloudWatch Logs to monitor your gateway. Configure your Amazon FSx File Gateway API Version 2021-03-31 55 AWS Storage Gateway Amazon FSx File Gateway User Guide Note
|
storagegateway-fsxfile-ug-022
|
storagegateway-fsxfile-ug.pdf
| 22 |
host platform. In the CloudWatch log group section, choose how to set up Amazon CloudWatch Logs to monitor the health of your gateway. You can choose from the following options: 2. 3. • Create a new log group – Set up a new log group to monitor your gateway. • Use an existing log group – Choose an existing log group from the corresponding dropdown list. • Deactivate logging – Do not use Amazon CloudWatch Logs to monitor your gateway. Configure your Amazon FSx File Gateway API Version 2021-03-31 55 AWS Storage Gateway Amazon FSx File Gateway User Guide Note To receive Storage Gateway health logs, the following permissions must be present in your log group resource policy. Replace the highlighted section with the specific log group resourceArn information for your deployment. "Sid": "AWSLogDeliveryWrite20150319", "Effect": "Allow", "Principal": { "Service": [ "delivery.logs.amazonaws.com" ] }, "Action": [ "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:eu-west-1:1234567890:log-group:/foo/bar:log- stream:*" The "Resource" element is required only if you want the permissions to apply explicitly to an individual log group. 4. In the CloudWatch alarms section, choose how to set up Amazon CloudWatch alarms to notify you when your gateway's metrics deviate from defined limits. You can choose from the following options: • Create Storage Gateway's recommended alarms – Create all recommended CloudWatch alarms automatically when the gateway is created. For more information on recommended alarms, see Understanding CloudWatch alarms. Note This feature requires CloudWatch policy permissions which are not automatically granted as part of the preconfigured Storage Gateway full access policy. Make sure your security policy grants the following permissions before you attempt to create recommended CloudWatch alarms: • cloudwatch:PutMetricAlarm - create alarms Configure your Amazon FSx File Gateway API Version 2021-03-31 56 AWS Storage Gateway Amazon FSx File Gateway User Guide • cloudwatch:DisableAlarmActions - turn alarm actions off • cloudwatch:EnableAlarmActions - turn alarm actions on • cloudwatch:DeleteAlarms - delete alarms • Create a custom alarm – Configure a new CloudWatch alarm to be notified about your gateway's metrics. Choose Create alarm to define metrics and specify alarm actions in the Amazon CloudWatch console. For instructions, see Using Amazon CloudWatch alarms in the Amazon CloudWatch User Guide. 5. 6. • No alarm – Do not use CloudWatch alarms to be notified about your gateway's metrics. (Optional) In the Tags section, choose Add new tag, then enter a case-sensitive key-value pair to help you search and filter for your gateway on the list pages in the AWS Storage Gateway console. Repeat this step to add as many tags as you need. (Optional) In the Verify VMware High Availability configuration section, if your gateway is deployed on a VMware host that is part of a VMware High Availability (HA) cluster, choose Verify VMware HA to test whether the HA configuration is working properly. Note This section appears only for gateways that are running on the VMware host platform. This step is not required to complete the gateway configuration process. You can test your gateway's HA configuration at any time. Verification takes a few minutes, and reboots the Storage Gateway virtual machine (VM). 7. Choose Configure to finish creating your gateway. To check the status of your new gateway, search for it on the Gateway overview page of the AWS Storage Gateway console. Now that you have created your gateway, you must attach a file system for it to use. For instructions, see Attach an Amazon FSx for Windows File Server file system. If you do not have an existing Amazon FSx file system to attach, you must create one. For instructions, see Getting started with Amazon FSx. Configure your Amazon FSx File Gateway API Version 2021-03-31 57 AWS Storage Gateway Amazon FSx File Gateway User Guide Activating a gateway in a virtual private cloud You can create a private connection between your on-premises gateway appliance and cloud-based storage infrastructure. You can use this connection to activate your gateway and configure it to transfer data to AWS storage services without communicating over the public internet. Using the Amazon VPC service, you can launch AWS resources, including private network interface endpoints, in a custom virtual private cloud (VPC). A VPC gives you control over network settings such as IP address range, subnets, route tables, and network gateways. For more information about VPCs, see What is Amazon VPC? in the Amazon VPC User Guide. To activate your gateway in a VPC, use the Amazon VPC Console to create a VPC endpoint for Storage Gateway and get the VPC endpoint ID, then specify this VPC endpoint ID when you create and activate the gateway. For more information, see Connect your Amazon FSx File Gateway to AWS. To configure your FSx File Gateway to transfer data through the VPC, you must establish a VPN or AWS DirectConnect link between the Amazon FSx for Windows File Server
|
storagegateway-fsxfile-ug-023
|
storagegateway-fsxfile-ug.pdf
| 23 |
tables, and network gateways. For more information about VPCs, see What is Amazon VPC? in the Amazon VPC User Guide. To activate your gateway in a VPC, use the Amazon VPC Console to create a VPC endpoint for Storage Gateway and get the VPC endpoint ID, then specify this VPC endpoint ID when you create and activate the gateway. For more information, see Connect your Amazon FSx File Gateway to AWS. To configure your FSx File Gateway to transfer data through the VPC, you must establish a VPN or AWS DirectConnect link between the Amazon FSx for Windows File Server VPC and the network where your gateway is deployed. Note You must activate your gateway in the same region where you create the VPC endpoint for Storage Gateway. Create a VPC endpoint for Storage Gateway Follow these instructions to create a VPC endpoint. If you already have a VPC endpoint for Storage Gateway, you can use it. To create a VPC endpoint for Storage Gateway 1. Sign in to the AWS Management Console and open the Amazon VPC console at https:// console.aws.amazon.com/vpc/. 2. In the navigation pane, choose Endpoints, and then choose Create Endpoint. 3. On the Create Endpoint page, choose AWS Services for Service category. 4. For Service Name, choose com.amazonaws.region.storagegateway. For example com.amazonaws.us-east-2.storagegateway. Activating a gateway in a VPC API Version 2021-03-31 58 AWS Storage Gateway Amazon FSx File Gateway User Guide 5. For VPC, choose your VPC and note its Availability Zones and subnets. 6. Verify that Enable Private DNS Name is not selected. 7. For Security group, choose the security group that you want to use for your VPC. You can accept the default security group. Verify that all of the following TCP ports are allowed in your security group: • TCP 443 • TCP 1026 • TCP 1027 • TCP 1028 • TCP 1031 • TCP 2222 8. Choose Create endpoint. The initial state of the endpoint is pending. When the endpoint is created, note the ID of the VPC endpoint that you just created. 9. When the endpoint is created, choose Endpoints, then choose the new VPC endpoint. 10. In Details tab of the selected storage gateway endpoint, under DNS Names, use the first DNS name that doesn't specify an Availability Zone. Your DNS name should look similar to the following example: vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com Now that you have a VPC endpoint, you can create and activate your gateway. For more information, see Create and activate an Amazon FSx File Gateway. For information about getting an activation key, see Getting an activation key for your gateway. Create a VPC endpoint for Storage Gateway API Version 2021-03-31 59 AWS Storage Gateway Amazon FSx File Gateway User Guide Configure Microsoft Active Directory domain access settings In this step, you configure access settings to join your Amazon FSx File Gateway to a Microsoft Active Directory domain. To configure Active Directory settings 1. In the Storage Gateway console, choose FSx file systems from the navigation menu. 2. Choose Attach FSx file system. 3. On the Confirm gateway page, choose the gateway you want to join to your Active Directory domain from the drop-down menu. If you don't have a gateway, you must create one. Make sure your gateway can resolve the name of your Active Directory Domain Controller. For information, see Prerequisites. 4. Enter values for the Active Directory settings: Note If your gateway is already joined to a domain, you don't need to join again. Go to the next step. • For Domain name, enter the domain name of the Active Directory that you want to use. • For Domain user, enter the user name of the Active Directory user that you want to use to join the gateway to the domain. This user must have the necessary permissions. For more information, see Active Directory service account permission requirements. • For Domain password, enter the password for the user. • For Organizational unit- optional, you can specify an organizational unit the Active Directory belongs to. Note If you leave this field blank, joining a domain creates an Active Directory computer account in the default computers container (which is not an OU), using the gateway's API Version 2021-03-31 60 AWS Storage Gateway Amazon FSx File Gateway User Guide Gateway ID as the account name (for example, SGW-1234ADE). It is not possible to customize the name of this account. 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. If your Active Directory environment has a designated OU for new computer objects, you must specify that OU when joining the domain. • Enter a value for Domain controller(s) - optional. 5. Choose Next to open the Attach FSx File system page. Next step Attach
|
storagegateway-fsxfile-ug-024
|
storagegateway-fsxfile-ug.pdf
| 24 |
AWS Storage Gateway Amazon FSx File Gateway User Guide Gateway ID as the account name (for example, SGW-1234ADE). It is not possible to customize the name of this account. 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. If your Active Directory environment has a designated OU for new computer objects, you must specify that OU when joining the domain. • Enter a value for Domain controller(s) - optional. 5. Choose Next to open the Attach FSx File system page. Next step Attach an Amazon FSx for Windows File Server file system API Version 2021-03-31 61 AWS Storage Gateway Amazon FSx File Gateway User Guide Attach an Amazon FSx for Windows File Server file system You must have an FSx for Windows File Server file system before you can attach it to an FSx File Gateway. If you don't have a file system, you must create one. For instructions, see Step 1: Create Your File System in the Amazon FSx for Windows File Server User Guide. The next step is to attach an Amazon FSx file system to the gateway. When you attach an Amazon FSx file system, all the file shares on the file system are made available to Amazon FSx File Gateway (FSx File Gateway) for you to mount. Note The following limitations apply when writing to an Amazon FSx file system from Amazon FSx File Gateway: • Your Amazon FSx file system and your FSx File Gateway must be owned by the same AWS account and located in the same AWS Region. • Each gateway can support up to five attached file systems. When you're attaching a file system, the Storage Gateway console notifies you if the selected gateway is at capacity. In that case, you must choose a different gateway or detach a file system before you can attach another one. • FSx File Gateway supports soft storage quotas (which warn you when users surpass their data limits), but does not support hard quotas (which enforce data limits by denying write access). Soft quotas are supported for all users except the Amazon FSx admin user. For more information about setting up storage quotas, see Storage quotas in the Amazon FSx User Guide. • We don't recommend using Microsoft Distributed File System (DFS) to redirect users to your Amazon FSx file system through FSx File Gateway. Instead, configure DFS to redirect directly to the Amazon FSx file system in the AWS Cloud as described in Grouping multiple file systems with DFS Namespaces in the Amazon FSx for Windows File Server User Guide. API Version 2021-03-31 62 AWS Storage Gateway Amazon FSx File Gateway User Guide To attach an Amazon FSx file system 1. In the Storage Gateway console, on the FSx file systems > Attach FSx file system page, complete the following fields in the FSx file system settings section: • For FSx file system name, choose the file system that you want to attach from the dropdown list. • For Local Endpoint IP address, enter the gateway IP address that clients will use to browse file shares on the FSx file system. Note • You must specify an IP address for each file system attached to the gateway. • For Amazon EC2 gateways, you can specify the private IP address of the EC2 instance, unless it is already in use by a different file system, in which case you must add a new private address to the gateway, then restart it. For more information, see Multiple IP addresses in the Amazon EC2 User Guide. • For on-premises gateways, you can specify the IP address of the primary network interface (static or DHCP), unless it is already in use by a different file system, in which case you must provide a different IP address from the same subnet as the primary interface, which will be made available as a virtual IP. Do not use an IP address assigned to any network interface other than the primary. 2. In the Service account settings section, provide the service account sign-in credentials that is associated with the Amazon FSx file system. Note This service account must have Backup Operators privileges from the Active Directory service that is associated with your Amazon FSx file systems or have equivalent permissions. Important To ensure sufficient permissions to files, folders, and file metadata, we recommend that you make the service account a member of the file system administrators group. API Version 2021-03-31 63 AWS Storage Gateway Amazon FSx File Gateway User Guide If you are using AWS Directory Service for Microsoft Active Directory with Amazon FSx for Windows File Server, the service account must be a member of the AWS Delegated FSx Administrators group. If you are
|
storagegateway-fsxfile-ug-025
|
storagegateway-fsxfile-ug.pdf
| 25 |
service account must have Backup Operators privileges from the Active Directory service that is associated with your Amazon FSx file systems or have equivalent permissions. Important To ensure sufficient permissions to files, folders, and file metadata, we recommend that you make the service account a member of the file system administrators group. API Version 2021-03-31 63 AWS Storage Gateway Amazon FSx File Gateway User Guide If you are using AWS Directory Service for Microsoft Active Directory with Amazon FSx for Windows File Server, the service account must be a member of the AWS Delegated FSx Administrators group. If you are using a self-managed Active Directory with Amazon FSx for Windows File Server, we recommend that the service account be a member of the custom delegated file system administrators group you specified for file system administration when you created your Amazon FSx file system. If you chose not to create a custom delegated file system administrators group when you created the Amazon FSx filesystem, the default group is Domain Admins. While you can make the service account a member of this group instead, it is not recommended as a best practice. For more information, see Delegating privileges to your Amazon FSx service account in the Amazon FSx for Windows File Server User Guide. 3. 4. 5. In the Audit logs section, choose Existing log groups, and choose the log that you want to use to monitor access to your Amazon FSx file system. You can create a new one. If you don't want to monitor your system, choose Disable logging. For Automated cache refresh setting, if you want your cache to refresh automatically, choose Set refresh interval and specify an interval between 5 minutes and 30 days. (Optional) In the Tags section, choose Add new tag to add one or more keys and a value for tagging your settings. 6. Choose Next and review the settings. To change your settings, you can choose Edit in each section. 7. When you are done, choose Finish. Next step Mount and use your Amazon FSx file share API Version 2021-03-31 64 AWS Storage Gateway Amazon FSx File Gateway User Guide Mount and use your Amazon FSx file share Before mounting your file share on the client, wait for the status of the Amazon FSx file system to change to Available. After your file share is mounted, you can start using your Amazon FSx File Gateway (FSx File Gateway). Topics • Mount your SMB file share on your client • Test your FSx File Gateway Mount your SMB file share on your client In this step, you mount your SMB file share and map to a drive that is accessible to your client. The console's File Gateway section shows the supported mount commands that you can use for SMB clients. Following are some additional options to try. You can use several different methods for mounting SMB file shares, including the following: • The net use command – Doesn't persist across system reboots, unless you use the / persistent:(yes:no) switch. • The CmdKey command line utility – Creates a persistent connection to a mounted SMB file share that remains after a reboot. • A network drive mapped in File Explorer – Configures the mounted file share to reconnect at sign-in and to require that you enter your network credentials. • PowerShell script – Can be persistent, and can be either visible or invisible to the operating system while mounted. Note If you are a Microsoft Active Directory user, check with your administrator to ensure that you have access to the SMB file share before mounting the file share to your local system. Amazon FSx File Gateway doesn't support SMB locking or SMB extended attributes. Mount your SMB file share on your client API Version 2021-03-31 65 AWS Storage Gateway Amazon FSx File Gateway User Guide To mount an SMB file share for Active Directory users using the net use command 1. Make sure that you have access to the SMB file share before mounting the file share to your local system. 2. For Microsoft Active Directory clients, enter the following command at the command prompt: net use [WindowsDriveLetter]: \\[Gateway IP Address]\[Name of the share on the FSx file system] To mount an SMB file share on Windows using CmdKey 1. Press the Windows key and enter cmd to view the command prompt menu item. 2. Open the context (right-click) menu for Command Prompt, and choose Run as administrator. 3. Enter the following command: C:\>cmdkey /add:[Gateway VM IP address] /user:[DomainName]\[UserName] / pass:[Password] Note When mounting file shares, you might need to remount your file share after rebooting your client. To mount an SMB file share using Windows File Explorer 1. Press the Windows key and enter File Explorer in the Search Windows box, or press Win +E.
|
storagegateway-fsxfile-ug-026
|
storagegateway-fsxfile-ug.pdf
| 26 |
FSx file system] To mount an SMB file share on Windows using CmdKey 1. Press the Windows key and enter cmd to view the command prompt menu item. 2. Open the context (right-click) menu for Command Prompt, and choose Run as administrator. 3. Enter the following command: C:\>cmdkey /add:[Gateway VM IP address] /user:[DomainName]\[UserName] / pass:[Password] Note When mounting file shares, you might need to remount your file share after rebooting your client. To mount an SMB file share using Windows File Explorer 1. Press the Windows key and enter File Explorer in the Search Windows box, or press Win +E. 2. 3. 4. 5. 6. In the navigation pane, choose This PC. Then, on the Computer tab, choose Map network drive. In the Map network drive dialog box, choose a drive letter for Drive. For Folder, enter \\[File Gateway IP]\[SMB File Share Name], or choose Browse to select your SMB file share from the dialog box. (Optional) Select Reconnect at sign-up if you want your mount point to persist after reboots. (Optional) Select Connect using different credentials if you want a user to enter the Active Directory logon or guest account user password. Mount your SMB file share on your client API Version 2021-03-31 66 AWS Storage Gateway Amazon FSx File Gateway User Guide 7. Choose Finish to complete your mount point. Test your FSx File Gateway You can copy files and directories to your mapped drive. The files automatically upload to your FSx for Windows File Server file system. To upload files from your Windows client to Amazon FSx 1. On your Windows client, navigate to the drive that you mounted your file system on. The name of the drive is preceded by the name of your file system. 2. Copy files or a directory to the drive. Note File Gateways don't support creating hard or symbolic links on a file share. Test your FSx File Gateway API Version 2021-03-31 67 AWS Storage Gateway Amazon FSx File Gateway User Guide Managing your Amazon FSx File Gateway resources The following sections provide information about how to manage your Amazon FSx File Gateway (FSx File Gateway) resources, including attaching and detaching Amazon FSx file systems, and configuring Microsoft Active Directory settings. Topics • Understanding gateway status • Understanding file system status • Edit basic information for an FSx File Gateway • Set a security level for your gateway • Editing Active Directory settings for n FSx File Gateway • Editing settings for an Amazon FSx file system • Detaching an Amazon FSx file system Understanding gateway status Each gateway in your AWS Storage Gateway deployment has an associated status that tells you at a glance what the health of the gateway is. Most of the time, the status indicates that the gateway is functioning normally and that no action is needed on your part. In some cases, the status indicates a problem that might or might not require action on your part. You can see the status for each gateway in your deployment on the Gateways page of the Storage Gateway console. The gateway status appears in the Status column next to the name of the gateway. A gateway that is functioning normally has a status of RUNNING. In the following table, you can find a description of each gateway status, and whether you should act based on the status. A gateway should have RUNNING status all or most of the time it's in use. Status RUNNING OFFLINE Gateway status Meaning The gateway is configured properly and is available to use. Your gateway might be in an OFFLINE status for one or more of the following reasons: API Version 2021-03-31 68 AWS Storage Gateway Amazon FSx File Gateway User Guide Status Meaning • The gateway can't reach the Storage Gateway service endpoints. • The gateway had an unexpected shutdown. • The gateway has an associated cache disk that is disconnected, has been modified, or has failed. Understanding file system status You can view the health of a file system at a glance by looking at its status. If the status indicates that the file system is functioning normally, no action is needed on your part. If the status indicates that there's a problem, you can investigate to determine whether action could be required. You can view a file system's status on the Storage Gateway console in the Status column. A file system that's functioning properly shows a status of AVAILABLE. This should be the status most of the time. The following table describes file share statuses, what they mean, and whether action might be required. Status Meaning AVAILABLE CREATING UPDATING The file system is configured properly and is available to use. This is the standard status for a file system that's working properly. The file system is not yet fully created
|
storagegateway-fsxfile-ug-027
|
storagegateway-fsxfile-ug.pdf
| 27 |
a problem, you can investigate to determine whether action could be required. You can view a file system's status on the Storage Gateway console in the Status column. A file system that's functioning properly shows a status of AVAILABLE. This should be the status most of the time. The following table describes file share statuses, what they mean, and whether action might be required. Status Meaning AVAILABLE CREATING UPDATING The file system is configured properly and is available to use. This is the standard status for a file system that's working properly. The file system is not yet fully created and is not ready for use. The CREATING status is transitional. No action is required. If the file system gets stuck in this status, it's probably because the gateway VM lost connection to AWS. The file system configuration is currently updating. The UPDATING status is transitional. No action is required. If a file system gets stuck in this status, it's probably because the gateway VM lost connection to AWS. Understanding file system status API Version 2021-03-31 69 AWS Storage Gateway Amazon FSx File Gateway User Guide Status Meaning DELETING The file system is being deleted. The file system is not deleted until all data is uploaded to AWS. The DELETING status is transitional, and no action is required. FORCE_DELETING The file system is being deleted forcibly. The file system is deleted immediately and data is not uploaded to AWS. The FORCE_DELETING status is transitional, and no action is required. ERROR The file system is in an unhealthy state. Action is required. Some possible causes include problems with access credentials or privilege s, connectivity issues, or insufficient storage space on the file system. When the issue that caused the unhealthy state is resolved, the file system returns to a status of AVAILABLE. Edit basic information for an FSx File Gateway You can use the Storage Gateway console to edit basic information for an existing gateway, including the gateway name, time zone, and CloudWatch log group. To edit basic information for an existing gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Gateways, then choose the gateway for which you want to edit basic information. 3. 4. From the Actions dropdown menu, choose Edit gateway information. For Gateway name, enter a name for your gateway. You can search for this name to find your gateway on the list pages in the Storage Gateway console. Note Gateway names must be between 2 and 255 characters, and cannot include a slash (\ or /). Edit basic gateway information API Version 2021-03-31 70 AWS Storage Gateway Amazon FSx File Gateway User Guide Changing a gateway's name will disconnect any CloudWatch alarms set up to monitor the gateway. To reconnect the alarms, update the GatewayName for each alarm in the CloudWatch console. 5. 6. For Gateway time zone, choose the local time zone for the part of the world where you want to deploy your gateway. For Choose how to set up log group, choose how to set up Amazon CloudWatch Logs to monitor the health of your gateway. You can choose from the following options: • Create a new log group – Set up a new log group to monitor your gateway. • Use an existing log group – Choose an existing log group from the corresponding dropdown list. • Deactivate logging – Do not use Amazon CloudWatch Logs to monitor your gateway. 7. When you finish modifying the settings you want to change, choose Save changes. Set a security level for your gateway You can configure the SMB security level for your FSx File Gateway to specify whether the gateway should require Server Message Block (SMB) signing or SMB encryption. To configure security level 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Gateways, then choose the gateway for which you want to edit SMB settings. 3. From the Actions dropdown menu, choose Edit SMB settings, then choose SMB security settings. 4. For Security level, choose one of the following: Note For information about configuring this setting using the AWS API, see UpdateSMBSecurityStrategy in the AWS Storage Gateway API Reference. A higher security level can affect performance of the gateway. Set gateway security level API Version 2021-03-31 71 AWS Storage Gateway Amazon FSx File Gateway User Guide • Mandatory encryption – If you choose this option, FSx 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. • Enforce encryption – If you choose this option, FSx File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are
|
storagegateway-fsxfile-ug-028
|
storagegateway-fsxfile-ug.pdf
| 28 |
gateway. Set gateway security level API Version 2021-03-31 71 AWS Storage Gateway Amazon FSx File Gateway User Guide • Mandatory encryption – If you choose this option, FSx 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. • Enforce encryption – If you choose this option, FSx 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. • Enforce signing – If you choose this option, FSx 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. Note The default security level for FSx File Gateway is Enforce encryption. 5. Choose Save. Editing Active Directory settings for n FSx File Gateway To use your corporate Microsoft Active Directory or AWS Managed Microsoft AD for user authenticated access to your Amazon FSx file system, edit the SMB settings for your gateway and provide your Active Directory domain credentials. Doing this allows your gateway to join your Active Directory domain and allows members of the domain to access the file system. Note Using AWS Directory Service, you can create a hosted Active Directory domain service in the AWS Cloud. To use AWS Managed Microsoft AD with an Amazon EC2 gateway, you must create the Amazon EC2 instance in the same VPC as the AWS Managed Microsoft AD, add the _workspaceMembers security group to the Amazon EC2 instance, and join the AD domain using the Admin credentials from the AWS Managed Microsoft AD. For more information about AWS Managed Microsoft AD, see the AWS Directory Service Administration Guide. Editing Active Directory settings for n FSx File Gateway API Version 2021-03-31 72 AWS Storage Gateway Amazon FSx File Gateway User Guide For more information about Amazon EC2, see the Amazon Elastic Compute Cloud Documentation. To turn on Active Directory authentication 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Gateways, then choose the gateway for which you want to edit SMB settings. 3. 4. 5. 6. From the Actions drop-down menu, choose Edit SMB settings, then choose Active Directory settings. For Domain name, enter the name of the Active Directory domain you want your gateway to join. Note Active Directory status shows Detached when a gateway has never joined a domain. Your Active Directory service account must have the requisite permissions. For more information, see Active Directory service account permission requirements. Joining a domain creates an Active Directory computer account in the default computers container (which is not an OU), using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). It is not possible to customize the name of this account. 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. If your Active Directory environment has a designated OU for new computer objects, you must specify that OU when joining the domain. If your gateway can't join an Active Directory directory, try joining with the directory's IP address by using the JoinDomain API operation. For Domain user and Domain password, enter the credentials for the Active Directory service account that the gateway will use to join the domain. (Optional) For Organization unit (OU), enter the designated OU that your Active Directory uses for new computer objects. Editing Active Directory settings for n FSx File Gateway API Version 2021-03-31 73 AWS Storage Gateway Amazon FSx File Gateway User Guide 7. (Optional) For Domain controller(s) (DC), enter the name of one or more DCs through which your gateway will connect to Active Directory. You can enter multiple DCs as a comma- separated list. You can leave this field blank to allow DNS to automatically select a DC. 8. Choose Save changes. Editing settings for an Amazon FSx file system After creating an Amazon FSx for Windows File Server file system, you can edit settings for CloudWatch logs, automated cache refresh, and Amazon FSx service account credentials. To edit Amazon FSx file system settings 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. 3. 4. 5. 6. In the navigation pane, choose File system, and choose the file system whose settings you want to edit. For Actions, choose Edit file system settings. In the file system settings section, verify the gateway, Amazon FSx location, and IP address information. Note You cannot edit a file system's IP address
|
storagegateway-fsxfile-ug-029
|
storagegateway-fsxfile-ug.pdf
| 29 |
file system After creating an Amazon FSx for Windows File Server file system, you can edit settings for CloudWatch logs, automated cache refresh, and Amazon FSx service account credentials. To edit Amazon FSx file system settings 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. 3. 4. 5. 6. In the navigation pane, choose File system, and choose the file system whose settings you want to edit. For Actions, choose Edit file system settings. In the file system settings section, verify the gateway, Amazon FSx location, and IP address information. Note You cannot edit a file system's IP address after it is attached to a gateway. To change the IP address, you must detach and reattach the file system. In the Audit logs section, choose an option to use CloudWatch log groups to monitor access to Amazon FSx file systems. You can use an existing log group. For Automated cache refresh settings, choose an option. If you choose Set refresh interval, set the time in days, hours, and minutes to refresh the file system's cache using Time To Live (TTL). TTL is the length of time since the last refresh. When the directory is accessed after that length of time, the File Gateway refreshes that directory's contents from the Amazon FSx file system. Editing settings for an Amazon FSx file system API Version 2021-03-31 74 AWS Storage Gateway Amazon FSx File Gateway User Guide Note Valid refresh interval values are between 5 minutes and 30 days. 7. In the Service account settings - optional section, enter a user name and a Password. These credentials are for a user that has the Backup Administrator role from the Active Directory service associated with your Amazon FSx file systems. 8. Choose Save changes. Detaching an Amazon FSx file system Detaching a file system doesn't delete your data in FSx for Windows File Server. Data that is written to these the file systems before you detach them will still be uploaded to your FSx for Windows File Server. To detach an Amazon FSx file system 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose FSx file systems, then select one or more file systems to detach. 3. For Actions, choose Detach file system. The confirmation dialog box appears. 4. Verify that you want to detach the specified file systems, then type the word detach in the confirmation box and choose Detach. Detaching an Amazon FSx file system API Version 2021-03-31 75 AWS Storage Gateway Amazon FSx File Gateway User Guide Monitoring Storage Gateway The topics in this section describe how to monitor a gateway using Amazon CloudWatch, including monitoring cache storage and other resources associated with the gateway. You use the Storage Gateway console to view metrics and alarms for your gateway. For example, you can view the number of bytes used in read and write operations, the time spent in read and write operations, and the time taken to retrieve data from the AWS Cloud. With metrics, you can track the health of your gateway and set up alarms to notify you when one or more metrics fall outside a defined threshold. Storage Gateway provides CloudWatch metrics at no additional charge. Storage Gateway metrics are recorded for a period of two weeks. By using these metrics, you can access historical information and get a better perspective on how your gateways are performing. Storage Gateway also provides CloudWatch alarms, except high-resolution alarms, at no additional charge. For more information about CloudWatch pricing, see Amazon CloudWatch pricing. For more information about CloudWatch, see the Amazon CloudWatch User Guide. Topics • Understanding CloudWatch alarms - Learn basic information about CloudWatch alarms, including alarm states and recommended configurations. • Create recommended CloudWatch alarms - Learn how you can quickly and automatically configure all recommended CloudWatch alarms as part of the initial File Gateway setup process. • Create a custom CloudWatch alarm - Learn how you can create a custom CloudWatch alarm to monitor a specific metric using specific evaluation criteria to trigger alarm states and send notifications. • Monitoring your FSx File Gateway - Learn how to view CloudWatch logs and audit logs, and find information about the specific gateway and file sharefile system metrics that are reported by your gateway. Understanding CloudWatch alarms CloudWatch alarms monitor information about your gateway based on metrics and expressions. You can add CloudWatch alarms for your gateway and view their statuses in the Storage Gateway console. For more information about the metrics that are used to monitor FSx File Gateway, see Understanding CloudWatch alarms API Version 2021-03-31 76 AWS Storage Gateway Amazon FSx File Gateway User Guide Understanding gateway metrics and Understanding file system metrics. For each alarm, you specify conditions that will activate its ALARM state. Alarm status indicators in the Storage Gateway console turn red
|
storagegateway-fsxfile-ug-030
|
storagegateway-fsxfile-ug.pdf
| 30 |
metrics that are reported by your gateway. Understanding CloudWatch alarms CloudWatch alarms monitor information about your gateway based on metrics and expressions. You can add CloudWatch alarms for your gateway and view their statuses in the Storage Gateway console. For more information about the metrics that are used to monitor FSx File Gateway, see Understanding CloudWatch alarms API Version 2021-03-31 76 AWS Storage Gateway Amazon FSx File Gateway User Guide Understanding gateway metrics and Understanding file system metrics. For each alarm, you specify conditions that will activate its ALARM state. Alarm status indicators in the Storage Gateway console turn red when in the ALARM state, making it easier for you to monitor status proactively. You can configure alarms to invoke actions automatically based on sustained changes in state. For more information about CloudWatch alarms, see Using Amazon CloudWatch alarms in the Amazon CloudWatch User Guide. Note If you don't have permission to view CloudWatch, you can't view the alarms. For each activated gateway, we recommend that you create the following CloudWatch alarms: • High IO wait: IoWaitpercent >= 20 for 3 datapoints in 15 minutes • Cache percent dirty: CachePercentDirty > 80 for 4 datapoints within 20 minutes • Files failing upload: FilesFailingUpload >= 1 for 1 datapoint within 5 minutes • File system error: FileSystem-ERROR >= 1 for 1 datapoint within 5 minutes • Health notifications: HealthNotifications >= 1 for 1 datapoints within 5 minutes. When configuring this alarm, set Missing data treatment to notBreaching. Note You can set a health notification alarm only if the gateway had a previous health notification in CloudWatch. For gateways on VMware host platforms that are part of a VMware High Availability cluster, we also recommend this additional CloudWatch alarm: • Availability notifications: AvailabilityNotifications >= 1 for 1 datapoints within 5 minutes. When configuring this alarm, set Missing data treatment to notBreaching. The following table describes CloudWatch alarm states. Understanding CloudWatch alarms API Version 2021-03-31 77 AWS Storage Gateway Amazon FSx File Gateway User Guide State OK Alarm Insufficient data None Unavailable Description The metric or expression is within the defined threshold. The metric or expression is outside of the defined threshold. The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. No alarms are created for the gateway. To create a new alarm, see Create a custom CloudWatch alarm for your gateway. The state of the alarm is unknown. Choose Unavailable to view error information in the Monitoring tab. Creating recommended CloudWatch alarms for your gateway When you create a new gateway using the Storage Gateway console, you can choose to create all recommended CloudWatch alarms automatically as part of the initial setup process. For more information, see Configure your Amazon FSx File Gateway. If you want to add or update recommended CloudWatch alarms for an existing gateway after you have already completed the first-time setup, use the following procedure. To add or update recommended CloudWatch alarms for an existing gateway Note This feature requires CloudWatch policy permissions, which are not automatically granted as part of the preconfigured Storage Gateway full access policy. Make sure your security policy grants the following permissions before you attempt to create recommended CloudWatch alarms: • cloudwatch:PutMetricAlarm - create alarms Create recommended CloudWatch alarms API Version 2021-03-31 78 AWS Storage Gateway Amazon FSx File Gateway User Guide • cloudwatch:DisableAlarmActions - turn alarm actions off • cloudwatch:EnableAlarmActions - turn alarm actions on • cloudwatch:DeleteAlarms - delete alarms 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/. 2. In the navigation pane on the left side of the page, choose Gateways, and then choose the gateway for which you want to create recommended CloudWatch alarms. 3. On the Details page for the gateway, choose the Monitoring tab. 4. Under Alarms, choose Create recommended alarms. The recommended alarms are created automatically. The Alarms section lists all CloudWatch alarms for a specific gateway. From here, you can select and delete one or more alarms, turn alarm actions on or off, and create new alarms. Create a custom CloudWatch alarm for your gateway CloudWatch uses Amazon Simple Notification Service (Amazon SNS) to send alarm notifications when an alarm changes state. An alarm watches a single metric over a time period that you specify, and performs one or more actions based on the value of the metric relative to a given threshold over a number of time periods. The action is a notification that's sent to an Amazon SNS topic. You can create an Amazon SNS topic when you create a CloudWatch alarm. For more information about Amazon SNS, see What is Amazon SNS? in the Amazon Simple Notification Service Developer Guide. To create a CloudWatch alarm in the Storage Gateway console 1. Open the Storage Gateway console at
|
storagegateway-fsxfile-ug-031
|
storagegateway-fsxfile-ug.pdf
| 31 |
changes state. An alarm watches a single metric over a time period that you specify, and performs one or more actions based on the value of the metric relative to a given threshold over a number of time periods. The action is a notification that's sent to an Amazon SNS topic. You can create an Amazon SNS topic when you create a CloudWatch alarm. For more information about Amazon SNS, see What is Amazon SNS? in the Amazon Simple Notification Service Developer Guide. To create a CloudWatch alarm in the Storage Gateway console 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/. 2. In the navigation pane, choose Gateways, then choose the gateway for which you want to create an alarm. 3. On the gateway details page, choose the Monitoring tab. 4. Under Alarms, choose Create alarm to open the CloudWatch console. 5. Use the CloudWatch console to create the type of alarm that you want. You can create the following types of alarms: Create a custom CloudWatch alarm API Version 2021-03-31 79 AWS Storage Gateway Amazon FSx File Gateway User Guide • Static threshold alarm: An alarm based on a set threshold for a chosen metric. The alarm enter the ALARM state when the metric breaches the threshold for a specified number of evaluation periods. To create a static threshold alarm, see Creating a CloudWatch alarm based on a static threshold in the Amazon CloudWatch User Guide. • Anomaly detection alarm: Anomaly detection mines past metric data and creates a model of expected values. You set a value for the anomaly detection threshold, and CloudWatch uses this threshold with the model to determine the "normal" range of values for the metric. A higher value for the threshold produces a thicker band of "normal" values. You can choose to activate the alarm only when the metric value is above the band of expected values, only when it's below the band, or when it's above or below the band. To create an anomaly detection alarm, see Creating a CloudWatch alarm based on anomaly detection in the Amazon CloudWatch User Guide. • Metric math expression alarm: An alarm based one or more metrics used in a math expression. You specify the expression, threshold, and evaluation periods. To create a metric math expression alarm, see Creating a CloudWatch alarm based on a metric math expression in the Amazon CloudWatch User Guide. • Composite alarm: An alarm that determines its alarm state by watching the alarm states of other alarms. A composite alarm can help you reduce alarm noise. To create a composite alarm, see Creating a composite alarm in the Amazon CloudWatch User Guide. 6. After you create the alarm in the CloudWatch console, return to the Storage Gateway console. You can view the alarm by doing one of the following: • In the navigation pane, choose Gateways, then choose the gateway for which you want to view alarms. On the Details tab, under Alarms, choose CloudWatch Alarms. • In the navigation pane, choose Gateways, choose the gateway for which you want to view alarms, then choose the Monitoring tab. The Alarms section lists all of the CloudWatch alarms for a specific gateway. From here, you can select and delete one or more alarms, turn alarm actions on or off, and create new alarms. Create a custom CloudWatch alarm API Version 2021-03-31 80 AWS Storage Gateway Amazon FSx File Gateway User Guide • In the navigation pane, choose Gateways, then choose the alarm state of the gateway for which you want to view alarms. For information about how to edit or delete an alarm, see Editing or deleting a CloudWatch alarm. Note When you delete a gateway using the Storage Gateway console, all CloudWatch alarms associated with the gateway are also automatically deleted. Monitoring your FSx File Gateway You can monitor your FSx File Gateway and associated resources in AWS Storage Gateway by using Amazon CloudWatch metrics and audit logs. You can also use CloudWatch Events to get notified when your file operations are done. Topics • Getting FSx File Gateway health logs with CloudWatch log groups • Using Amazon CloudWatch metrics • Understanding gateway metrics • Understanding file system metrics • Understanding FSx File Gateway audit logs Getting FSx File Gateway health logs with CloudWatch log groups You can use Amazon CloudWatch Logs to get information about the health of your FSx File Gateway and related resources. You can use the logs to monitor your gateway for errors that it encounters. In addition, you can use Amazon CloudWatch subscription filters to automate processing of the log information in real time. For more information, see Real-time Processing of Log Data with Subscriptions in the Amazon CloudWatch User Guide. For example, you can configure a CloudWatch log group to monitor your gateway and get
|
storagegateway-fsxfile-ug-032
|
storagegateway-fsxfile-ug.pdf
| 32 |
FSx File Gateway audit logs Getting FSx File Gateway health logs with CloudWatch log groups You can use Amazon CloudWatch Logs to get information about the health of your FSx File Gateway and related resources. You can use the logs to monitor your gateway for errors that it encounters. In addition, you can use Amazon CloudWatch subscription filters to automate processing of the log information in real time. For more information, see Real-time Processing of Log Data with Subscriptions in the Amazon CloudWatch User Guide. For example, you can configure a CloudWatch log group to monitor your gateway and get notified when your FSx File Gateway fails to upload files to an Amazon FSx file system. You can configure the group either when you are activating the gateway or after your gateway is activated and up Monitoring your FSx File Gateway API Version 2021-03-31 81 AWS Storage Gateway Amazon FSx File Gateway User Guide and running. For information about how to configure a CloudWatch log group when activating a gateway, see Configure your Amazon FSx File Gateway. For general information about CloudWatch log groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide. For information about how to troubleshoot the errors that may be reported by FSx File Gateway, see Troubleshooting: File Gateway issues. Configuring a CloudWatch log group after your gateway is activated The following procedure shows you how to configure a CloudWatch Log Group after your gateway is activated. To configure a CloudWatch log group to work with your FSx File Gateway 1. Sign in to the AWS Management Console and open the Storage Gateway console at https:// console.aws.amazon.com/storagegateway/home. 2. 3. In the navigation pane, choose Gateways, and then choose the gateway that you want to configure the CloudWatch log group for. For Actions, choose Edit gateway information. Or, on the Details tab, under Health logs and Not Enabled, choose Configure log group to open the Edit CustomerGatewayName dialog box. 4. For Gateway health log group, choose one of the following: • Disable logging if you don't want to monitor your gateway using CloudWatch log groups. • Create a new log group to create a new CloudWatch log group. • Use an existing log group to use a CloudWatch log group that already exists. Choose a log group from the Existing log group list. 5. Choose Save changes. 6. To see the health logs for your gateway, do the following: 1. In the navigation pane, choose Gateways, and then choose the gateway that you configured the CloudWatch log group for. 2. Choose the Details tab, and under Health logs, choose CloudWatch Logs. The Log group details page opens in the CloudWatch console. Getting FSx File Gateway health logs API Version 2021-03-31 82 AWS Storage Gateway Amazon FSx File Gateway User Guide Using Amazon CloudWatch metrics You can get monitoring data for your FSx File Gateway by using either the AWS Management Console or the CloudWatch API. The console displays a series of graphs based on the raw data from the CloudWatch API. The CloudWatch API can also be used through one of the AWS SDKs or Amazon CloudWatch API tools. Depending on your needs, you might prefer to use either the graphs displayed in the console or retrieved from the API. Regardless of which method you use to work with metrics, you must specify the following information: • The metric dimension to work with. A dimension is a name-value pair that helps you to uniquely identify a metric. The dimensions for Storage Gateway are GatewayId and GatewayName. In the CloudWatch console, you can use the Gateway Metrics view to select gateway-specific dimensions. For more information about dimensions, see Dimensions in the Amazon CloudWatch User Guide. • The metric name, such as ReadBytes. The following table summarizes the types of Storage Gateway metric data that are available to you. Amazon CloudWatch namespace Dimension Description AWS/Stora GatewayId , geGateway GatewayName These dimensions filter for metric data that describes aspects of the gateway. You can identify a FSx File Gateway to work with by specifying both the GatewayId and the GatewayName dimensions. Throughput and latency data of a gateway are based on all the file shares in the gateway. Data is available automatically in 5-minute periods at no charge. Using Amazon CloudWatch metrics API Version 2021-03-31 83 AWS Storage Gateway Amazon FSx File Gateway User Guide Working with gateway and file metrics is similar to working with other service metrics. You can find a discussion of some of the most common metrics tasks in the CloudWatch documentation listed following: • Viewing available metrics • Getting statistics for a metric • Creating CloudWatch alarms Understanding gateway metrics The following table describes metrics that cover FSx File Gateways. Each gateway has a set of metrics associated with it.
|
storagegateway-fsxfile-ug-033
|
storagegateway-fsxfile-ug.pdf
| 33 |
in the gateway. Data is available automatically in 5-minute periods at no charge. Using Amazon CloudWatch metrics API Version 2021-03-31 83 AWS Storage Gateway Amazon FSx File Gateway User Guide Working with gateway and file metrics is similar to working with other service metrics. You can find a discussion of some of the most common metrics tasks in the CloudWatch documentation listed following: • Viewing available metrics • Getting statistics for a metric • Creating CloudWatch alarms Understanding gateway metrics The following table describes metrics that cover FSx File Gateways. Each gateway has a set of metrics associated with it. Some gateway-specific metrics have the same name as certain file- system-specific metrics. These metrics represent the same kinds of measurements, but are scoped to the gateway rather than the file system. Always specify whether you want to work with a gateway or a file system when working with a particular metric. Specifically, when working with gateway metrics, you must specify the Gateway Name for the gateway whose metric data you want to view. For more information, see Using Amazon CloudWatch metrics. Note Some metrics return data points only when new data has been generated during the most recent monitoring period. The following table describes the metrics that you can use to get information about your FSx File Gateways. Metric AvailabilityNotifications Description This metric reports the number of availabil ity-related health notifications that were generated by the gateway in the reporting period. Units: Count Understanding gateway metrics API Version 2021-03-31 84 AWS Storage Gateway Metric CacheDirectorySize CacheFileSize CacheFree Amazon FSx File Gateway User Guide Description This metric tracks the size of folders in the gateway cache. Folder size is determined by the number of files and subfolders in its first level, this does not count recursively into subfolders. Use this metric with the Average statistic to measure the average size of a folder in the gateway cache. Use this metric with the Max statistic to measure the maximum size of a folder in the gateway cache. Units: Count This metric tracks the size of files in the gateway cache. Use this metric with the Average statistic to measure the average size of a file in the gateway cache. Use this metric with the Max statistic to measure the maximum size of a file in the gateway cache. Units: Bytes This metric reports the number of available bytes in the gateway cache. Units: Bytes Understanding gateway metrics API Version 2021-03-31 85 AWS Storage Gateway Metric CacheHitPercent CachePercentDirty CachePercentUsed CacheUsed CloudBytesDownloaded Amazon FSx File Gateway User Guide Description Percent of application read operations from the gateway that are served from cache. The sample is taken at the end of the reporting period. When there are no application read operation s from the gateway, this metric reports 100 percent. Units: Percent The overall percentage of the gateway cache that has not been persisted to AWS. The sample is taken at the end of the reporting period. Units: Percent The overall percent of the gateway cache storage that is used. The sample is taken at the end of the reporting period. Units: Percent This metric reports the number of used bytes in the gateway cache. Units: Bytes The total number of bytes that the gateway downloaded from AWS during the reporting period. Use this metric with the Sum statistic to measure throughput and with the Samples statistic to measure IOPS. Units: Bytes Understanding gateway metrics API Version 2021-03-31 86 AWS Storage Gateway Metric CloudBytesUploaded FilesFailingUpload FileShares Amazon FSx File Gateway User Guide Description The total number of bytes that the gateway uploaded to AWS during the reporting period. Use this metric with the Sum statistic to measure throughput and with the Samples statistic to measure input/output operations per second (IOPS). Units: Bytes This metric tracks the number of files which are failing to upload to AWS. These files will generate health notifications which contain more information on the issue. Use this metric with the Sum statistic to show the number of files which are currently failing to upload to AWS. Units: Count This metric reports the number of file shares on the gateway. Units: Count Understanding gateway metrics API Version 2021-03-31 87 AWS Storage Gateway Metric FileSystem-ERROR HealthNotifications IndexEvictions IndexFetches Amazon FSx File Gateway User Guide Description This metric provides the number of file system associations on this gateways which are in the ERROR state. If this metric reports any file system associati ons are in the ERROR state, then it is likely there is a problem with the gateway which is may cause disruption to your workflow. It is recommended to create an alarm for when this metric reports a non-zero value. Units: Count This metric reports the number of health notifications that were generated by this gateway in the reporting period. Units: Count
|
storagegateway-fsxfile-ug-034
|
storagegateway-fsxfile-ug.pdf
| 34 |
Metric FileSystem-ERROR HealthNotifications IndexEvictions IndexFetches Amazon FSx File Gateway User Guide Description This metric provides the number of file system associations on this gateways which are in the ERROR state. If this metric reports any file system associati ons are in the ERROR state, then it is likely there is a problem with the gateway which is may cause disruption to your workflow. It is recommended to create an alarm for when this metric reports a non-zero value. Units: Count This metric reports the number of health notifications that were generated by this gateway in the reporting period. Units: Count This metric reports the number of files whose metadata was evicted from the cached index of file metadata to make room for new entries. The gateway maintains this metadata index, which is populated from the AWS Cloud on demand. Units: Count This metric reports the number of files for which metadata was fetched. The gateway maintains a cached index of file metadata, which is populated from the AWS Cloud on demand. Units: Count Understanding gateway metrics API Version 2021-03-31 88 AWS Storage Gateway Metric IoWaitPercent MemTotalBytes MemUsedBytes RootDiskFreeBytes SmbV2Sessions Amazon FSx File Gateway User Guide Description This metric reports the percentage of time that the CPU is waiting for a response from the local disk. Units: Percent This metric reports the total amount of memory on the gateway. Units: Bytes This metric reports the amount of used memory on the gateway. Units: Bytes This metric reports the number of available bytes on the root disk of the gateway. If this metric reports less than 20 GB are free, you should increase the size of the root disk. To increase the root disk size, you can increase the size of existing root disk on the VM. When the VM is rebooted, gateway recognizes the increased size on the root disk. Units: Bytes This metric reports the number of SMBv2 sessions that are active on the gateway. This metric is emitted once for each file system associated with the gateway. Use the SUM stat to calculate the total number of active SMBv2 sessions across all file systems. Units: Count Understanding gateway metrics API Version 2021-03-31 89 AWS Storage Gateway Metric SmbV3Sessions Amazon FSx File Gateway User Guide Description This metric reports the number of SMBv3 sessions that are active on the gateway. This metric is emitted once for each file system associated with the gateway. Use the SUM stat to calculate the total number of active SMBv3 sessions across all file systems. Units: Count TotalCacheSize This metric reports the total size of the cache. UserCpuPercent Units: Bytes This metric reports the percentage of time that is spent on gateway processing. Units: Percent Understanding file system metrics You can find information following about the Storage Gateway metrics that cover file systems. Each file system has a set of metrics associated with it. Some file system-specific metrics have the same name as certain gateway-specific metrics. These metrics represent the same kinds of measurements, but are scoped to the file system instead. Always specify whether you want to work with either a gateway or a file system metric before working with a metric. Specifically, when working with file system metrics, you must specify the File system ID that identifies the file system for which you are interested in viewing metrics. For more information, see Using Amazon CloudWatch metrics. Note Some metrics return data points only when new data has been generated during the most recent monitoring period. Understanding file system metrics API Version 2021-03-31 90 AWS Storage Gateway Amazon FSx File Gateway User Guide The following table describes the Storage Gateway metrics that you can use to get information about your file shares. Metric Description CacheHitPercent CachePercentDirty CachePercentUsed 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. When there are no application read operation s from the file share, this metric reports 100 percent. Units: Percent 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. Use this metric with the Sum statistic. Ideally, this metric should remain low. Note Use the CachePercentDirty metric of the gateway to view the overall percentage of the gateway's cache that has not been persisted to AWS. Units: Percent The percent of the data cache used across the entire gateway. The sample is taken at the end of the reporting period. This file share- Understanding file system metrics API Version 2021-03-31 91 AWS Storage Gateway Metric CloudBytesUploaded CloudBytesDownloaded FilesFailingUpload Amazon FSx File Gateway User Guide Description specific metric reports the same value as the corresponding gateway-specific metric. Units: Percent The total number of
|
storagegateway-fsxfile-ug-035
|
storagegateway-fsxfile-ug.pdf
| 35 |
with the Sum statistic. Ideally, this metric should remain low. Note Use the CachePercentDirty metric of the gateway to view the overall percentage of the gateway's cache that has not been persisted to AWS. Units: Percent The percent of the data cache used across the entire gateway. The sample is taken at the end of the reporting period. This file share- Understanding file system metrics API Version 2021-03-31 91 AWS Storage Gateway Metric CloudBytesUploaded CloudBytesDownloaded FilesFailingUpload Amazon FSx File Gateway User Guide Description specific metric reports the same value as the corresponding gateway-specific metric. Units: Percent The total number of bytes that the gateway uploaded to AWS during the reporting period. Use this metric with the Sum statistic to measure throughput and with the Samples statistic to measure IOPS. Units: Bytes The total number of bytes that the gateway downloaded from AWS during the reporting period. Use this metric with the Sum statistic to measure throughput and with the Samples statistic to measure input/output operations per second (IOPS). Units: Bytes This metric tracks the number of files which are failing to upload to AWS. These files will generate health notifications which contain more information on the issue. Use this metric with the Sum statistic to show the number of files which are currently failing to upload to AWS. Units: Count Understanding file system metrics API Version 2021-03-31 92 AWS Storage Gateway Metric ReadBytes WriteBytes Amazon FSx File Gateway User Guide Description The total number of bytes read from your on- premises applications in the reporting period for a file share. Use this metric with the Sum statistic to measure throughput and with the Samples statistic to measure IOPS. Units: Bytes The total number of bytes written to your on- premises applications in the reporting period. Use this metric with the Sum statistic to measure throughput and with the Samples statistic to measure IOPS. Units: Bytes Understanding FSx File Gateway audit logs Amazon FSx File Gateway (FSx File Gateway) audit logs provide you with details about user access to files and folders within a file system association. You can use audit logs to monitor user activities and take action if inappropriate activity patterns are identified. The logs are formatted similar to Windows Server security log events, to support compatibility with existing log processing tools for Windows security events. Operations The following table describes the FSx File Gateway audit log file access operations. Operation name Definition Read Data Write Data Read the contents of a file. Change the contents of a file. Understanding FSx File Gateway audit logs API Version 2021-03-31 93 AWS Storage Gateway Amazon FSx File Gateway User Guide Operation name Definition Create Rename Delete Write Attributes Attributes Create a new file or folder. Rename an existing file or folder. Delete a file or folder. Update file or folder metadata (ACLs, owner, group, permissions). The following table describes FSx File Gateway audit log file access attributes. Attribute Definition securityDescriptor Shows the discretionary access control list (DACL) set on an object, in SDDL format. sourceAddress The IP address of file share client machine. SubjectDomainName The Active Directory (AD) domain that the client’s account belongs to. SubjectUserName The Active Directory user name of the client. source mtime version ObjectType The ID of the Storage Gateway FileSyste mAssociation that is being audited. This time that the object's content was modified, set by the client. The version of the audit log format. Defines whether the object is a file or folder. locationDnsName The FSx File Gateway system DNS name. objectName The full path to the object. Understanding FSx File Gateway audit logs API Version 2021-03-31 94 AWS Storage Gateway Amazon FSx File Gateway User Guide Attribute ctime shareName operation newObjectName gateway status fileSizeInBytes Definition The time that the object’s content or metadata was modified, set by the client. The name of the share that is being accessed. The name of the object access operation. The full path to the new object after it has been renamed. The Storage Gateway ID. The status of the operation. Only success is logged (failures are logged with the exception of failures arising from permissions denied). The size of the file in bytes, set by the client at file creation time. Attributes logged per operation The following table describes the FSx File Gateway audit log attributes logged in each file access operation. Read data Write data Create folder Create file Rename file/ Delete file/ Write attribute Write attribute Write attribute Write attribute fold fold s s s s er er (change (chown) (chmod) (chgrp) securityD escriptor X sourceAdd X X X X X ress ACL) X X X X X Understanding FSx File Gateway audit logs API Version 2021-03-31 95 AWS Storage Gateway Amazon FSx File Gateway User Guide Read data Write data Create folder Create file Rename file/
|
storagegateway-fsxfile-ug-036
|
storagegateway-fsxfile-ug.pdf
| 36 |
creation time. Attributes logged per operation The following table describes the FSx File Gateway audit log attributes logged in each file access operation. Read data Write data Create folder Create file Rename file/ Delete file/ Write attribute Write attribute Write attribute Write attribute fold fold s s s s er er (change (chown) (chmod) (chgrp) securityD escriptor X sourceAdd X X X X X ress ACL) X X X X X Understanding FSx File Gateway audit logs API Version 2021-03-31 95 AWS Storage Gateway Amazon FSx File Gateway User Guide Read data Write data Create folder Create file Rename file/ Delete file/ Write attribute Write attribute Write attribute Write attribute X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X SubjectDo mainName X SubjectUs erName source X mtime version X X objectTyp e X locationD nsName X objectNam e ctime shareNameX operationX newObject Name gateway X X X X fold fold s s s s er er (change (chown) (chmod) (chgrp) ACL) X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X Understanding FSx File Gateway audit logs API Version 2021-03-31 96 AWS Storage Gateway Amazon FSx File Gateway User Guide Read data Write data Create folder Create file Rename file/ Delete file/ Write attribute Write attribute Write attribute Write attribute fold fold s s s s er er (change (chown) (chmod) (chgrp) ACL) X X X X X X status X X X fileSizeI nBytes X X Create a cache report for your S3 File Gateway S3 File Gateway can generate a report of the metadata for files that are currently in the local upload cache for a specific file share. You can apply filters and additional criteria that determine which specific types of cached files appear in the report. You can use this report to help identify and resolve gateway issues. For example, if you have files failing upload from your gateway to Amazon S3, you can generate a report that lists the specific files that are failing to upload, and the reasons for upload failure. The report is a CSV file containing a list of files which match the set of filter parameters you specify. The output file is stored as an Amazon S3 object in a bucket location that you specify when you configure the report. To create a cache report using the AWS Storage Gateway API, see StartCacheReport in the Storage Gateway API Reference. To create a cache report in the Storage Gateway console, use the following procedure. Prerequisites • 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 file share. • There must be fewer than 10 existing cache reports for the file share. • The gateway must be online and connected to AWS. • The gateway root disk must have at least 20GB of free space. Create a cache report API Version 2021-03-31 97 AWS Storage Gateway Amazon FSx File Gateway User Guide To create a cache report using the Storage Gateway console 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/. 2. 3. 4. 5. In the navigation pane on the left side of the page, choose File shares, and then choose the file share for which you want to create a cache report. From the Actions drop-down menu, chooseCreate cache report. For Amazon S3 location, enter the Amazon S3 bucket and prefix of the location where you want to save the completed cache report CSV file object in Amazon S3. To select the bucket and prefix from your existing Amazon S3 storage, choose Browse S3. For IAM role, do one of the following to specify an IAM role that grants your File Gateway permissions to generate and store your cache report: • To specify an existing IAM role, choose a role from the drop-down list. • To manually create a new IAM role, choose Create a role, then create the new role using the IAM console. Note The IAM role you specify must have the following permissions to write objects to the report bucket Amazon S3 location, and to stop multipart uploads to the report bucket: • s3:PutObject • s3:AbortMultipartUpload 6. For Report filter, do one of the following to determine which files will be included in the cache report: • To include all cached files
|
storagegateway-fsxfile-ug-037
|
storagegateway-fsxfile-ug.pdf
| 37 |
and store your cache report: • To specify an existing IAM role, choose a role from the drop-down list. • To manually create a new IAM role, choose Create a role, then create the new role using the IAM console. Note The IAM role you specify must have the following permissions to write objects to the report bucket Amazon S3 location, and to stop multipart uploads to the report bucket: • s3:PutObject • s3:AbortMultipartUpload 6. For Report filter, do one of the following to determine which files will be included in the cache report: • To include all cached files that are currently failing upload to Amazon S3, choose All files failing to upload. • To include only those files that fail upload to Amazon S3 for a specific reason, choose Specific upload failure reasons only. Then, for Failure reasons, select one or more of the following reasons: • Inaccessible storage class — The gateway can't access the Amazon S3 storage class where the object is stored. For more information, see Error: InaccessibleStorageClass. Create a cache report API Version 2021-03-31 98 AWS Storage Gateway Amazon FSx File Gateway User Guide • Invalid object state — The state of the file on the gateway doesn't match its state in Amazon S3. For more information, see Error: InvalidObjectState. • Object missing — The object has been deleted or moved in Amazon S3. For more information, see Error: ObjectMissing. • S3 Access Denied — The Amazon S3 bucket access IAM role doesn't allow the gateway to perform the upload operation. For more information, see Error: S3AccessDenied. 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. 7. For Use a VPC endpoint to connect to S3?, do one of the following to specify how your gateway will connect to the Amazon S3 bucket: • To connect directly without using Amazon VPC, choose Connect directly to the bucket. • To browse a list of existing Amazon VPC endpoints, choose Choose a VPC endpoint, and then specify an endpoint from the VPC endpoints drop-down list that appears. • To specify an existing Amazon VPC endpoint by its DNS name, choose Input a VPC endpoint DNS name, and then enter the DNS name in the VPC endpoint DNS name field that appears. 8. (Optional) Under Tags - optional, choose Add new tag, then enter a Key and Value for your cache report. A tag is a case-sensitive key-value pair that helps you categorize your Storage Gateway resources. Adding tags can make filtering and searching for your cache report easier. You can repeat this step to add up to 50 tags. 9. Choose Create report when finished. Storage Gateway begins generating the report. You can check progress and view status on the Cache reports tab of the details page for the file share. Create a cache report API Version 2021-03-31 99 AWS Storage Gateway Amazon FSx File Gateway User Guide View and manage cache reports for your S3 File Gateway Cache reports list files that are currently in the local cache for a specific file share, according to filters and criteria that you specify. You can view a list of existing cache reports for a specific file share, check report progress and status, and delete reports you no longer need using the AWS Storage Gateway API or the Storage Gateway console. To manage cache reports using the API, see the following sections in the Storage Gateway API Reference: • ListCacheReports • DescribeCacheReport • CancelCacheReport • DeleteCacheReport To manage cache reports in the Storage Gateway console, use the following procedure. To manage cache reports using the Storage Gateway console 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/. 2. In the navigation pane on the left side of the page, choose File shares, and then choose the file share for which you want to manage cache reports. 3. On the Details page for the file share, choose the Cache reports tab. This tab lists the existing cache reports for the file share, and provides information about status, progress, and the object path where the report file is stored in Amazon S3. 4. Do one of the following: • To view additional details for a specific report, such as the report ARN and associated tags, choose a report from the Report ID column. • To specify multiple reports to manage simultaneously, select the reports using the checkbox column. 5. To manage one or more reports, choose one of the following from the Actions drop-down menu: Manage cache reports API Version 2021-03-31 100 AWS Storage Gateway Amazon FSx File Gateway User Guide • Delete cache report — This deletes the record
|
storagegateway-fsxfile-ug-038
|
storagegateway-fsxfile-ug.pdf
| 38 |
the object path where the report file is stored in Amazon S3. 4. Do one of the following: • To view additional details for a specific report, such as the report ARN and associated tags, choose a report from the Report ID column. • To specify multiple reports to manage simultaneously, select the reports using the checkbox column. 5. To manage one or more reports, choose one of the following from the Actions drop-down menu: Manage cache reports API Version 2021-03-31 100 AWS Storage Gateway Amazon FSx File Gateway User Guide • Delete cache report — This deletes the record of the cache report from the Storage Gateway database. Delete records for obsolete cache reports to make room for new reports. Each file share can have up to 10 existing cache reports at any time. Note Deleting the cache report record using this procedure does not delete the report file object from Amazon S3. • Cancel report — This cancels a report that is currently in-progress. Cancel an in-progress report if you made a mistake during report configuration, or if the report takes an unusually long time to complete. Confirm the cancellation when prompted. Note Completion times can vary significantly depending on the number of files in the cache. Typically, most reports complete within 5 minutes. The Storage Gateway console displays a message indicating the result of the cancellation or delete action. Understanding the information provided in S3 File Gateway cache reports Cache reports list files that are currently in the local cache for a specific file share, according to filters and criteria that you specify. Each cache report includes the following information: • Bucket — The Amazon S3 bucket or Access Point that is associated with the file share. • S3ObjectKey — The Amazon S3 object that stores the data and metadata for this file. This object has the latest data that has been uploaded to S3, but it could be missing data which is failing to upload to S3. • FilePath — The file path for the file entry in the gateway cache. This is where you can find the file when mounting and browsing the file share. Understanding cache reports API Version 2021-03-31 101 AWS Storage Gateway Amazon FSx File Gateway User Guide • RenamedTo — The new path of a renamed file. When you rename a file on your file share, the gateway needs to track both the old and new locations of the file. This field shows where the file was moved to, helping you track file rename operations - even if a file has been renamed multiple times. This information is particularly useful when you need to understand how files in your file share correspond to objects in your Amazon S3 bucket. The following example shows the cache report entries for a complex scenario involving a file being overwritten directly in Amazon S3, while also being renamed through File Gateway. In this scenario, the gateway uploads file A.txt to S3, and then evicts the file contents to make space in the local cache. The associated S3 object is then overwritten directly in S3—not through an action taken by the gateway—which results in an InvalidObjectState due to the mismatch between the S3 object and what the gateway expects. At the same time, file A.txt was renamed to B.txt through the gateway. Bucket S3ObjectK ey FilePathRenamedToType IsDirtyIsDataDir ty UploadErr SizeInByt IsDeletedIsFailing es or ToUpload IsWholeFi leInCache A.txt samplebuc ket- / B.txt iad A.txt samplebuc ket- / A.txt / B.txt iad FILE TRUE FALSE FALSE TRUE 4 InvalidOb jectState FALSE FILE TRUE FALSE TRUE FALSE 4 FALSE • Type — Denotes whether the entry is for a FILE or DIRECTORY. • IsDirty — Reports TRUE if there is any type of change to the file which have not been uploaded to Amazon S3. This includes changes to metadata such as file name and read/write permissions, even if the file's data has not changed. • IsDataDirty — Reports TRUE if there are changes to the file's data which have not been uploaded to Amazon S3. • IsDeleted — Reports TRUE if the file was deleted on the gateway. If a file is marked as deleted, then it will always be marked as dirty. • IsFailingToUpload — Reports TRUE if there is a problem uploading the file to Amazon S3. This status resets every 24 hours to allow the gateway to retry the upload and check whether the issue has been resolved. The gateway rejects any new write operations for a file that is failing to upload. If the gateway does not have the entire file in cache, then it also rejects read operations. Understanding cache reports API Version 2021-03-31 102 AWS Storage Gateway Amazon FSx File Gateway User Guide • UploadError — The error that is preventing the
|
storagegateway-fsxfile-ug-039
|
storagegateway-fsxfile-ug.pdf
| 39 |
always be marked as dirty. • IsFailingToUpload — Reports TRUE if there is a problem uploading the file to Amazon S3. This status resets every 24 hours to allow the gateway to retry the upload and check whether the issue has been resolved. The gateway rejects any new write operations for a file that is failing to upload. If the gateway does not have the entire file in cache, then it also rejects read operations. Understanding cache reports API Version 2021-03-31 102 AWS Storage Gateway Amazon FSx File Gateway User Guide • UploadError — The error that is preventing the file from uploading to Amazon S3. For more information and recommended steps to resolve these errors, see Troubleshooting: File Gateway issues. • SizeInBytes — The total size of the file. • IsWholeFileInCache — Reports TRUE if all of the file's data is currently stored in the gateway cache. If this is TRUE for a file failing to upload to Amazon S3, then the gateway will allow the file to be read. Understanding cache reports API Version 2021-03-31 103 AWS Storage Gateway Amazon FSx File Gateway User Guide Maintaining your gateway Maintaining your Amazon FSx File Gateway involves doing general maintenance to optimize your gateway's performance. These tasks are common to all gateway types. This section contains the following topics, which describe concepts and procedures related to maintaining your Amazon FSx File Gateway: Topics • Managing gateway updates - Learn how to turn maintenance updates on or off, and modify the maintenance window schedule for your File Gateway. • Performing maintenance tasks using the local console - Learn how to perform maintenance tasks using the gateway local console. • Shutting down your gateway VM - Learn about what to do if you need to shutdown or reboot your gateway virtual machine for maintenance, such as when applying a patch to your hypervisor. • Replacing your existing FSx File Gateway with a new instance - Learn how to replace your FSx File Gateway with a new instance when you want to improve performance or to respond to a notification to migrate the gateway. • Deleting your gateway and removing associated resources - Learn how to delete your gateway using the AWS Storage Gateway console and clean up associated resources to avoid being charged for their continued use. Managing gateway updates Storage Gateway consists of a managed cloud services component and a gateway appliance component that you deploy either on-premises, or on an Amazon EC2 instance in the AWS cloud. Both components receive regular updates. The topics in this section describe the cadence of these updates, how they are applied, and how to configure update-related settings on the gateways in your deployment. Important You should treat the Storage Gateway appliance as a managed virtual machine, and should not attempt to access or modify its installation in any way. Attempting to install or Managing gateway updates API Version 2021-03-31 104 AWS Storage Gateway Amazon FSx File Gateway User Guide update any software packages using methods other than the normal AWS gateway update mechanism (for example, SSM or hypervisor tools) may cause the gateway to malfunction. Update frequency and expected behavior AWS updates the cloud services component as needed without causing disruption to deployed gateways. Your deployed gateway appliances receive the following types of updates: • Maintenance - Regular updates that can include operating system and software upgrades, fixes to address stability, performance, and security, and access to new features. • Urgent - Critical updates that include required fixes for issues that immediately impact the security, performance, or durability of your gateway. Urgent updates can be released at any time, outside the normal cadence of the monthly maintenance and feature updates. All updates are cumulative, and upgrade gateways to the current version when applied. For information about the specific changes included in each update, see . All gateway appliance updates may cause a brief disruption of service. The gateway's VM host doesn't need to reboot during updates, but the gateway will be unavailable for a short period while the gateway appliance updates and restarts. When you deploy and activate your gateway, a default maintenance window schedule is set. You can modify the maintenance window schedule at any time. You can also turn off maintenance updates, but we recommend leaving them turned on. Note Urgent updates will be applied according to the maintenance window schedule, even if regular maintenance updates are turned off. Before any update is applied to your gateway, AWS notifies you with a message on the Storage Gateway console and your AWS Health Dashboard. For more information, see AWS Health Dashboard. To modify the email address where software update notifications are sent, see Update the alternate contacts for your AWS account in the AWS Account Management Reference Guide. Update frequency and expected behavior
|
storagegateway-fsxfile-ug-040
|
storagegateway-fsxfile-ug.pdf
| 40 |
at any time. You can also turn off maintenance updates, but we recommend leaving them turned on. Note Urgent updates will be applied according to the maintenance window schedule, even if regular maintenance updates are turned off. Before any update is applied to your gateway, AWS notifies you with a message on the Storage Gateway console and your AWS Health Dashboard. For more information, see AWS Health Dashboard. To modify the email address where software update notifications are sent, see Update the alternate contacts for your AWS account in the AWS Account Management Reference Guide. Update frequency and expected behavior API Version 2021-03-31 105 AWS Storage Gateway Amazon FSx File Gateway User Guide When updates are available, the gateway Details tab displays a maintenance message. You can also see the date and time that the last successful update was applied on the Details tab. Turn maintenance updates on or off When maintenance updates are turned on, your gateway automatically applies these updates according to the configured maintenance window schedule. For more information, see Modify the gateway maintenance window schedule. If maintenance updates are turned off, the gateway will not apply these updates automatically, but you can always apply them manually using the Storage Gateway console, API, or CLI. Urgent updates will sometimes be applied during your configured maintenance window, regardless of this setting. Note The following procedure describes how to turn gateway updates on or off using the Storage Gateway console. To change this setting programmatically using the API, see UpdateMaintenanceStartTime in the Storage Gateway API Reference. To turn maintenance updates on or off using the Storage Gateway console: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the navigation pane, choose Gateways, and then choose the gateway for which you want to configure maintenance updates. 3. Choose Actions, and then choose Edit maintenance settings. 4. For Maintenance updates, select On or Off. 5. Choose Save changes when finished. You can verify the updated setting on the Details tab for the selected gateway in the Storage Gateway console. Turn maintenance updates on or off API Version 2021-03-31 106 AWS Storage Gateway Amazon FSx File Gateway User Guide Modify the gateway maintenance window schedule If maintenance updates are turned on, your gateway automatically applies these updates according the maintenance window schedule. Urgent updates will sometimes be applied during your configured maintenance window, regardless of the maintenance updates setting. Note The following procedure describes how to modify the maintenance window schedule using the Storage Gateway console. To change this setting programmatically using the API, see UpdateMaintenanceStartTime in the Storage Gateway API Reference. To modify the maintenance window schedule using the Storage Gateway console: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the navigation pane, choose Gateways, and then choose the gateway for which you want to configure maintenance updates. 3. Choose Actions, and then choose Edit maintenance settings. 4. Under Maintenance window start time, do the following: a. b. For Schedule, choose Weekly or Monthly to set the maintenance window cadence. If you choose Weekly, modify the values for Day of the week and Time to set the specific point during each week when the maintenance window will begin. If you choose Monthly, modify the values for Day of the month and Time to set the specific point during each month when the maintenance window will begin. Note The maximum value that can be set for day of the month is 28. It is not possible to set the maintenance schedule to start on days 29 through 31. If you receive an error while configuring this setting, it might mean that your gateway software is out of date. Considering updating your gateway manually first, and then attempt to configure the maintenance window schedule again. 5. Choose Save changes when finished. Modify the gateway maintenance window schedule API Version 2021-03-31 107 AWS Storage Gateway Amazon FSx File Gateway User Guide You can verify the updated settings on the Details tab for the selected gateway in the Storage Gateway console. Apply an update manually If a software update is available for your gateway, you can apply it manually by following the procedure below. This manual update process ignores the maintenance window schedule and applies the update immediately, even if maintenance updates are turned off. Note The following procedure describes how to manually apply an update using the Storage Gateway console. To perform this action programmatically using the API, see UpdateGatewaySoftwareNow in the Storage Gateway API Reference. To apply a gateway software update manually using the Storage Gateway console: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the navigation pane, choose Gateways, and then choose the gateway you want to update. If an update is available, the console displays a blue notification banner on the gateway Details
|
storagegateway-fsxfile-ug-041
|
storagegateway-fsxfile-ug.pdf
| 41 |
maintenance window schedule and applies the update immediately, even if maintenance updates are turned off. Note The following procedure describes how to manually apply an update using the Storage Gateway console. To perform this action programmatically using the API, see UpdateGatewaySoftwareNow in the Storage Gateway API Reference. To apply a gateway software update manually using the Storage Gateway console: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the navigation pane, choose Gateways, and then choose the gateway you want to update. If an update is available, the console displays a blue notification banner on the gateway Details tab, which includes an option to apply the update. 3. Choose Apply update now to immediately update the gateway. Note This operation causes a temporary disruption to gateway functionality while the update installs. During this time, the gateway status appears OFFLINE in the Storage Gateway console. After the update finishes installing, the gateway resumes normal operation and its status changes to RUNNING. You can verify that the gateway software was updated to the latest version by checking the Details tab for the selected gateway in the Storage Gateway console. Apply an update manually API Version 2021-03-31 108 AWS Storage Gateway Amazon FSx File Gateway User Guide Performing maintenance tasks using the local console This section contains the following topics, which provide information about how to perform maintenance tasks using the gateway appliance local console. You can perform these tasks by accessing the local console through the on-premises virtual machine or Amazon EC2 instance that hosts your gateway appliance. Most of the tasks are common across the different host platforms, but there are also some differences. Topics • Accessing the gateway local console - Learn how to log into the local console for an on-premises gateway hosted on a Linux Kernel-based Virtual Machine (KVM), VMware ESXi, or Microsoft Hyper-V Manager platform. • Performing tasks on the virtual machine local console - Learn how to use the local console to perform basic setup and advanced configuration tasks for an on-premises gateway, such as configuring an HTTP proxy, viewing system resource status, or running terminal commands. • Performing tasks on the Amazon EC2 gateway local console - Learn how to log into the local console to perform basic setup and advanced configuration tasks for an Amazon EC2 gateway, such as configuring an HTTP proxy, viewing system resource status, or running terminal commands. Accessing the gateway local console How you access your VM's local console depends on the type of the Hypervisor you deployed your gateway VM on. In this section, you can find information on how to access the VM local console using Linux Kernel-based Virtual Machine (KVM), VMware ESXi, and Microsoft Hyper-V Manager. Topics • Accessing the Gateway Local Console with Linux KVM • Accessing the Gateway Local Console with VMware ESXi • Access the Gateway Local Console with Microsoft Hyper-V Performing maintenance tasks using the local console API Version 2021-03-31 109 AWS Storage Gateway Amazon FSx File Gateway User Guide Accessing the Gateway Local Console with Linux KVM There are different ways to configure virtual machines running on KVM, depending on the Linux distribution being used. Instructions for accessing KVM configuration options from the command line follow. Instructions might differ depending on your KVM implementation. To access your gateway's local console with KVM 1. Use the following command to list the VMs that are currently available in KVM. # virsh list The command returns a list of VMs with Id, Name, and State information for each. Note the Id of the VM for which you want to launch the gateway local console. 2. Use the following command to access the local console. # virsh console Id Replace Id with the Id of the VM you noted in the previous step. The AWS Appliance gateway local console prompts you to login to change your network configuration and other settings. 3. Enter your username and password to log into the gateway local console. For more information, see Logging in to the File Gateway local console . After you log in, the AWS Appliance Activation - Configuration menu appears. You can select from the menu options to perform gateway configuration tasks. For more information, see Performing tasks on the virtual machine local console . Accessing the Gateway Local Console with VMware ESXi To access your gateway's local console with VMware ESXi 1. In the VMware vSphere client, select your gateway VM. 2. Make sure that the gateway VM is turned on. Accessing the gateway local console API Version 2021-03-31 110 AWS Storage Gateway Amazon FSx File Gateway User Guide Note If your gateway VM is turned on, a green arrow icon appears with the VM icon in the VM browser panel on the left side of the application window. If your gateway VM is
|
storagegateway-fsxfile-ug-042
|
storagegateway-fsxfile-ug.pdf
| 42 |
see Performing tasks on the virtual machine local console . Accessing the Gateway Local Console with VMware ESXi To access your gateway's local console with VMware ESXi 1. In the VMware vSphere client, select your gateway VM. 2. Make sure that the gateway VM is turned on. Accessing the gateway local console API Version 2021-03-31 110 AWS Storage Gateway Amazon FSx File Gateway User Guide Note If your gateway VM is turned on, a green arrow icon appears with the VM icon in the VM browser panel on the left side of the application window. If your gateway VM is not turned on, you can turn it on by choosing the green Power On icon on the Toolbar at the top of the application window. 3. Choose the Console tab in the main information panel on the right side of the application window. After a few moments, the AWS Appliance gateway local console prompts you to login to change your network configuration and other settings. Note To release the cursor from the console window, press Ctrl+Alt. 4. Enter your username and password to log into the gateway local console. For more information, see Logging in to the File Gateway local console . After you log in, the AWS Appliance Activation - Configuration menu appears. You can select from the menu options to perform gateway configuration tasks. For more information, see Performing tasks on the virtual machine local console . Access the Gateway Local Console with Microsoft Hyper-V To access your gateway's local console (Microsoft Hyper-V) 1. Select your gateway appliance VM from the Virtual Machines panel on the left side of the Microsoft Hyper-V Manager application window. 2. Make sure that the gateway is turned on. Note If your gateway VM is turned on, Running is displayed in the State column for the VM in the Virtual Machines panel on the left side of the application window. If your Accessing the gateway local console API Version 2021-03-31 111 AWS Storage Gateway Amazon FSx File Gateway User Guide gateway VM is not turned on, you can turn it on by choosing Start in the Actions panel on the right side of the application window. 3. Choose Connect from the Actions panel. The Virtual Machine Connection window appears. If an authentication window appears, type the sign-in credentials provided to you by the hypervisor administrator. After a few moments, the AWS Appliance gateway local console prompts you to login to change your network configuration and other settings. 4. Enter your username and password to log into the gateway local console. For more information, see Logging in to the File Gateway local console . After you log in, the AWS Appliance Activation - Configuration menu appears. You can select from the menu options to perform gateway configuration tasks. For more information, see Performing tasks on the virtual machine local console . Performing tasks on the virtual machine local console For a File Gateway deployed on-premises, you can perform the following maintenance tasks using the VM host's local console. These tasks are common to VMware, Microsoft Hyper-V, and Linux Kernel-based Virtual Machine (KVM) hypervisors. Topics • Logging in to the File Gateway local console - Learn how to login to the local console where you can configure gateway network settings and change the default password. • Configuring an HTTP proxy - Learn how to configure Storage Gateway to route all AWS endpoint traffic through a proxy server. • Configuring your gateway network settings - Learn how to configure your gateway to use DHCP or a static IP address. • Testing your gateway's network connectivity - Learn how to use the gateway local console to test network connectivity. • Viewing your gateway system resource status - Learn how to check your gateway's virtual CPU cores, root volume size, and RAM. Performing tasks on the virtual machine local console API Version 2021-03-31 112 AWS Storage Gateway Amazon FSx File Gateway User Guide • Configuring a Network Time Protocol (NTP) server for your gateway - Learn how to view and edit Network Time Protocol (NTP) server configurations and synchronize the time on your gateway with your hypervisor host. • Running Storage Gateway commands on the local console - Learn how to run local console commands to perform tasks such as saving routing tables, connecting to Support, and more. Logging in to the File Gateway local console When the VM is ready for you to log in, the login screen is displayed. If this is your first time logging in to the local console, you use the default sign-in credentials to log in. These default login credentials give you access to menus where you can configure gateway network settings and change the password from the local console. AWS Storage Gateway allows you to set your own password from the
|
storagegateway-fsxfile-ug-043
|
storagegateway-fsxfile-ug.pdf
| 43 |
Learn how to run local console commands to perform tasks such as saving routing tables, connecting to Support, and more. Logging in to the File Gateway local console When the VM is ready for you to log in, the login screen is displayed. If this is your first time logging in to the local console, you use the default sign-in credentials to log in. These default login credentials give you access to menus where you can configure gateway network settings and change the password from the local console. AWS Storage Gateway allows you to set your own password from the Storage Gateway console instead of changing the password from the local console. You don't need to know the default password to set a new password. For more information, see Setting the local console password from the Storage Gateway console. To log in to the gateway's local console • If this is your first time logging in to the local console, log in to the VM with the default credentials. The default user name is admin and the password is password. Otherwise, use your credentials to log in. Note We recommend changing the default password by entering the corresponding numeral for Gateway Console from the AWS Appliance Activation - Configuration main menu, then running the passwd command. For information about how to run the command, see Running Storage Gateway commands on the local console. You can also set the password from the Storage Gateway console. For more information, see Setting the local console password from the Storage Gateway console. Setting the local console password from the Storage Gateway console When you log in to the local console for the first time, you log in to the VM with the default credentials. For all types of gateways, you use default credentials. The user name is admin and the password is password. Performing tasks on the virtual machine local console API Version 2021-03-31 113 AWS Storage Gateway Amazon FSx File Gateway User Guide We recommend that you always set a new password immediately after you create your new gateway. You can set this password from the AWS Storage Gateway console rather than the local console if you want. You don't need to know the default password to set a new password. To set the local console password on the Storage Gateway console 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the navigation pane, choose Gateways, and then choose the gateway for which you want 3. 4. to set a new password. For Actions, choose Set Local Console Password. In the Set Local Console Password dialog box, enter a new password, confirm the password, and then choose Save. Your new password replaces the default password. Storage Gateway doesn't save the password but rather safely transmits it to the VM. Note The password can consist of any character on the keyboard and can be 1–512 characters long. Configuring an HTTP proxy File Gateways support configuration of an HTTP proxy. Note The only proxy configuration that File Gateways support is HTTP. If your gateway must use a proxy server to communicate to the internet, then you need to configure the HTTP proxy settings for your gateway. You do this by specifying an IP address and port number for the host running your proxy. After you do so, Storage Gateway routes all AWS endpoint traffic through your proxy server. Communications between the gateway and endpoints is encrypted, even when using the HTTP proxy. For information about network requirements for your gateway, see Network and firewall requirements. Performing tasks on the virtual machine local console API Version 2021-03-31 114 AWS Storage Gateway Amazon FSx File Gateway User Guide To configure an HTTP proxy for a File Gateway 1. Log in to your gateway's local console: • For more information on logging in to the VMware ESXi local console, see Accessing the Gateway Local Console with VMware ESXi. • For more information on logging in to the Microsoft Hyper-V local console, see Access the Gateway Local Console with Microsoft Hyper-V. • For more information on logging in to the local console for the Linux Kernel-Based Virtual Machine (KVM), see Accessing the Gateway Local Console with Linux KVM. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select Configure HTTP Proxy. From the AWS Appliance Activation HTTP Proxy Configuration menu, enter the corresponding numeral for the task you want to perform: 2. 3. • Configure HTTP proxy - You will need to supply a host name and port to complete configuration. • View current HTTP proxy configuration - If an HTTP proxy is not configured, the message HTTP Proxy not configured is displayed. If an HTTP proxy is configured, the host name and port of the proxy are displayed. • Remove an
|
storagegateway-fsxfile-ug-044
|
storagegateway-fsxfile-ug.pdf
| 44 |
KVM. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select Configure HTTP Proxy. From the AWS Appliance Activation HTTP Proxy Configuration menu, enter the corresponding numeral for the task you want to perform: 2. 3. • Configure HTTP proxy - You will need to supply a host name and port to complete configuration. • View current HTTP proxy configuration - If an HTTP proxy is not configured, the message HTTP Proxy not configured is displayed. If an HTTP proxy is configured, the host name and port of the proxy are displayed. • Remove an HTTP proxy configuration - The message HTTP Proxy Configuration Removed is displayed. 4. Restart your VM to apply your HTTP configuration settings. Configuring your gateway network settings The default network configuration for the gateway is Dynamic Host Configuration Protocol (DHCP). With DHCP, your gateway is automatically assigned an IP address. In some cases, you might need to manually assign your gateway's IP as a static IP address, as described following. To configure your gateway to use static IP addresses 1. Log in to your gateway's local console: • For more information on logging in to the VMware ESXi local console, see Accessing the Gateway Local Console with VMware ESXi. Performing tasks on the virtual machine local console API Version 2021-03-31 115 AWS Storage Gateway Amazon FSx File Gateway User Guide • For more information on logging in to the Microsoft Hyper-V local console, see Access the Gateway Local Console with Microsoft Hyper-V. • For more information on logging in to the KVM local console, see Accessing the Gateway Local Console with Linux KVM. 2. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select Network Configuration. 3. From the Network Configuration menu, perform one of the following tasks: To Perform This Task Do This Get information about your network adapter Enter the corresponding numeral to select Describe Adapter. A list of adapter names appears, and you are prompted to enter an adapter name—for example, eth0. If the adapter you specify is in use, the following information about the adapter is displayed: Media access control (MAC) address IP address Netmask • • • • Gateway IP address • DHCP enabled status You use the adapter names listed here when you configure a static IP address or when you set your gateway's default adapter. Configure DHCP routing Performing tasks on the virtual machine local console API Version 2021-03-31 116 AWS Storage Gateway Amazon FSx File Gateway User Guide To Perform This Task Do This Enter the corresponding numeral to select Configure DHCP. You are prompted to configure the network interface to use DHCP. Performing tasks on the virtual machine local console API Version 2021-03-31 117 AWS Storage Gateway Amazon FSx File Gateway User Guide To Perform This Task Do This Configure a static IP address for your gateway Enter the corresponding numeral to select Configure Static IP. You are prompted to enter the following information to configure a static IP: • • • • • • Network adapter name IP address Netmask Default gateway address Primary Domain Name Service (DNS) address Secondary DNS address Important If your gateway has already been activated, you must shut it down and restart it from the Storage Gateway console for the settings to take effect. For more information, see Shutting down your gateway VM. If your gateway uses more than one network interface, you must set all active interfaces to use DHCP or static IP addresses. Performing tasks on the virtual machine local console API Version 2021-03-31 118 AWS Storage Gateway Amazon FSx File Gateway User Guide To Perform This Task Do This Configure a hostname for your gateway For example, suppose that your gateway VM uses two interfaces configured as DHCP. If you later set one interface to a static IP, the other interface is deactivated. To activate the interface in this case, you must set it to a static IP. If both interfaces are initially set to use static IP addresses and you then set the gateway to use DHCP, both interfaces use DHCP. Enter the corresponding numeral to select Configure Hostname. You are prompted to choose whether the gateway will use a static hostname that you specify, or aquire one automatically through DCHP or rDNS. If you select Static, you are prompted to provide a static hostname, such as testgateway.example.com . Enter y to apply the configuration. Note If you configure a static hostname for your gateway, ensure that the provided hostname is in the domain that gateway is joined to. You must also create an A record in your DNS system that points the gateway's IP address to its static hostname. Performing tasks on the virtual machine local console API Version 2021-03-31 119 AWS Storage Gateway Amazon
|
storagegateway-fsxfile-ug-045
|
storagegateway-fsxfile-ug.pdf
| 45 |
gateway will use a static hostname that you specify, or aquire one automatically through DCHP or rDNS. If you select Static, you are prompted to provide a static hostname, such as testgateway.example.com . Enter y to apply the configuration. Note If you configure a static hostname for your gateway, ensure that the provided hostname is in the domain that gateway is joined to. You must also create an A record in your DNS system that points the gateway's IP address to its static hostname. Performing tasks on the virtual machine local console API Version 2021-03-31 119 AWS Storage Gateway Amazon FSx File Gateway User Guide To Perform This Task Do This View your gateway's hostname configura tion Reset all your gateway's network configuration to DHCP Set your gateway's default route adapter Enter the corresponding numeral to select View Hostname Configuration. Your gateway's hostname, aquisition mode, domain, and Active Directory realm are displayed. Enter the corresponding numeral to select Reset all to DHCP. All network interfaces are set to use DHCP. Important If your gateway has already been activated, you must shut down and restart your gateway from the Storage Gateway console for the settings to take effect. For more information, see Shutting down your gateway VM. Enter the corresponding numeral to select Set Default Adapter. The available adapters for your gateway are shown, and you are prompted to choose one of the adapters—for example, eth0. Performing tasks on the virtual machine local console API Version 2021-03-31 120 AWS Storage Gateway Amazon FSx File Gateway User Guide To Perform This Task Do This Edit your gateway's DNS configuration View your gateway's DNS configuration View routing tables Enter the corresponding numeral to select Edit DNS Configuration. The available adapters of the primary and secondary DNS servers are displayed. You are prompted to provide the new IP address. Enter the corresponding numeral to select View DNS Configuration. The available adapters of the primary and secondary DNS servers are displayed. Note For some versions of the VMware hypervisor, you can edit the adapter configuration in this menu. Enter the corresponding numeral to select View Routes. The default route of your gateway is displayed. Testing your gateway's network connectivity You can use your gateway's local console to test your network connectivity. This test can be useful when you are troubleshooting network issues with your gateway. To test your gateway's network connectivity 1. Log in to your gateway's local console: Performing tasks on the virtual machine local console API Version 2021-03-31 121 AWS Storage Gateway Amazon FSx File Gateway User Guide • For more information on logging in to the VMware ESXi local console, see Accessing the Gateway Local Console with VMware ESXi. • For more information on logging in to the Microsoft Hyper-V local console, see Access the Gateway Local Console with Microsoft Hyper-V. • For more information on logging in to the KVM local console, see Accessing the Gateway Local Console with Linux KVM. 2. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select Test Network Connectivity. If your gateway has already been activated, the connectivity test begins immediately. For gateways that have not yet been activated, you must specify the endpoint type and AWS Region as described in the following steps. 3. If your gateway is not yet activated, enter the corresponding numeral to select the endpoint type for your gateway. 4. If you selected the public endpoint type, enter the corresponding numeral to select the AWS Region that you want to test. For supported AWS Regions and a list of AWS service endpoints you can use with Storage Gateway, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. As the test progresses, each endpoint displays either [PASSED] or [FAILED], indicating the status of the connection as follows: Message [PASSED] [FAILED] Description Storage Gateway has network connectivity. Storage Gateway does not have network connectivity. Viewing your gateway system resource status When your gateway starts, it checks its virtual CPU cores, root volume size, and RAM. It then determines whether these system resources are sufficient for your gateway to function properly. You can view the results of this check on the gateway's local console. Performing tasks on the virtual machine local console API Version 2021-03-31 122 AWS Storage Gateway Amazon FSx File Gateway User Guide To view the status of a system resource check 1. Log in to your gateway's local console: • For more information on logging in to the VMware ESXi console, see Accessing the Gateway Local Console with VMware ESXi. • For more information on logging in to the Microsoft Hyper-V local console, see Access the Gateway Local Console with Microsoft Hyper-V. • For more information on logging in to the KVM local console, see Accessing the Gateway Local Console with Linux
|
storagegateway-fsxfile-ug-046
|
storagegateway-fsxfile-ug.pdf
| 46 |
tasks on the virtual machine local console API Version 2021-03-31 122 AWS Storage Gateway Amazon FSx File Gateway User Guide To view the status of a system resource check 1. Log in to your gateway's local console: • For more information on logging in to the VMware ESXi console, see Accessing the Gateway Local Console with VMware ESXi. • For more information on logging in to the Microsoft Hyper-V local console, see Access the Gateway Local Console with Microsoft Hyper-V. • For more information on logging in to the KVM local console, see Accessing the Gateway Local Console with Linux KVM. 2. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select View System Resource Check. Each resource displays [OK], [WARNING], or [FAIL], indicating the status of the resource as follows: Message [OK] [WARNING] [FAIL] Description The resource has passed the system resource check. The resource doesn't meet the recommended requirements, but your gateway can continue to function. Storage Gateway displays a message that describes the results of the resource check. The resource doesn't meet the minimum requirements. Your gateway might not function properly. Storage Gateway displays a message that describes the results of the resource check. The console also displays the number of errors and warnings next to the resource check menu option. Performing tasks on the virtual machine local console API Version 2021-03-31 123 AWS Storage Gateway Amazon FSx File Gateway User Guide Configuring a Network Time Protocol (NTP) server for your gateway You can view and edit Network Time Protocol (NTP) server configurations and synchronize the VM time on your gateway with your hypervisor host. To manage system time 1. Log in to your gateway's local console: • For more information on logging in to the VMware ESXi local console, see Accessing the Gateway Local Console with VMware ESXi. • For more information on logging in to the Microsoft Hyper-V local console, see Access the Gateway Local Console with Microsoft Hyper-V. • For more information on logging in to the KVM local console, see Accessing the Gateway Local Console with Linux KVM. 2. 3. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select System Time Management. From the System Time Management menu, enter the corresponding numeral to perform one of the following tasks. To Perform This Task Do This View and synchronize your VM time with NTP server time. Enter the corresponding numeral to select View and Synchronize System Time. The current time of your VM is displayed . Your File Gateway determines the time difference from your gateway VM, and your NTP server time prompts you to synchronize the VM time with NTP time. After your gateway is deployed and running, in some scenarios the gateway VM's time can drift. For example, suppose that there is a prolonged network outage and your hypervisor host and gateway don't get time updates. In this case, the gateway VM's time Performing tasks on the virtual machine local console API Version 2021-03-31 124 AWS Storage Gateway Amazon FSx File Gateway User Guide To Perform This Task Do This is different from the true time. When there is a time drift, a discrepancy occurs between the stated times when operations such as snapshots occur and the actual times that the operations occur. For a gateway deployed on VMware ESXi, setting the hypervisor host time and synchronizing the VM time to the host is sufficient to avoid time drift. For more inf ormation, see Synchronize VM time with VMware host time. For a gateway deployed on Microsoft Hyper-V, you should periodically check your VM's time. For more information, see Synchronize VM time with Hyper-V or Linux KVM host time. For a gateway deployed on KVM, you can check and synchronize the VM time using virsh command line interface for KVM. Enter the corresponding numeral to select Edit NTP Configuration. You are prompted to provide a preferred and a secondary NTP server. Enter the corresponding numeral to select View NTP Configuration. Your NTP server configuration is displayed. Edit your NTP server configuration View your NTP server configuration Performing tasks on the virtual machine local console API Version 2021-03-31 125 AWS Storage Gateway Amazon FSx File Gateway User Guide Running Storage Gateway commands on the local console The VM local console in Storage Gateway helps provide a secure environment for configuring and diagnosing issues with your gateway. Using the local console commands, you can perform maintenance tasks such as saving routing tables, connecting to Support, and so on. To run a configuration or diagnostic command 1. Log in to your gateway's local console: • For more information on logging in to the VMware ESXi local console, see Accessing the Gateway Local Console with VMware ESXi. • For more information on logging in to
|
storagegateway-fsxfile-ug-047
|
storagegateway-fsxfile-ug.pdf
| 47 |
Amazon FSx File Gateway User Guide Running Storage Gateway commands on the local console The VM local console in Storage Gateway helps provide a secure environment for configuring and diagnosing issues with your gateway. Using the local console commands, you can perform maintenance tasks such as saving routing tables, connecting to Support, and so on. To run a configuration or diagnostic command 1. Log in to your gateway's local console: • For more information on logging in to the VMware ESXi local console, see Accessing the Gateway Local Console with VMware ESXi. • For more information on logging in to the Microsoft Hyper-V local console, see Access the Gateway Local Console with Microsoft Hyper-V. • For more information on logging in to the KVM local console, see Accessing the Gateway Local Console with Linux KVM. 2. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select Gateway Console. 3. From the gateway console command prompt, enter h. The console displays the AVAILABLE COMMANDS menu, which lists the available commands: Command Function dig exit h Collect output from dig for DNS troublesh ooting. Return to Configuration menu. Display available command list. ifconfig View or configure network interfaces. Note We recommend configuring network or IP settings using the Storage Gateway console or the dedicated Performing tasks on the virtual machine local console API Version 2021-03-31 126 AWS Storage Gateway Command Amazon FSx File Gateway User Guide Function local console menu option. For instructions, see Configuring your gateway network settings. ip Show / manipulate routing, devices, and tunnels. Note We recommend configuring network or IP settings using the Storage Gateway console or the dedicated local console menu option. For instructions, see Configuring your gateway network settings. Administration tool for IPv4 packet filtering and NAT. Test connectivity to a specific TCP port on a network. Collect output from nping for network t roubleshooting. Connect to AWS Support. For instructions on how to turn on AWS support access, see You want AWS Support to help troubleshoot your EC2 gateway. iptables ncport nping open-support-channel passwd save-iptables Update authentication tokens. Persist IP tables. save-routing-table Save newly added routing table entry. Performing tasks on the virtual machine local console API Version 2021-03-31 127 AWS Storage Gateway Amazon FSx File Gateway User Guide Command tcptraceroute Function Collect traceroute output on TCP traffic to a destination. sslcheck Returns output with certificate issuer Note Storage Gateway uses certifica te issuer verification and does not support ssl inspection. If this command returns an issuer other than [email protected], then it is likely that an application performing an ssl inspection. In that case, we recommend bypassing ssl inspection for the Storage Gateway appliance. 4. From the gateway console command prompt, enter the corresponding command for the function you want to use, and follow the instructions. To learn about a command, enter man + command name at the command prompt. Performing tasks on the Amazon EC2 gateway local console Some maintenance tasks require that you log in to the local console when running a gateway deployed on an Amazon EC2 instance. This section describes how to log in to the local console and perform maintenance tasks. Topics • Logging in to your Amazon EC2 gateway local console - Learn how to connect and log in to the gateway local console your Amazon EC2 instance by using a Secure Shell (SSH) client. • Routing your gateway deployed on Amazon EC2 through an HTTP proxy - Learn how to configure a Socket Secure version 5 (SOCKS5) proxy between AWS and a gateway deployed on an Amazon EC2 instance. Performing tasks on the EC2 local console API Version 2021-03-31 128 AWS Storage Gateway Amazon FSx File Gateway User Guide • Testing your gateway's network connectivity - Learn how to use the gateway local console to test network connectivity between your gateway and various network resources. • Viewing your gateway system resource status - Learn how to use the gateway local console to checks your gateway's virtual CPU cores, root volume size, and RAM. • Running Storage Gateway commands on the local console for an Amazon EC2 gateway - Learn how to run local console commands to perform tasks such as saving routing tables, connecting to Support, and more. • Configuring your Amazon EC2 gateway network settings - Learn how to use the local console to view and configure network settings such as DNS and hostname for a gateway on an Amazon EC2 instance. Logging in to your Amazon EC2 gateway local console You log in to the gateway local console on an Amazon EC2 instance by using a Secure Shell (SSH) client. For detailed information, see Connect to your instance in the Amazon EC2 User Guide. To connect this way, you need the SSH key pair that you specified when you launched your
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.