CreatePresignedNotebookUrl - Amazon Athena
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.

Request Syntax

{ "SessionId": "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.


The session ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax

{ "AuthToken": "string", "AuthTokenExpirationTime": number, "NotebookUrl": "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.


The authentication token for the notebook.

Type: String

Length Constraints: Maximum length of 2048.


The UTC epoch time when the authentication token expires.

Type: Long


The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook.

Type: String


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


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

HTTP Status Code: 500


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


A resource, such as a workgroup, was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: