Skip to main content

Interface: IUpdateScheduleRequest

Properties of an UpdateScheduleRequest.

Extends​

Properties​

conflictToken?​

optional conflictToken?: Uint8Array<ArrayBufferLike> | null

This can be the value of conflict_token from a DescribeScheduleResponse, which will cause this request to fail if the schedule has been modified between the Describe and this Update. If missing, the schedule will be updated unconditionally.

Inherited from​

$Properties.conflictToken

identity?​

optional identity?: string | null

The identity of the client who initiated this request.

Inherited from​

$Properties.identity

memo?​

optional memo?: $Properties | null

Schedule memo to replace. If set, replaces the entire memo. Do not set this field if you do not want to update the memo. A non-null empty object will clear the memo.

Inherited from​

$Properties.memo

namespace?​

optional namespace?: string | null

The namespace of the schedule to update.

Inherited from​

$Properties.namespace

requestId?​

optional requestId?: string | null

A unique identifier for this update request for idempotence. Typically UUIDv4.

Inherited from​

$Properties.requestId

schedule?​

optional schedule?: $Properties | null

The new schedule. The four main fields of the schedule (spec, action, policies, state) are replaced completely by the values in this message.

Inherited from​

$Properties.schedule

scheduleId?​

optional scheduleId?: string | null

The id of the schedule to update.

Inherited from​

$Properties.scheduleId

searchAttributes?​

optional searchAttributes?: $Properties | null

Schedule search attributes to be updated. Do not set this field if you do not want to update the search attributes. A non-null empty object will set the search attributes to an empty map. Note: you cannot only update the search attributes with UpdateScheduleRequest, you must also set the schedule field; otherwise, it will unset the schedule.

Inherited from​

$Properties.searchAttributes