AWS.Tools.CognitoIdentity.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CognitoIdentity</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CGI.AddCGIResourceTagCmdlet"> <summary> 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. <para> 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 <c>Environment</c> tag key to both identity pools. The value of this key might be <c>Test</c> for one identity pool and <c>Production</c> for the other. </para><para> 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. </para><para> You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.AddCGIResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the identity pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.AddCGIResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to assign to the identity pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.AddCGIResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.AddCGIResourceTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.AddCGIResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.DismountCGIDeveloperIdentityCmdlet"> <summary> Unlinks a <c>DeveloperUserIdentifier</c> from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIDeveloperIdentityCmdlet.DeveloperProviderName"> <summary> <para> <para>The "domain" by which Cognito will refer to your users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIDeveloperIdentityCmdlet.DeveloperUserIdentifier"> <summary> <para> <para>A unique ID used by your backend authentication process to identify a user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIDeveloperIdentityCmdlet.IdentityId"> <summary> <para> <para>A unique identifier in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIDeveloperIdentityCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIDeveloperIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIDeveloperIdentityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIDeveloperIdentityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.DismountCGIIdentityCmdlet"> <summary> Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIIdentityCmdlet.IdentityId"> <summary> <para> <para>A unique identifier in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIIdentityCmdlet.Login"> <summary> <para> <para>A set of optional name-value pairs that map provider names to provider tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIIdentityCmdlet.LoginsToRemove"> <summary> <para> <para>Provider names to unlink from this identity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.UnlinkIdentityResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIIdentityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.DismountCGIIdentityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.FindCGIDeveloperIdentityCmdlet"> <summary> Retrieves the <c>IdentityID</c> associated with a <c>DeveloperUserIdentifier</c> or the list of <c>DeveloperUserIdentifier</c> values associated with an <c>IdentityId</c> for an existing identity. Either <c>IdentityID</c> or <c>DeveloperUserIdentifier</c> must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, <c>DeveloperUserIdentifier</c> will be matched against <c>IdentityID</c>. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a <c>ResourceConflictException</c> is thrown. <para><c>LookupDeveloperIdentity</c> is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. <a>GetOpenIdTokenForDeveloperIdentity</a> is a better option for higher-volume operations for user authentication. </para><para> You must use AWS Developer credentials to call this API. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.FindCGIDeveloperIdentityCmdlet.DeveloperUserIdentifier"> <summary> <para> <para>A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.FindCGIDeveloperIdentityCmdlet.IdentityId"> <summary> <para> <para>A unique identifier in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.FindCGIDeveloperIdentityCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.FindCGIDeveloperIdentityCmdlet.MaxResult"> <summary> <para> <para>The maximum number of identities to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.FindCGIDeveloperIdentityCmdlet.NextToken"> <summary> <para> <para>A pagination token. The first call you make will have <c>NextToken</c> set to null. After that the service will return <c>NextToken</c> values as needed. For example, let's say you make a request with <c>MaxResults</c> set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.FindCGIDeveloperIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.LookupDeveloperIdentityResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.LookupDeveloperIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.FindCGIDeveloperIdentityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.FindCGIDeveloperIdentityCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGICredentialsForIdentityCmdlet"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGICredentialsForIdentityCmdlet.CustomRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGICredentialsForIdentityCmdlet.IdentityId"> <summary> <para> <para>A unique identifier in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGICredentialsForIdentityCmdlet.Login"> <summary> <para> <para>A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".</para><para>Logins should not be specified when trying to get credentials for an unauthenticated identity.</para><para>The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of <c>Logins</c> maps, see the code examples in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html">External Identity Providers</a> section of the Amazon Cognito Developer Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGICredentialsForIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.GetCredentialsForIdentityResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.GetCredentialsForIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGICredentialsForIdentityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdCmdlet"> <summary> Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdCmdlet.AccountId"> <summary> <para> <para>A standard AWS account ID (9+ digits).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdCmdlet.Login"> <summary> <para> <para>A set of optional name-value pairs that map provider names to provider tokens. The available provider names for <c>Logins</c> are as follows:</para><ul><li><para>Facebook: <c>graph.facebook.com</c></para></li><li><para>Amazon Cognito user pool: <c>cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID></c>, for example, <c>cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789</c>. </para></li><li><para>Google: <c>accounts.google.com</c></para></li><li><para>Amazon: <c>www.amazon.com</c></para></li><li><para>Twitter: <c>api.twitter.com</c></para></li><li><para>Digits: <c>www.digits.com</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.GetIdResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.GetIdResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityCmdlet"> <summary> Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityCmdlet.IdentityId"> <summary> <para> <para>A unique identifier in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.DescribeIdentityResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.DescribeIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityListCmdlet"> <summary> Lists the identities in an identity pool. <para> You must use AWS Developer credentials to call this API. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityListCmdlet.HideDisabled"> <summary> <para> <para>An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityListCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of identities to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityListCmdlet.NextToken"> <summary> <para> <para>A pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.ListIdentitiesResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.ListIdentitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolCmdlet"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolListCmdlet"> <summary> Lists all of the Cognito identity pools registered for your account. <para> You must use AWS Developer credentials to call this API. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of identities to return.</para> </para> <para> <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. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>60</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolListCmdlet.NextToken"> <summary> <para> <para>A pagination token.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolListCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolRoleCmdlet"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolRoleCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolRoleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolRoleCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenCmdlet"> <summary> Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenID token is valid for 10 minutes. </para><para> This is a public API. You do not need any credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenCmdlet.IdentityId"> <summary> <para> <para>A unique identifier in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenCmdlet.Login"> <summary> <para> <para>A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the <c>id_token</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.GetOpenIdTokenResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.GetOpenIdTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityId parameter. The -PassThru parameter is deprecated, use -Select '^IdentityId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenForDeveloperIdentityCmdlet"> <summary> Registers (or retrieves) a Cognito <c>IdentityId</c> and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the <c>Logins</c> map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. <para> You can use <c>GetOpenIdTokenForDeveloperIdentity</c> to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the <c>IdentityId</c> should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing <c>IdentityId</c>. This API will create the identity in the specified <c>IdentityPoolId</c>. </para><para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenForDeveloperIdentityCmdlet.IdentityId"> <summary> <para> <para>A unique identifier in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenForDeveloperIdentityCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenForDeveloperIdentityCmdlet.Login"> <summary> <para> <para>A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax <c>"developer_provider_name": "developer_user_identifier"</c>. The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenForDeveloperIdentityCmdlet.PrincipalTag"> <summary> <para> <para>Use this operation to configure attribute mappings for custom providers. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenForDeveloperIdentityCmdlet.TokenDuration"> <summary> <para> <para>The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.</para><note><para>Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenForDeveloperIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIOpenIdTokenForDeveloperIdentityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIPrincipalTagAttributeMapCmdlet"> <summary> Use <c>GetPrincipalTagAttributeMap</c> to list all mappings between <c>PrincipalTags</c> and user attributes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIPrincipalTagAttributeMapCmdlet.IdentityPoolId"> <summary> <para> <para>You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIPrincipalTagAttributeMapCmdlet.IdentityProviderName"> <summary> <para> <para>You can use this operation to get the provider name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIPrincipalTagAttributeMapCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIPrincipalTagAttributeMapCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIResourceTagCmdlet"> <summary> Lists the tags that are assigned to an Amazon Cognito identity pool. <para> 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><para> You can use this action up to 10 times per second, per account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIResourceTagCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIResourceTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.MergeCGIDeveloperIdentityCmdlet"> <summary> Merges two users having different <c>IdentityId</c>s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (<c>SourceUserIdentifier</c>) with the <c>IdentityId</c> of the <c>DestinationUserIdentifier</c>. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. <para> The number of linked logins is limited to 20. So, the number of linked logins for the source user, <c>SourceUserIdentifier</c>, and the destination user, <c>DestinationUserIdentifier</c>, together should not be larger than 20. Otherwise, an exception will be thrown. </para><para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.MergeCGIDeveloperIdentityCmdlet.DestinationUserIdentifier"> <summary> <para> <para>User identifier for the destination user. The value should be a <c>DeveloperUserIdentifier</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.MergeCGIDeveloperIdentityCmdlet.DeveloperProviderName"> <summary> <para> <para>The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the <c>DeveloperProviderName</c>, you can use letters as well as period (.), underscore (_), and dash (-).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.MergeCGIDeveloperIdentityCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.MergeCGIDeveloperIdentityCmdlet.SourceUserIdentifier"> <summary> <para> <para>User identifier for the source user. The value should be a <c>DeveloperUserIdentifier</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.MergeCGIDeveloperIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.MergeCGIDeveloperIdentityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.MergeCGIDeveloperIdentityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet"> <summary> 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 <c>SupportedLoginProviders</c> are as follows: <ul><li><para> Facebook: <c>graph.facebook.com</c></para></li><li><para> Google: <c>accounts.google.com</c></para></li><li><para> Amazon: <c>www.amazon.com</c></para></li><li><para> Twitter: <c>api.twitter.com</c></para></li><li><para> Digits: <c>www.digits.com</c></para></li></ul><para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.AllowClassicFlow"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.AllowUnauthenticatedIdentity"> <summary> <para> <para>TRUE if the identity pool supports unauthenticated logins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.CognitoIdentityProvider"> <summary> <para> <para>An array of Amazon Cognito user pools and their client IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.DeveloperProviderName"> <summary> <para> <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 <c>DeveloperProviderName</c>, you can use letters as well as period (<c>.</c>), underscore (<c>_</c>), and dash (<c>-</c>).</para><para>Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.IdentityPoolName"> <summary> <para> <para>A string that you provide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.IdentityPoolTag"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.OpenIdConnectProviderARNs"> <summary> <para> <para>The Amazon Resource Names (ARN) of the OpenID Connect providers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.SamlProviderARNs"> <summary> <para> <para>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.SupportedLoginProvider"> <summary> <para> <para>Optional key:value pairs mapping provider names to provider app IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityCmdlet"> <summary> Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityCmdlet.IdentityIdsToDelete"> <summary> <para> <para>A list of 1-60 identities that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UnprocessedIdentityIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.DeleteIdentitiesResponse). Specifying the name of a property of type Amazon.CognitoIdentity.Model.DeleteIdentitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IdentityIdsToDelete parameter. The -PassThru parameter is deprecated, use -Select '^IdentityIdsToDelete' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityPoolCmdlet"> <summary> Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityPoolCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityPoolCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.DeleteIdentityPoolResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityPoolCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityPoolCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIResourceTagCmdlet"> <summary> Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the identity pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to remove from the user pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIResourceTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <a>GetCredentialsForIdentity</a> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.RoleMapping"> <summary> <para> <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".</para><para>Up to 25 rules can be specified per identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.Role"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentity.Model.SetIdentityPoolRolesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.SetCGIPrincipalTagAttributeMapCmdlet"> <summary> You can use this operation to use default (username and clientID) attribute or custom attribute mappings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIPrincipalTagAttributeMapCmdlet.IdentityPoolId"> <summary> <para> <para>The ID of the Identity Pool you want to set attribute mappings for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIPrincipalTagAttributeMapCmdlet.IdentityProviderName"> <summary> <para> <para>The provider name you want to use for attribute mappings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIPrincipalTagAttributeMapCmdlet.PrincipalTag"> <summary> <para> <para>You can use this operation to add principal tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIPrincipalTagAttributeMapCmdlet.UseDefault"> <summary> <para> <para>You can use this operation to use default (username and clientID) attribute mappings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIPrincipalTagAttributeMapCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIPrincipalTagAttributeMapCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIPrincipalTagAttributeMapCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet"> <summary> Updates an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.AllowClassicFlow"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.AllowUnauthenticatedIdentity"> <summary> <para> <para>TRUE if the identity pool supports unauthenticated logins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.CognitoIdentityProvider"> <summary> <para> <para>A list representing an Amazon Cognito user pool and its client ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.DeveloperProviderName"> <summary> <para> <para>The "domain" by which Cognito will refer to your users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.IdentityPoolName"> <summary> <para> <para>A string that you provide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.IdentityPoolTag"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.OpenIdConnectProviderARNs"> <summary> <para> <para>The ARNs of the OpenID Connect providers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.SamlProviderARNs"> <summary> <para> <para>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.SupportedLoginProvider"> <summary> <para> <para>Optional key:value pairs mapping provider names to provider app IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |