{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.CognitoIdentity.UpdateIdentityPool -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Updates an identity pool. -- -- You must use AWS Developer credentials to call this API. module Amazonka.CognitoIdentity.UpdateIdentityPool ( -- * Creating a Request UpdateIdentityPool (..), newUpdateIdentityPool, -- * Request Lenses updateIdentityPool_allowClassicFlow, updateIdentityPool_cognitoIdentityProviders, updateIdentityPool_developerProviderName, updateIdentityPool_identityPoolTags, updateIdentityPool_openIdConnectProviderARNs, updateIdentityPool_samlProviderARNs, updateIdentityPool_supportedLoginProviders, updateIdentityPool_identityPoolId, updateIdentityPool_identityPoolName, updateIdentityPool_allowUnauthenticatedIdentities, -- * Destructuring the Response IdentityPool (..), newIdentityPool, -- * Response Lenses identityPool_allowClassicFlow, identityPool_cognitoIdentityProviders, identityPool_developerProviderName, identityPool_identityPoolTags, identityPool_openIdConnectProviderARNs, identityPool_samlProviderARNs, identityPool_supportedLoginProviders, identityPool_identityPoolId, identityPool_identityPoolName, identityPool_allowUnauthenticatedIdentities, ) where import Amazonka.CognitoIdentity.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | An object representing an Amazon Cognito identity pool. -- -- /See:/ 'newUpdateIdentityPool' smart constructor. data UpdateIdentityPool = UpdateIdentityPool' { -- | Enables or disables the Basic (Classic) authentication flow. For more -- information, see -- -- in the /Amazon Cognito Developer Guide/. allowClassicFlow :: Prelude.Maybe Prelude.Bool, -- | A list representing an Amazon Cognito user pool and its client ID. cognitoIdentityProviders :: Prelude.Maybe [CognitoIdentityProvider], -- | The \"domain\" by which Cognito will refer to your users. developerProviderName :: Prelude.Maybe Prelude.Text, -- | 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. identityPoolTags :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text), -- | The ARNs of the OpenID Connect providers. openIdConnectProviderARNs :: Prelude.Maybe [Prelude.Text], -- | An array of Amazon Resource Names (ARNs) of the SAML provider for your -- identity pool. samlProviderARNs :: Prelude.Maybe [Prelude.Text], -- | Optional key:value pairs mapping provider names to provider app IDs. supportedLoginProviders :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text), -- | An identity pool ID in the format REGION:GUID. identityPoolId :: Prelude.Text, -- | A string that you provide. identityPoolName :: Prelude.Text, -- | TRUE if the identity pool supports unauthenticated logins. allowUnauthenticatedIdentities :: Prelude.Bool } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'UpdateIdentityPool' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'allowClassicFlow', 'updateIdentityPool_allowClassicFlow' - Enables or disables the Basic (Classic) authentication flow. For more -- information, see -- -- in the /Amazon Cognito Developer Guide/. -- -- 'cognitoIdentityProviders', 'updateIdentityPool_cognitoIdentityProviders' - A list representing an Amazon Cognito user pool and its client ID. -- -- 'developerProviderName', 'updateIdentityPool_developerProviderName' - The \"domain\" by which Cognito will refer to your users. -- -- 'identityPoolTags', 'updateIdentityPool_identityPoolTags' - 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. -- -- 'openIdConnectProviderARNs', 'updateIdentityPool_openIdConnectProviderARNs' - The ARNs of the OpenID Connect providers. -- -- 'samlProviderARNs', 'updateIdentityPool_samlProviderARNs' - An array of Amazon Resource Names (ARNs) of the SAML provider for your -- identity pool. -- -- 'supportedLoginProviders', 'updateIdentityPool_supportedLoginProviders' - Optional key:value pairs mapping provider names to provider app IDs. -- -- 'identityPoolId', 'updateIdentityPool_identityPoolId' - An identity pool ID in the format REGION:GUID. -- -- 'identityPoolName', 'updateIdentityPool_identityPoolName' - A string that you provide. -- -- 'allowUnauthenticatedIdentities', 'updateIdentityPool_allowUnauthenticatedIdentities' - TRUE if the identity pool supports unauthenticated logins. newUpdateIdentityPool :: -- | 'identityPoolId' Prelude.Text -> -- | 'identityPoolName' Prelude.Text -> -- | 'allowUnauthenticatedIdentities' Prelude.Bool -> UpdateIdentityPool newUpdateIdentityPool pIdentityPoolId_ pIdentityPoolName_ pAllowUnauthenticatedIdentities_ = UpdateIdentityPool' { allowClassicFlow = Prelude.Nothing, cognitoIdentityProviders = Prelude.Nothing, developerProviderName = Prelude.Nothing, identityPoolTags = Prelude.Nothing, openIdConnectProviderARNs = Prelude.Nothing, samlProviderARNs = Prelude.Nothing, supportedLoginProviders = Prelude.Nothing, identityPoolId = pIdentityPoolId_, identityPoolName = pIdentityPoolName_, allowUnauthenticatedIdentities = pAllowUnauthenticatedIdentities_ } -- | Enables or disables the Basic (Classic) authentication flow. For more -- information, see -- -- in the /Amazon Cognito Developer Guide/. updateIdentityPool_allowClassicFlow :: Lens.Lens' UpdateIdentityPool (Prelude.Maybe Prelude.Bool) updateIdentityPool_allowClassicFlow = Lens.lens (\UpdateIdentityPool' {allowClassicFlow} -> allowClassicFlow) (\s@UpdateIdentityPool' {} a -> s {allowClassicFlow = a} :: UpdateIdentityPool) -- | A list representing an Amazon Cognito user pool and its client ID. updateIdentityPool_cognitoIdentityProviders :: Lens.Lens' UpdateIdentityPool (Prelude.Maybe [CognitoIdentityProvider]) updateIdentityPool_cognitoIdentityProviders = Lens.lens (\UpdateIdentityPool' {cognitoIdentityProviders} -> cognitoIdentityProviders) (\s@UpdateIdentityPool' {} a -> s {cognitoIdentityProviders = a} :: UpdateIdentityPool) Prelude.. Lens.mapping Lens.coerced -- | The \"domain\" by which Cognito will refer to your users. updateIdentityPool_developerProviderName :: Lens.Lens' UpdateIdentityPool (Prelude.Maybe Prelude.Text) updateIdentityPool_developerProviderName = Lens.lens (\UpdateIdentityPool' {developerProviderName} -> developerProviderName) (\s@UpdateIdentityPool' {} a -> s {developerProviderName = a} :: UpdateIdentityPool) -- | 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. updateIdentityPool_identityPoolTags :: Lens.Lens' UpdateIdentityPool (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) updateIdentityPool_identityPoolTags = Lens.lens (\UpdateIdentityPool' {identityPoolTags} -> identityPoolTags) (\s@UpdateIdentityPool' {} a -> s {identityPoolTags = a} :: UpdateIdentityPool) Prelude.. Lens.mapping Lens.coerced -- | The ARNs of the OpenID Connect providers. updateIdentityPool_openIdConnectProviderARNs :: Lens.Lens' UpdateIdentityPool (Prelude.Maybe [Prelude.Text]) updateIdentityPool_openIdConnectProviderARNs = Lens.lens (\UpdateIdentityPool' {openIdConnectProviderARNs} -> openIdConnectProviderARNs) (\s@UpdateIdentityPool' {} a -> s {openIdConnectProviderARNs = a} :: UpdateIdentityPool) Prelude.. Lens.mapping Lens.coerced -- | An array of Amazon Resource Names (ARNs) of the SAML provider for your -- identity pool. updateIdentityPool_samlProviderARNs :: Lens.Lens' UpdateIdentityPool (Prelude.Maybe [Prelude.Text]) updateIdentityPool_samlProviderARNs = Lens.lens (\UpdateIdentityPool' {samlProviderARNs} -> samlProviderARNs) (\s@UpdateIdentityPool' {} a -> s {samlProviderARNs = a} :: UpdateIdentityPool) Prelude.. Lens.mapping Lens.coerced -- | Optional key:value pairs mapping provider names to provider app IDs. updateIdentityPool_supportedLoginProviders :: Lens.Lens' UpdateIdentityPool (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) updateIdentityPool_supportedLoginProviders = Lens.lens (\UpdateIdentityPool' {supportedLoginProviders} -> supportedLoginProviders) (\s@UpdateIdentityPool' {} a -> s {supportedLoginProviders = a} :: UpdateIdentityPool) Prelude.. Lens.mapping Lens.coerced -- | An identity pool ID in the format REGION:GUID. updateIdentityPool_identityPoolId :: Lens.Lens' UpdateIdentityPool Prelude.Text updateIdentityPool_identityPoolId = Lens.lens (\UpdateIdentityPool' {identityPoolId} -> identityPoolId) (\s@UpdateIdentityPool' {} a -> s {identityPoolId = a} :: UpdateIdentityPool) -- | A string that you provide. updateIdentityPool_identityPoolName :: Lens.Lens' UpdateIdentityPool Prelude.Text updateIdentityPool_identityPoolName = Lens.lens (\UpdateIdentityPool' {identityPoolName} -> identityPoolName) (\s@UpdateIdentityPool' {} a -> s {identityPoolName = a} :: UpdateIdentityPool) -- | TRUE if the identity pool supports unauthenticated logins. updateIdentityPool_allowUnauthenticatedIdentities :: Lens.Lens' UpdateIdentityPool Prelude.Bool updateIdentityPool_allowUnauthenticatedIdentities = Lens.lens (\UpdateIdentityPool' {allowUnauthenticatedIdentities} -> allowUnauthenticatedIdentities) (\s@UpdateIdentityPool' {} a -> s {allowUnauthenticatedIdentities = a} :: UpdateIdentityPool) instance Core.AWSRequest UpdateIdentityPool where type AWSResponse UpdateIdentityPool = IdentityPool request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON (\s h x -> Data.eitherParseJSON x) instance Prelude.Hashable UpdateIdentityPool where hashWithSalt _salt UpdateIdentityPool' {..} = _salt `Prelude.hashWithSalt` allowClassicFlow `Prelude.hashWithSalt` cognitoIdentityProviders `Prelude.hashWithSalt` developerProviderName `Prelude.hashWithSalt` identityPoolTags `Prelude.hashWithSalt` openIdConnectProviderARNs `Prelude.hashWithSalt` samlProviderARNs `Prelude.hashWithSalt` supportedLoginProviders `Prelude.hashWithSalt` identityPoolId `Prelude.hashWithSalt` identityPoolName `Prelude.hashWithSalt` allowUnauthenticatedIdentities instance Prelude.NFData UpdateIdentityPool where rnf UpdateIdentityPool' {..} = Prelude.rnf allowClassicFlow `Prelude.seq` Prelude.rnf cognitoIdentityProviders `Prelude.seq` Prelude.rnf developerProviderName `Prelude.seq` Prelude.rnf identityPoolTags `Prelude.seq` Prelude.rnf openIdConnectProviderARNs `Prelude.seq` Prelude.rnf samlProviderARNs `Prelude.seq` Prelude.rnf supportedLoginProviders `Prelude.seq` Prelude.rnf identityPoolId `Prelude.seq` Prelude.rnf identityPoolName `Prelude.seq` Prelude.rnf allowUnauthenticatedIdentities instance Data.ToHeaders UpdateIdentityPool where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AWSCognitoIdentityService.UpdateIdentityPool" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON UpdateIdentityPool where toJSON UpdateIdentityPool' {..} = Data.object ( Prelude.catMaybes [ ("AllowClassicFlow" Data..=) Prelude.<$> allowClassicFlow, ("CognitoIdentityProviders" Data..=) Prelude.<$> cognitoIdentityProviders, ("DeveloperProviderName" Data..=) Prelude.<$> developerProviderName, ("IdentityPoolTags" Data..=) Prelude.<$> identityPoolTags, ("OpenIdConnectProviderARNs" Data..=) Prelude.<$> openIdConnectProviderARNs, ("SamlProviderARNs" Data..=) Prelude.<$> samlProviderARNs, ("SupportedLoginProviders" Data..=) Prelude.<$> supportedLoginProviders, Prelude.Just ("IdentityPoolId" Data..= identityPoolId), Prelude.Just ("IdentityPoolName" Data..= identityPoolName), Prelude.Just ( "AllowUnauthenticatedIdentities" Data..= allowUnauthenticatedIdentities ) ] ) instance Data.ToPath UpdateIdentityPool where toPath = Prelude.const "/" instance Data.ToQuery UpdateIdentityPool where toQuery = Prelude.const Prelude.mempty