software.amazon.awssdk.services.ssm.model

Class StartSessionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ssm.model.SsmResponse

software.amazon.awssdk.services.ssm.model.StartSessionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSessionResponse.Builder,StartSessionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartSessionResponse
extends SsmResponse
implements ToCopyableBuilder<StartSessionResponse.Builder,StartSessionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartSessionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static StartSessionResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends StartSessionResponse.Builder>	serializableBuilderClass()
String	sessionId() The ID of the session.
String	streamUrl() A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance.
StartSessionResponse.Builder	toBuilder()
String	tokenValue() An encrypted token value containing session and caller information.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

sessionId

public final String sessionId()

The ID of the session.

Returns:

The ID of the session.

tokenValue

public final String tokenValue()

An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.

Returns:

An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.

streamUrl

public final String streamUrl()

A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

Returns:

A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

toBuilder

public StartSessionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartSessionResponse.Builder,StartSessionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static StartSessionResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo