Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class RestoreFromSnapshotCommandProtected

Restores a namespace from a snapshot.

Example

Use a bare-bones client and the command you need to make an API call.

import { RedshiftServerlessClient, RestoreFromSnapshotCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import
// const { RedshiftServerlessClient, RestoreFromSnapshotCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import
const client = new RedshiftServerlessClient(config);
const input = { // RestoreFromSnapshotRequest
namespaceName: "STRING_VALUE", // required
workgroupName: "STRING_VALUE", // required
snapshotName: "STRING_VALUE",
snapshotArn: "STRING_VALUE",
ownerAccount: "STRING_VALUE",
manageAdminPassword: true || false,
adminPasswordSecretKmsKeyId: "STRING_VALUE",
};
const command = new RestoreFromSnapshotCommand(input);
const response = await client.send(command);
// { // RestoreFromSnapshotResponse
// snapshotName: "STRING_VALUE",
// ownerAccount: "STRING_VALUE",
// namespace: { // Namespace
// namespaceArn: "STRING_VALUE",
// namespaceId: "STRING_VALUE",
// namespaceName: "STRING_VALUE",
// adminUsername: "STRING_VALUE",
// dbName: "STRING_VALUE",
// kmsKeyId: "STRING_VALUE",
// defaultIamRoleArn: "STRING_VALUE",
// iamRoles: [ // IamRoleArnList
// "STRING_VALUE",
// ],
// logExports: [ // LogExportList
// "STRING_VALUE",
// ],
// status: "STRING_VALUE",
// creationDate: new Date("TIMESTAMP"),
// adminPasswordSecretArn: "STRING_VALUE",
// adminPasswordSecretKmsKeyId: "STRING_VALUE",
// },
// };

Param

RestoreFromSnapshotCommandInput

Returns

RestoreFromSnapshotCommandOutput

See

Throws

ConflictException (client fault)

The submitted action has conflicts.

Throws

InternalServerException (server fault)

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

Throws

ResourceNotFoundException (client fault)

The resource could not be found.

Throws

ServiceQuotaExceededException (client fault)

The service limit was exceeded.

Throws

ValidationException (client fault)

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

Throws

RedshiftServerlessServiceException

Base exception class for all service exceptions from RedshiftServerless service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods