SSM / Paginator / DescribeSessions
DescribeSessions#
- class SSM.Paginator.DescribeSessions#
paginator = client.get_paginator('describe_sessions')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SSM.Client.describe_sessions()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( State='Active'|'History', Filters=[ { 'key': 'InvokedAfter'|'InvokedBefore'|'Target'|'Owner'|'Status'|'SessionId', 'value': 'string' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
State (string) –
[REQUIRED]
The session status to retrieve a list of sessions for. For example, “Active”.
Filters (list) –
One or more filters to limit the type of sessions returned by the request.
(dict) –
Describes a filter for Session Manager information.
key (string) – [REQUIRED]
The name of the filter.
value (string) – [REQUIRED]
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 a managed node to which session connections have been made.
Owner: Specify an Amazon Web Services user 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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'Sessions': [ { 'SessionId': 'string', 'Target': 'string', 'Status': 'Connected'|'Connecting'|'Disconnected'|'Terminated'|'Terminating'|'Failed', 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'DocumentName': 'string', 'Owner': 'string', 'Reason': 'string', 'Details': 'string', 'OutputUrl': { 'S3OutputUrl': 'string', 'CloudWatchOutputUrl': 'string' }, 'MaxSessionDuration': 'string' }, ], }
Response Structure
(dict) –
Sessions (list) –
A list of sessions meeting the request parameters.
(dict) –
Information about a Session Manager connection to a managed node.
SessionId (string) –
The ID of the session.
Target (string) –
The managed node that the Session Manager session connected to.
Status (string) –
The status of the session. For example, “Connected” or “Terminated”.
StartDate (datetime) –
The date and time, in ISO-8601 Extended format, when the session began.
EndDate (datetime) –
The date and time, in ISO-8601 Extended format, when the session was terminated.
DocumentName (string) –
The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example,
SSM-SessionManagerRunShell
.Owner (string) –
The ID of the Amazon Web Services user that started the session.
Reason (string) –
The reason for connecting to the instance.
Details (string) –
Reserved for future use.
OutputUrl (dict) –
Reserved for future use.
S3OutputUrl (string) –
Reserved for future use.
CloudWatchOutputUrl (string) –
Reserved for future use.
MaxSessionDuration (string) –
The maximum duration of a session before it terminates.