ScheduleJob

pydantic model openapi_client.models.schedule_job.ScheduleJob

POST /schedules/schedule body. Permissive for API Gateway; Lambda enforces required fields. Job schedules use JobName/ScheduleType/Resource; datalab uses ResourceType=`sagemaker-notebook` with ScheduleName.

Fields:

• additional_properties (Dict[str, Any])

• arguments (List[Dict[str, Any]])

• cost_tags (List[Dict[str, Any]] | None)

• description (str)

• event_targets (Any | None)

• event_type (str | None)

• is_enabled (bool | None)

• job_name (str)

• job_type (str)

• keywords (List[str] | None)

• priority (Any | None)

• resource (str)

• resource_type (str | None)

• schedule_description (str | None)

• schedule_name (str | None)

• schedule_param (openapi_client.models.schedule_job_schedule_param.ScheduleJobScheduleParam)

• schedule_type (str)

• source (str | None)

• source_arn (str | None)

• start_schedule (Dict[str, Any] | None)

• stop_schedule (Dict[str, Any] | None)

• target_dataset_id (str | None)

field job_name: StrictStr [Required] (alias 'JobName')

Display name for job/event schedules.

Constraints:

• strict = True

field schedule_type: StrictStr [Required] (alias 'ScheduleType')

time | event | none | event-trigger | external-trigger

Constraints:

• strict = True

field schedule_param: ScheduleJobScheduleParam [Required] (alias 'ScheduleParam')

field job_type: StrictStr [Required] (alias 'JobType')

Job category for time/event/none (etl, ingestion, glue, …).

Constraints:

• strict = True

field resource: StrictStr [Required] (alias 'Resource')

Target resource id/name, or datalab id.

Constraints:

• strict = True

field description: StrictStr [Required] (alias 'Description')

Optional job schedule description.

Constraints:

• strict = True

field arguments: List[Dict[str, Any]] [Required] (alias 'Arguments')

Key/Value args for the job (handler may add userId/roleId).

field resource_type: Optional[StrictStr] = None (alias 'ResourceType')

Resource category, or sagemaker-notebook for datalab.

field event_type: Optional[StrictStr] = None (alias 'EventType')

Required for event-trigger schedules.

field event_targets: Optional[Any] = None (alias 'EventTargets')

Targets for event-trigger schedules.

field source_arn: Optional[StrictStr] = None (alias 'SourceArn')

Source ARN for external-trigger schedules.

field source: Optional[StrictStr] = None (alias 'Source')

Source label for external-trigger schedules.

field target_dataset_id: Optional[StrictStr] = None (alias 'TargetDatasetId')

Optional related target dataset id.

field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')

Optional keywords.

field cost_tags: Optional[List[Dict[str, Any]]] = None (alias 'CostTags')

Optional cost tags (TagKey/TagValue).

field schedule_name: Optional[StrictStr] = None (alias 'ScheduleName')

Datalab schedule name (sagemaker-notebook).

field schedule_description: Optional[StrictStr] = None (alias 'ScheduleDescription')

Optional datalab schedule description.

field is_enabled: Optional[StrictBool] = None (alias 'IsEnabled')

Whether the datalab schedule is enabled.

field priority: Optional[Any] = None (alias 'Priority')

Datalab priority (lower = higher priority).

field start_schedule: Optional[Dict[str, Any]] = None (alias 'StartSchedule')

Datalab start expression (ScheduleType, ScheduleTime, …).

field stop_schedule: Optional[Dict[str, Any]] = None (alias 'StopSchedule')

Datalab stop expression (same shape as StartSchedule).

field additional_properties: Dict[str, Any] = {}

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of ScheduleJob from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

• Fields in self.additional_properties are added to the output dict.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of ScheduleJob from a dict

Return type:

Optional[Self]