Interface AdminGetUserResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CognitoIdentityProviderResponse.Builder
,CopyableBuilder<AdminGetUserResponse.Builder,
,AdminGetUserResponse> SdkBuilder<AdminGetUserResponse.Builder,
,AdminGetUserResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
AdminGetUserResponse
-
Method Summary
Modifier and TypeMethodDescriptionIndicates that the status isenabled
.mfaOptions
(Collection<MFAOptionType> mfaOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.mfaOptions
(Consumer<MFAOptionType.Builder>... mfaOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.mfaOptions
(MFAOptionType... mfaOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.preferredMfaSetting
(String preferredMfaSetting) The user's preferred MFA setting.userAttributes
(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.userAttributes
(Consumer<AttributeType.Builder>... userAttributes) An array of name-value pairs representing user attributes.userAttributes
(AttributeType... userAttributes) An array of name-value pairs representing user attributes.userCreateDate
(Instant userCreateDate) The date the user was created.userLastModifiedDate
(Instant userLastModifiedDate) The date and time, in ISO 8601 format, when the item was modified.userMFASettingList
(String... userMFASettingList) The MFA options that are activated for the user.userMFASettingList
(Collection<String> userMFASettingList) The MFA options that are activated for the user.The username of the user that you requested.userStatus
(String userStatus) The user status.userStatus
(UserStatusType userStatus) The user status.Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
username
The username of the user that you requested.
- Parameters:
username
- The username of the user that you requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userAttributes
An array of name-value pairs representing user attributes.
- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userAttributes
An array of name-value pairs representing user attributes.
- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userAttributes
An array of name-value pairs representing user attributes.
This is a convenience method that creates an instance of theAttributeType.Builder
avoiding the need to create one manually viaAttributeType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserAttributes(List<AttributeType>)
.- Parameters:
userAttributes
- a consumer that will call methods onAttributeType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
userCreateDate
The date the user was created.
- Parameters:
userCreateDate
- The date the user was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userLastModifiedDate
The date and time, in ISO 8601 format, when the item was modified.
- Parameters:
userLastModifiedDate
- The date and time, in ISO 8601 format, when the item was modified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enabled
Indicates that the status is
enabled
.- Parameters:
enabled
- Indicates that the status isenabled
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userStatus
The user status. Can be one of the following:
-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
- Parameters:
userStatus
- The user status. Can be one of the following:-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
userStatus
The user status. Can be one of the following:
-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
- Parameters:
userStatus
- The user status. Can be one of the following:-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
mfaOptions
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
- Parameters:
mfaOptions
- This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mfaOptions
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
- Parameters:
mfaOptions
- This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mfaOptions
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
This is a convenience method that creates an instance of theMFAOptionType.Builder
avoiding the need to create one manually viaMFAOptionType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomfaOptions(List<MFAOptionType>)
.- Parameters:
mfaOptions
- a consumer that will call methods onMFAOptionType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
preferredMfaSetting
The user's preferred MFA setting.
- Parameters:
preferredMfaSetting
- The user's preferred MFA setting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userMFASettingList
The MFA options that are activated for the user. The possible values in this list are
SMS_MFA
andSOFTWARE_TOKEN_MFA
.- Parameters:
userMFASettingList
- The MFA options that are activated for the user. The possible values in this list areSMS_MFA
andSOFTWARE_TOKEN_MFA
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userMFASettingList
The MFA options that are activated for the user. The possible values in this list are
SMS_MFA
andSOFTWARE_TOKEN_MFA
.- Parameters:
userMFASettingList
- The MFA options that are activated for the user. The possible values in this list areSMS_MFA
andSOFTWARE_TOKEN_MFA
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-