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

Description

Synopsis

data SessionFilter = SessionFilter' {
- key :: SessionFilterKey
- value :: Text
}
newSessionFilter :: SessionFilterKey -> Text -> SessionFilter
sessionFilter_key :: Lens' SessionFilter SessionFilterKey
sessionFilter_value :: Lens' SessionFilter Text

Documentation

data SessionFilter Source #

Describes a filter for Session Manager information.

See: newSessionFilter smart constructor.

Constructors

SessionFilter'

Fields

key :: SessionFilterKey
The name of the filter.
value :: Text
The filter value. Valid values for each filter key are as follows:
- InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
- InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
- Target: Specify an instance to which session connections have been made.
- Owner: Specify an Amazon Web Services user account to see a list of sessions started by that user.
- Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:
  - Connected
  - Connecting
  - Disconnected
  - Terminated
  - Terminating
  - Failed
- SessionId: Specify a session ID to return details about the session.

Instances

Instances details

Eq SessionFilter Source #
Instance details Defined in Amazonka.SSM.Types.SessionFilter Methods (==) :: SessionFilter -> SessionFilter -> Bool # (/=) :: SessionFilter -> SessionFilter -> Bool #
Read SessionFilter Source #
Instance details Defined in Amazonka.SSM.Types.SessionFilter Methods readsPrec :: Int -> ReadS SessionFilter # readList :: ReadS [SessionFilter] # readPrec :: ReadPrec SessionFilter # readListPrec :: ReadPrec [SessionFilter] #
Show SessionFilter Source #
Instance details Defined in Amazonka.SSM.Types.SessionFilter Methods showsPrec :: Int -> SessionFilter -> ShowS # show :: SessionFilter -> String # showList :: [SessionFilter] -> ShowS #
Generic SessionFilter Source #
Instance details Defined in Amazonka.SSM.Types.SessionFilter Associated Types type Rep SessionFilter :: Type -> Type # Methods from :: SessionFilter -> Rep SessionFilter x # to :: Rep SessionFilter x -> SessionFilter #
NFData SessionFilter Source #
Instance details Defined in Amazonka.SSM.Types.SessionFilter Methods rnf :: SessionFilter -> () #
Hashable SessionFilter Source #
Instance details Defined in Amazonka.SSM.Types.SessionFilter Methods hashWithSalt :: Int -> SessionFilter -> Int # hash :: SessionFilter -> Int #
ToJSON SessionFilter Source #
Instance details Defined in Amazonka.SSM.Types.SessionFilter Methods toJSON :: SessionFilter -> Value # toEncoding :: SessionFilter -> Encoding # toJSONList :: [SessionFilter] -> Value # toEncodingList :: [SessionFilter] -> Encoding #
type Rep SessionFilter Source #
Instance details Defined in Amazonka.SSM.Types.SessionFilter type Rep SessionFilter = D1 ('MetaData "SessionFilter" "Amazonka.SSM.Types.SessionFilter" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "SessionFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SessionFilterKey) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSessionFilter Source #

Arguments

:: SessionFilterKey	`$sel:key:SessionFilter'`
-> Text	`$sel:value:SessionFilter'`
-> SessionFilter

Create a value of SessionFilter 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:key:SessionFilter', sessionFilter_key - The name of the filter.

$sel:value:SessionFilter', sessionFilter_value - The filter value. Valid values for each filter key are as follows:

InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
Target: Specify an instance to which session connections have been made.
Owner: Specify an Amazon Web Services user account to see a list of sessions started by that user.
Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:
- Connected
- Connecting
- Disconnected
- Terminated
- Terminating
- Failed
SessionId: Specify a session ID to return details about the session.

sessionFilter_key :: Lens' SessionFilter SessionFilterKey Source #

The name of the filter.

sessionFilter_value :: Lens' SessionFilter Text Source #

The filter value. Valid values for each filter key are as follows:

InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
Target: Specify an instance to which session connections have been made.
Owner: Specify an Amazon Web Services user account to see a list of sessions started by that user.
Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:
- Connected
- Connecting
- Disconnected
- Terminated
- Terminating
- Failed
SessionId: Specify a session ID to return details about the session.