Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListNotebookMetadata

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

Request Syntax


{
   "Filters": { 
      "Name": "string"
   },
   "MaxResults": number,
   "NextToken": "string",
   "WorkGroup": "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.

Filters

Search filter string.

Type: FilterDefinition object

Required: No

MaxResults

Specifies the maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

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

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


{
   "NextToken": "string",
   "NotebookMetadataList": [ 
      { 
         "CreationTime": number,
         "LastModifiedTime": number,
         "Name": "string",
         "NotebookId": "string",
         "Type": "string",
         "WorkGroup": "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.

NextToken

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

The list of notebook metadata for the specified workgroup.

Type: Array of NotebookMetadata objects

Errors

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

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.

HTTP Status Code: 400

TooManyRequestsException

Indicates that the request was throttled.

HTTP Status Code: 400