DescribeNotebookExecution
Provides details of a notebook execution.
Request Syntax
{
"NotebookExecutionId": "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.
- NotebookExecutionId
-
The unique identifier of the notebook execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
Response Syntax
{
"NotebookExecution": {
"Arn": "string",
"EditorId": "string",
"EndTime": number,
"EnvironmentVariables": {
"string" : "string"
},
"ExecutionEngine": {
"ExecutionRoleArn": "string",
"Id": "string",
"MasterInstanceSecurityGroupId": "string",
"Type": "string"
},
"LastStateChangeReason": "string",
"NotebookExecutionId": "string",
"NotebookExecutionName": "string",
"NotebookInstanceSecurityGroupId": "string",
"NotebookParams": "string",
"NotebookS3Location": {
"Bucket": "string",
"Key": "string"
},
"OutputNotebookFormat": "string",
"OutputNotebookS3Location": {
"Bucket": "string",
"Key": "string"
},
"OutputNotebookURI": "string",
"StartTime": number,
"Status": "string",
"Tags": [
{
"Key": "string",
"Value": "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.
- NotebookExecution
-
Properties of the notebook execution.
Type: NotebookExecution object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
Indicates that an error occurred while processing the request and that the request was not completed.
HTTP Status Code: 400
- InvalidRequestException
-
This exception occurs when there is something wrong with user input.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: