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

Interface AdminListGroupsForUserRequest.Builder

    • Method Detail

      • username

        AdminListGroupsForUserRequest.Builder username​(String username)

        The username 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.

        Parameters:
        username - The username 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:
        Returns a reference to this object so that method calls can be chained together.

      • userPoolId

        AdminListGroupsForUserRequest.Builder userPoolId​(String userPoolId)

        The ID of the user pool where you want to view a user's groups.

        Parameters:
        userPoolId - The ID of the user pool where you want to view a user's groups.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • limit

        AdminListGroupsForUserRequest.Builder limit​(Integer limit)

        The maximum number of groups that you want Amazon Cognito to return in the response.

        Parameters:
        limit - The maximum number of groups that you want Amazon Cognito to return in the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        AdminListGroupsForUserRequest.Builder nextToken​(String nextToken)

        This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

        Parameters:
        nextToken - This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
        Returns:
        Returns a reference to this object so that method calls can be chained together.