Get Calendar State
ssm_get_calendar_state | R Documentation |
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time¶
Description¶
Gets the state of a Amazon Web Services Systems Manager change calendar
at the current time or a specified time. If you specify a time,
get_calendar_state
returns the state of the calendar at that specific
time, and returns the next time that the change calendar state will
transition. If you don't specify a time, get_calendar_state
uses the
current time. Change Calendar entries have two possible states: OPEN
or CLOSED
.
If you specify more than one calendar in a request, the command returns
the status of OPEN
only if all calendars in the request are open. If
one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
Usage¶
Arguments¶
CalendarNames
[required] The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.
AtTime
(Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you don't specify a value or
AtTime
, the current time is used.
Value¶
A list with the following syntax: