GetNotebookMetadataCommand

Suggest an Edit

Retrieves notebook metadata for the specified notebook ID.

Example Syntax

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

import { AthenaClient, GetNotebookMetadataCommand } from "@aws-sdk/client-athena"; // ES Modules import
// const { AthenaClient, GetNotebookMetadataCommand } = require("@aws-sdk/client-athena"); // CommonJS import
const client = new AthenaClient(config);
const input = { // GetNotebookMetadataInput
  NotebookId: "STRING_VALUE", // required
};
const command = new GetNotebookMetadataCommand(input);
const response = await client.send(command);
// { // GetNotebookMetadataOutput
//   NotebookMetadata: { // NotebookMetadata
//     NotebookId: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     WorkGroup: "STRING_VALUE",
//     CreationTime: new Date("TIMESTAMP"),
//     Type: "IPYNB",
//     LastModifiedTime: new Date("TIMESTAMP"),
//   },
// };

GetNotebookMetadataCommand Input

See GetNotebookMetadataCommandInput for more details

Parameter
Type
Description
NotebookId
Required
string | undefined

The ID of the notebook whose metadata is to be retrieved.

GetNotebookMetadataCommand Output

See GetNotebookMetadataCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NotebookMetadata
NotebookMetadata | undefined

The metadata that is returned for the specified notebook ID.

Throws

Name
Fault
Details
InternalServerException
server

Indicates a platform issue, which may be due to a transient condition or outage.

InvalidRequestException
client

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

TooManyRequestsException
client

Indicates that the request was throttled.

AthenaServiceException
Base exception class for all service exceptions from Athena service.