Actions, resources, and condition keys for AWS Directory Service Data

AWS Directory Service Data (service prefix: ds-data) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Learn how to configure this service.
View a list of the API operations available for this service.
Learn how to secure this service and its resources by using IAM permission policies.

Topics

Actions defined by AWS Directory Service Data
Resource types defined by AWS Directory Service Data
Condition keys for AWS Directory Service Data

Actions defined by AWS Directory Service Data

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
AddGroupMember	Grants permission to add a member to a group on a directory	Write	directory*		ds:AccessDSData
AddGroupMember	Grants permission to add a member to a group on a directory	Write		ds-data:SAMAccountName ds-data:MemberName ds-data:Realm ds-data:MemberRealm ds-data:Identifier
CreateGroup	Grants permission to create a group on a directory	Write	directory*		ds:AccessDSData
CreateGroup	Grants permission to create a group on a directory	Write		ds-data:SAMAccountName ds-data:Identifier ds-data:Realm
CreateUser	Grants permission to create a user on a directory	Write	directory*		ds:AccessDSData
CreateUser	Grants permission to create a user on a directory	Write		ds-data:SAMAccountName ds-data:Identifier ds-data:Realm
DeleteGroup	Grants permission to delete a group on a directory	Write	directory*		ds:AccessDSData
DeleteGroup	Grants permission to delete a group on a directory	Write		ds-data:SAMAccountName ds-data:Identifier ds-data:Realm
DeleteUser	Grants permission to delete a user on a directory	Write	directory*		ds:AccessDSData
DeleteUser	Grants permission to delete a user on a directory	Write		ds-data:SAMAccountName ds-data:Identifier ds-data:Realm
DescribeGroup	Grants permission to describe a group on a directory	Read	directory*		ds:AccessDSData
DescribeGroup	Grants permission to describe a group on a directory	Read		ds-data:SAMAccountName ds-data:Identifier ds-data:Realm
DescribeUser	Grants permission to describe a user on a directory	Read	directory*		ds:AccessDSData
DescribeUser	Grants permission to describe a user on a directory	Read		ds-data:SAMAccountName ds-data:Identifier ds-data:Realm
DisableUser	Grants permission to disable a user on a directory	Write	directory*		ds:AccessDSData
DisableUser	Grants permission to disable a user on a directory	Write		ds-data:SAMAccountName ds-data:Identifier ds-data:Realm
ListGroupMembers	Grants permission to list members in a group on a directory	List	directory*		ds:AccessDSData
ListGroupMembers	Grants permission to list members in a group on a directory	List		ds-data:SAMAccountName ds-data:Realm ds-data:MemberRealm ds-data:Identifier
ListGroups	Grants permission to list groups on a directory	List	directory*		ds:AccessDSData
ListGroups	Grants permission to list groups on a directory	List		ds-data:Realm
ListGroupsForMember	Grants permission to list the groups that a member is in on a directory	List	directory*		ds:AccessDSData
ListGroupsForMember		List		ds-data:SAMAccountName ds-data:Realm ds-data:MemberRealm ds-data:Identifier
ListUsers	Grants permission to list users on a directory	List	directory*		ds:AccessDSData
ListUsers	Grants permission to list users on a directory	List		ds-data:Realm
RemoveGroupMember	Grants permission to remove a member from a group on a directory	Write	directory*		ds:AccessDSData
RemoveGroupMember		Write		ds-data:SAMAccountName ds-data:MemberName ds-data:Realm ds-data:MemberRealm ds-data:Identifier
SearchGroups	Grants permission to search for groups on a directory	Read	directory*		ds-data:DescribeGroup ds:AccessDSData
SearchGroups	Grants permission to search for groups on a directory	Read		ds-data:Realm
SearchUsers	Grants permission to search for users on a directory	Read	directory*		ds-data:DescribeUser ds:AccessDSData
SearchUsers	Grants permission to search for users on a directory	Read		ds-data:Realm
UpdateGroup	Grants permission to update a group on a directory	Write	directory*		ds:AccessDSData
UpdateGroup	Grants permission to update a group on a directory	Write		ds-data:SAMAccountName ds-data:Identifier ds-data:Realm
UpdateUser	Grants permission to update a user on a directory	Write	directory*		ds:AccessDSData
UpdateUser	Grants permission to update a user on a directory	Write		ds-data:SAMAccountName ds-data:Identifier ds-data:Realm

Resource types defined by AWS Directory Service Data

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types	ARN	Condition keys
directory	`arn:${Partition}:ds:${Region}:${Account}:directory/${DirectoryId}`	aws:ResourceTag/${TagKey}

Condition keys for AWS Directory Service Data

AWS Directory Service Data defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys	Description	Type
aws:ResourceTag/${TagKey}	Filters access by the AWS DS Resource being acted upon	String
ds-data:Identifier	Filters access by the type of identifier provided in the request (i.e. SAM Account Name)	String
ds-data:MemberName	Filters access by the directory SAM Account Name included in the MemberName input of the request	String
ds-data:MemberRealm	Filters access by the directory realm name included in the MemberRealm input of the request	String
ds-data:Realm	Filters access by the directory realm name for the request	String
ds-data:SAMAccountName	Filters access by the directory SAM Account Name included in the SAMAccountName input of the request	String

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

AWS Directory Service

Amazon DocumentDB Elastic Clusters