UpdateSnapshot - Amazon GameSparks

Amazon GameSparks is currently in preview. Changes might be made to this service and to this documentation. We don't recommend using this service for production workloads.


Updates the metadata of a GameSparks snapshot.

Request Syntax

PATCH /game/GameName/snapshot/SnapshotId HTTP/1.1 Content-type: application/json { "Description": "string" }

URI Request Parameters

The request uses the following URI parameters.


The name of the game.

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes


The identifier of the snapshot.

Length Constraints: Minimum length of 33. Maximum length of 36.

Pattern: ^Snapshot_\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3,6}Z$

Required: Yes

Request Body

The request accepts the following data in JSON format.


The description of the snapshot.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 250.

Pattern: ^\S(.*\S)?$|^$

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Snapshot": { "Created": number, "Description": "string", "Id": "string", "LastUpdated": number, "Sections": { "string" : { "Attributes": JSON value, "Name": "string", "Size": 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.


Properties that provide details of the updated snapshot.

Type: SnapshotDetails object


For information about the errors that are common to all actions, see Errors.


You do not have sufficient access to perform this action.

HTTP Status Code: 403


The service encountered an internal error.

HTTP Status Code: 500


The resource specified in the request does not exist.

HTTP Status Code: 404


The request throughput limit was exceeded.

HTTP Status Code: 429


One of the parameters in the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: