選取您的 Cookie 偏好設定

我們使用提供自身網站和服務所需的基本 Cookie 和類似工具。我們使用效能 Cookie 收集匿名統計資料,以便了解客戶如何使用我們的網站並進行改進。基本 Cookie 無法停用,但可以按一下「自訂」或「拒絕」以拒絕效能 Cookie。

如果您同意,AWS 與經核准的第三方也會使用 Cookie 提供實用的網站功能、記住您的偏好設定,並顯示相關內容,包括相關廣告。若要接受或拒絕所有非必要 Cookie,請按一下「接受」或「拒絕」。若要進行更詳細的選擇,請按一下「自訂」。

DescribeSessions - AWS Systems Manager
此頁面尚未翻譯為您的語言。 請求翻譯

DescribeSessions

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

Request Syntax

{ "Filters": [ { "key": "string", "value": "string" } ], "MaxResults": number, "NextToken": "string", "State": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

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

Type: Array of SessionFilter objects

Array Members: Minimum number of 1 item. Maximum number of 6 items.

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 200.

Required: No

NextToken

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

Type: String

Required: No

State

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

Type: String

Valid Values: Active | History

Required: Yes

Response Syntax

{ "NextToken": "string", "Sessions": [ { "Details": "string", "DocumentName": "string", "EndDate": number, "MaxSessionDuration": "string", "OutputUrl": { "CloudWatchOutputUrl": "string", "S3OutputUrl": "string" }, "Owner": "string", "Reason": "string", "SessionId": "string", "StartDate": number, "Status": "string", "Target": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

Sessions

A list of sessions meeting the request parameters.

Type: Array of Session objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidFilterKey

The specified key isn't valid.

HTTP Status Code: 400

InvalidNextToken

The specified token isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeSessions.

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeSessions Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4 X-Amz-Date: 20240221T175636Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 20 { "State": "History" }

Sample Response

{ "Sessions": [ { "EndDate": 1582069847.807, "OutputUrl": { "S3OutputUrl": "https://us-east-2.console.aws.amazon.com/s3/object/amzn-s3-demo-bucket/session-data/Mary-Major-0ab177d470EXAMPLE.log" }, "Owner": "arn:aws:iam::111122223333:user/Mary-Major", "SessionId": "Mary-Major-0ab177d470EXAMPLE", "StartDate": 1582068633.188, "Status": "Terminated", "Target": "i-07782c72faEXAMPLE" } // There may be more content here ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

隱私權網站條款Cookie 偏好設定
© 2025, Amazon Web Services, Inc.或其附屬公司。保留所有權利。