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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
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() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

sessionId

public String sessionId()

The ID of the session.

Returns:

The ID of the session.

tokenValue

public 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 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 AWS Region supported by AWS 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 AWS 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 AWS Region supported by AWS 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 AWS General Reference.

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

toBuilder

public StartSessionResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartSessionResponse.Builder,StartSessionResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static StartSessionResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.