AWS.Tools.IdentityStore.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IdentityStore</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IDS.AssertIDSMemberInGroupCmdlet"> <summary> Checks the user's membership in all requested groups and returns if the member exists in all queried groups. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.AssertIDSMemberInGroupCmdlet.GroupId"> <summary> <para> <para>A list of identifiers for groups in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.AssertIDSMemberInGroupCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.AssertIDSMemberInGroupCmdlet.MemberId_UserId"> <summary> <para> <para>An object containing the identifiers of resources that can be members.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.AssertIDSMemberInGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.IsMemberInGroupsResponse). Specifying the name of a property of type Amazon.IdentityStore.Model.IsMemberInGroupsResponse 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.AssertIDSMemberInGroupCmdlet.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="P:Amazon.PowerShell.Cmdlets.IDS.AssertIDSMemberInGroupCmdlet.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.IDS.FindIDSGroupListCmdlet"> <summary> Lists all groups in the identity store. Returns a paginated list of complete <c>Group</c> objects. Filtering for a <c>Group</c> by the <c>DisplayName</c> attribute is deprecated. Instead, use the <c>GetGroupId</c> API action. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSGroupListCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store, such as <c>d-1234567890</c>. In this example, <c>d-</c> is a fixed prefix, and <c>1234567890</c> is a randomly generated string that contains numbers 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.Filter"> <summary> <para> <para>A list of <c>Filter</c> objects, which is used in the <c>ListUsers</c> and <c>ListGroups</c> requests.</para> </para> <para>This parameter is deprecated.</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 <c>ListUsers</c> and <c>ListGroups</c> requests 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 <c>ListUsers</c> and <c>ListGroups</c> 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 all users in the identity store. Returns a paginated list of complete <c>User</c> objects. Filtering for a <c>User</c> by the <c>UserName</c> attribute is deprecated. Instead, use the <c>GetUserId</c> API action. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.FindIDSUserListCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store, such as <c>d-1234567890</c>. In this example, <c>d-</c> is a fixed prefix, and <c>1234567890</c> is a randomly generated string that contains numbers 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.Filter"> <summary> <para> <para>A list of <c>Filter</c> objects, which is used in the <c>ListUsers</c> and <c>ListGroups</c> requests. </para> </para> <para>This parameter is deprecated.</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 <c>ListUsers</c> and <c>ListGroups</c> requests 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 <c>ListUsers</c> and <c>ListGroups</c> 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 <c>GroupId</c> in an identity store. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </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 <c>d-1234567890</c>. In this example, <c>d-</c> is a fixed prefix, and <c>1234567890</c> is a randomly generated string that contains numbers 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.GetIDSGroupIdCmdlet"> <summary> Retrieves <c>GroupId</c> in an identity store. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupIdCmdlet.UniqueAttribute_AttributePath"> <summary> <para> <para>A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupIdCmdlet.UniqueAttribute_AttributeValue"> <summary> <para> <para>The value of the attribute. This is a <c>Document</c> type. This type is not supported by Java V1, Go V1, and older versions of the CLI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupIdCmdlet.ExternalId_Id"> <summary> <para> <para>The identifier issued to this resource by an external identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupIdCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupIdCmdlet.ExternalId_Issuer"> <summary> <para> <para>The issuer for an external identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.GetGroupIdResponse). Specifying the name of a property of type Amazon.IdentityStore.Model.GetGroupIdResponse 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.GetIDSGroupIdCmdlet.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.GetIDSGroupMembershipCmdlet"> <summary> Retrieves membership metadata and attributes from <c>MembershipId</c> in an identity store. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipCmdlet.MembershipId"> <summary> <para> <para>The identifier for a <c>GroupMembership</c> in an identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipCmdlet.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.DescribeGroupMembershipResponse). Specifying the name of a property of type Amazon.IdentityStore.Model.DescribeGroupMembershipResponse 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.GetIDSGroupMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MembershipId parameter. The -PassThru parameter is deprecated, use -Select '^MembershipId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipIdCmdlet"> <summary> Retrieves the <c>MembershipId</c> in an identity store. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipIdCmdlet.GroupId"> <summary> <para> <para>The identifier for a group in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipIdCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipIdCmdlet.MemberId_UserId"> <summary> <para> <para>An object containing the identifiers of resources that can be members.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MembershipId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.GetGroupMembershipIdResponse). Specifying the name of a property of type Amazon.IdentityStore.Model.GetGroupMembershipIdResponse 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.GetIDSGroupMembershipIdCmdlet.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.GetIDSGroupMembershipListCmdlet"> <summary> For the specified group in the specified identity store, returns the list of all <c>GroupMembership</c> objects and returns results in paginated form. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipListCmdlet.GroupId"> <summary> <para> <para>The identifier for a group in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipListCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request. This parameter is used in all <c>List</c> requests to specify how many results to return in one page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipListCmdlet.NextToken"> <summary> <para> <para>The pagination token used for the <c>ListUsers</c>, <c>ListGroups</c> and <c>ListGroupMemberships</c> 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.GetIDSGroupMembershipListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupMemberships'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.ListGroupMembershipsResponse). Specifying the name of a property of type Amazon.IdentityStore.Model.ListGroupMembershipsResponse 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.GetIDSGroupMembershipListCmdlet.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.GetIDSGroupMembershipsForMemberListCmdlet"> <summary> For the specified member in the specified identity store, returns the list of all <c>GroupMembership</c> objects and returns results in paginated form. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipsForMemberListCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipsForMemberListCmdlet.MemberId_UserId"> <summary> <para> <para>An object containing the identifiers of resources that can be members.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSGroupMembershipsForMemberListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request. This parameter is used in the <c>ListUsers</c> and <c>ListGroups</c> requests 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.GetIDSGroupMembershipsForMemberListCmdlet.NextToken"> <summary> <para> <para>The pagination token used for the <c>ListUsers</c>, <c>ListGroups</c>, and <c>ListGroupMemberships</c> 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.GetIDSGroupMembershipsForMemberListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupMemberships'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.ListGroupMembershipsForMemberResponse). Specifying the name of a property of type Amazon.IdentityStore.Model.ListGroupMembershipsForMemberResponse 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.GetIDSGroupMembershipsForMemberListCmdlet.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.GetIDSUserCmdlet"> <summary> Retrieves the user metadata and attributes from the <c>UserId</c> in an identity store. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store, such as <c>d-1234567890</c>. In this example, <c>d-</c> is a fixed prefix, and <c>1234567890</c> is a randomly generated string that contains numbers 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> <member name="T:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserIdCmdlet"> <summary> Retrieves the <c>UserId</c> in an identity store. <note><para> If you have administrator access to a member account, you can use this API from the member account. Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the <i>Organizations User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserIdCmdlet.UniqueAttribute_AttributePath"> <summary> <para> <para>A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserIdCmdlet.UniqueAttribute_AttributeValue"> <summary> <para> <para>The value of the attribute. This is a <c>Document</c> type. This type is not supported by Java V1, Go V1, and older versions of the CLI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserIdCmdlet.ExternalId_Id"> <summary> <para> <para>The identifier issued to this resource by an external identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserIdCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserIdCmdlet.ExternalId_Issuer"> <summary> <para> <para>The issuer for an external identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.GetIDSUserIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.GetUserIdResponse). Specifying the name of a property of type Amazon.IdentityStore.Model.GetUserIdResponse 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.GetIDSUserIdCmdlet.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.NewIDSGroupCmdlet"> <summary> Creates a group within the specified identity store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupCmdlet.Description"> <summary> <para> <para>A string containing the description of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupCmdlet.DisplayName"> <summary> <para> <para>A string containing the name of the group. This value is commonly displayed when the group is referenced. <c>Administrator</c> and <c>AWSAdministrators</c> are reserved names and can't be used for users or groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.CreateGroupResponse). Specifying the name of a property of type Amazon.IdentityStore.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.IDS.NewIDSGroupCmdlet.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="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupCmdlet.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.IDS.NewIDSGroupMembershipCmdlet"> <summary> Creates a relationship between a member and a group. The following identifiers must be specified: <c>GroupId</c>, <c>IdentityStoreId</c>, and <c>MemberId</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupMembershipCmdlet.GroupId"> <summary> <para> <para>The identifier for a group in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupMembershipCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupMembershipCmdlet.MemberId_UserId"> <summary> <para> <para>An object containing the identifiers of resources that can be members.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MembershipId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.CreateGroupMembershipResponse). Specifying the name of a property of type Amazon.IdentityStore.Model.CreateGroupMembershipResponse 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.NewIDSGroupMembershipCmdlet.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="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSGroupMembershipCmdlet.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.IDS.NewIDSUserCmdlet"> <summary> Creates a user within the specified identity store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Address"> <summary> <para> <para>A list of <c>Address</c> objects containing addresses associated with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.DisplayName"> <summary> <para> <para>A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe." </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Email"> <summary> <para> <para>A list of <c>Email</c> objects containing email addresses associated with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Name_FamilyName"> <summary> <para> <para>The family name of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Name_Formatted"> <summary> <para> <para>A string containing a formatted version of the name for display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Name_GivenName"> <summary> <para> <para>The given name of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Name_HonorificPrefix"> <summary> <para> <para>The honorific prefix of the user. For example, "Dr."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Name_HonorificSuffix"> <summary> <para> <para>The honorific suffix of the user. For example, "M.D."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Locale"> <summary> <para> <para>A string containing the geographical region or location of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Name_MiddleName"> <summary> <para> <para>The middle name of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.NickName"> <summary> <para> <para>A string containing an alternate name for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.PhoneNumber"> <summary> <para> <para>A list of <c>PhoneNumber</c> objects containing phone numbers associated with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.PreferredLanguage"> <summary> <para> <para>A string containing the preferred language of the user. For example, "American English" or "en-us."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.ProfileUrl"> <summary> <para> <para>A string containing a URL that might be associated with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Timezone"> <summary> <para> <para>A string containing the time zone of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Title"> <summary> <para> <para>A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.UserName"> <summary> <para> <para>A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. <c>Administrator</c> and <c>AWSAdministrators</c> are reserved names and can't be used for users or groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.UserType"> <summary> <para> <para>A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityStore.Model.CreateUserResponse). Specifying the name of a property of type Amazon.IdentityStore.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.IDS.NewIDSUserCmdlet.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="P:Amazon.PowerShell.Cmdlets.IDS.NewIDSUserCmdlet.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.IDS.RemoveIDSGroupCmdlet"> <summary> Delete a group within an identity store given <c>GroupId</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupCmdlet.GroupId"> <summary> <para> <para>The identifier for a group in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupCmdlet.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.IdentityStore.Model.DeleteGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupCmdlet.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="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupCmdlet.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.IDS.RemoveIDSGroupMembershipCmdlet"> <summary> Delete a membership within a group given <c>MembershipId</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupMembershipCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupMembershipCmdlet.MembershipId"> <summary> <para> <para>The identifier for a <c>GroupMembership</c> in an identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupMembershipCmdlet.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.IdentityStore.Model.DeleteGroupMembershipResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MembershipId parameter. The -PassThru parameter is deprecated, use -Select '^MembershipId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSGroupMembershipCmdlet.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.IDS.RemoveIDSUserCmdlet"> <summary> Deletes a user within an identity store given <c>UserId</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSUserCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSUserCmdlet.UserId"> <summary> <para> <para>The identifier for a user in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSUserCmdlet.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.IdentityStore.Model.DeleteUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSUserCmdlet.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> <member name="P:Amazon.PowerShell.Cmdlets.IDS.RemoveIDSUserCmdlet.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.IDS.UpdateIDSGroupCmdlet"> <summary> For the specified group in the specified identity store, updates the group metadata and attributes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSGroupCmdlet.GroupId"> <summary> <para> <para>The identifier for a group in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSGroupCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSGroupCmdlet.Operation"> <summary> <para> <para>A list of <c>AttributeOperation</c> objects to apply to the requested group. These operations might add, replace, or remove an attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSGroupCmdlet.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.IdentityStore.Model.UpdateGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSGroupCmdlet.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="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSGroupCmdlet.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.IDS.UpdateIDSUserCmdlet"> <summary> For the specified user in the specified identity store, updates the user metadata and attributes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSUserCmdlet.IdentityStoreId"> <summary> <para> <para>The globally unique identifier for the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSUserCmdlet.Operation"> <summary> <para> <para>A list of <c>AttributeOperation</c> objects to apply to the requested user. These operations might add, replace, or remove an attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSUserCmdlet.UserId"> <summary> <para> <para>The identifier for a user in the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSUserCmdlet.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.IdentityStore.Model.UpdateUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSUserCmdlet.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> <member name="P:Amazon.PowerShell.Cmdlets.IDS.UpdateIDSUserCmdlet.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> |