GetNamespace - Amazon Redshift Serverless

GetNamespace

Returns information about a namespace in Amazon Redshift Serverless.

Request Syntax

{ "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.

namespaceName

The name of the namespace to retrieve information for.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: ^[a-z0-9-]+$

Required: Yes

Response Syntax

{ "namespace": { "adminUsername": "string", "creationDate": number, "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 returned namespace object.

Type: Namespace object

Errors

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

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: