Skip to main content

Interface: IDescribeScheduleResponse

Properties of a DescribeScheduleResponse.

Extends​

Properties​

conflictToken?​

optional conflictToken?: Uint8Array<ArrayBufferLike> | null

This value can be passed back to UpdateSchedule to ensure that the schedule was not modified between a Describe and an Update, which could lead to lost updates and other confusion.

Inherited from​

$Properties.conflictToken


info?​

optional info?: $Properties | null

Extra schedule state info.

Inherited from​

$Properties.info


memo?​

optional memo?: $Properties | null

The memo and search attributes that the schedule was created with.

Inherited from​

$Properties.memo


schedule?​

optional schedule?: $Properties | null

The complete current schedule details. This may not match the schedule as created because:

  • some types of schedule specs may get compiled into others (e.g. CronString into StructuredCalendarSpec)
  • some unspecified fields may be replaced by defaults
  • some fields in the state are modified automatically
  • the schedule may have been modified by UpdateSchedule or PatchSchedule

Inherited from​

$Properties.schedule


searchAttributes?​

optional searchAttributes?: $Properties | null

DescribeScheduleResponse searchAttributes

Inherited from​

$Properties.searchAttributes