- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetNamespaceCommand
Gets details about a namespace. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide.
- Permissions
-
You must have the
s3tables:GetNamespace
permission to use this operation.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { S3TablesClient, GetNamespaceCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
// const { S3TablesClient, GetNamespaceCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
const client = new S3TablesClient(config);
const input = { // GetNamespaceRequest
tableBucketARN: "STRING_VALUE", // required
namespace: "STRING_VALUE", // required
};
const command = new GetNamespaceCommand(input);
const response = await client.send(command);
// { // GetNamespaceResponse
// namespace: [ // NamespaceList // required
// "STRING_VALUE",
// ],
// createdAt: new Date("TIMESTAMP"), // required
// createdBy: "STRING_VALUE", // required
// ownerAccountId: "STRING_VALUE", // required
// namespaceId: "STRING_VALUE",
// tableBucketId: "STRING_VALUE",
// };
GetNamespaceCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
namespace Required | string | undefined | The name of the namespace. |
tableBucketARN Required | string | undefined | The Amazon Resource Name (ARN) of the table bucket. |
GetNamespaceCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
createdAt Required | Date | undefined | The date and time the namespace was created at. |
createdBy Required | string | undefined | The ID of the account that created the namespace. |
namespace Required | string[] | undefined | The name of the namespace. |
ownerAccountId Required | string | undefined | The ID of the account that owns the namespcace. |
namespaceId | string | undefined | The unique identifier of the namespace. |
tableBucketId | string | undefined | The unique identifier of the table bucket containing this namespace. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The action cannot be performed because you do not have the required permission. |
BadRequestException | client | The request is invalid or malformed. |
ConflictException | client | The request failed because there is a conflict with a previous write. You can retry the request. |
ForbiddenException | client | The caller isn't authorized to make the request. |
InternalServerErrorException | server | The request failed due to an internal server error. |
NotFoundException | client | The request was rejected because the specified resource could not be found. |
TooManyRequestsException | client | The limit on the number of requests per second was exceeded. |
S3TablesServiceException | Base exception class for all service exceptions from S3Tables service. |