Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.GetCalendarState

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Creating a Request

data GetCalendarState Source #

See: newGetCalendarState smart constructor.

Constructors

GetCalendarState'
Fields atTime :: Maybe Text (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. calendarNames :: [Text] 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.

Instances

Instances details

ToJSON GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods toJSON :: GetCalendarState -> Value # toEncoding :: GetCalendarState -> Encoding # toJSONList :: [GetCalendarState] -> Value # toEncodingList :: [GetCalendarState] -> Encoding #
ToHeaders GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods toHeaders :: GetCalendarState -> [Header] #
ToPath GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods toPath :: GetCalendarState -> ByteString #
ToQuery GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods toQuery :: GetCalendarState -> QueryString #
AWSRequest GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Associated Types type AWSResponse GetCalendarState # Methods request :: (Service -> Service) -> GetCalendarState -> Request GetCalendarState # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetCalendarState -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCalendarState))) #
Generic GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Associated Types type Rep GetCalendarState :: Type -> Type # Methods from :: GetCalendarState -> Rep GetCalendarState x # to :: Rep GetCalendarState x -> GetCalendarState #
Read GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods readsPrec :: Int -> ReadS GetCalendarState # readList :: ReadS [GetCalendarState] # readPrec :: ReadPrec GetCalendarState # readListPrec :: ReadPrec [GetCalendarState] #
Show GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods showsPrec :: Int -> GetCalendarState -> ShowS # show :: GetCalendarState -> String # showList :: [GetCalendarState] -> ShowS #
NFData GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods rnf :: GetCalendarState -> () #
Eq GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods (==) :: GetCalendarState -> GetCalendarState -> Bool # (/=) :: GetCalendarState -> GetCalendarState -> Bool #
Hashable GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods hashWithSalt :: Int -> GetCalendarState -> Int # hash :: GetCalendarState -> Int #
type AWSResponse GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState type AWSResponse GetCalendarState = GetCalendarStateResponse
type Rep GetCalendarState Source #
Instance details Defined in Amazonka.SSM.GetCalendarState type Rep GetCalendarState = D1 ('MetaData "GetCalendarState" "Amazonka.SSM.GetCalendarState" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetCalendarState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "atTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "calendarNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newGetCalendarState :: GetCalendarState Source #

Create a value of GetCalendarState with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

Request Lenses

getCalendarState_atTime :: Lens' GetCalendarState (Maybe Text) Source #

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

getCalendarState_calendarNames :: Lens' GetCalendarState [Text] Source #

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.

Destructuring the Response

data GetCalendarStateResponse Source #

See: newGetCalendarStateResponse smart constructor.

Constructors

GetCalendarStateResponse'

Fields

atTime :: Maybe Text
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 :: Maybe Text
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.
state :: Maybe CalendarState
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetCalendarStateResponse Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Associated Types type Rep GetCalendarStateResponse :: Type -> Type # Methods from :: GetCalendarStateResponse -> Rep GetCalendarStateResponse x # to :: Rep GetCalendarStateResponse x -> GetCalendarStateResponse #
Read GetCalendarStateResponse Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods readsPrec :: Int -> ReadS GetCalendarStateResponse # readList :: ReadS [GetCalendarStateResponse] # readPrec :: ReadPrec GetCalendarStateResponse # readListPrec :: ReadPrec [GetCalendarStateResponse] #
Show GetCalendarStateResponse Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods showsPrec :: Int -> GetCalendarStateResponse -> ShowS # show :: GetCalendarStateResponse -> String # showList :: [GetCalendarStateResponse] -> ShowS #
NFData GetCalendarStateResponse Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods rnf :: GetCalendarStateResponse -> () #
Eq GetCalendarStateResponse Source #
Instance details Defined in Amazonka.SSM.GetCalendarState Methods (==) :: GetCalendarStateResponse -> GetCalendarStateResponse -> Bool # (/=) :: GetCalendarStateResponse -> GetCalendarStateResponse -> Bool #
type Rep GetCalendarStateResponse Source #
Instance details Defined in Amazonka.SSM.GetCalendarState type Rep GetCalendarStateResponse = D1 ('MetaData "GetCalendarStateResponse" "Amazonka.SSM.GetCalendarState" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetCalendarStateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "atTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextTransitionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CalendarState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetCalendarStateResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetCalendarStateResponse'`
-> GetCalendarStateResponse

Create a value of GetCalendarStateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:nextTransitionTime:GetCalendarStateResponse', getCalendarStateResponse_nextTransitionTime - 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.

GetCalendarStateResponse, getCalendarStateResponse_state - 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.

$sel:httpStatus:GetCalendarStateResponse', getCalendarStateResponse_httpStatus - The response's http status code.

Response Lenses

getCalendarStateResponse_atTime :: Lens' GetCalendarStateResponse (Maybe Text) Source #

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.

getCalendarStateResponse_nextTransitionTime :: Lens' GetCalendarStateResponse (Maybe Text) Source #

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.

getCalendarStateResponse_state :: Lens' GetCalendarStateResponse (Maybe CalendarState) Source #

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.

getCalendarStateResponse_httpStatus :: Lens' GetCalendarStateResponse Int Source #

The response's http status code.