Skip to content

aws.iam.get_group

Example SQL Queries

SELECT * FROM
aws.iam.get_group
WHERE
"group_name" = 'VALUE';

Description

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

Table Definition

Column NameColumn Data Type
group_name Required Input Column

The name of the group.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

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.

group

A structure that contains details about the group.

STRUCT(
"path" VARCHAR,
"group_name" VARCHAR,
"group_id" VARCHAR,
"arn" VARCHAR,
"create_date" TIMESTAMP_S
)
Show child fields
group.arn

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.

group.create_date

The date and time, in ISO 8601 date-time format, when the group was created.

group.group_id

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

group.group_name

The friendly name that identifies the group.

group.path

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

users

A list of users in the group.

STRUCT(
"path" VARCHAR,
"user_name" VARCHAR,
"user_id" VARCHAR,
"arn" VARCHAR,
"create_date" TIMESTAMP_S,
"password_last_used" TIMESTAMP_S,
"permissions_boundary" STRUCT(
"permissions_boundary_type" VARCHAR,
"permissions_boundary_arn" VARCHAR
),
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
Show child fields
users[]
Show child fields
users[].arn

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

users[].create_date

The date and time, in ISO 8601 date-time format, when the user was created.

users[].password_last_used

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the Credential reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

users[].path

The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.

The ARN of the policy used to set the permissions boundary for the user.

users[].permissions_boundary

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

Show child fields
users[].permissions_boundary.permissions_boundary_arn

The ARN of the policy used to set the permissions boundary for the user or role.

users[].permissions_boundary.permissions_boundary_type

The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy.

users[].tags[]
Show child fields
users[].tags[].key

The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

users[].tags[].value

The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

users[].user_id

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

users[].user_name

The friendly name identifying the user.