Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465272236.5 KB

Restores a namespace from a snapshot.

post/#X-Amz-Target=RedshiftServerless.RestoreFromSnapshot

Headers

X-Amz-Target'RedshiftServerless.RestoreFromSnapshot' required

Request body

adminPasswordSecretKmsKeyIdstring

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

maintainIntegrationboolean
<p>If <code>true</code>, maintain existing data sharing, zero-ETL and S3 event integrations when restoring. Otherwise, integrations will not be maintained after the restore operation. Integrations are only maintained when restored to the same serverless namespace.</p> <p>Default: true</p>
manageAdminPasswordboolean

If <code>true</code>, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If <code>MmanageAdminPassword</code> is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.

namespaceNamestring required

The name of the namespace to restore the snapshot to.

ownerAccountstring

The Amazon Web Services account that owns the snapshot.

snapshotArnstring
<p>The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. Must not be specified at the same time as <code>snapshotName</code>.</p> <p>The format of the ARN is arn:aws:redshift:&lt;region&gt;:&lt;account_id&gt;:snapshot:&lt;cluster_identifier&gt;/&lt;snapshot_identifier&gt;.</p>
snapshotNamestring

The name of the snapshot to restore from. Must not be specified at the same time as <code>snapshotArn</code>.

workgroupNamestring required

The name of the workgroup used to restore the snapshot.

Response

Success

ownerAccountstring

The owner Amazon Web Services; account of the snapshot that was restored.

snapshotNamestring

The name of the snapshot used to restore the namespace.