ScheduledJobStatus

pydantic model openapi_client.models.scheduled_job_status.ScheduledJobStatus

Job/event/external-trigger schedule item returned by list/get schedule APIs after conversion from DynamoDB schedule metadata.

Fields:

• accept_runtime_arguments (bool | None)

• access_type (str | None)

• arguments (List[openapi_client.models.scheduled_job_argument.ScheduledJobArgument])

• created_by (str | None)

• creation_time (str | None)

• description (str | None)

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

• event_type (str | None)

• ingestion_type (str | None)

• job_name (str)

• job_type (str | None)

• keywords (List[str] | None)

• last_modified (str | None)

• message_format (openapi_client.models.external_trigger_message_format.ExternalTriggerMessageFormat | None)

• resource (str)

• resource_name (str | None)

• resource_type (str | None)

• schedule_id (str)

• schedule_param (openapi_client.models.schedule_param.ScheduleParam)

• schedule_type (str)

• source (str | None)

• source_arn (str | None)

• state (str | None)

• subscription_arn (str | None)

• subscription_status (str | None)

• target_dataset_id (str | None)

• trigger (str | None)

• trigger_details (str | None)

field schedule_id: StrictStr [Required] (alias 'ScheduleId')

Unique schedule identifier.

Constraints:

• strict = True

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

Display name of the schedule/job.

Constraints:

• strict = True

field description: Optional[StrictStr] = None (alias 'Description')

Schedule description. Defaults to N/A when unset.

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

User who created the schedule.

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

Creation timestamp.

field last_modified: Optional[StrictStr] = None (alias 'LastModified')

Last modification timestamp (default sort key for list APIs).

field state: Optional[StrictStr] = None (alias 'State')

Schedule state such as ENABLED or DISABLED.

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

Optional target dataset id when applicable. May be null.

field access_type: Optional[StrictStr] = None (alias 'AccessType')

Caller access level on the underlying resource/schedule.

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

Trigger category for the schedule. Notebook schedules report time.

Constraints:

• strict = True

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

field job_type: Optional[StrictStr] = None (alias 'JobType')

What the schedule runs, for example etl, ingestion or jdbc-cdc. Event and external-trigger schedules have no job type of their own - an event trigger runs every entry in EventTargets, an external trigger runs whatever Resource names - so those report their ScheduleType (event-trigger / external-trigger) here instead of null.

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

Target resource id (job, dataset, datasource, pipeline, etc.).

Constraints:

• strict = True

field arguments: List[ScheduledJobArgument] [Required] (alias 'Arguments')

Key/Value argument list (pipeline metadata keys may be filtered out).

field trigger: Optional[StrictStr] = None (alias 'Trigger')

Display-ready description of what fires a schedule - external triggers report the source, with the topic ARN in TriggerDetails - time schedules report the cron/rate expression verbatim - notebook schedules report the expression type of each configured half - one-time, daily, weekly or monthly

field trigger_details: Optional[StrictStr] = None (alias 'TriggerDetails')

Expanded details for Trigger. - External triggers show the full source ARN. - Notebook schedules show start/stop expressions in one line, joined by ·. - Others are null.

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

Resource category for the schedule target. Common values include jobs, datasets, datasources, data-pipelines, and HCLS store types when enabled.

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

Event type for event-based schedules. May be null/absent.

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

Event targets payload for event-based schedules. May be null/absent.

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 subscription_arn: Optional[StrictStr] = None (alias 'SubscriptionArn')

field subscription_status: Optional[StrictStr] = None (alias 'SubscriptionStatus')

field ingestion_type: Optional[StrictStr] = None (alias 'IngestionType')

field accept_runtime_arguments: Optional[StrictBool] = None (alias 'AcceptRuntimeArguments')

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

field message_format: Optional[ExternalTriggerMessageFormat] = None (alias 'MessageFormat')

field resource_name: Optional[StrictStr] = None (alias 'ResourceName')

Display name of the resource the schedule belongs to.

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 ScheduledJobStatus 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.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of ScheduledJobStatus from a dict

Return type:

Optional[Self]