AWS.Tools.DirectoryServiceData.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.DirectoryServiceData</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.DSD.AddDSDGroupMemberCmdlet"> <summary> Adds an existing user, group, or computer as a group member. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.AddDSDGroupMemberCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.AddDSDGroupMemberCmdlet.GroupName"> <summary> <para> <para> The name of the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.AddDSDGroupMemberCmdlet.MemberName"> <summary> <para> <para> The <c>SAMAccountName</c> of the user, group, or computer to add as a group member. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.AddDSDGroupMemberCmdlet.MemberRealm"> <summary> <para> <para> The domain name that's associated with the group member. This parameter is required only when adding a member outside of your Managed Microsoft AD domain to a group inside of your Managed Microsoft AD domain. This parameter defaults to the Managed Microsoft AD domain. </para><note><para> This parameter is case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.AddDSDGroupMemberCmdlet.ClientToken"> <summary> <para> <para> A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call. </para><para> A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours. </para><para> If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an <c>ConflictException</c>. </para><note><para> This parameter is optional when using the CLI or SDK. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.AddDSDGroupMemberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.AddGroupMemberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.AddDSDGroupMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.DisableDSDUserCmdlet"> <summary> Deactivates an active user account. For information about how to enable an inactive user account, see <a href="https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html">ResetUserPassword</a> in the <i>Directory Service API Reference</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.DisableDSDUserCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.DisableDSDUserCmdlet.SAMAccountName"> <summary> <para> <para> The name of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.DisableDSDUserCmdlet.ClientToken"> <summary> <para> <para> A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call. </para><para> A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours. </para><para> If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an <c>ConflictException</c>. </para><note><para> This parameter is optional when using the CLI or SDK. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.DisableDSDUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.DisableUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.DisableDSDUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupCmdlet"> <summary> Returns information about a specific group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupCmdlet.DirectoryId"> <summary> <para> <para>The Identifier (ID) of the directory associated with the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupCmdlet.OtherAttribute"> <summary> <para> <para> One or more attributes to be returned for the group. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data-attributes.html">Directory Service Data Attributes</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupCmdlet.Realm"> <summary> <para> <para> The domain name that's associated with the group. </para><note><para> This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned. </para><para> This value is case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupCmdlet.SAMAccountName"> <summary> <para> <para> The name of the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.DescribeGroupResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.DescribeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupListCmdlet"> <summary> Returns group information for the specified directory. <para> This operation supports pagination with the use of the <c>NextToken</c> request and response parameters. If more results are available, the <c>ListGroups.NextToken</c> member contains a token that you pass in the next call to <c>ListGroups</c>. This retrieves the next set of items. </para><para> You can also specify a maximum number of return results with the <c>MaxResults</c> parameter. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupListCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupListCmdlet.Realm"> <summary> <para> <para> The domain name associated with the directory. </para><note><para> This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned. </para><para> This value is case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to be returned per request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupListCmdlet.NextToken"> <summary> <para> <para> An encoded paging token for paginated calls that can be passed back to retrieve the next page. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.ListGroupsResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.ListGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupMemberListCmdlet"> <summary> Returns member information for the specified group. <para> This operation supports pagination with the use of the <c>NextToken</c> request and response parameters. If more results are available, the <c>ListGroupMembers.NextToken</c> member contains a token that you pass in the next call to <c>ListGroupMembers</c>. This retrieves the next set of items. </para><para> You can also specify a maximum number of return results with the <c>MaxResults</c> parameter. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupMemberListCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupMemberListCmdlet.MemberRealm"> <summary> <para> <para> The domain name that's associated with the group member. This parameter defaults to the Managed Microsoft AD domain. </para><note><para> This parameter is optional and case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupMemberListCmdlet.Realm"> <summary> <para> <para> The domain name that's associated with the group. </para><note><para> This parameter is optional, so you can return members from a group outside of your Managed Microsoft AD domain. When no value is defined, only members of your Managed Microsoft AD groups are returned. </para><para> This value is case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupMemberListCmdlet.SAMAccountName"> <summary> <para> <para> The name of the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupMemberListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to be returned per request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupMemberListCmdlet.NextToken"> <summary> <para> <para>An encoded paging token for paginated calls that can be passed back to retrieve the next page.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupMemberListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.ListGroupMembersResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.ListGroupMembersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupMemberListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupsForMemberListCmdlet"> <summary> Returns group information for the specified member. <para> This operation supports pagination with the use of the <c>NextToken</c> request and response parameters. If more results are available, the <c>ListGroupsForMember.NextToken</c> member contains a token that you pass in the next call to <c>ListGroupsForMember</c>. This retrieves the next set of items. </para><para> You can also specify a maximum number of return results with the <c>MaxResults</c> parameter. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupsForMemberListCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the member. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupsForMemberListCmdlet.MemberRealm"> <summary> <para> <para> The domain name that's associated with the group member. </para><note><para> This parameter is optional, so you can limit your results to the group members in a specific domain. </para><para> This parameter is case insensitive and defaults to <c>Realm</c></para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupsForMemberListCmdlet.Realm"> <summary> <para> <para> The domain name that's associated with the group. </para><note><para> This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned. </para><para> This value is case insensitive and defaults to your Managed Microsoft AD domain. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupsForMemberListCmdlet.SAMAccountName"> <summary> <para> <para> The <c>SAMAccountName</c> of the user, group, or computer that's a member of the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupsForMemberListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to be returned per request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupsForMemberListCmdlet.NextToken"> <summary> <para> <para> An encoded paging token for paginated calls that can be passed back to retrieve the next page. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupsForMemberListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.ListGroupsForMemberResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.ListGroupsForMemberResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDGroupsForMemberListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserCmdlet"> <summary> Returns information about a specific user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserCmdlet.OtherAttribute"> <summary> <para> <para> One or more attribute names to be returned for the user. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserCmdlet.Realm"> <summary> <para> <para> The domain name that's associated with the user. </para><note><para> This parameter is optional, so you can return users outside your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned. </para><para> This value is case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserCmdlet.SAMAccountName"> <summary> <para> <para> The name of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.DescribeUserResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.DescribeUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserListCmdlet"> <summary> Returns user information for the specified directory. <para> This operation supports pagination with the use of the <c>NextToken</c> request and response parameters. If more results are available, the <c>ListUsers.NextToken</c> member contains a token that you pass in the next call to <c>ListUsers</c>. This retrieves the next set of items. </para><para> You can also specify a maximum number of return results with the <c>MaxResults</c> parameter. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserListCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserListCmdlet.Realm"> <summary> <para> <para> The domain name that's associated with the user. </para><note><para> This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned. </para><para> This value is case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to be returned per request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserListCmdlet.NextToken"> <summary> <para> <para> An encoded paging token for paginated calls that can be passed back to retrieve the next page. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.ListUsersResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.ListUsersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.GetDSDUserListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.NewDSDGroupCmdlet"> <summary> Creates a new group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDGroupCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDGroupCmdlet.GroupScope"> <summary> <para> <para> The scope of the AD group. For details, see <a href="https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#group-scope">Active Directory security group scope</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDGroupCmdlet.GroupType"> <summary> <para> <para> The AD group type. For details, see <a href="https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#how-active-directory-security-groups-work">Active Directory security group type</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDGroupCmdlet.OtherAttribute"> <summary> <para> <para> An expression that defines one or more attributes with the data type and value of each attribute. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDGroupCmdlet.SAMAccountName"> <summary> <para> <para> The name of the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDGroupCmdlet.ClientToken"> <summary> <para> <para> A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call. </para><para> A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours. </para><para> If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an <c>ConflictException</c>. </para><note><para> This parameter is optional when using the CLI or SDK. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.CreateGroupResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.CreateGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet"> <summary> Creates a new user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that’s associated with the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet.EmailAddress"> <summary> <para> <para> The email address of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet.GivenName"> <summary> <para> <para> The first name of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet.OtherAttribute"> <summary> <para> <para> An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </para><note><para> Attribute names are case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet.SAMAccountName"> <summary> <para> <para> The name of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet.Surname"> <summary> <para> <para> The last name of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet.ClientToken"> <summary> <para> <para> A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call. </para><para> A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours. </para><para> If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an <c>ConflictException</c>. </para><note><para> This parameter is optional when using the CLI or SDK. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.CreateUserResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.CreateUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.NewDSDUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupCmdlet"> <summary> Deletes a group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupCmdlet.SAMAccountName"> <summary> <para> <para> The name of the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupCmdlet.ClientToken"> <summary> <para> <para> A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call. </para><para> A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours. </para><para> If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an <c>ConflictException</c>. </para><note><para> This parameter is optional when using the CLI or SDK. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.DeleteGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupMemberCmdlet"> <summary> Removes a member from a group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupMemberCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the member. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupMemberCmdlet.GroupName"> <summary> <para> <para> The name of the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupMemberCmdlet.MemberName"> <summary> <para> <para> The <c>SAMAccountName</c> of the user, group, or computer to remove from the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupMemberCmdlet.MemberRealm"> <summary> <para> <para> The domain name that's associated with the group member. This parameter defaults to the Managed Microsoft AD domain. </para><note><para> This parameter is optional and case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupMemberCmdlet.ClientToken"> <summary> <para> <para> A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call. </para><para> A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours. </para><para> If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an <c>ConflictException</c>. </para><note><para> This parameter is optional when using the CLI or SDK. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupMemberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.RemoveGroupMemberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDGroupMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDUserCmdlet"> <summary> Deletes a user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDUserCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDUserCmdlet.SAMAccountName"> <summary> <para> <para> The name of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDUserCmdlet.ClientToken"> <summary> <para> <para> A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call. </para><para> A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours. </para><para> If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an <c>ConflictException</c>. </para><note><para> This parameter is optional when using the CLI or SDK. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.DeleteUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.RemoveDSDUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet"> <summary> Searches the specified directory for a group. You can find groups that match the <c>SearchString</c> parameter with the value of their attributes included in the <c>SearchString</c> parameter. <para> This operation supports pagination with the use of the <c>NextToken</c> request and response parameters. If more results are available, the <c>SearchGroups.NextToken</c> member contains a token that you pass in the next call to <c>SearchGroups</c>. This retrieves the next set of items. </para><para> You can also specify a maximum number of return results with the <c>MaxResults</c> parameter. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet.Realm"> <summary> <para> <para> The domain name that's associated with the group. </para><note><para> This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned. </para><para> This value is case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet.SearchAttribute"> <summary> <para> <para> One or more data attributes that are used to search for a group. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet.SearchString"> <summary> <para> <para> The attribute value that you want to search for. </para><note><para> Wildcard <c>(*)</c> searches aren't supported. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to be returned per request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet.NextToken"> <summary> <para> <para> An encoded paging token for paginated calls that can be passed back to retrieve the next page. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.SearchGroupsResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.SearchGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDGroupCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet"> <summary> Searches the specified directory for a user. You can find users that match the <c>SearchString</c> parameter with the value of their attributes included in the <c>SearchString</c> parameter. <para> This operation supports pagination with the use of the <c>NextToken</c> request and response parameters. If more results are available, the <c>SearchUsers.NextToken</c> member contains a token that you pass in the next call to <c>SearchUsers</c>. This retrieves the next set of items. </para><para> You can also specify a maximum number of return results with the <c>MaxResults</c> parameter. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet.Realm"> <summary> <para> <para> The domain name that's associated with the user. </para><note><para> This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned. </para><para> This value is case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet.SearchAttribute"> <summary> <para> <para> One or more data attributes that are used to search for a user. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet.SearchString"> <summary> <para> <para> The attribute value that you want to search for. </para><note><para> Wildcard <c>(*)</c> searches aren't supported. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to be returned per request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet.NextToken"> <summary> <para> <para> An encoded paging token for paginated calls that can be passed back to retrieve the next page. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.SearchUsersResponse). Specifying the name of a property of type Amazon.DirectoryServiceData.Model.SearchUsersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.SearchDSDUserCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet"> <summary> Updates group information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet.GroupScope"> <summary> <para> <para> The scope of the AD group. For details, see <a href="https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#group-scope">Active Directory security groups</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet.GroupType"> <summary> <para> <para> The AD group type. For details, see <a href="https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#how-active-directory-security-groups-work">Active Directory security group type</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet.OtherAttribute"> <summary> <para> <para> An expression that defines one or more attributes with the data type and the value of each attribute. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet.SAMAccountName"> <summary> <para> <para> The name of the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet.UpdateType"> <summary> <para> <para> The type of update to be performed. If no value exists for the attribute, use <c>ADD</c>. Otherwise, use <c>REPLACE</c> to change an attribute value or <c>REMOVE</c> to clear the attribute value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet.ClientToken"> <summary> <para> <para> A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call. </para><para> A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours. </para><para> If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an <c>ConflictException</c>. </para><note><para> This parameter is optional when using the CLI or SDK. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.UpdateGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet"> <summary> Updates user information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.DirectoryId"> <summary> <para> <para> The identifier (ID) of the directory that's associated with the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.EmailAddress"> <summary> <para> <para> The email address of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.GivenName"> <summary> <para> <para> The first name of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.OtherAttribute"> <summary> <para> <para> An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data-attributes.html">Directory Service Data Attributes</a>. </para><note><para> Attribute names are case insensitive. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.SAMAccountName"> <summary> <para> <para> The name of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.Surname"> <summary> <para> <para> The last name of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.UpdateType"> <summary> <para> <para> The type of update to be performed. If no value exists for the attribute, use <c>ADD</c>. Otherwise, use <c>REPLACE</c> to change an attribute value or <c>REMOVE</c> to clear the attribute value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.ClientToken"> <summary> <para> <para> A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call. </para><para> A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours. </para><para> If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an <c>ConflictException</c>. </para><note><para> This parameter is optional when using the CLI or SDK. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectoryServiceData.Model.UpdateUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSD.UpdateDSDUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |