Class AdminRevokeUserSessionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.AdminRevokeUserSessionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AdminRevokeUserSessionRequest.Builder,AdminRevokeUserSessionRequest>
@Generated("software.amazon.awssdk:codegen") public final class AdminRevokeUserSessionRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<AdminRevokeUserSessionRequest.Builder,AdminRevokeUserSessionRequest>

  • Method Details

    • userPoolId

      public final String userPoolId()

      The ID of the user pool that contains the session.

      Returns:
      The ID of the user pool that contains the session.

    • username

      public final String username()

      The username of the user who owns the session. The username must match the user associated with the SessionId, to confirm they are the intended target user.

      Returns:
      The username of the user who owns the session. The username must match the user associated with the SessionId, to confirm they are the intended target user.

    • sessionId

      public final String sessionId()

      The ID of the session to revoke. This is a 28-character string of lowercase letters and digits, prefixed with tkn for a token session or sso for an SSO session.

      Returns:
      The ID of the session to revoke. This is a 28-character string of lowercase letters and digits, prefixed with tkn for a token session or sso for an SSO session.

    • revokeAssociatedSessions

      public final RevokeAssociatedSessionsType revokeAssociatedSessions()

      Specifies whether to also revoke the sessions that are linked to the targeted session. NONE, the default, revokes only the targeted session. LINKED also revokes the directly linked session or sessions, interpreted relative to the type of the targeted session: revoking a token session also revokes the parent SSO session it came through, and revoking an SSO session also revokes the token sessions that came through it. The set of linked sessions is eventually consistent, so associated sessions are typically revoked within a few seconds.

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

      Returns:
      Specifies whether to also revoke the sessions that are linked to the targeted session. NONE, the default, revokes only the targeted session. LINKED also revokes the directly linked session or sessions, interpreted relative to the type of the targeted session: revoking a token session also revokes the parent SSO session it came through, and revoking an SSO session also revokes the token sessions that came through it. The set of linked sessions is eventually consistent, so associated sessions are typically revoked within a few seconds.
      See Also:

    • revokeAssociatedSessionsAsString

      public final String revokeAssociatedSessionsAsString()

      Specifies whether to also revoke the sessions that are linked to the targeted session. NONE, the default, revokes only the targeted session. LINKED also revokes the directly linked session or sessions, interpreted relative to the type of the targeted session: revoking a token session also revokes the parent SSO session it came through, and revoking an SSO session also revokes the token sessions that came through it. The set of linked sessions is eventually consistent, so associated sessions are typically revoked within a few seconds.

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

      Returns:
      Specifies whether to also revoke the sessions that are linked to the targeted session. NONE, the default, revokes only the targeted session. LINKED also revokes the directly linked session or sessions, interpreted relative to the type of the targeted session: revoking a token session also revokes the parent SSO session it came through, and revoking an SSO session also revokes the token sessions that came through it. The set of linked sessions is eventually consistent, so associated sessions are typically revoked within a few seconds.
      See Also:

    • toBuilder

      public AdminRevokeUserSessionRequest.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<AdminRevokeUserSessionRequest.Builder,AdminRevokeUserSessionRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest
      Returns:
      a builder for type T

    • builder

      public static AdminRevokeUserSessionRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final 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 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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 final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.