Class ListUsersRequest

    • Constructor Detail

      • ListUsersRequest

        public ListUsersRequest()
    • Method Detail

      • setUserPoolId

        public void setUserPoolId​(String userPoolId)

        The user pool ID for which you want to list users.

        Parameters:
        userPoolId - The user pool ID for which you want to list users.
      • getUserPoolId

        public String getUserPoolId()

        The user pool ID for which you want to list users.

        Returns:
        The user pool ID for which you want to list users.
      • withUserPoolId

        public ListUsersRequest withUserPoolId​(String userPoolId)

        The user pool ID for which you want to list users.

        Parameters:
        userPoolId - The user pool ID for which you want to list users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getAttributesToGet

        public List<String> getAttributesToGet()

        The attributes to get from the request to list users.

        Returns:
        The attributes to get from the request to list users.
      • setAttributesToGet

        public void setAttributesToGet​(Collection<String> attributesToGet)

        The attributes to get from the request to list users.

        Parameters:
        attributesToGet - The attributes to get from the request to list users.
      • withAttributesToGet

        public ListUsersRequest withAttributesToGet​(String... attributesToGet)

        The attributes to get from the request to list users.

        NOTE: This method appends the values to the existing list (if any). Use setAttributesToGet(java.util.Collection) or withAttributesToGet(java.util.Collection) if you want to override the existing values.

        Parameters:
        attributesToGet - The attributes to get from the request to list users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withAttributesToGet

        public ListUsersRequest withAttributesToGet​(Collection<String> attributesToGet)

        The attributes to get from the request to list users.

        Parameters:
        attributesToGet - The attributes to get from the request to list users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setLimit

        public void setLimit​(Integer limit)

        The limit of the request to list users.

        Parameters:
        limit - The limit of the request to list users.
      • getLimit

        public Integer getLimit()

        The limit of the request to list users.

        Returns:
        The limit of the request to list users.
      • withLimit

        public ListUsersRequest withLimit​(Integer limit)

        The limit of the request to list users.

        Parameters:
        limit - The limit of the request to list users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setPaginationToken

        public void setPaginationToken​(String paginationToken)

        An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

        Parameters:
        paginationToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
      • getPaginationToken

        public String getPaginationToken()

        An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

        Returns:
        An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
      • withPaginationToken

        public ListUsersRequest withPaginationToken​(String paginationToken)

        An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

        Parameters:
        paginationToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setUserStatus

        public void setUserStatus​(String userStatus)

        The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        Parameters:
        userStatus - The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        See Also:
        UserStatusType
      • getUserStatus

        public String getUserStatus()

        The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        Returns:
        The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        See Also:
        UserStatusType
      • withUserStatus

        public ListUsersRequest withUserStatus​(String userStatus)

        The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        Parameters:
        userStatus - The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UserStatusType
      • setUserStatus

        public void setUserStatus​(UserStatusType userStatus)

        The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        Parameters:
        userStatus - The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        See Also:
        UserStatusType
      • withUserStatus

        public ListUsersRequest withUserStatus​(UserStatusType userStatus)

        The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        Parameters:
        userStatus - The user status. Can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.
        • CONFIRMED - User has been confirmed.
        • ARCHIVED - User is no longer active.
        • COMPROMISED - User is disabled due to a potential security threat.
        • UNKNOWN - User status is not known.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UserStatusType
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object