AWS API Changes

2026/04/30 - Amazon DataZone - 4 new api methods

Changes Adds support for asynchronous notebook runs

ListNotebookRuns (new)

Link ¶

Lists notebook runs in an Amazon DataZone domain.

Request Syntax

client.list_notebook_runs(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    notebookIdentifier='string',
    status='QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED',
    scheduleIdentifier='string',
    maxResults=123,
    sortOrder='ASCENDING'|'DESCENDING',
    nextToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain in which to list notebook runs.

type owningProjectIdentifier:

string

param owningProjectIdentifier:

[REQUIRED]

The identifier of the project that owns the notebook runs.

type notebookIdentifier:

string

param notebookIdentifier:

The identifier of the notebook to filter runs by.

type status:

string

param status:

The status to filter notebook runs by.

type scheduleIdentifier:

string

param scheduleIdentifier:

The identifier of the schedule to filter notebook runs by.

type maxResults:

integer

param maxResults:

The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of MaxResults, the response contains a NextToken value.

type sortOrder:

string

param sortOrder:

The sort order for the results.

type nextToken:

string

param nextToken:

When the number of notebook runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'domainId': 'string',
            'owningProjectId': 'string',
            'notebookId': 'string',
            'scheduleId': 'string',
            'status': 'QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED',
            'triggerSource': {
                'type': 'MANUAL'|'SCHEDULED'|'WORKFLOW',
                'name': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'startedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  The results of the ListNotebookRuns action.
  - (dict) --
    
    The summary of a notebook run in Amazon DataZone.
    - id (string) --
      
      The identifier of the notebook run.
    - domainId (string) --
      
      The identifier of the Amazon DataZone domain.
    - owningProjectId (string) --
      
      The identifier of the project that owns the notebook run.
    - notebookId (string) --
      
      The identifier of the notebook.
    - scheduleId (string) --
      
      The identifier of the schedule associated with the notebook run.
    - status (string) --
      
      The status of the notebook run.
    - triggerSource (dict) --
      
      The source that triggered the notebook run.
      - type (string) --
        
        The type of the trigger source. Valid values are MANUAL, SCHEDULED, and WORKFLOW.
      - name (string) --
        
        The name of the trigger source.
    - createdAt (datetime) --
      
      The timestamp of when the notebook run was created.
    - createdBy (string) --
      
      The identifier of the user who created the notebook run.
    - updatedAt (datetime) --
      
      The timestamp of when the notebook run was last updated.
    - updatedBy (string) --
      
      The identifier of the user who last updated the notebook run.
    - startedAt (datetime) --
      
      The timestamp of when the notebook run started executing.
    - completedAt (datetime) --
      
      The timestamp of when the notebook run completed.
- nextToken (string) --
  
  When the number of notebook runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.

StopNotebookRun (new)

Link ¶

Stops a running notebook run in an Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

client.stop_notebook_run(
    domainIdentifier='string',
    identifier='string',
    clientToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain in which the notebook run is stopped.

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the notebook run to stop.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'domainId': 'string',
    'owningProjectId': 'string',
    'status': 'QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'
}

Response Structure

(dict) --
- id (string) --
  
  The identifier of the notebook run.
- domainId (string) --
  
  The identifier of the Amazon DataZone domain.
- owningProjectId (string) --
  
  The identifier of the project that owns the notebook run.
- status (string) --
  
  The status of the notebook run.

GetNotebookRun (new)

Link ¶

Gets the details of a notebook run in an Amazon DataZone domain.

See also: AWS API Documentation

Request Syntax

client.get_notebook_run(
    domainIdentifier='string',
    identifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain in which the notebook run exists.

type identifier:

string

param identifier:

[REQUIRED]

The identifier of the notebook run.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'domainId': 'string',
    'owningProjectId': 'string',
    'notebookId': 'string',
    'scheduleId': 'string',
    'status': 'QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED',
    'cellOrder': [
        {},
    ],
    'metadata': {
        'string': 'string'
    },
    'parameters': {
        'string': 'string'
    },
    'computeConfiguration': {
        'instanceType': 'string',
        'environmentVersion': 'string'
    },
    'networkConfiguration': {
        'networkAccessType': 'PUBLIC_INTERNET_ONLY'|'VPC_ONLY',
        'vpcId': 'string',
        'subnetIds': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ]
    },
    'timeoutConfiguration': {
        'runTimeoutInMinutes': 123
    },
    'environmentConfiguration': {
        'imageVersion': 'string',
        'packageConfig': {
            'packageManager': 'UV',
            'packageSpecification': 'string'
        }
    },
    'storageConfiguration': {
        'projectS3Path': 'string',
        'kmsKeyArn': 'string'
    },
    'triggerSource': {
        'type': 'MANUAL'|'SCHEDULED'|'WORKFLOW',
        'name': 'string'
    },
    'error': {
        'message': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'startedAt': datetime(2015, 1, 1),
    'completedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- id (string) --
  
  The identifier of the notebook run.
- domainId (string) --
  
  The identifier of the Amazon DataZone domain.
- owningProjectId (string) --
  
  The identifier of the project that owns the notebook run.
- notebookId (string) --
  
  The identifier of the notebook.
- scheduleId (string) --
  
  The identifier of the schedule associated with the notebook run.
- status (string) --
  
  The status of the notebook run.
- cellOrder (list) --
  
  The ordered list of cells in the notebook run.
  - (dict) --
    
    The information about a cell in a notebook run in Amazon DataZone.
- metadata (dict) --
  
  The metadata of the notebook run.
  - (string) --
    - (string) --
- parameters (dict) --
  
  The sensitive parameters of the notebook run.
  - (string) --
    - (string) --
- computeConfiguration (dict) --
  
  The compute configuration of the notebook run.
  - instanceType (string) --
    
    The instance type for the notebook run compute.
  - environmentVersion (string) --
    
    The environment version for the notebook run compute.
- networkConfiguration (dict) --
  
  The network configuration of the notebook run.
  - networkAccessType (string) --
    
    The network access type for the notebook run. Valid values are PUBLIC_INTERNET_ONLY and VPC_ONLY.
  - vpcId (string) --
    
    The identifier of the VPC for the notebook run. This is required when the network access type is VPC_ONLY.
  - subnetIds (list) --
    
    The identifiers of the subnets for the notebook run. You can specify up to 10 subnets.
    - (string) --
  - securityGroupIds (list) --
    
    The identifiers of the security groups for the notebook run. You can specify up to 5 security groups.
    - (string) --
- timeoutConfiguration (dict) --
  
  The timeout configuration of the notebook run.
  - runTimeoutInMinutes (integer) --
    
    The timeout for the notebook run, in minutes. The minimum value is 60 minutes (1 hour), the maximum value is 1440 minutes (24 hours), and the default value is 720 minutes (12 hours).
- environmentConfiguration (dict) --
  
  The environment configuration of the notebook run, including image version and package settings.
  - imageVersion (string) --
    
    The image version for the notebook run environment.
  - packageConfig (dict) --
    
    The package configuration for the notebook run environment.
    - packageManager (string) --
      
      The package manager for the notebook run environment. The default value is UV.
    - packageSpecification (string) --
      
      The package specification content for the notebook run environment. The maximum length is 10240 characters.
- storageConfiguration (dict) --
  
  The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.
  - projectS3Path (string) --
    
    The Amazon Simple Storage Service path for the project storage.
  - kmsKeyArn (string) --
    
    The ARN of the KMS key used for encryption.
- triggerSource (dict) --
  
  The source that triggered the notebook run.
  - type (string) --
    
    The type of the trigger source. Valid values are MANUAL, SCHEDULED, and WORKFLOW.
  - name (string) --
    
    The name of the trigger source.
- error (dict) --
  
  The error details if the notebook run failed.
  - message (string) --
    
    The error message. The maximum length is 1024 characters.
- createdAt (datetime) --
  
  The timestamp of when the notebook run was created.
- createdBy (string) --
  
  The identifier of the user who created the notebook run.
- updatedAt (datetime) --
  
  The timestamp of when the notebook run was last updated.
- updatedBy (string) --
  
  The identifier of the user who last updated the notebook run.
- startedAt (datetime) --
  
  The timestamp of when the notebook run started executing.
- completedAt (datetime) --
  
  The timestamp of when the notebook run completed.

StartNotebookRun (new)

Link ¶

Starts a notebook run in an Amazon DataZone domain. A notebook run represents the execution of a Amazon DataZone notebook within a project. You can configure compute, network, timeout, and environment settings for the run.

See also: AWS API Documentation

Request Syntax

client.start_notebook_run(
    domainIdentifier='string',
    owningProjectIdentifier='string',
    notebookIdentifier='string',
    scheduleIdentifier='string',
    computeConfiguration={
        'instanceType': 'string',
        'environmentVersion': 'string'
    },
    networkConfiguration={
        'networkAccessType': 'PUBLIC_INTERNET_ONLY'|'VPC_ONLY',
        'vpcId': 'string',
        'subnetIds': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ]
    },
    timeoutConfiguration={
        'runTimeoutInMinutes': 123
    },
    triggerSource={
        'type': 'MANUAL'|'SCHEDULED'|'WORKFLOW',
        'name': 'string'
    },
    metadata={
        'string': 'string'
    },
    parameters={
        'string': 'string'
    },
    clientToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain in which the notebook run is started.

type owningProjectIdentifier:

string

param owningProjectIdentifier:

[REQUIRED]

The identifier of the project that owns the notebook run.

type notebookIdentifier:

string

param notebookIdentifier:

[REQUIRED]

The identifier of the notebook to run.

type scheduleIdentifier:

string

param scheduleIdentifier:

The identifier of the schedule associated with the notebook run.

type computeConfiguration:

dict

param computeConfiguration:

The compute configuration for the notebook run, including instance type and environment version.

instanceType (string) --

The instance type for the notebook run compute.
environmentVersion (string) --

The environment version for the notebook run compute.

type networkConfiguration:

dict

param networkConfiguration:

The network configuration for the notebook run, including network access type and optional VPC settings.

networkAccessType (string) -- [REQUIRED]

The network access type for the notebook run. Valid values are PUBLIC_INTERNET_ONLY and VPC_ONLY.
vpcId (string) --

The identifier of the VPC for the notebook run. This is required when the network access type is VPC_ONLY.
subnetIds (list) --

The identifiers of the subnets for the notebook run. You can specify up to 10 subnets.
- (string) --
securityGroupIds (list) --

The identifiers of the security groups for the notebook run. You can specify up to 5 security groups.
- (string) --

type timeoutConfiguration:

dict

param timeoutConfiguration:

The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).

runTimeoutInMinutes (integer) --

The timeout for the notebook run, in minutes. The minimum value is 60 minutes (1 hour), the maximum value is 1440 minutes (24 hours), and the default value is 720 minutes (12 hours).

type triggerSource:

dict

param triggerSource:

The source that triggered the notebook run.

type (string) --

The type of the trigger source. Valid values are MANUAL, SCHEDULED, and WORKFLOW.
name (string) --

The name of the trigger source.

type metadata:

dict

param metadata:

The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

(string) --
- (string) --

type parameters:

dict

param parameters:

The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

(string) --
- (string) --

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'domainId': 'string',
    'owningProjectId': 'string',
    'notebookId': 'string',
    'scheduleId': 'string',
    'status': 'QUEUED'|'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED',
    'cellOrder': [
        {},
    ],
    'metadata': {
        'string': 'string'
    },
    'parameters': {
        'string': 'string'
    },
    'computeConfiguration': {
        'instanceType': 'string',
        'environmentVersion': 'string'
    },
    'networkConfiguration': {
        'networkAccessType': 'PUBLIC_INTERNET_ONLY'|'VPC_ONLY',
        'vpcId': 'string',
        'subnetIds': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ]
    },
    'timeoutConfiguration': {
        'runTimeoutInMinutes': 123
    },
    'environmentConfiguration': {
        'imageVersion': 'string',
        'packageConfig': {
            'packageManager': 'UV',
            'packageSpecification': 'string'
        }
    },
    'storageConfiguration': {
        'projectS3Path': 'string',
        'kmsKeyArn': 'string'
    },
    'triggerSource': {
        'type': 'MANUAL'|'SCHEDULED'|'WORKFLOW',
        'name': 'string'
    },
    'error': {
        'message': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'startedAt': datetime(2015, 1, 1),
    'completedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- id (string) --
  
  The identifier of the notebook run.
- domainId (string) --
  
  The identifier of the Amazon DataZone domain.
- owningProjectId (string) --
  
  The identifier of the project that owns the notebook run.
- notebookId (string) --
  
  The identifier of the notebook.
- scheduleId (string) --
  
  The identifier of the schedule associated with the notebook run.
- status (string) --
  
  The status of the notebook run.
- cellOrder (list) --
  
  The ordered list of cells in the notebook run.
  - (dict) --
    
    The information about a cell in a notebook run in Amazon DataZone.
- metadata (dict) --
  
  The metadata of the notebook run.
  - (string) --
    - (string) --
- parameters (dict) --
  
  The sensitive parameters of the notebook run.
  - (string) --
    - (string) --
- computeConfiguration (dict) --
  
  The compute configuration of the notebook run.
  - instanceType (string) --
    
    The instance type for the notebook run compute.
  - environmentVersion (string) --
    
    The environment version for the notebook run compute.
- networkConfiguration (dict) --
  
  The network configuration of the notebook run.
  - networkAccessType (string) --
    
    The network access type for the notebook run. Valid values are PUBLIC_INTERNET_ONLY and VPC_ONLY.
  - vpcId (string) --
    
    The identifier of the VPC for the notebook run. This is required when the network access type is VPC_ONLY.
  - subnetIds (list) --
    
    The identifiers of the subnets for the notebook run. You can specify up to 10 subnets.
    - (string) --
  - securityGroupIds (list) --
    
    The identifiers of the security groups for the notebook run. You can specify up to 5 security groups.
    - (string) --
- timeoutConfiguration (dict) --
  
  The timeout configuration of the notebook run.
  - runTimeoutInMinutes (integer) --
    
    The timeout for the notebook run, in minutes. The minimum value is 60 minutes (1 hour), the maximum value is 1440 minutes (24 hours), and the default value is 720 minutes (12 hours).
- environmentConfiguration (dict) --
  
  The environment configuration of the notebook run, including image version and package settings.
  - imageVersion (string) --
    
    The image version for the notebook run environment.
  - packageConfig (dict) --
    
    The package configuration for the notebook run environment.
    - packageManager (string) --
      
      The package manager for the notebook run environment. The default value is UV.
    - packageSpecification (string) --
      
      The package specification content for the notebook run environment. The maximum length is 10240 characters.
- storageConfiguration (dict) --
  
  The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.
  - projectS3Path (string) --
    
    The Amazon Simple Storage Service path for the project storage.
  - kmsKeyArn (string) --
    
    The ARN of the KMS key used for encryption.
- triggerSource (dict) --
  
  The source that triggered the notebook run.
  - type (string) --
    
    The type of the trigger source. Valid values are MANUAL, SCHEDULED, and WORKFLOW.
  - name (string) --
    
    The name of the trigger source.
- error (dict) --
  
  The error details if the notebook run failed.
  - message (string) --
    
    The error message. The maximum length is 1024 characters.
- createdAt (datetime) --
  
  The timestamp of when the notebook run was created.
- createdBy (string) --
  
  The identifier of the user who created the notebook run.
- updatedAt (datetime) --
  
  The timestamp of when the notebook run was last updated.
- updatedBy (string) --
  
  The identifier of the user who last updated the notebook run.
- startedAt (datetime) --
  
  The timestamp of when the notebook run started executing.
- completedAt (datetime) --
  
  The timestamp of when the notebook run completed.