GETCALENDARSTATE()`¶

About GetCalendarState¶

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 tool in Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

Method Signature¶

METHODS /AWS1/IF_SSM~GETCALENDARSTATE
  IMPORTING
    !IT_CALENDARNAMES TYPE /AWS1/CL_SSMCALENDARNAMEORAR00=>TT_CALENDARNAMEORARNLIST OPTIONAL
    !IV_ATTIME TYPE /AWS1/SSMISO8601STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmgetcalendarstate01
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDDOCUMENT
    /AWS1/CX_SSMINVALIDDOCTYPE
    /AWS1/CX_SSMUNSUPPEDCALENDAREX
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`it_calendarnames` `TYPE /AWS1/CL_SSMCALENDARNAMEORAR00=>TT_CALENDARNAMEORARNLIST` `TT_CALENDARNAMEORARNLIST`¶

The names of Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.

Optional arguments:¶

`iv_attime` `TYPE /AWS1/SSMISO8601STRING` `/AWS1/SSMISO8601STRING`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmgetcalendarstate01` `/AWS1/CL_SSMGETCALENDARSTATE01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getcalendarstate(
  it_calendarnames = VALUE /aws1/cl_ssmcalendarnameorar00=>tt_calendarnameorarnlist(
    ( new /aws1/cl_ssmcalendarnameorar00( |string| ) )
  )
  iv_attime = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_calendarstate = lo_result->get_state( ).
  lv_iso8601string = lo_result->get_attime( ).
  lv_iso8601string = lo_result->get_nexttransitiontime( ).
ENDIF.

/AWS1/IF_SSM=>GETCALENDARSTATE()¶