[[reference-ml-get_calendar_events]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.ml.getCalendarEvents

Get info about events in calendars.

{ref}/ml-get-calendar-event.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(MlGetCalendarEventsRequest, options?): Promise<MlGetCalendarEventsResponse>
----

[discrete]
===== `MlGetCalendarEventsRequest`

[source,ts]
----
interface MlGetCalendarEventsRequest extends <<shared-type-request-base, RequestBase>> {
  calendar_id: <<shared-type-id, Id>>
  end?: <<shared-type-date-time, DateTime>>
  from?: <<shared-type-integer, integer>>
  job_id?: <<shared-type-id, Id>>
  size?: <<shared-type-integer, integer>>
  start?: <<shared-type-date-time, DateTime>>
}
----

[discrete]
===== `MlGetCalendarEventsResponse`

[source,ts]
----
interface MlGetCalendarEventsResponse {
  count: <<shared-type-long, long>>
  events: MlCalendarEvent[]
}
----