Skip to content
AWS for Query.Farm

aws.cognito_idp.list_users_in_group

Example SQL Queries

SELECT * FROM
aws.cognito_idp.list_users_in_group
WHERE
"user_pool_id" = 'VALUE'
AND "group_name" = 'VALUE';

Description

Lists the users in the specified group.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Table Definition

Column NameColumn Data Type
group_name Required Input Column

The name of the group.

VARCHAR
user_pool_id Required Input Column

The user pool ID for the user pool.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
attributes

A container with information about the user type attributes.

STRUCT(
    "name" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
attributes[]
Show child fields
attributes[].name

The name of the attribute.

attributes[].value

The value of the attribute.

enabled

Specifies whether the user is enabled.

BOOLEAN
mfa_options

The MFA options for the user.

STRUCT(
    "delivery_medium" VARCHAR,
    "attribute_name" VARCHAR
)[]
Show child fields
mfa_options[]
Show child fields
mfa_options[].attribute_name

The attribute name of the MFA option type. The only valid value is phone_number.

mfa_options[].delivery_medium

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

user_create_date

The creation date of the user.

TIMESTAMP_S
user_last_modified_date

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

TIMESTAMP_S
user_status

The user status. This can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • EXTERNAL_PROVIDER - User signed in with a third-party IdP.

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

VARCHAR
username

The user name of the user you want to describe.

VARCHAR