AWS.Tools.CognitoIdentity.dll-Help.xml
|
<helpItems schema="maml"><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-CGIPrincipalTagAttributeMap</name><description><para>Calls the Amazon Cognito Identity GetPrincipalTagAttributeMap API operation.</para></description><verb>Get</verb><noun>CGIPrincipalTagAttributeMap</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Use <code>GetPrincipalTagAttributeMap</code> to list all mappings between <code>PrincipalTags</code> and user attributes. </para></description><syntax><syntaxItem><name>Get-CGIPrincipalTagAttributeMap</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>You can use this operation to get the ID of the Identity Pool you setup attribute mappings for. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityProviderName</name><description><para>You can use this operation to get the provider name. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.GetPrincipalTagAttributeMapResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.GetPrincipalTagAttributeMapResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>You can use this operation to get the ID of the Identity Pool you setup attribute mappings for. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityProviderName</name><description><para>You can use this operation to get the provider name. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.GetPrincipalTagAttributeMapResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.GetPrincipalTagAttributeMapResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CognitoIdentity.Model.GetPrincipalTagAttributeMapResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.CognitoIdentity.Model.GetPrincipalTagAttributeMapResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CGIPrincipalTagAttributeMap.html&tocid=Get-CGIPrincipalTagAttributeMap</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Add-CGIResourceTag</name><description><para>Calls the Amazon Cognito Identity TagResource API operation.</para></description><verb>Add</verb><noun>CGIResourceTag</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an <code>Environment</code> tag key to both identity pools. The value of this key might be <code>Test</code> for one identity pool and <code>Production</code> for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags. </para></description><syntax><syntaxItem><name>Add-CGIResourceTag</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceArn</name><description><para>The Amazon Resource Name (ARN) of the identity pool. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The tags to assign to the identity pool. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceArn</name><description><para>The Amazon Resource Name (ARN) of the identity pool. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Tag</name><description><para>The tags to assign to the identity pool. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue><type><name>System.Collections.Hashtable</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>None or Amazon.CognitoIdentity.Model.TagResourceResponse</name><uri /><description /></type><description><para>This cmdlet does not generate any output.The service response (type Amazon.CognitoIdentity.Model.TagResourceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Add-CGIResourceTag.html&tocid=Add-CGIResourceTag</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-CGIResourceTag</name><description><para>Calls the Amazon Cognito Identity ListTagsForResource API operation.</para></description><verb>Get</verb><noun>CGIResourceTag</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Lists the tags that are assigned to an Amazon Cognito identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account. </para></description><syntax><syntaxItem><name>Get-CGIResourceTag</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceArn</name><description><para>The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceArn</name><description><para>The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>System.String or Amazon.CognitoIdentity.Model.ListTagsForResourceResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of System.String objects. The service call response (type Amazon.CognitoIdentity.Model.ListTagsForResourceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CGIResourceTag.html&tocid=Get-CGIResourceTag</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-CGIResourceTag</name><description><para>Calls the Amazon Cognito Identity UntagResource API operation.</para></description><verb>Remove</verb><noun>CGIResourceTag</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account </para></description><syntax><syntaxItem><name>Remove-CGIResourceTag</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceArn</name><description><para>The Amazon Resource Name (ARN) of the identity pool. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TagKey</name><description><para>The keys of the tags to remove from the user pool. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ResourceArn</name><description><para>The Amazon Resource Name (ARN) of the identity pool. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>TagKey</name><description><para>The keys of the tags to remove from the user pool. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>None or Amazon.CognitoIdentity.Model.UntagResourceResponse</name><uri /><description /></type><description><para>This cmdlet does not generate any output.The service response (type Amazon.CognitoIdentity.Model.UntagResourceResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-CGIResourceTag.html&tocid=Remove-CGIResourceTag</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-CGIIdentityPoolRole</name><description><para>Calls the Amazon Cognito Identity GetIdentityPoolRoles API operation.</para></description><verb>Get</verb><noun>CGIIdentityPoolRole</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Gets the roles for an identity pool. You must use AWS Developer credentials to call this API. </para></description><syntax><syntaxItem><name>Get-CGIIdentityPoolRole</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.GetIdentityPoolRolesResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.GetIdentityPoolRolesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.GetIdentityPoolRolesResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.GetIdentityPoolRolesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CognitoIdentity.Model.GetIdentityPoolRolesResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.CognitoIdentity.Model.GetIdentityPoolRolesResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CGIIdentityPoolRole.html&tocid=Get-CGIIdentityPoolRole</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 LoggedAt : 8/12/2015 4:33:51 PM IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 Roles : {[unauthenticated, arn:aws:iam::123456789012:role/CommonTests1Role]} ResponseMetadata : Amazon.Runtime.ResponseMetadata ContentLength : 165 HttpStatusCode : OK </code><remarks><para>Description</para><para>-----------</para><para>Gets the information about roles for a specific Identity Pool.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-CGIIdentityPool</name><description><para>Calls the Amazon Cognito Identity DescribeIdentityPool API operation.</para></description><verb>Get</verb><noun>CGIIdentityPool</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. You must use AWS Developer credentials to call this API. </para></description><syntax><syntaxItem><name>Get-CGIIdentityPool</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.DescribeIdentityPoolResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.DescribeIdentityPoolResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.DescribeIdentityPoolResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.DescribeIdentityPoolResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CognitoIdentity.Model.DescribeIdentityPoolResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.CognitoIdentity.Model.DescribeIdentityPoolResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CGIIdentityPool.html&tocid=Get-CGIIdentityPool</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 LoggedAt : 8/12/2015 4:29:40 PM AllowUnauthenticatedIdentities : True DeveloperProviderName : IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 IdentityPoolName : CommonTests1 OpenIdConnectProviderARNs : {} SupportedLoginProviders : {} ResponseMetadata : Amazon.Runtime.ResponseMetadata ContentLength : 142 HttpStatusCode : OK </code><remarks><para>Description</para><para>-----------</para><para>Retrieves information about a specific Identity Pool by its id.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>New-CGIIdentityPool</name><description><para>Calls the Amazon Cognito Identity CreateIdentityPool API operation.</para></description><verb>New</verb><noun>CGIIdentityPool</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for <code>SupportedLoginProviders</code> are as follows: - Facebook: <code>graph.facebook.com</code> - Google: <code>accounts.google.com</code> - Amazon: <code>www.amazon.com</code> - Twitter: <code>api.twitter.com</code> - Digits: <code>www.digits.com</code> You must use AWS Developer credentials to call this API. </para></description><syntax><syntaxItem><name>New-CGIIdentityPool</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolName</name><description><para>A string that you provide. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AllowClassicFlow</name><description><para>Enables or disables the Basic (Classic) authentication flow. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the <i>Amazon Cognito Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AllowUnauthenticatedIdentity</name><description><para>TRUE if the identity pool supports unauthenticated logins. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CognitoIdentityProvider</name><description><para>An array of Amazon Cognito user pools and their client IDs. </para></description><parameterValue required="true" variableLength="false">Amazon.CognitoIdentity.Model.CognitoIdentityProviderInfo[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DeveloperProviderName</name><description><para>The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the <code>DeveloperProviderName</code>, you can use letters as well as period (<code>.</code>), underscore (<code>_</code>), and dash (<code>-</code>). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityPoolTag</name><description><para>Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenIdConnectProviderARNs</name><description><para>The Amazon Resource Names (ARN) of the OpenID Connect providers. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SamlProviderARNs</name><description><para>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SupportedLoginProvider</name><description><para>Optional key:value pairs mapping provider names to provider app IDs. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.CreateIdentityPoolResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.CreateIdentityPoolResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolName parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolName' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AllowClassicFlow</name><description><para>Enables or disables the Basic (Classic) authentication flow. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the <i>Amazon Cognito Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AllowUnauthenticatedIdentity</name><description><para>TRUE if the identity pool supports unauthenticated logins. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CognitoIdentityProvider</name><description><para>An array of Amazon Cognito user pools and their client IDs. </para></description><parameterValue required="true" variableLength="false">Amazon.CognitoIdentity.Model.CognitoIdentityProviderInfo[]</parameterValue><type><name>Amazon.CognitoIdentity.Model.CognitoIdentityProviderInfo[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DeveloperProviderName</name><description><para>The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the <code>DeveloperProviderName</code>, you can use letters as well as period (<code>.</code>), underscore (<code>_</code>), and dash (<code>-</code>). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolName</name><description><para>A string that you provide. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityPoolTag</name><description><para>Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue><type><name>System.Collections.Hashtable</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenIdConnectProviderARNs</name><description><para>The Amazon Resource Names (ARN) of the OpenID Connect providers. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolName parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolName' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SamlProviderARNs</name><description><para>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.CreateIdentityPoolResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.CreateIdentityPoolResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SupportedLoginProvider</name><description><para>Optional key:value pairs mapping provider names to provider app IDs. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue><type><name>System.Collections.Hashtable</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CognitoIdentity.Model.CreateIdentityPoolResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.CognitoIdentity.Model.CreateIdentityPoolResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-CGIIdentityPool.html&tocid=New-CGIIdentityPool</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>New-CGIIdentityPool -AllowUnauthenticatedIdentities $true -IdentityPoolName CommonTests13 LoggedAt : 8/12/2015 4:56:07 PM AllowUnauthenticatedIdentities : True DeveloperProviderName : IdentityPoolId : us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3 IdentityPoolName : CommonTests13 OpenIdConnectProviderARNs : {} SupportedLoginProviders : {} ResponseMetadata : Amazon.Runtime.ResponseMetadata ContentLength : 136 HttpStatusCode : OK </code><remarks><para>Description</para><para>-----------</para><para>Creates a new Identity Pool which allows unauthenticated identities.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-CGIIdentityPoolList</name><description><para>Calls the Amazon Cognito Identity ListIdentityPools API operation.</para></description><verb>Get</verb><noun>CGIIdentityPoolList</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Lists all of the Cognito identity pools registered for your account. You must use AWS Developer credentials to call this API. <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. </para></description><syntax><syntaxItem><name>Get-CGIIdentityPoolList</name><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The maximum number of identities to return. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. If a value for this parameter is not specified the cmdlet will use a default value of '<b>60</b>'. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>A pagination token. <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></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'IdentityPools'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.ListIdentityPoolsResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.ListIdentityPoolsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>MaxResult</name><description><para>The maximum number of identities to return. <br /><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br />In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br />Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. If a value for this parameter is not specified the cmdlet will use a default value of '<b>60</b>'. </para></description><parameterValue required="true" variableLength="false">System.Int32</parameterValue><type><name>System.Int32</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NextToken</name><description><para>A pagination token. <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></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>NoAutoIteration</name><description><para>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. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is 'IdentityPools'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.ListIdentityPoolsResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.ListIdentityPoolsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CognitoIdentity.Model.IdentityPoolShortDescription or Amazon.CognitoIdentity.Model.ListIdentityPoolsResponse</name><uri /><description /></type><description><para>This cmdlet returns a collection of Amazon.CognitoIdentity.Model.IdentityPoolShortDescription objects. The service call response (type Amazon.CognitoIdentity.Model.ListIdentityPoolsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CGIIdentityPoolList.html&tocid=Get-CGIIdentityPoolList</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Get-CGIIdentityPoolList IdentityPoolId IdentityPoolName -------------- ---------------- us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 CommonTests1 us-east-1:118d242d-204e-4b88-b803-EXAMPLEGUID2 Tests2 us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3 CommonTests13 </code><remarks><para>Description</para><para>-----------</para><para>Retrieves a list of existing Identity Pools.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Remove-CGIIdentityPool</name><description><para>Calls the Amazon Cognito Identity DeleteIdentityPool API operation.</para></description><verb>Remove</verb><noun>CGIIdentityPool</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. You must use AWS Developer credentials to call this API. </para></description><syntax><syntaxItem><name>Remove-CGIIdentityPool</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.DeleteIdentityPoolResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.DeleteIdentityPoolResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>None or Amazon.CognitoIdentity.Model.DeleteIdentityPoolResponse</name><uri /><description /></type><description><para>This cmdlet does not generate any output.The service response (type Amazon.CognitoIdentity.Model.DeleteIdentityPoolResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-CGIIdentityPool.html&tocid=Remove-CGIIdentityPool</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Remove-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1</code><remarks><para>Description</para><para>-----------</para><para>Deletes a specific Identity Pool.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Set-CGIPrincipalTagAttributeMap</name><description><para>Calls the Amazon Cognito Identity SetPrincipalTagAttributeMap API operation.</para></description><verb>Set</verb><noun>CGIPrincipalTagAttributeMap</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>You can use this operation to use default (username and clientID) attribute or custom attribute mappings. </para></description><syntax><syntaxItem><name>Set-CGIPrincipalTagAttributeMap</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>The ID of the Identity Pool you want to set attribute mappings for. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityProviderName</name><description><para>The provider name you want to use for attribute mappings. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PrincipalTag</name><description><para>You can use this operation to add principal tags. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>UseDefault</name><description><para>You can use this operation to use default (username and clientID) attribute mappings. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.SetPrincipalTagAttributeMapResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.SetPrincipalTagAttributeMapResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>The ID of the Identity Pool you want to set attribute mappings for. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityProviderName</name><description><para>The provider name you want to use for attribute mappings. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PrincipalTag</name><description><para>You can use this operation to add principal tags. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue><type><name>System.Collections.Hashtable</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.SetPrincipalTagAttributeMapResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.SetPrincipalTagAttributeMapResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>UseDefault</name><description><para>You can use this operation to use default (username and clientID) attribute mappings. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CognitoIdentity.Model.SetPrincipalTagAttributeMapResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.CognitoIdentity.Model.SetPrincipalTagAttributeMapResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-CGIPrincipalTagAttributeMap.html&tocid=Set-CGIPrincipalTagAttributeMap</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Set-CGIIdentityPoolRole</name><description><para>Calls the Amazon Cognito Identity SetIdentityPoolRoles API operation.</para></description><verb>Set</verb><noun>CGIIdentityPoolRole</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Sets the roles for an identity pool. These roles are used when making calls to <a>GetCredentialsForIdentity</a> action. You must use AWS Developer credentials to call this API. </para></description><syntax><syntaxItem><name>Set-CGIIdentityPoolRole</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RoleMapping</name><description><para>How users for a specific identity provider are to mapped to roles. This is a string to <a>RoleMapping</a> object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". Up to 25 rules can be specified per identity provider. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Role</name><description><para>The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.SetIdentityPoolRolesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Role</name><description><para>The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue><type><name>System.Collections.Hashtable</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>RoleMapping</name><description><para>How users for a specific identity provider are to mapped to roles. This is a string to <a>RoleMapping</a> object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". Up to 25 rules can be specified per identity provider. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue><type><name>System.Collections.Hashtable</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.SetIdentityPoolRolesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>None or Amazon.CognitoIdentity.Model.SetIdentityPoolRolesResponse</name><uri /><description /></type><description><para>This cmdlet does not generate any output.The service response (type Amazon.CognitoIdentity.Model.SetIdentityPoolRolesResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-CGIIdentityPoolRole.html&tocid=Set-CGIIdentityPoolRole</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Set-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -Role @{ "unauthenticated" = "arn:aws:iam::123456789012:role/CommonTests1Role" }</code><remarks><para>Description</para><para>-----------</para><para>Configures the specific Identity Pool to have an unauthenticated IAM role.</para><para /><para /></remarks></example></examples></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Update-CGIIdentityPool</name><description><para>Calls the Amazon Cognito Identity UpdateIdentityPool API operation.</para></description><verb>Update</verb><noun>CGIIdentityPool</noun><copyright><para>&copy; Copyright 2012 - 2022 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Updates an identity pool. You must use AWS Developer credentials to call this API. </para></description><syntax><syntaxItem><name>Update-CGIIdentityPool</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AllowClassicFlow</name><description><para>Enables or disables the Basic (Classic) authentication flow. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the <i>Amazon Cognito Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AllowUnauthenticatedIdentity</name><description><para>TRUE if the identity pool supports unauthenticated logins. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CognitoIdentityProvider</name><description><para>A list representing an Amazon Cognito user pool and its client ID. </para></description><parameterValue required="true" variableLength="false">Amazon.CognitoIdentity.Model.CognitoIdentityProviderInfo[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DeveloperProviderName</name><description><para>The "domain" by which Cognito will refer to your users. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityPoolName</name><description><para>A string that you provide. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityPoolTag</name><description><para>The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenIdConnectProviderARNs</name><description><para>The ARNs of the OpenID Connect providers. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SamlProviderARNs</name><description><para>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SupportedLoginProvider</name><description><para>Optional key:value pairs mapping provider names to provider app IDs. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.UpdateIdentityPoolResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.UpdateIdentityPoolResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.AccessKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AllowClassicFlow</name><description><para>Enables or disables the Basic (Classic) authentication flow. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the <i>Amazon Cognito Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AllowUnauthenticatedIdentity</name><description><para>TRUE if the identity pool supports unauthenticated logins. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>CognitoIdentityProvider</name><description><para>A list representing an Amazon Cognito user pool and its client ID. </para></description><parameterValue required="true" variableLength="false">Amazon.CognitoIdentity.Model.CognitoIdentityProviderInfo[]</parameterValue><type><name>Amazon.CognitoIdentity.Model.CognitoIdentityProviderInfo[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Credential </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>DeveloperProviderName</name><description><para>The "domain" by which Cognito will refer to your users. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>Amazon.PowerShell.Common.ServiceCmdlet.EndpointUrl </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>IdentityPoolId</name><description><para>An identity pool ID in the format REGION:GUID. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityPoolName</name><description><para>A string that you provide. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>IdentityPoolTag</name><description><para>The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue><type><name>System.Collections.Hashtable</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.NetworkCredential </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>OpenIdConnectProviderARNs</name><description><para>The ARNs of the OpenID Connect providers. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>PassThru</name><description><para>Changes the cmdlet behavior to return the value passed to the IdentityPoolId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityPoolId' instead. This parameter will be removed in a future version. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileLocation </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.ProfileName </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.Region </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SamlProviderARNs</name><description><para>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. </para></description><parameterValue required="true" variableLength="false">System.String[]</parameterValue><type><name>System.String[]</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SecretKey </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Select</name><description><para>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.CognitoIdentity.Model.UpdateIdentityPoolResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.UpdateIdentityPoolResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>Amazon.PowerShell.Common.AWSCommonArgumentsCmdlet.SessionToken </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SupportedLoginProvider</name><description><para>Optional key:value pairs mapping provider names to provider app IDs. </para></description><parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue><type><name>System.Collections.Hashtable</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CognitoIdentity.Model.UpdateIdentityPoolResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.CognitoIdentity.Model.UpdateIdentityPoolResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-CGIIdentityPool.html&tocid=Update-CGIIdentityPool</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/</uri></navigationLink><navigationLink><linkText>Service API Reference:</linkText><uri>https://docs.aws.amazon.com/cognito/devguide/identity/api-reference/</uri></navigationLink></relatedLinks><examples><example><title>-------------------------- EXAMPLE 1 --------------------------</title><code>Update-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -IdentityPoolName NewPoolName LoggedAt : 8/12/2015 4:53:33 PM AllowUnauthenticatedIdentities : False DeveloperProviderName : IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 IdentityPoolName : NewPoolName OpenIdConnectProviderARNs : {} SupportedLoginProviders : {} ResponseMetadata : Amazon.Runtime.ResponseMetadata ContentLength : 135 HttpStatusCode : OK </code><remarks><para>Description</para><para>-----------</para><para>Updates some of the Identity Pool properties, in this case the name of the Identity Pool.</para><para /><para /></remarks></example></examples></command></helpItems> |