groups_for_members
Creates, updates, deletes, gets or lists a groups_for_members resource.
Overview
| Name | groups_for_members |
| Type | Resource |
| Id | aws.ds_data.groups_for_members |
Fields
The following fields are returned by SELECT queries:
- list_groups_for_member
| Name | Datatype | Description |
|---|---|---|
group_scope | string | The scope of the AD group. For details, see Active Directory security groups. (DomainLocal, Global, Universal, BuiltinLocal) |
group_type | string | The AD group type. For details, see Active Directory security group type. (Distribution, Security) |
sam_account_name | string | The name of the group. (pattern: <code>^[^:;|=+"*?<>/\,[]@]+$</code>) |
sid | string | The unique security identifier (SID) of the group. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_groups_for_member | select | DirectoryId, region | Returns group information for the specified member. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupsForMember.NextToken member contains a token that you pass in the next call to ListGroupsForMember. This retrieves the next set of items. You can also specify a maximum number of return results with the MaxResults parameter. |
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 |
|---|---|---|
DirectoryId | string | The identifier (ID) of the directory that's associated with the member. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_groups_for_member
Returns group information for the specified member. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupsForMember.NextToken member contains a token that you pass in the next call to ListGroupsForMember. This retrieves the next set of items. You can also specify a maximum number of return results with the MaxResults parameter.
SELECT
group_scope,
group_type,
sam_account_name,
sid
FROM aws.ds_data.groups_for_members
WHERE DirectoryId = '{{ DirectoryId }}' -- required
AND region = '{{ region }}' -- required
;