CmdID / aws / aws ssm

aws ssm describe-sessions

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

2 examples 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To list all active Session Manager sessions

The following describe-sessions example retrieves a list of the active sessions created most recently (both connected and disconnected sessions) over the past 30 days that were started by the specified user. This command returns only results for connections to targets initiated using Session Manager. It does not list connections made through other means, such as Remote Desktop Connections or SSH.

aws ssm describe-sessions --state "Active" --filters "key=Owner,value=arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez"

Identify

--stateThe session status to retrieve a list of sessions for.

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

Its output

{
    "Sessions": [
        {
            "SessionId": "John-07a16060613c408b5",
            "Target": "i-1234567890abcdef0",
            "Status": "Connected",
            "StartDate": 1550676938.352,
            "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez",
            "OutputUrl": {}
        },
        {
            "SessionId": "John-01edf534b8b56e8eb",
            "Target": "i-9876543210abcdef0",
            "Status": "Connected",
            "StartDate": 1550676842.194,
            "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez",
            "OutputUrl": {}
        }
    ]
}

Example 2: To list all terminated Session Manager sessions

The following describe-sessions example retrieves a list of the most recently terminated sessions from the past 30 days for all users.

aws ssm describe-sessions --state "History"Identify

--stateThe session status to retrieve a list of sessions for.

Its output

{
    "Sessions": [
        {
            "SessionId": "Mary-Major-0022b1eb2b0d9e3bd",
            "Target": "i-1234567890abcdef0",
            "Status": "Terminated",
            "StartDate": 1550520701.256,
            "EndDate": 1550521931.563,
            "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Mary-Major"
        },
        {
            "SessionId": "Jane-Roe-0db53f487931ed9d4",
            "Target": "i-9876543210abcdef0",
            "Status": "Terminated",
            "StartDate": 1550161369.149,
            "EndDate": 1550162580.329,
            "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Jane-Roe"
        }
    ],
    "NextToken": "--token string truncated--"
}

For more information, see View Session History in the AWS Systems Manager User Guide.

Options

4 in the AWS CLI reference

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

--max-resultsThe maximum number of items to return for this call.

--next-tokenThe token for the next set of items to return.

--stateThe session status to retrieve a list of sessions for.