AWS.Tools.IdentityStore.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IdentityStore</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IDS.FindIDSGroupListCmdlet"> <summary> Lists the attribute name and value of the group that you specified in the search. We only support <code>DisplayName</code> as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including <code>GroupId</code> and group <code>DisplayName</code> in the response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSGroupListCmdlet.Filter"> <summary> <para> <para>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and <code>ListGroups</code> request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSGroupListCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request. This parameter is used in the <code>ListUsers</code> and <code>ListGroups</code> request to specify how many results to return in one page. The length limit is 50 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSGroupListCmdlet.NextToken"> <summary> <para> <para>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Groups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.ListGroupsResponse). Specifying the name of a property of type Amazon.IdentityStore.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.IDS.FindIDSGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityStoreId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IDS.FindIDSUserListCmdlet"> <summary> Lists the attribute name and value of the user that you specified in the search. We only support <code>UserName</code> as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including <code>UserId</code> and <code>UserName</code> in the response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSUserListCmdlet.Filter"> <summary> <para> <para>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and <code>ListGroups</code> request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSUserListCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request. This parameter is used in the <code>ListUsers</code> and <code>ListGroups</code> request to specify how many results to return in one page. The length limit is 50 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSUserListCmdlet.NextToken"> <summary> <para> <para>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Users'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.ListUsersResponse). Specifying the name of a property of type Amazon.IdentityStore.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.IDS.FindIDSUserListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityStoreId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupCmdlet"> <summary> Retrieves the group metadata and attributes from <code>GroupId</code> in an identity store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupCmdlet.GroupId"> <summary> <para> <para>The identifier for a group in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupCmdlet.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.IdentityStore.Model.DescribeGroupResponse). Specifying the name of a property of type Amazon.IdentityStore.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="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupId parameter. The -PassThru parameter is deprecated, use -Select '^GroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserCmdlet"> <summary> Retrieves the user metadata and attributes from <code>UserId</code> in an identity store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserCmdlet.UserId"> <summary> <para> <para>The identifier for a user in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserCmdlet.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.IdentityStore.Model.DescribeUserResponse). Specifying the name of a property of type Amazon.IdentityStore.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="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> </members> </doc> |