- 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.
GetTableEncryptionCommand
Gets the encryption configuration for a table.
- Permissions
-
You must have the
s3tables:GetTableEncryptionpermission to use this operation.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { S3TablesClient, GetTableEncryptionCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
// const { S3TablesClient, GetTableEncryptionCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
const client = new S3TablesClient(config);
const input = { // GetTableEncryptionRequest
tableBucketARN: "STRING_VALUE", // required
namespace: "STRING_VALUE", // required
name: "STRING_VALUE", // required
};
const command = new GetTableEncryptionCommand(input);
const response = await client.send(command);
// { // GetTableEncryptionResponse
// encryptionConfiguration: { // EncryptionConfiguration
// sseAlgorithm: "AES256" || "aws:kms", // required
// kmsKeyArn: "STRING_VALUE",
// },
// };
GetTableEncryptionCommand Input
See GetTableEncryptionCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
nameRequired | string | undefined | The name of the table. |
namespaceRequired | string | undefined | The namespace associated with the table. |
tableBucketARNRequired | string | undefined | The Amazon Resource Name (ARN) of the table bucket containing the table. |
GetTableEncryptionCommand Output
See GetTableEncryptionCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
encryptionConfigurationRequired | EncryptionConfiguration | undefined | The encryption configuration for the table. |
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. |
| 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. |