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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

This operation returns paginated results.

Synopsis

data DescribeSessions = DescribeSessions' {
- filters :: Maybe (NonEmpty SessionFilter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- state :: SessionState
}
newDescribeSessions :: SessionState -> DescribeSessions
describeSessions_filters :: Lens' DescribeSessions (Maybe (NonEmpty SessionFilter))
describeSessions_maxResults :: Lens' DescribeSessions (Maybe Natural)
describeSessions_nextToken :: Lens' DescribeSessions (Maybe Text)
describeSessions_state :: Lens' DescribeSessions SessionState
data DescribeSessionsResponse = DescribeSessionsResponse' {
- nextToken :: Maybe Text
- sessions :: Maybe [Session]
- httpStatus :: Int
}
newDescribeSessionsResponse :: Int -> DescribeSessionsResponse
describeSessionsResponse_nextToken :: Lens' DescribeSessionsResponse (Maybe Text)
describeSessionsResponse_sessions :: Lens' DescribeSessionsResponse (Maybe [Session])
describeSessionsResponse_httpStatus :: Lens' DescribeSessionsResponse Int

Creating a Request

data DescribeSessions Source #

See: newDescribeSessions smart constructor.

Constructors

DescribeSessions'

Fields

filters :: Maybe (NonEmpty SessionFilter)
One or more filters to limit the type of sessions returned by the request.
maxResults :: Maybe Natural
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
state :: SessionState
The session status to retrieve a list of sessions for. For example, "Active".

Instances

Instances details

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

newDescribeSessions Source #

Arguments

:: SessionState	`DescribeSessions`
-> DescribeSessions

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

DescribeSessions, describeSessions_filters - One or more filters to limit the type of sessions returned by the request.

$sel:maxResults:DescribeSessions', describeSessions_maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

DescribeSessions, describeSessions_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

DescribeSessions, describeSessions_state - The session status to retrieve a list of sessions for. For example, "Active".

Request Lenses

describeSessions_filters :: Lens' DescribeSessions (Maybe (NonEmpty SessionFilter)) Source #

One or more filters to limit the type of sessions returned by the request.

describeSessions_maxResults :: Lens' DescribeSessions (Maybe Natural) Source #

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

describeSessions_nextToken :: Lens' DescribeSessions (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeSessions_state :: Lens' DescribeSessions SessionState Source #

The session status to retrieve a list of sessions for. For example, "Active".

Destructuring the Response

data DescribeSessionsResponse Source #

See: newDescribeSessionsResponse smart constructor.

Constructors

DescribeSessionsResponse'
Fields nextToken :: Maybe Text The token for the next set of items to return. (You received this token from a previous call.) sessions :: Maybe [Session] A list of sessions meeting the request parameters. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeSessionsResponse Source #

Arguments

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

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

DescribeSessions, describeSessionsResponse_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:sessions:DescribeSessionsResponse', describeSessionsResponse_sessions - A list of sessions meeting the request parameters.

$sel:httpStatus:DescribeSessionsResponse', describeSessionsResponse_httpStatus - The response's http status code.

Response Lenses

describeSessionsResponse_nextToken :: Lens' DescribeSessionsResponse (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeSessionsResponse_sessions :: Lens' DescribeSessionsResponse (Maybe [Session]) Source #

A list of sessions meeting the request parameters.

describeSessionsResponse_httpStatus :: Lens' DescribeSessionsResponse Int Source #

The response's http status code.