groups_for_users

Creates, updates, deletes, gets or lists a groups_for_users resource.

Overview

Name	groups_for_users
Type	Resource
Id	aws.iam.groups_for_users

Fields

The following fields are returned by SELECT queries:

list_groups_for_user

Name	Datatype	Description
arn	string	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.
create_date	string	The date and time, in ISO 8601 date-time format, when the group was created.
group_id	string	The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.
group_name	string	The friendly name that identifies the group.
path	string	The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_groups_for_user	select	UserName, region	Marker, MaxItems	Lists the IAM groups that the specified IAM user belongs to. You can paginate the results using the MaxItems and Marker parameters.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
UserName	string	The name of the user to list groups for. 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: _+=,.@-
region	string	AWS region (default: us-east-1)
Marker	string	Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
MaxItems	integer	Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

SELECT examples

list_groups_for_user

Lists the IAM groups that the specified IAM user belongs to. You can paginate the results using the MaxItems and Marker parameters.

SELECT
arn,
create_date,
group_id,
group_name,
path
FROM aws.iam.groups_for_users
WHERE UserName = '{{ UserName }}' -- required
AND region = '{{ region }}' -- required
AND Marker = '{{ Marker }}'
AND MaxItems = '{{ MaxItems }}'
;