RestoreFromSnapshot
Restores a namespace from a snapshot.
Request Syntax
{
"adminPasswordSecretKmsKeyId": "string",
"manageAdminPassword": boolean,
"namespaceName": "string",
"ownerAccount": "string",
"snapshotArn": "string",
"snapshotName": "string",
"workgroupName": "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.
- adminPasswordSecretKmsKeyId
-
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
Type: String
Required: No
- manageAdminPassword
-
If
true, Amazon Redshift uses AWS Secrets Manager to manage the restored snapshot's admin credentials. IfMmanageAdminPasswordis false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.Type: Boolean
Required: No
- namespaceName
-
The name of the namespace to restore the snapshot to.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 64.
Pattern:
^[a-z0-9-]+$Required: Yes
- ownerAccount
-
The AWS account that owns the snapshot.
Type: String
Required: No
- snapshotArn
-
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
snapshotName.The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.
Type: String
Required: No
- snapshotName
-
The name of the snapshot to restore from. Must not be specified at the same time as
snapshotArn.Type: String
Required: No
- workgroupName
-
The name of the workgroup used to restore the snapshot.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 64.
Pattern:
^[a-z0-9-]+$Required: Yes
Response Syntax
{
"namespace": {
"adminPasswordSecretArn": "string",
"adminPasswordSecretKmsKeyId": "string",
"adminUsername": "string",
"creationDate": "string",
"dbName": "string",
"defaultIamRoleArn": "string",
"iamRoles": [ "string" ],
"kmsKeyId": "string",
"logExports": [ "string" ],
"namespaceArn": "string",
"namespaceId": "string",
"namespaceName": "string",
"status": "string"
},
"ownerAccount": "string",
"snapshotName": "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.
- namespace
-
A collection of database objects and users.
Type: Namespace object
- ownerAccount
-
The owner AWS; account of the snapshot that was restored.
Type: String
- snapshotName
-
The name of the snapshot used to restore the namespace.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The submitted action has conflicts.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
The service limit was exceeded.
HTTP Status Code: 400
- ValidationException
-
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:
