Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.Types.Session

Description

Synopsis

data Session = Session' {
- status :: Maybe SessionStatus
- outputUrl :: Maybe SessionManagerOutputUrl
- documentName :: Maybe Text
- endDate :: Maybe POSIX
- owner :: Maybe Text
- startDate :: Maybe POSIX
- details :: Maybe Text
- sessionId :: Maybe Text
- target :: Maybe Text
}
newSession :: Session
session_status :: Lens' Session (Maybe SessionStatus)
session_outputUrl :: Lens' Session (Maybe SessionManagerOutputUrl)
session_documentName :: Lens' Session (Maybe Text)
session_endDate :: Lens' Session (Maybe UTCTime)
session_owner :: Lens' Session (Maybe Text)
session_startDate :: Lens' Session (Maybe UTCTime)
session_details :: Lens' Session (Maybe Text)
session_sessionId :: Lens' Session (Maybe Text)
session_target :: Lens' Session (Maybe Text)

Documentation

data Session Source #

Information about a Session Manager connection to an instance.

See: newSession smart constructor.

Constructors

Session'

Fields

status :: Maybe SessionStatus
The status of the session. For example, "Connected" or "Terminated".
outputUrl :: Maybe SessionManagerOutputUrl
Reserved for future use.
documentName :: Maybe Text
The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.
endDate :: Maybe POSIX
The date and time, in ISO-8601 Extended format, when the session was terminated.
owner :: Maybe Text
The ID of the Amazon Web Services user account that started the session.
startDate :: Maybe POSIX
The date and time, in ISO-8601 Extended format, when the session began.
details :: Maybe Text
Reserved for future use.
sessionId :: Maybe Text
The ID of the session.
target :: Maybe Text
The instance that the Session Manager session connected to.

Instances

Instances details

Eq Session Source #
Instance details Defined in Amazonka.SSM.Types.Session Methods (==) :: Session -> Session -> Bool # (/=) :: Session -> Session -> Bool #
Read Session Source #
Instance details Defined in Amazonka.SSM.Types.Session Methods readsPrec :: Int -> ReadS Session # readList :: ReadS [Session] # readPrec :: ReadPrec Session # readListPrec :: ReadPrec [Session] #
Show Session Source #
Instance details Defined in Amazonka.SSM.Types.Session Methods showsPrec :: Int -> Session -> ShowS # show :: Session -> String # showList :: [Session] -> ShowS #
Generic Session Source #
Instance details Defined in Amazonka.SSM.Types.Session Associated Types type Rep Session :: Type -> Type # Methods from :: Session -> Rep Session x # to :: Rep Session x -> Session #
NFData Session Source #
Instance details Defined in Amazonka.SSM.Types.Session Methods rnf :: Session -> () #
Hashable Session Source #
Instance details Defined in Amazonka.SSM.Types.Session Methods hashWithSalt :: Int -> Session -> Int # hash :: Session -> Int #
FromJSON Session Source #
Instance details Defined in Amazonka.SSM.Types.Session Methods parseJSON :: Value -> Parser Session # parseJSONList :: Value -> Parser [Session] #
type Rep Session Source #
Instance details Defined in Amazonka.SSM.Types.Session type Rep Session = D1 ('MetaData "Session" "Amazonka.SSM.Types.Session" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "Session'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionStatus)) :: S1 ('MetaSel ('Just "outputUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionManagerOutputUrl))) :: (S1 ('MetaSel ('Just "documentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newSession :: Session Source #

Create a value of Session 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:

$sel:status:Session', session_status - The status of the session. For example, "Connected" or "Terminated".

$sel:outputUrl:Session', session_outputUrl - Reserved for future use.

$sel:documentName:Session', session_documentName - The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

$sel:endDate:Session', session_endDate - The date and time, in ISO-8601 Extended format, when the session was terminated.

$sel:owner:Session', session_owner - The ID of the Amazon Web Services user account that started the session.

$sel:startDate:Session', session_startDate - The date and time, in ISO-8601 Extended format, when the session began.

$sel:details:Session', session_details - Reserved for future use.

$sel:sessionId:Session', session_sessionId - The ID of the session.

$sel:target:Session', session_target - The instance that the Session Manager session connected to.

session_status :: Lens' Session (Maybe SessionStatus) Source #

The status of the session. For example, "Connected" or "Terminated".

session_outputUrl :: Lens' Session (Maybe SessionManagerOutputUrl) Source #

Reserved for future use.

session_documentName :: Lens' Session (Maybe Text) Source #

The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

session_endDate :: Lens' Session (Maybe UTCTime) Source #

The date and time, in ISO-8601 Extended format, when the session was terminated.

session_owner :: Lens' Session (Maybe Text) Source #

The ID of the Amazon Web Services user account that started the session.

session_startDate :: Lens' Session (Maybe UTCTime) Source #

The date and time, in ISO-8601 Extended format, when the session began.

session_details :: Lens' Session (Maybe Text) Source #

Reserved for future use.

session_sessionId :: Lens' Session (Maybe Text) Source #

The ID of the session.

session_target :: Lens' Session (Maybe Text) Source #

The instance that the Session Manager session connected to.