SessionFilter - AWS Systems Manager
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

SessionFilter

Describes a filter for Session Manager information.

Contents

key

The name of the filter.

Type: String

Valid Values: InvokedAfter | InvokedBefore | Target | Owner | Status | SessionId | AccessType

Required: Yes

value

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

  • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2024-08-29T00:00:00Z to see sessions that started August 29, 2024, and later.

  • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2024-08-29T00:00:00Z to see sessions that started before August 29, 2024.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 400.

Required: Yes

See Also

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