DataZone / Client / get_notebook_export

get_notebook_export

DataZone.Client.get_notebook_export(**kwargs)

Gets the details of a notebook export in Amazon SageMaker Unified Studio.

See also: AWS API Documentation

Request Syntax

response = client.get_notebook_export(
    domainIdentifier='string',
    identifier='string'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon SageMaker Unified Studio domain in which the notebook export exists.

• identifier (string) –

  [REQUIRED]

  The identifier of the notebook export.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'domainId': 'string',
    'owningProjectId': 'string',
    'notebookId': 'string',
    'fileFormat': 'PDF'|'IPYNB',
    'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'outputLocation': {
        's3': {
            'uri': 'string'
        }
    },
    'error': {
        'message': 'string'
    },
    'completedAt': datetime(2015, 1, 1),
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string'
}

Response Structure

• (dict) –

  • id (string) –

    The identifier of the notebook export.

  • domainId (string) –

    The identifier of the Amazon SageMaker Unified Studio domain.

  • owningProjectId (string) –

    The identifier of the project that owns the notebook.

  • notebookId (string) –

    The identifier of the notebook.

  • fileFormat (string) –

    The file format of the notebook export.

  • status (string) –

    The status of the notebook export.

  • outputLocation (dict) –

    The output location of the exported notebook in Amazon Simple Storage Service.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • s3 (dict) –

      The Amazon Simple Storage Service destination for the notebook export.

      • uri (string) –

        The Amazon Simple Storage Service URI of the exported notebook.

  • error (dict) –

    The error details if the notebook export failed.

    • message (string) –

      The error message. The maximum length is 256 characters.

  • completedAt (datetime) –

    The timestamp of when the notebook export completed.

  • createdAt (datetime) –

    The timestamp of when the notebook export was started.

  • createdBy (string) –

    The identifier of the user who started the notebook export.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException