Starts a process that cleans the specified file share's cache of file entries that are failing upload to Amazon S3. This API operation reports success if the request is received with valid arguments, and there are no other cache clean operations currently in-progress for the specified file share. After a successful request, the cache clean operation occurs asynchronously and reports progress using CloudWatch logs and notifications.
Important
If ForceRemove is set to True, the cache clean operation
will delete file data from the gateway which might otherwise be recoverable. We
recommend using this operation only after all other methods to clear files failing
upload have been exhausted, and if your business need outweighs the potential data
loss.
Request Syntax
{
"FileShareARN": "string",
"ForceRemove": 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.
-
The Amazon Resource Name (ARN) of the file share for which you want to start the cache clean operation.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: Yes
- ForceRemove
-
Specifies whether cache entries with full or partial file data currently stored on the gateway will be forcibly removed by the cache clean operation.
Valid arguments:
-
False- The cache clean operation skips cache entries failing upload if they are associated with data currently stored on the gateway. This preserves the cached data. -
True- The cache clean operation removes cache entries failing upload even if they are associated with data currently stored on the gateway. This deletes the cached data.Important
If
ForceRemoveis set toTrue, the cache clean operation will delete file data from the gateway which might otherwise be recoverable.
Type: Boolean
Required: No
-
Response Syntax
{
"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.
- NotificationId
-
The randomly generated ID of the CloudWatch notification associated with the cache clean operation. This ID is in UUID format.
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.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
