Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminUserGlobalSignOutRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AdminUserGlobalSignOutRequest.Builder,AdminUserGlobalSignOutRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AdminUserGlobalSignOutRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<AdminUserGlobalSignOutRequest.Builder,AdminUserGlobalSignOutRequest>

The request to sign out of all devices, as an administrator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdminUserGlobalSignOutRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AdminUserGlobalSignOutRequest.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends AdminUserGlobalSignOutRequest.Builder>	serializableBuilderClass()
AdminUserGlobalSignOutRequest.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final String	username()	The name of the user that you want to query or modify.
final String	userPoolId()	The ID of the user pool where you want to sign out a user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 Details

userPoolId

public final String userPoolId()

The ID of the user pool where you want to sign out a user.

Returns:

The ID of the user pool where you want to sign out a user.

username

public final String username()

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

toBuilder

public AdminUserGlobalSignOutRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdminUserGlobalSignOutRequest.Builder,AdminUserGlobalSignOutRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static AdminUserGlobalSignOutRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AdminUserGlobalSignOutRequest.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)

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo