# ListNotebookMetadata
<a name="API_ListNotebookMetadata"></a>

Displays the notebook files for the specified workgroup in paginated format.

## Request Syntax
<a name="API_ListNotebookMetadata_RequestSyntax"></a>

```
{
   "Filters": { 
      "Name": "string"
   },
   "MaxResults": number,
   "NextToken": "string",
   "WorkGroup": "string"
}
```

## Request Parameters
<a name="API_ListNotebookMetadata_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filters](#API_ListNotebookMetadata_RequestSyntax) **   <a name="athena-ListNotebookMetadata-request-Filters"></a>
Search filter string.  
Type: [FilterDefinition](API_FilterDefinition.md) object  
Required: No

 ** [MaxResults](#API_ListNotebookMetadata_RequestSyntax) **   <a name="athena-ListNotebookMetadata-request-MaxResults"></a>
Specifies the maximum number of results to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [NextToken](#API_ListNotebookMetadata_RequestSyntax) **   <a name="athena-ListNotebookMetadata-request-NextToken"></a>
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [WorkGroup](#API_ListNotebookMetadata_RequestSyntax) **   <a name="athena-ListNotebookMetadata-request-WorkGroup"></a>
The name of the Spark enabled workgroup to retrieve notebook metadata for.  
Type: String  
Pattern: `[a-zA-Z0-9._-]{1,128}`   
Required: Yes

## Response Syntax
<a name="API_ListNotebookMetadata_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "NotebookMetadataList": [ 
      { 
         "CreationTime": number,
         "LastModifiedTime": number,
         "Name": "string",
         "NotebookId": "string",
         "Type": "string",
         "WorkGroup": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListNotebookMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListNotebookMetadata_ResponseSyntax) **   <a name="athena-ListNotebookMetadata-response-NextToken"></a>
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the `NextToken` from the response object of the previous page call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [NotebookMetadataList](#API_ListNotebookMetadata_ResponseSyntax) **   <a name="athena-ListNotebookMetadata-response-NotebookMetadataList"></a>
The list of notebook metadata for the specified workgroup.  
Type: Array of [NotebookMetadata](API_NotebookMetadata.md) objects

## Errors
<a name="API_ListNotebookMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
Indicates a platform issue, which may be due to a transient condition or outage.  
HTTP Status Code: 500

 ** InvalidRequestException **   
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.    
 ** AthenaErrorCode **   
The error code returned when the query execution failed to process, or when the processing request for the named query failed.
HTTP Status Code: 400

 ** TooManyRequestsException **   
Indicates that the request was throttled.    
 ** Reason **   
The reason for the query throttling, for example, when it exceeds the concurrent query limit.
HTTP Status Code: 400

## See Also
<a name="API_ListNotebookMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/athena-2017-05-18/ListNotebookMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/athena-2017-05-18/ListNotebookMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/athena-2017-05-18/ListNotebookMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/athena-2017-05-18/ListNotebookMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/athena-2017-05-18/ListNotebookMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/athena-2017-05-18/ListNotebookMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/athena-2017-05-18/ListNotebookMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/athena-2017-05-18/ListNotebookMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/athena-2017-05-18/ListNotebookMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/athena-2017-05-18/ListNotebookMetadata)