DeleteNamespace - Amazon Redshift Serverless

DeleteNamespace

Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.

Request Syntax

{ "finalSnapshotName": "string", "finalSnapshotRetentionPeriod": number, "namespaceName": "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.

finalSnapshotName

The name of the snapshot to be created before the namespace is deleted.

Type: String

Required: No

finalSnapshotRetentionPeriod

How long to retain the final snapshot.

Type: Integer

Required: No

namespaceName

The name of the namespace to delete.

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" } }

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

The deleted namespace object.

Type: Namespace object

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

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: