StorageGateway / Client / notify_when_uploaded

notify_when_uploaded#

StorageGateway.Client.notify_when_uploaded(**kwargs)#

Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.

Storage Gateway can send a notification through Amazon CloudWatch Events 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 an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or 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.

See also: AWS API Documentation

Request Syntax

response = client.notify_when_uploaded(
    FileShareARN='string'
)
Parameters:

FileShareARN (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the file share.

Return type:

dict

Returns:

Response Syntax

{
    'FileShareARN': 'string',
    'NotificationId': 'string'
}

Response Structure

  • (dict) –

    • FileShareARN (string) –

      The Amazon Resource Name (ARN) of the file share.

    • NotificationId (string) –

      The randomly generated ID of the notification that was sent. This ID is in UUID format.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError