/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

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, GetCalendarState 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, GetCalendarState 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.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "CalendarNames": [],
    "AtTime": "string"
}'

Response Example

200 - Example 1

{
    "State": "OPEN",
    "AtTime": "string",
    "NextTransitionTime": "string"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

CalendarNames

array[string]

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

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

State

enum<string>

optional

The state of the calendar. An OPEN calendar indicates that actions are allowed to proceed, and a CLOSED calendar indicates that actions aren't allowed to proceed.

Allowed values:

OPENCLOSED

AtTime

string

optional

The time, as an ISO 8601 string, that you specified in your command. If you don't specify a time, GetCalendarState uses the current time.

NextTransitionTime

string

optional

The time, as an ISO 8601 string, that the calendar state will change. If the current calendar state is OPEN, NextTransitionTime indicates when the calendar state changes to CLOSED, and vice-versa.

🟠480InternalServerError

🟠481InvalidDocument

🟠482InvalidDocumentType

🟠483UnsupportedCalendarException