Package software.amazon.awssdk.services.ssm.model

Class SessionFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.SessionFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SessionFilter.Builder,SessionFilter>

@Generated("software.amazon.awssdk:codegen")
public final class SessionFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SessionFilter.Builder,SessionFilter>

Describes a filter for Session Manager information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SessionFilter.Builder

Method Summary

Modifier and Type	Method	Description
static SessionFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SessionFilterKey	key()	The name of the filter.
String	keyAsString()	The name of the filter.
List<SdkField<?>>	sdkFields()
static Class<? extends SessionFilter.Builder>	serializableBuilderClass()
SessionFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	The filter value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

key

public final SessionFilterKey key()

The name of the filter.

If the service returns an enum value that is not available in the current SDK version, key will return SessionFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The name of the filter.

See Also:

SessionFilterKey

keyAsString

public final String keyAsString()

The name of the filter.

If the service returns an enum value that is not available in the current SDK version, key will return SessionFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The name of the filter.

See Also:

SessionFilterKey

value

public final String 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.

Returns:

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.

toBuilder

public SessionFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SessionFilter.Builder,SessionFilter>

builder

public static SessionFilter.Builder builder()

serializableBuilderClass

public static Class<? extends SessionFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo