UpdateSnapshot - Amazon Redshift Serverless


Updates a snapshot.

Request Syntax

{ "retentionPeriod": number, "snapshotName": "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.


The new retention period of the snapshot.

Type: Integer

Required: No


The name of the snapshot.

Type: String

Required: Yes

Response Syntax

{ "snapshot": { "accountsWithProvisionedRestoreAccess": [ "string" ], "accountsWithRestoreAccess": [ "string" ], "actualIncrementalBackupSizeInMegaBytes": number, "adminUsername": "string", "backupProgressInMegaBytes": number, "currentBackupRateInMegaBytesPerSecond": number, "elapsedTimeInSeconds": number, "estimatedSecondsToCompletion": number, "kmsKeyId": "string", "namespaceArn": "string", "namespaceName": "string", "ownerAccount": "string", "snapshotArn": "string", "snapshotCreateTime": number, "snapshotName": "string", "snapshotRemainingDays": number, "snapshotRetentionPeriod": number, "snapshotRetentionStartTime": number, "status": "string", "totalBackupSizeInMegaBytes": 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.


The updated snapshot object.

Type: Snapshot object


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


The submitted action has conflicts.

HTTP Status Code: 400


The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500


The resource could not be found.

HTTP Status Code: 400


The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

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