summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrendanHay <>2016-12-04 15:32:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2016-12-04 15:32:00 (GMT)
commit9fea5b779456da1ad9d41c653b399be299496621 (patch)
tree7be1a8f20f84f9bf5436d3961f1765e4e08c66e5
parent4a660a960c49d97be77ef7bae33c6aac63cc67cc (diff)
version 1.4.51.4.5
-rw-r--r--README.md77
-rw-r--r--amazonka-cognito-identity.cabal83
-rw-r--r--gen/Network/AWS/CognitoIdentity.hs9
-rw-r--r--gen/Network/AWS/CognitoIdentity/CreateIdentityPool.hs28
-rw-r--r--gen/Network/AWS/CognitoIdentity/DeleteIdentities.hs18
-rw-r--r--gen/Network/AWS/CognitoIdentity/DeleteIdentityPool.hs6
-rw-r--r--gen/Network/AWS/CognitoIdentity/DescribeIdentity.hs8
-rw-r--r--gen/Network/AWS/CognitoIdentity/DescribeIdentityPool.hs4
-rw-r--r--gen/Network/AWS/CognitoIdentity/GetCredentialsForIdentity.hs24
-rw-r--r--gen/Network/AWS/CognitoIdentity/GetId.hs24
-rw-r--r--gen/Network/AWS/CognitoIdentity/GetIdentityPoolRoles.hs20
-rw-r--r--gen/Network/AWS/CognitoIdentity/GetOpenIdToken.hs18
-rw-r--r--gen/Network/AWS/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.hs34
-rw-r--r--gen/Network/AWS/CognitoIdentity/ListIdentities.hs20
-rw-r--r--gen/Network/AWS/CognitoIdentity/ListIdentityPools.hs14
-rw-r--r--gen/Network/AWS/CognitoIdentity/LookupDeveloperIdentity.hs36
-rw-r--r--gen/Network/AWS/CognitoIdentity/MergeDeveloperIdentities.hs32
-rw-r--r--gen/Network/AWS/CognitoIdentity/SetIdentityPoolRoles.hs14
-rw-r--r--gen/Network/AWS/CognitoIdentity/Types.hs12
-rw-r--r--gen/Network/AWS/CognitoIdentity/Types/Product.hs54
-rw-r--r--gen/Network/AWS/CognitoIdentity/UnlinkDeveloperIdentity.hs18
-rw-r--r--gen/Network/AWS/CognitoIdentity/UnlinkIdentity.hs8
-rw-r--r--gen/Network/AWS/CognitoIdentity/UpdateIdentityPool.hs20
23 files changed, 264 insertions, 317 deletions
diff --git a/README.md b/README.md
index 8bfccd9..8e16a7e 100644
--- a/README.md
+++ b/README.md
@@ -8,87 +8,28 @@
## Version
-`1.4.4`
+`1.4.5`
## Description
-Amazon Cognito
-
-Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
-
-Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
-
-To provide end-user credentials, first make an unsigned call to < GetId>. If the end user is authenticated with one of the supported identity providers, set the
- @
- Logins
- @
- map with the identity provider token.
- @
- GetId
- @
- returns a unique identifier for the user.
-
-Next, make an unsigned call to < GetCredentialsForIdentity>. This call expects the same
- @
- Logins
- @
- map as the
- @
- GetId
- @
- call, as well as the
- @
- IdentityID
- @
- originally returned by
- @
- GetId
- @
- . Assuming your identity pool has been configured via the < SetIdentityPoolRoles> operation,
- @
- GetCredentialsForIdentity
- @
- will return AWS credentials for your use. If your pool has not been configured with
- @
- SetIdentityPoolRoles
- @
- , or if you want to follow legacy flow, make an unsigned call to < GetOpenIdToken>, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same
- @
- Logins
- @
- map as the
- @
- GetId
- @
- call, as well as the
- @
- IdentityID
- @
- originally returned by
- @
- GetId
- @
- . The token returned by
- @
- GetOpenIdToken
- @
- can be passed to the STS operation <http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html AssumeRoleWithWebIdentity> to retrieve AWS credentials.
-
-If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <http://docs.aws.amazon.com/mobile/index.html AWS Mobile SDK Developer Guide>.
-
Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-cognito-identity)
and the [AWS API Reference](https://aws.amazon.com/documentation/).
The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka),
-which provides mechanisms for specifying AuthN/AuthZ information and sending requests.
+which provides mechanisms for specifying AuthN/AuthZ information, sending requests,
+and receiving responses.
-Use of lenses is required for constructing and manipulating types.
-This is due to the amount of nesting of AWS types and transparency regarding
+Lenses are used for constructing and manipulating types,
+due to the depth of nesting of AWS types and transparency regarding
de/serialisation into more palatable Haskell values.
The provided lenses should be compatible with any of the major lens libraries
[lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core).
+See [Network.AWS.CognitoIdentity](http://hackage.haskell.org/package/amazonka-cognito-identity/docs/Network-AWS-CognitoIdentity.html)
+or [the AWS documentation](https://aws.amazon.com/documentation/) to get started.
+
+
## Contribute
For any problems, comments, or feedback please create an issue [here on GitHub](https://github.com/brendanhay/amazonka/issues).
diff --git a/amazonka-cognito-identity.cabal b/amazonka-cognito-identity.cabal
index 12b6427..800bfdc 100644
--- a/amazonka-cognito-identity.cabal
+++ b/amazonka-cognito-identity.cabal
@@ -1,5 +1,5 @@
name: amazonka-cognito-identity
-version: 1.4.4
+version: 1.4.5
synopsis: Amazon Cognito Identity SDK.
homepage: https://github.com/brendanhay/amazonka
bug-reports: https://github.com/brendanhay/amazonka/issues
@@ -13,82 +13,19 @@ build-type: Simple
cabal-version: >= 1.10
extra-source-files: README.md fixture/*.yaml fixture/*.proto src/.gitkeep
description:
- Amazon Cognito
-
- Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
-
- Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
-
- To provide end-user credentials, first make an unsigned call to < GetId>. If the end user is authenticated with one of the supported identity providers, set the
- @
- Logins
- @
- map with the identity provider token.
- @
- GetId
- @
- returns a unique identifier for the user.
-
- Next, make an unsigned call to < GetCredentialsForIdentity>. This call expects the same
- @
- Logins
- @
- map as the
- @
- GetId
- @
- call, as well as the
- @
- IdentityID
- @
- originally returned by
- @
- GetId
- @
- . Assuming your identity pool has been configured via the < SetIdentityPoolRoles> operation,
- @
- GetCredentialsForIdentity
- @
- will return AWS credentials for your use. If your pool has not been configured with
- @
- SetIdentityPoolRoles
- @
- , or if you want to follow legacy flow, make an unsigned call to < GetOpenIdToken>, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same
- @
- Logins
- @
- map as the
- @
- GetId
- @
- call, as well as the
- @
- IdentityID
- @
- originally returned by
- @
- GetId
- @
- . The token returned by
- @
- GetOpenIdToken
- @
- can be passed to the STS operation <http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html AssumeRoleWithWebIdentity> to retrieve AWS credentials.
-
- If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <http://docs.aws.amazon.com/mobile/index.html AWS Mobile SDK Developer Guide>.
- .
The types from this library are intended to be used with
<http://hackage.haskell.org/package/amazonka amazonka>, which provides
- mechanisms for specifying AuthN/AuthZ information and sending requests.
+ mechanisms for specifying AuthN/AuthZ information, sending requests,
+ and receiving responses.
.
- Use of lenses is required for constructing and manipulating types.
- This is due to the amount of nesting of AWS types and transparency regarding
+ Lenses are used for constructing and manipulating types,
+ due to the depth of nesting of AWS types and transparency regarding
de/serialisation into more palatable Haskell values.
The provided lenses should be compatible with any of the major lens libraries
such as <http://hackage.haskell.org/package/lens lens> or
<http://hackage.haskell.org/package/lens-family-core lens-family-core>.
.
- See "Network.AWS.CognitoIdentity" or <https://aws.amazon.com/documentation/ the AWS Documentation>
+ See "Network.AWS.CognitoIdentity" or <https://aws.amazon.com/documentation/ the AWS documentation>
to get started.
source-repository head
@@ -129,7 +66,7 @@ library
, Network.AWS.CognitoIdentity.Types.Sum
build-depends:
- amazonka-core == 1.4.4.*
+ amazonka-core == 1.4.5.*
, base >= 4.7 && < 5
test-suite amazonka-cognito-identity-test
@@ -149,9 +86,9 @@ test-suite amazonka-cognito-identity-test
, Test.AWS.CognitoIdentity.Internal
build-depends:
- amazonka-core == 1.4.4.*
- , amazonka-test == 1.4.4.*
- , amazonka-cognito-identity == 1.4.4.*
+ amazonka-core == 1.4.5.*
+ , amazonka-test == 1.4.5.*
+ , amazonka-cognito-identity == 1.4.5.*
, base
, bytestring
, tasty
diff --git a/gen/Network/AWS/CognitoIdentity.hs b/gen/Network/AWS/CognitoIdentity.hs
index 4046f8e..2765770 100644
--- a/gen/Network/AWS/CognitoIdentity.hs
+++ b/gen/Network/AWS/CognitoIdentity.hs
@@ -11,17 +11,18 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Amazon Cognito
+-- __Amazon Cognito__
--
-- Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
--
-- Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
--
--- To provide end-user credentials, first make an unsigned call to < GetId>. If the end user is authenticated with one of the supported identity providers, set the 'Logins' map with the identity provider token. 'GetId' returns a unique identifier for the user.
+-- To provide end-user credentials, first make an unsigned call to 'GetId' . If the end user is authenticated with one of the supported identity providers, set the @Logins@ map with the identity provider token. @GetId@ returns a unique identifier for the user.
--
--- Next, make an unsigned call to < GetCredentialsForIdentity>. This call expects the same 'Logins' map as the 'GetId' call, as well as the 'IdentityID' originally returned by 'GetId'. Assuming your identity pool has been configured via the < SetIdentityPoolRoles> operation, 'GetCredentialsForIdentity' will return AWS credentials for your use. If your pool has not been configured with 'SetIdentityPoolRoles', or if you want to follow legacy flow, make an unsigned call to < GetOpenIdToken>, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same 'Logins' map as the 'GetId' call, as well as the 'IdentityID' originally returned by 'GetId'. The token returned by 'GetOpenIdToken' can be passed to the STS operation <http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html AssumeRoleWithWebIdentity> to retrieve AWS credentials.
+-- Next, make an unsigned call to 'GetCredentialsForIdentity' . This call expects the same @Logins@ map as the @GetId@ call, as well as the @IdentityID@ originally returned by @GetId@ . Assuming your identity pool has been configured via the 'SetIdentityPoolRoles' operation, @GetCredentialsForIdentity@ will return AWS credentials for your use. If your pool has not been configured with @SetIdentityPoolRoles@ , or if you want to follow legacy flow, make an unsigned call to 'GetOpenIdToken' , which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same @Logins@ map as the @GetId@ call, as well as the @IdentityID@ originally returned by @GetId@ . The token returned by @GetOpenIdToken@ can be passed to the STS operation <http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html AssumeRoleWithWebIdentity> to retrieve AWS credentials.
+--
+-- If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <http://docs.aws.amazon.com/mobile/index.html AWS Mobile SDK Developer Guide> .
--
--- If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <http://docs.aws.amazon.com/mobile/index.html AWS Mobile SDK Developer Guide>.
module Network.AWS.CognitoIdentity
(
-- * Service Configuration
diff --git a/gen/Network/AWS/CognitoIdentity/CreateIdentityPool.hs b/gen/Network/AWS/CognitoIdentity/CreateIdentityPool.hs
index 5c74dbb..01011a6 100644
--- a/gen/Network/AWS/CognitoIdentity/CreateIdentityPool.hs
+++ b/gen/Network/AWS/CognitoIdentity/CreateIdentityPool.hs
@@ -18,15 +18,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for 'SupportedLoginProviders' are as follows:
+-- Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for @SupportedLoginProviders@ are as follows: * Facebook: @graph.facebook.com@ * Google: @accounts.google.com@ * Amazon: @www.amazon.com@ * Twitter: @api.twitter.com@ * Digits: @www.digits.com@
--
--- - Facebook: 'graph.facebook.com'
--- - Google: 'accounts.google.com'
--- - Amazon: 'www.amazon.com'
--- - Twitter: 'api.twitter.com'
--- - Digits: 'www.digits.com'
--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.CreateIdentityPool
(
-- * Creating a Request
@@ -64,6 +60,8 @@ import Network.AWS.Response
-- | Input to the CreateIdentityPool action.
--
+--
+--
-- /See:/ 'createIdentityPool' smart constructor.
data CreateIdentityPool = CreateIdentityPool'
{ _cipSamlProviderARNs :: !(Maybe [Text])
@@ -79,19 +77,19 @@ data CreateIdentityPool = CreateIdentityPool'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'cipSamlProviderARNs'
+-- * 'cipSamlProviderARNs' - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
--
--- * 'cipSupportedLoginProviders'
+-- * 'cipSupportedLoginProviders' - Optional key:value pairs mapping provider names to provider app IDs.
--
--- * 'cipDeveloperProviderName'
+-- * 'cipDeveloperProviderName' - 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 @DeveloperProviderName@ , you can use letters as well as period (@.@ ), underscore (@_@ ), and dash (@-@ ). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
--
--- * 'cipOpenIdConnectProviderARNs'
+-- * 'cipOpenIdConnectProviderARNs' - A list of OpendID Connect provider ARNs.
--
--- * 'cipCognitoIdentityProviders'
+-- * 'cipCognitoIdentityProviders' - An array of Amazon Cognito Identity user pools.
--
--- * 'cipIdentityPoolName'
+-- * 'cipIdentityPoolName' - A string that you provide.
--
--- * 'cipAllowUnauthenticatedIdentities'
+-- * 'cipAllowUnauthenticatedIdentities' - TRUE if the identity pool supports unauthenticated logins.
createIdentityPool
:: Text -- ^ 'cipIdentityPoolName'
-> Bool -- ^ 'cipAllowUnauthenticatedIdentities'
@@ -115,9 +113,7 @@ cipSamlProviderARNs = lens _cipSamlProviderARNs (\ s a -> s{_cipSamlProviderARNs
cipSupportedLoginProviders :: Lens' CreateIdentityPool (HashMap Text Text)
cipSupportedLoginProviders = lens _cipSupportedLoginProviders (\ s a -> s{_cipSupportedLoginProviders = a}) . _Default . _Map;
--- | 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 'DeveloperProviderName', you can use letters as well as period ('.'), underscore ('_'), and dash ('-').
---
--- Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
+-- | 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 @DeveloperProviderName@ , you can use letters as well as period (@.@ ), underscore (@_@ ), and dash (@-@ ). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
cipDeveloperProviderName :: Lens' CreateIdentityPool (Maybe Text)
cipDeveloperProviderName = lens _cipDeveloperProviderName (\ s a -> s{_cipDeveloperProviderName = a});
diff --git a/gen/Network/AWS/CognitoIdentity/DeleteIdentities.hs b/gen/Network/AWS/CognitoIdentity/DeleteIdentities.hs
index cd3949b..33fe2cd 100644
--- a/gen/Network/AWS/CognitoIdentity/DeleteIdentities.hs
+++ b/gen/Network/AWS/CognitoIdentity/DeleteIdentities.hs
@@ -20,7 +20,9 @@
--
-- Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.
--
+--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.DeleteIdentities
(
-- * Creating a Request
@@ -44,7 +46,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Input to the 'DeleteIdentities' action.
+-- | Input to the @DeleteIdentities@ action.
+--
+--
--
-- /See:/ 'deleteIdentities' smart constructor.
newtype DeleteIdentities = DeleteIdentities'
@@ -55,7 +59,7 @@ newtype DeleteIdentities = DeleteIdentities'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'diIdentityIdsToDelete'
+-- * 'diIdentityIdsToDelete' - A list of 1-60 identities that you want to delete.
deleteIdentities
:: NonEmpty Text -- ^ 'diIdentityIdsToDelete'
-> DeleteIdentities
@@ -105,7 +109,9 @@ instance ToPath DeleteIdentities where
instance ToQuery DeleteIdentities where
toQuery = const mempty
--- | Returned in response to a successful 'DeleteIdentities' operation.
+-- | Returned in response to a successful @DeleteIdentities@ operation.
+--
+--
--
-- /See:/ 'deleteIdentitiesResponse' smart constructor.
data DeleteIdentitiesResponse = DeleteIdentitiesResponse'
@@ -117,9 +123,9 @@ data DeleteIdentitiesResponse = DeleteIdentitiesResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dirsUnprocessedIdentityIds'
+-- * 'dirsUnprocessedIdentityIds' - An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
--
--- * 'dirsResponseStatus'
+-- * 'dirsResponseStatus' - -- | The response status code.
deleteIdentitiesResponse
:: Int -- ^ 'dirsResponseStatus'
-> DeleteIdentitiesResponse
@@ -133,7 +139,7 @@ deleteIdentitiesResponse pResponseStatus_ =
dirsUnprocessedIdentityIds :: Lens' DeleteIdentitiesResponse [UnprocessedIdentityId]
dirsUnprocessedIdentityIds = lens _dirsUnprocessedIdentityIds (\ s a -> s{_dirsUnprocessedIdentityIds = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
dirsResponseStatus :: Lens' DeleteIdentitiesResponse Int
dirsResponseStatus = lens _dirsResponseStatus (\ s a -> s{_dirsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/DeleteIdentityPool.hs b/gen/Network/AWS/CognitoIdentity/DeleteIdentityPool.hs
index 5fbf19a..3938d71 100644
--- a/gen/Network/AWS/CognitoIdentity/DeleteIdentityPool.hs
+++ b/gen/Network/AWS/CognitoIdentity/DeleteIdentityPool.hs
@@ -20,7 +20,9 @@
--
-- Deletes a user 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.
+--
module Network.AWS.CognitoIdentity.DeleteIdentityPool
(
-- * Creating a Request
@@ -43,6 +45,8 @@ import Network.AWS.Response
-- | Input to the DeleteIdentityPool action.
--
+--
+--
-- /See:/ 'deleteIdentityPool' smart constructor.
newtype DeleteIdentityPool = DeleteIdentityPool'
{ _dIdentityPoolId :: Text
@@ -52,7 +56,7 @@ newtype DeleteIdentityPool = DeleteIdentityPool'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dIdentityPoolId'
+-- * 'dIdentityPoolId' - An identity pool ID in the format REGION:GUID.
deleteIdentityPool
:: Text -- ^ 'dIdentityPoolId'
-> DeleteIdentityPool
diff --git a/gen/Network/AWS/CognitoIdentity/DescribeIdentity.hs b/gen/Network/AWS/CognitoIdentity/DescribeIdentity.hs
index dbfcdfa..73ee8f5 100644
--- a/gen/Network/AWS/CognitoIdentity/DescribeIdentity.hs
+++ b/gen/Network/AWS/CognitoIdentity/DescribeIdentity.hs
@@ -20,7 +20,9 @@
--
-- Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
--
+--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.DescribeIdentity
(
-- * Creating a Request
@@ -46,7 +48,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Input to the 'DescribeIdentity' action.
+-- | Input to the @DescribeIdentity@ action.
+--
+--
--
-- /See:/ 'describeIdentity' smart constructor.
newtype DescribeIdentity = DescribeIdentity'
@@ -57,7 +61,7 @@ newtype DescribeIdentity = DescribeIdentity'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'diIdentityId'
+-- * 'diIdentityId' - A unique identifier in the format REGION:GUID.
describeIdentity
:: Text -- ^ 'diIdentityId'
-> DescribeIdentity
diff --git a/gen/Network/AWS/CognitoIdentity/DescribeIdentityPool.hs b/gen/Network/AWS/CognitoIdentity/DescribeIdentityPool.hs
index d534790..6be482b 100644
--- a/gen/Network/AWS/CognitoIdentity/DescribeIdentityPool.hs
+++ b/gen/Network/AWS/CognitoIdentity/DescribeIdentityPool.hs
@@ -20,7 +20,9 @@
--
-- 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.
+--
module Network.AWS.CognitoIdentity.DescribeIdentityPool
(
-- * Creating a Request
@@ -61,7 +63,7 @@ newtype DescribeIdentityPool = DescribeIdentityPool'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dipIdentityPoolId'
+-- * 'dipIdentityPoolId' - An identity pool ID in the format REGION:GUID.
describeIdentityPool
:: Text -- ^ 'dipIdentityPoolId'
-> DescribeIdentityPool
diff --git a/gen/Network/AWS/CognitoIdentity/GetCredentialsForIdentity.hs b/gen/Network/AWS/CognitoIdentity/GetCredentialsForIdentity.hs
index 48b50fd..e647558 100644
--- a/gen/Network/AWS/CognitoIdentity/GetCredentialsForIdentity.hs
+++ b/gen/Network/AWS/CognitoIdentity/GetCredentialsForIdentity.hs
@@ -20,7 +20,9 @@
--
-- 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.
--
+--
-- This is a public API. You do not need any credentials to call this API.
+--
module Network.AWS.CognitoIdentity.GetCredentialsForIdentity
(
-- * Creating a Request
@@ -47,7 +49,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Input to the 'GetCredentialsForIdentity' action.
+-- | Input to the @GetCredentialsForIdentity@ action.
+--
+--
--
-- /See:/ 'getCredentialsForIdentity' smart constructor.
data GetCredentialsForIdentity = GetCredentialsForIdentity'
@@ -60,11 +64,11 @@ data GetCredentialsForIdentity = GetCredentialsForIdentity'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gcfiCustomRoleARN'
+-- * 'gcfiCustomRoleARN' - 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.
--
--- * 'gcfiLogins'
+-- * 'gcfiLogins' - A set of optional name-value pairs that map provider names to provider tokens.
--
--- * 'gcfiIdentityId'
+-- * 'gcfiIdentityId' - A unique identifier in the format REGION:GUID.
getCredentialsForIdentity
:: Text -- ^ 'gcfiIdentityId'
-> GetCredentialsForIdentity
@@ -126,7 +130,9 @@ instance ToPath GetCredentialsForIdentity where
instance ToQuery GetCredentialsForIdentity where
toQuery = const mempty
--- | Returned in response to a successful 'GetCredentialsForIdentity' operation.
+-- | Returned in response to a successful @GetCredentialsForIdentity@ operation.
+--
+--
--
-- /See:/ 'getCredentialsForIdentityResponse' smart constructor.
data GetCredentialsForIdentityResponse = GetCredentialsForIdentityResponse'
@@ -139,11 +145,11 @@ data GetCredentialsForIdentityResponse = GetCredentialsForIdentityResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gcfirsCredentials'
+-- * 'gcfirsCredentials' - Credentials for the provided identity ID.
--
--- * 'gcfirsIdentityId'
+-- * 'gcfirsIdentityId' - A unique identifier in the format REGION:GUID.
--
--- * 'gcfirsResponseStatus'
+-- * 'gcfirsResponseStatus' - -- | The response status code.
getCredentialsForIdentityResponse
:: Int -- ^ 'gcfirsResponseStatus'
-> GetCredentialsForIdentityResponse
@@ -162,7 +168,7 @@ gcfirsCredentials = lens _gcfirsCredentials (\ s a -> s{_gcfirsCredentials = a})
gcfirsIdentityId :: Lens' GetCredentialsForIdentityResponse (Maybe Text)
gcfirsIdentityId = lens _gcfirsIdentityId (\ s a -> s{_gcfirsIdentityId = a});
--- | The response status code.
+-- | -- | The response status code.
gcfirsResponseStatus :: Lens' GetCredentialsForIdentityResponse Int
gcfirsResponseStatus = lens _gcfirsResponseStatus (\ s a -> s{_gcfirsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/GetId.hs b/gen/Network/AWS/CognitoIdentity/GetId.hs
index 57654f2..10e9d67 100644
--- a/gen/Network/AWS/CognitoIdentity/GetId.hs
+++ b/gen/Network/AWS/CognitoIdentity/GetId.hs
@@ -20,7 +20,9 @@
--
-- Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
--
+--
-- This is a public API. You do not need any credentials to call this API.
+--
module Network.AWS.CognitoIdentity.GetId
(
-- * Creating a Request
@@ -59,11 +61,11 @@ data GetId = GetId'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'giAccountId'
+-- * 'giAccountId' - A standard AWS account ID (9+ digits).
--
--- * 'giLogins'
+-- * 'giLogins' - A set of optional name-value pairs that map provider names to provider tokens. The available provider names for @Logins@ are as follows: * Facebook: @graph.facebook.com@ * Google: @accounts.google.com@ * Amazon: @www.amazon.com@ * Twitter: @api.twitter.com@ * Digits: @www.digits.com@
--
--- * 'giIdentityPoolId'
+-- * 'giIdentityPoolId' - An identity pool ID in the format REGION:GUID.
getId
:: Text -- ^ 'giIdentityPoolId'
-> GetId
@@ -78,15 +80,7 @@ getId pIdentityPoolId_ =
giAccountId :: Lens' GetId (Maybe Text)
giAccountId = lens _giAccountId (\ s a -> s{_giAccountId = a});
--- | A set of optional name-value pairs that map provider names to provider tokens.
---
--- The available provider names for 'Logins' are as follows:
---
--- - Facebook: 'graph.facebook.com'
--- - Google: 'accounts.google.com'
--- - Amazon: 'www.amazon.com'
--- - Twitter: 'api.twitter.com'
--- - Digits: 'www.digits.com'
+-- | A set of optional name-value pairs that map provider names to provider tokens. The available provider names for @Logins@ are as follows: * Facebook: @graph.facebook.com@ * Google: @accounts.google.com@ * Amazon: @www.amazon.com@ * Twitter: @api.twitter.com@ * Digits: @www.digits.com@
giLogins :: Lens' GetId (HashMap Text Text)
giLogins = lens _giLogins (\ s a -> s{_giLogins = a}) . _Default . _Map;
@@ -142,9 +136,9 @@ data GetIdResponse = GetIdResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'girsIdentityId'
+-- * 'girsIdentityId' - A unique identifier in the format REGION:GUID.
--
--- * 'girsResponseStatus'
+-- * 'girsResponseStatus' - -- | The response status code.
getIdResponse
:: Int -- ^ 'girsResponseStatus'
-> GetIdResponse
@@ -158,7 +152,7 @@ getIdResponse pResponseStatus_ =
girsIdentityId :: Lens' GetIdResponse (Maybe Text)
girsIdentityId = lens _girsIdentityId (\ s a -> s{_girsIdentityId = a});
--- | The response status code.
+-- | -- | The response status code.
girsResponseStatus :: Lens' GetIdResponse Int
girsResponseStatus = lens _girsResponseStatus (\ s a -> s{_girsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/GetIdentityPoolRoles.hs b/gen/Network/AWS/CognitoIdentity/GetIdentityPoolRoles.hs
index 5a87f13..fa19e33 100644
--- a/gen/Network/AWS/CognitoIdentity/GetIdentityPoolRoles.hs
+++ b/gen/Network/AWS/CognitoIdentity/GetIdentityPoolRoles.hs
@@ -20,7 +20,9 @@
--
-- Gets the roles for an identity pool.
--
+--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.GetIdentityPoolRoles
(
-- * Creating a Request
@@ -45,7 +47,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Input to the 'GetIdentityPoolRoles' action.
+-- | Input to the @GetIdentityPoolRoles@ action.
+--
+--
--
-- /See:/ 'getIdentityPoolRoles' smart constructor.
newtype GetIdentityPoolRoles = GetIdentityPoolRoles'
@@ -56,7 +60,7 @@ newtype GetIdentityPoolRoles = GetIdentityPoolRoles'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'giprIdentityPoolId'
+-- * 'giprIdentityPoolId' - An identity pool ID in the format REGION:GUID.
getIdentityPoolRoles
:: Text -- ^ 'giprIdentityPoolId'
-> GetIdentityPoolRoles
@@ -107,7 +111,9 @@ instance ToPath GetIdentityPoolRoles where
instance ToQuery GetIdentityPoolRoles where
toQuery = const mempty
--- | Returned in response to a successful 'GetIdentityPoolRoles' operation.
+-- | Returned in response to a successful @GetIdentityPoolRoles@ operation.
+--
+--
--
-- /See:/ 'getIdentityPoolRolesResponse' smart constructor.
data GetIdentityPoolRolesResponse = GetIdentityPoolRolesResponse'
@@ -120,11 +126,11 @@ data GetIdentityPoolRolesResponse = GetIdentityPoolRolesResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'giprrsRoles'
+-- * 'giprrsRoles' - The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
--
--- * 'giprrsIdentityPoolId'
+-- * 'giprrsIdentityPoolId' - An identity pool ID in the format REGION:GUID.
--
--- * 'giprrsResponseStatus'
+-- * 'giprrsResponseStatus' - -- | The response status code.
getIdentityPoolRolesResponse
:: Int -- ^ 'giprrsResponseStatus'
-> GetIdentityPoolRolesResponse
@@ -143,7 +149,7 @@ giprrsRoles = lens _giprrsRoles (\ s a -> s{_giprrsRoles = a}) . _Default . _Map
giprrsIdentityPoolId :: Lens' GetIdentityPoolRolesResponse (Maybe Text)
giprrsIdentityPoolId = lens _giprrsIdentityPoolId (\ s a -> s{_giprrsIdentityPoolId = a});
--- | The response status code.
+-- | -- | The response status code.
giprrsResponseStatus :: Lens' GetIdentityPoolRolesResponse Int
giprrsResponseStatus = lens _giprrsResponseStatus (\ s a -> s{_giprrsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/GetOpenIdToken.hs b/gen/Network/AWS/CognitoIdentity/GetOpenIdToken.hs
index 381a04e..5462f00 100644
--- a/gen/Network/AWS/CognitoIdentity/GetOpenIdToken.hs
+++ b/gen/Network/AWS/CognitoIdentity/GetOpenIdToken.hs
@@ -18,11 +18,13 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by < GetId>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
+-- Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by 'GetId' . You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
+--
--
-- The OpenId token is valid for 15 minutes.
--
-- This is a public API. You do not need any credentials to call this API.
+--
module Network.AWS.CognitoIdentity.GetOpenIdToken
(
-- * Creating a Request
@@ -60,9 +62,9 @@ data GetOpenIdToken = GetOpenIdToken'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'goitLogins'
+-- * 'goitLogins' - 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 or any other OpenId Connect provider, always include the id_token.
--
--- * 'goitIdentityId'
+-- * 'goitIdentityId' - A unique identifier in the format REGION:GUID.
getOpenIdToken
:: Text -- ^ 'goitIdentityId'
-> GetOpenIdToken
@@ -72,7 +74,7 @@ getOpenIdToken pIdentityId_ =
, _goitIdentityId = pIdentityId_
}
--- | 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 or any other OpenId Connect provider, always include the id_token.
+-- | 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 or any other OpenId Connect provider, always include the id_token.
goitLogins :: Lens' GetOpenIdToken (HashMap Text Text)
goitLogins = lens _goitLogins (\ s a -> s{_goitLogins = a}) . _Default . _Map;
@@ -130,11 +132,11 @@ data GetOpenIdTokenResponse = GetOpenIdTokenResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'goitrsToken'
+-- * 'goitrsToken' - An OpenID token, valid for 15 minutes.
--
--- * 'goitrsIdentityId'
+-- * 'goitrsIdentityId' - A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.
--
--- * 'goitrsResponseStatus'
+-- * 'goitrsResponseStatus' - -- | The response status code.
getOpenIdTokenResponse
:: Int -- ^ 'goitrsResponseStatus'
-> GetOpenIdTokenResponse
@@ -153,7 +155,7 @@ goitrsToken = lens _goitrsToken (\ s a -> s{_goitrsToken = a});
goitrsIdentityId :: Lens' GetOpenIdTokenResponse (Maybe Text)
goitrsIdentityId = lens _goitrsIdentityId (\ s a -> s{_goitrsIdentityId = a});
--- | The response status code.
+-- | -- | The response status code.
goitrsResponseStatus :: Lens' GetOpenIdTokenResponse Int
goitrsResponseStatus = lens _goitrsResponseStatus (\ s a -> s{_goitrsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.hs b/gen/Network/AWS/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.hs
index 830f66d..dc9ece3 100644
--- a/gen/Network/AWS/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.hs
+++ b/gen/Network/AWS/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.hs
@@ -18,11 +18,13 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Registers (or retrieves) a Cognito 'IdentityId' 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 'Logins' map, which is linked to the identity pool. The developer provider is the \"domain\" by which Cognito will refer to your users.
+-- Registers (or retrieves) a Cognito @IdentityId@ 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 @Logins@ map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.
--
--- You can use 'GetOpenIdTokenForDeveloperIdentity' 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 'IdentityId' 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 'IdentityId'. This API will create the identity in the specified 'IdentityPoolId'.
+--
+-- You can use @GetOpenIdTokenForDeveloperIdentity@ 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 @IdentityId@ 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 @IdentityId@ . This API will create the identity in the specified @IdentityPoolId@ .
--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity
(
-- * Creating a Request
@@ -50,7 +52,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Input to the 'GetOpenIdTokenForDeveloperIdentity' action.
+-- | Input to the @GetOpenIdTokenForDeveloperIdentity@ action.
+--
+--
--
-- /See:/ 'getOpenIdTokenForDeveloperIdentity' smart constructor.
data GetOpenIdTokenForDeveloperIdentity = GetOpenIdTokenForDeveloperIdentity'
@@ -64,13 +68,13 @@ data GetOpenIdTokenForDeveloperIdentity = GetOpenIdTokenForDeveloperIdentity'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'goitfdiTokenDuration'
+-- * 'goitfdiTokenDuration' - 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.
--
--- * 'goitfdiIdentityId'
+-- * 'goitfdiIdentityId' - A unique identifier in the format REGION:GUID.
--
--- * 'goitfdiIdentityPoolId'
+-- * 'goitfdiIdentityPoolId' - An identity pool ID in the format REGION:GUID.
--
--- * 'goitfdiLogins'
+-- * 'goitfdiLogins' - 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 @"developer_provider_name": "developer_user_identifier"@ . 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.
getOpenIdTokenForDeveloperIdentity
:: Text -- ^ 'goitfdiIdentityPoolId'
-> GetOpenIdTokenForDeveloperIdentity
@@ -82,7 +86,7 @@ getOpenIdTokenForDeveloperIdentity pIdentityPoolId_ =
, _goitfdiLogins = mempty
}
--- | 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.
+-- | 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.
goitfdiTokenDuration :: Lens' GetOpenIdTokenForDeveloperIdentity (Maybe Natural)
goitfdiTokenDuration = lens _goitfdiTokenDuration (\ s a -> s{_goitfdiTokenDuration = a}) . mapping _Nat;
@@ -94,7 +98,7 @@ goitfdiIdentityId = lens _goitfdiIdentityId (\ s a -> s{_goitfdiIdentityId = a})
goitfdiIdentityPoolId :: Lens' GetOpenIdTokenForDeveloperIdentity Text
goitfdiIdentityPoolId = lens _goitfdiIdentityPoolId (\ s a -> s{_goitfdiIdentityPoolId = a});
--- | 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 '\"developer_provider_name\": \"developer_user_identifier\"'. 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.
+-- | 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 @"developer_provider_name": "developer_user_identifier"@ . 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.
goitfdiLogins :: Lens' GetOpenIdTokenForDeveloperIdentity (HashMap Text Text)
goitfdiLogins = lens _goitfdiLogins (\ s a -> s{_goitfdiLogins = a}) . _Map;
@@ -143,7 +147,9 @@ instance ToQuery GetOpenIdTokenForDeveloperIdentity
where
toQuery = const mempty
--- | Returned in response to a successful 'GetOpenIdTokenForDeveloperIdentity' request.
+-- | Returned in response to a successful @GetOpenIdTokenForDeveloperIdentity@ request.
+--
+--
--
-- /See:/ 'getOpenIdTokenForDeveloperIdentityResponse' smart constructor.
data GetOpenIdTokenForDeveloperIdentityResponse = GetOpenIdTokenForDeveloperIdentityResponse'
@@ -156,11 +162,11 @@ data GetOpenIdTokenForDeveloperIdentityResponse = GetOpenIdTokenForDeveloperIden
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'goitfdirsToken'
+-- * 'goitfdirsToken' - An OpenID token.
--
--- * 'goitfdirsIdentityId'
+-- * 'goitfdirsIdentityId' - A unique identifier in the format REGION:GUID.
--
--- * 'goitfdirsResponseStatus'
+-- * 'goitfdirsResponseStatus' - -- | The response status code.
getOpenIdTokenForDeveloperIdentityResponse
:: Int -- ^ 'goitfdirsResponseStatus'
-> GetOpenIdTokenForDeveloperIdentityResponse
@@ -179,7 +185,7 @@ goitfdirsToken = lens _goitfdirsToken (\ s a -> s{_goitfdirsToken = a});
goitfdirsIdentityId :: Lens' GetOpenIdTokenForDeveloperIdentityResponse (Maybe Text)
goitfdirsIdentityId = lens _goitfdirsIdentityId (\ s a -> s{_goitfdirsIdentityId = a});
--- | The response status code.
+-- | -- | The response status code.
goitfdirsResponseStatus :: Lens' GetOpenIdTokenForDeveloperIdentityResponse Int
goitfdirsResponseStatus = lens _goitfdirsResponseStatus (\ s a -> s{_goitfdirsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/ListIdentities.hs b/gen/Network/AWS/CognitoIdentity/ListIdentities.hs
index 157ba00..05a43ce 100644
--- a/gen/Network/AWS/CognitoIdentity/ListIdentities.hs
+++ b/gen/Network/AWS/CognitoIdentity/ListIdentities.hs
@@ -20,7 +20,9 @@
--
-- Lists the identities in a pool.
--
+--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.ListIdentities
(
-- * Creating a Request
@@ -63,13 +65,13 @@ data ListIdentities = ListIdentities'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'liHideDisabled'
+-- * 'liHideDisabled' - An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
--
--- * 'liNextToken'
+-- * 'liNextToken' - A pagination token.
--
--- * 'liIdentityPoolId'
+-- * 'liIdentityPoolId' - An identity pool ID in the format REGION:GUID.
--
--- * 'liMaxResults'
+-- * 'liMaxResults' - The maximum number of identities to return.
listIdentities
:: Text -- ^ 'liIdentityPoolId'
-> Natural -- ^ 'liMaxResults'
@@ -152,13 +154,13 @@ data ListIdentitiesResponse = ListIdentitiesResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'lirsIdentityPoolId'
+-- * 'lirsIdentityPoolId' - An identity pool ID in the format REGION:GUID.
--
--- * 'lirsNextToken'
+-- * 'lirsNextToken' - A pagination token.
--
--- * 'lirsIdentities'
+-- * 'lirsIdentities' - An object containing a set of identities and associated mappings.
--
--- * 'lirsResponseStatus'
+-- * 'lirsResponseStatus' - -- | The response status code.
listIdentitiesResponse
:: Int -- ^ 'lirsResponseStatus'
-> ListIdentitiesResponse
@@ -182,7 +184,7 @@ lirsNextToken = lens _lirsNextToken (\ s a -> s{_lirsNextToken = a});
lirsIdentities :: Lens' ListIdentitiesResponse [IdentityDescription]
lirsIdentities = lens _lirsIdentities (\ s a -> s{_lirsIdentities = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
lirsResponseStatus :: Lens' ListIdentitiesResponse Int
lirsResponseStatus = lens _lirsResponseStatus (\ s a -> s{_lirsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/ListIdentityPools.hs b/gen/Network/AWS/CognitoIdentity/ListIdentityPools.hs
index 0c17476..7c66bf0 100644
--- a/gen/Network/AWS/CognitoIdentity/ListIdentityPools.hs
+++ b/gen/Network/AWS/CognitoIdentity/ListIdentityPools.hs
@@ -20,7 +20,9 @@
--
-- Lists all of the Cognito identity pools registered for your account.
--
+--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.ListIdentityPools
(
-- * Creating a Request
@@ -58,9 +60,9 @@ data ListIdentityPools = ListIdentityPools'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'lipNextToken'
+-- * 'lipNextToken' - A pagination token.
--
--- * 'lipMaxResults'
+-- * 'lipMaxResults' - The maximum number of identities to return.
listIdentityPools
:: Natural -- ^ 'lipMaxResults'
-> ListIdentityPools
@@ -129,11 +131,11 @@ data ListIdentityPoolsResponse = ListIdentityPoolsResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'liprsIdentityPools'
+-- * 'liprsIdentityPools' - The identity pools returned by the ListIdentityPools action.
--
--- * 'liprsNextToken'
+-- * 'liprsNextToken' - A pagination token.
--
--- * 'liprsResponseStatus'
+-- * 'liprsResponseStatus' - -- | The response status code.
listIdentityPoolsResponse
:: Int -- ^ 'liprsResponseStatus'
-> ListIdentityPoolsResponse
@@ -152,7 +154,7 @@ liprsIdentityPools = lens _liprsIdentityPools (\ s a -> s{_liprsIdentityPools =
liprsNextToken :: Lens' ListIdentityPoolsResponse (Maybe Text)
liprsNextToken = lens _liprsNextToken (\ s a -> s{_liprsNextToken = a});
--- | The response status code.
+-- | -- | The response status code.
liprsResponseStatus :: Lens' ListIdentityPoolsResponse Int
liprsResponseStatus = lens _liprsResponseStatus (\ s a -> s{_liprsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/LookupDeveloperIdentity.hs b/gen/Network/AWS/CognitoIdentity/LookupDeveloperIdentity.hs
index de2f829..f859dfb 100644
--- a/gen/Network/AWS/CognitoIdentity/LookupDeveloperIdentity.hs
+++ b/gen/Network/AWS/CognitoIdentity/LookupDeveloperIdentity.hs
@@ -18,9 +18,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Retrieves the 'IdentityID' associated with a 'DeveloperUserIdentifier' or the list of 'DeveloperUserIdentifier's associated with an 'IdentityId' for an existing identity. Either 'IdentityID' or 'DeveloperUserIdentifier' 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, 'DeveloperUserIdentifier' will be matched against 'IdentityID'. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a 'ResourceConflictException' is thrown.
+-- Retrieves the @IdentityID@ associated with a @DeveloperUserIdentifier@ or the list of @DeveloperUserIdentifier@ s associated with an @IdentityId@ for an existing identity. Either @IdentityID@ or @DeveloperUserIdentifier@ 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, @DeveloperUserIdentifier@ will be matched against @IdentityID@ . If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a @ResourceConflictException@ is thrown.
+--
--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.LookupDeveloperIdentity
(
-- * Creating a Request
@@ -50,7 +52,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Input to the 'LookupDeveloperIdentityInput' action.
+-- | Input to the @LookupDeveloperIdentityInput@ action.
+--
+--
--
-- /See:/ 'lookupDeveloperIdentity' smart constructor.
data LookupDeveloperIdentity = LookupDeveloperIdentity'
@@ -65,15 +69,15 @@ data LookupDeveloperIdentity = LookupDeveloperIdentity'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ldiDeveloperUserIdentifier'
+-- * 'ldiDeveloperUserIdentifier' - 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.
--
--- * 'ldiNextToken'
+-- * 'ldiNextToken' - A pagination token. The first call you make will have @NextToken@ set to null. After that the service will return @NextToken@ values as needed. For example, let's say you make a request with @MaxResults@ 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.
--
--- * 'ldiIdentityId'
+-- * 'ldiIdentityId' - A unique identifier in the format REGION:GUID.
--
--- * 'ldiMaxResults'
+-- * 'ldiMaxResults' - The maximum number of identities to return.
--
--- * 'ldiIdentityPoolId'
+-- * 'ldiIdentityPoolId' - An identity pool ID in the format REGION:GUID.
lookupDeveloperIdentity
:: Text -- ^ 'ldiIdentityPoolId'
-> LookupDeveloperIdentity
@@ -90,7 +94,7 @@ lookupDeveloperIdentity pIdentityPoolId_ =
ldiDeveloperUserIdentifier :: Lens' LookupDeveloperIdentity (Maybe Text)
ldiDeveloperUserIdentifier = lens _ldiDeveloperUserIdentifier (\ s a -> s{_ldiDeveloperUserIdentifier = a});
--- | A pagination token. The first call you make will have 'NextToken' set to null. After that the service will return 'NextToken' values as needed. For example, let\'s say you make a request with 'MaxResults' 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.
+-- | A pagination token. The first call you make will have @NextToken@ set to null. After that the service will return @NextToken@ values as needed. For example, let's say you make a request with @MaxResults@ 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.
ldiNextToken :: Lens' LookupDeveloperIdentity (Maybe Text)
ldiNextToken = lens _ldiNextToken (\ s a -> s{_ldiNextToken = a});
@@ -149,7 +153,9 @@ instance ToPath LookupDeveloperIdentity where
instance ToQuery LookupDeveloperIdentity where
toQuery = const mempty
--- | Returned in response to a successful 'LookupDeveloperIdentity' action.
+-- | Returned in response to a successful @LookupDeveloperIdentity@ action.
+--
+--
--
-- /See:/ 'lookupDeveloperIdentityResponse' smart constructor.
data LookupDeveloperIdentityResponse = LookupDeveloperIdentityResponse'
@@ -163,13 +169,13 @@ data LookupDeveloperIdentityResponse = LookupDeveloperIdentityResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ldirsNextToken'
+-- * 'ldirsNextToken' - A pagination token. The first call you make will have @NextToken@ set to null. After that the service will return @NextToken@ values as needed. For example, let's say you make a request with @MaxResults@ 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.
--
--- * 'ldirsIdentityId'
+-- * 'ldirsIdentityId' - A unique identifier in the format REGION:GUID.
--
--- * 'ldirsDeveloperUserIdentifierList'
+-- * 'ldirsDeveloperUserIdentifierList' - This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
--
--- * 'ldirsResponseStatus'
+-- * 'ldirsResponseStatus' - -- | The response status code.
lookupDeveloperIdentityResponse
:: Int -- ^ 'ldirsResponseStatus'
-> LookupDeveloperIdentityResponse
@@ -181,7 +187,7 @@ lookupDeveloperIdentityResponse pResponseStatus_ =
, _ldirsResponseStatus = pResponseStatus_
}
--- | A pagination token. The first call you make will have 'NextToken' set to null. After that the service will return 'NextToken' values as needed. For example, let\'s say you make a request with 'MaxResults' 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.
+-- | A pagination token. The first call you make will have @NextToken@ set to null. After that the service will return @NextToken@ values as needed. For example, let's say you make a request with @MaxResults@ 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.
ldirsNextToken :: Lens' LookupDeveloperIdentityResponse (Maybe Text)
ldirsNextToken = lens _ldirsNextToken (\ s a -> s{_ldirsNextToken = a});
@@ -193,7 +199,7 @@ ldirsIdentityId = lens _ldirsIdentityId (\ s a -> s{_ldirsIdentityId = a});
ldirsDeveloperUserIdentifierList :: Lens' LookupDeveloperIdentityResponse [Text]
ldirsDeveloperUserIdentifierList = lens _ldirsDeveloperUserIdentifierList (\ s a -> s{_ldirsDeveloperUserIdentifierList = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
ldirsResponseStatus :: Lens' LookupDeveloperIdentityResponse Int
ldirsResponseStatus = lens _ldirsResponseStatus (\ s a -> s{_ldirsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/MergeDeveloperIdentities.hs b/gen/Network/AWS/CognitoIdentity/MergeDeveloperIdentities.hs
index ea38bd0..c753db2 100644
--- a/gen/Network/AWS/CognitoIdentity/MergeDeveloperIdentities.hs
+++ b/gen/Network/AWS/CognitoIdentity/MergeDeveloperIdentities.hs
@@ -18,9 +18,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Merges two users having different 'IdentityId'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 ('SourceUserIdentifier') with the 'IdentityId' of the 'DestinationUserIdentifier'. 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.
+-- Merges two users having different @IdentityId@ 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 (@SourceUserIdentifier@ ) with the @IdentityId@ of the @DestinationUserIdentifier@ . 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.
+--
--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.MergeDeveloperIdentities
(
-- * Creating a Request
@@ -47,7 +49,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Input to the 'MergeDeveloperIdentities' action.
+-- | Input to the @MergeDeveloperIdentities@ action.
+--
+--
--
-- /See:/ 'mergeDeveloperIdentities' smart constructor.
data MergeDeveloperIdentities = MergeDeveloperIdentities'
@@ -61,13 +65,13 @@ data MergeDeveloperIdentities = MergeDeveloperIdentities'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'mdiSourceUserIdentifier'
+-- * 'mdiSourceUserIdentifier' - User identifier for the source user. The value should be a @DeveloperUserIdentifier@ .
--
--- * 'mdiDestinationUserIdentifier'
+-- * 'mdiDestinationUserIdentifier' - User identifier for the destination user. The value should be a @DeveloperUserIdentifier@ .
--
--- * 'mdiDeveloperProviderName'
+-- * 'mdiDeveloperProviderName' - 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 @DeveloperProviderName@ , you can use letters as well as period (.), underscore (_), and dash (-).
--
--- * 'mdiIdentityPoolId'
+-- * 'mdiIdentityPoolId' - An identity pool ID in the format REGION:GUID.
mergeDeveloperIdentities
:: Text -- ^ 'mdiSourceUserIdentifier'
-> Text -- ^ 'mdiDestinationUserIdentifier'
@@ -82,15 +86,15 @@ mergeDeveloperIdentities pSourceUserIdentifier_ pDestinationUserIdentifier_ pDev
, _mdiIdentityPoolId = pIdentityPoolId_
}
--- | User identifier for the source user. The value should be a 'DeveloperUserIdentifier'.
+-- | User identifier for the source user. The value should be a @DeveloperUserIdentifier@ .
mdiSourceUserIdentifier :: Lens' MergeDeveloperIdentities Text
mdiSourceUserIdentifier = lens _mdiSourceUserIdentifier (\ s a -> s{_mdiSourceUserIdentifier = a});
--- | User identifier for the destination user. The value should be a 'DeveloperUserIdentifier'.
+-- | User identifier for the destination user. The value should be a @DeveloperUserIdentifier@ .
mdiDestinationUserIdentifier :: Lens' MergeDeveloperIdentities Text
mdiDestinationUserIdentifier = lens _mdiDestinationUserIdentifier (\ s a -> s{_mdiDestinationUserIdentifier = a});
--- | 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 'DeveloperProviderName', you can use letters as well as period (.), underscore (_), and dash (-).
+-- | 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 @DeveloperProviderName@ , you can use letters as well as period (.), underscore (_), and dash (-).
mdiDeveloperProviderName :: Lens' MergeDeveloperIdentities Text
mdiDeveloperProviderName = lens _mdiDeveloperProviderName (\ s a -> s{_mdiDeveloperProviderName = a});
@@ -142,7 +146,9 @@ instance ToPath MergeDeveloperIdentities where
instance ToQuery MergeDeveloperIdentities where
toQuery = const mempty
--- | Returned in response to a successful 'MergeDeveloperIdentities' action.
+-- | Returned in response to a successful @MergeDeveloperIdentities@ action.
+--
+--
--
-- /See:/ 'mergeDeveloperIdentitiesResponse' smart constructor.
data MergeDeveloperIdentitiesResponse = MergeDeveloperIdentitiesResponse'
@@ -154,9 +160,9 @@ data MergeDeveloperIdentitiesResponse = MergeDeveloperIdentitiesResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'mdirsIdentityId'
+-- * 'mdirsIdentityId' - A unique identifier in the format REGION:GUID.
--
--- * 'mdirsResponseStatus'
+-- * 'mdirsResponseStatus' - -- | The response status code.
mergeDeveloperIdentitiesResponse
:: Int -- ^ 'mdirsResponseStatus'
-> MergeDeveloperIdentitiesResponse
@@ -170,7 +176,7 @@ mergeDeveloperIdentitiesResponse pResponseStatus_ =
mdirsIdentityId :: Lens' MergeDeveloperIdentitiesResponse (Maybe Text)
mdirsIdentityId = lens _mdirsIdentityId (\ s a -> s{_mdirsIdentityId = a});
--- | The response status code.
+-- | -- | The response status code.
mdirsResponseStatus :: Lens' MergeDeveloperIdentitiesResponse Int
mdirsResponseStatus = lens _mdirsResponseStatus (\ s a -> s{_mdirsResponseStatus = a});
diff --git a/gen/Network/AWS/CognitoIdentity/SetIdentityPoolRoles.hs b/gen/Network/AWS/CognitoIdentity/SetIdentityPoolRoles.hs
index f20c7b5..0de21ed 100644
--- a/gen/Network/AWS/CognitoIdentity/SetIdentityPoolRoles.hs
+++ b/gen/Network/AWS/CognitoIdentity/SetIdentityPoolRoles.hs
@@ -18,9 +18,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Sets the roles for an identity pool. These roles are used when making calls to 'GetCredentialsForIdentity' action.
+-- Sets the roles for an identity pool. These roles are used when making calls to @GetCredentialsForIdentity@ action.
+--
--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.SetIdentityPoolRoles
(
-- * Creating a Request
@@ -42,7 +44,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Input to the 'SetIdentityPoolRoles' action.
+-- | Input to the @SetIdentityPoolRoles@ action.
+--
+--
--
-- /See:/ 'setIdentityPoolRoles' smart constructor.
data SetIdentityPoolRoles = SetIdentityPoolRoles'
@@ -54,9 +58,9 @@ data SetIdentityPoolRoles = SetIdentityPoolRoles'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'siprIdentityPoolId'
+-- * 'siprIdentityPoolId' - An identity pool ID in the format REGION:GUID.
--
--- * 'siprRoles'
+-- * 'siprRoles' - 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.
setIdentityPoolRoles
:: Text -- ^ 'siprIdentityPoolId'
-> SetIdentityPoolRoles
@@ -70,7 +74,7 @@ setIdentityPoolRoles pIdentityPoolId_ =
siprIdentityPoolId :: Lens' SetIdentityPoolRoles Text
siprIdentityPoolId = lens _siprIdentityPoolId (\ s a -> s{_siprIdentityPoolId = a});
--- | 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.
+-- | 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.
siprRoles :: Lens' SetIdentityPoolRoles (HashMap Text Text)
siprRoles = lens _siprRoles (\ s a -> s{_siprRoles = a}) . _Map;
diff --git a/gen/Network/AWS/CognitoIdentity/Types.hs b/gen/Network/AWS/CognitoIdentity/Types.hs
index fa5abf9..455426f 100644
--- a/gen/Network/AWS/CognitoIdentity/Types.hs
+++ b/gen/Network/AWS/CognitoIdentity/Types.hs
@@ -84,7 +84,7 @@ import Network.AWS.Lens
import Network.AWS.Prelude
import Network.AWS.Sign.V4
--- | API version '2014-06-30' of the Amazon Cognito Identity SDK configuration.
+-- | API version @2014-06-30@ of the Amazon Cognito Identity SDK configuration.
cognitoIdentity :: Service
cognitoIdentity =
Service
@@ -118,7 +118,9 @@ cognitoIdentity =
| has (hasStatus 509) e = Just "limit_exceeded"
| otherwise = Nothing
--- | Thrown if the identity pool has no role associated for the given auth type (auth\/unauth) or if the AssumeRole fails.
+-- | Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
+--
+--
_InvalidIdentityPoolConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidIdentityPoolConfigurationException =
_ServiceError . hasCode "InvalidIdentityPoolConfigurationException"
@@ -137,6 +139,8 @@ _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceEr
_InternalErrorException = _ServiceError . hasCode "InternalErrorException"
-- | An exception thrown when a dependent service such as Facebook or Twitter is not responding
+--
+--
_ExternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError
_ExternalServiceException = _ServiceError . hasCode "ExternalServiceException"
@@ -145,6 +149,8 @@ _TooManyRequestsException :: AsError a => Getting (First ServiceError) a Service
_TooManyRequestsException = _ServiceError . hasCode "TooManyRequestsException"
-- | Thrown if there are parallel requests to modify a resource.
+--
+--
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
_ConcurrentModificationException =
_ServiceError . hasCode "ConcurrentModificationException"
@@ -155,6 +161,8 @@ _ResourceConflictException =
_ServiceError . hasCode "ResourceConflictException"
-- | The provided developer user identifier is already registered with Cognito under a different identity ID.
+--
+--
_DeveloperUserAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError
_DeveloperUserAlreadyRegisteredException =
_ServiceError . hasCode "DeveloperUserAlreadyRegisteredException"
diff --git a/gen/Network/AWS/CognitoIdentity/Types/Product.hs b/gen/Network/AWS/CognitoIdentity/Types/Product.hs
index 9e970d7..b1e6a64 100644
--- a/gen/Network/AWS/CognitoIdentity/Types/Product.hs
+++ b/gen/Network/AWS/CognitoIdentity/Types/Product.hs
@@ -23,6 +23,8 @@ import Network.AWS.Prelude
-- | A provider representing an Amazon Cognito Identity User Pool and its client ID.
--
+--
+--
-- /See:/ 'cognitoIdentityProvider' smart constructor.
data CognitoIdentityProvider = CognitoIdentityProvider'
{ _cipClientId :: !(Maybe Text)
@@ -33,9 +35,9 @@ data CognitoIdentityProvider = CognitoIdentityProvider'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'cipClientId'
+-- * 'cipClientId' - The client ID for the Amazon Cognito Identity User Pool.
--
--- * 'cipProviderName'
+-- * 'cipProviderName' - The provider name for an Amazon Cognito Identity User Pool. For example, @cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789@ .
cognitoIdentityProvider
:: CognitoIdentityProvider
cognitoIdentityProvider =
@@ -48,7 +50,7 @@ cognitoIdentityProvider =
cipClientId :: Lens' CognitoIdentityProvider (Maybe Text)
cipClientId = lens _cipClientId (\ s a -> s{_cipClientId = a});
--- | The provider name for an Amazon Cognito Identity User Pool. For example, 'cognito-idp.us-east-1.amazonaws.com\/us-east-1_123456789'.
+-- | The provider name for an Amazon Cognito Identity User Pool. For example, @cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789@ .
cipProviderName :: Lens' CognitoIdentityProvider (Maybe Text)
cipProviderName = lens _cipProviderName (\ s a -> s{_cipProviderName = a});
@@ -72,6 +74,8 @@ instance ToJSON CognitoIdentityProvider where
-- | Credentials for the provided identity ID.
--
+--
+--
-- /See:/ 'credentials' smart constructor.
data Credentials = Credentials'
{ _cSessionToken :: !(Maybe Text)
@@ -84,13 +88,13 @@ data Credentials = Credentials'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'cSessionToken'
+-- * 'cSessionToken' - The Session Token portion of the credentials
--
--- * 'cExpiration'
+-- * 'cExpiration' - The date at which these credentials will expire.
--
--- * 'cSecretKey'
+-- * 'cSecretKey' - The Secret Access Key portion of the credentials
--
--- * 'cAccessKeyId'
+-- * 'cAccessKeyId' - The Access Key portion of the credentials.
credentials
:: Credentials
credentials =
@@ -144,13 +148,13 @@ data IdentityDescription = IdentityDescription'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'idLastModifiedDate'
+-- * 'idLastModifiedDate' - Date on which the identity was last modified.
--
--- * 'idCreationDate'
+-- * 'idCreationDate' - Date on which the identity was created.
--
--- * 'idLogins'
+-- * 'idLogins' - A set of optional name-value pairs that map provider names to provider tokens.
--
--- * 'idIdentityId'
+-- * 'idIdentityId' - A unique identifier in the format REGION:GUID.
identityDescription
:: IdentityDescription
identityDescription =
@@ -208,21 +212,21 @@ data IdentityPool = IdentityPool'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ipSamlProviderARNs'
+-- * 'ipSamlProviderARNs' - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
--
--- * 'ipSupportedLoginProviders'
+-- * 'ipSupportedLoginProviders' - Optional key:value pairs mapping provider names to provider app IDs.
--
--- * 'ipDeveloperProviderName'
+-- * 'ipDeveloperProviderName' - The "domain" by which Cognito will refer to your users.
--
--- * 'ipOpenIdConnectProviderARNs'
+-- * 'ipOpenIdConnectProviderARNs' - A list of OpendID Connect provider ARNs.
--
--- * 'ipCognitoIdentityProviders'
+-- * 'ipCognitoIdentityProviders' - A list representing an Amazon Cognito Identity User Pool and its client ID.
--
--- * 'ipIdentityPoolId'
+-- * 'ipIdentityPoolId' - An identity pool ID in the format REGION:GUID.
--
--- * 'ipIdentityPoolName'
+-- * 'ipIdentityPoolName' - A string that you provide.
--
--- * 'ipAllowUnauthenticatedIdentities'
+-- * 'ipAllowUnauthenticatedIdentities' - TRUE if the identity pool supports unauthenticated logins.
identityPool
:: Text -- ^ 'ipIdentityPoolId'
-> Text -- ^ 'ipIdentityPoolName'
@@ -248,7 +252,7 @@ ipSamlProviderARNs = lens _ipSamlProviderARNs (\ s a -> s{_ipSamlProviderARNs =
ipSupportedLoginProviders :: Lens' IdentityPool (HashMap Text Text)
ipSupportedLoginProviders = lens _ipSupportedLoginProviders (\ s a -> s{_ipSupportedLoginProviders = a}) . _Default . _Map;
--- | The \"domain\" by which Cognito will refer to your users.
+-- | The "domain" by which Cognito will refer to your users.
ipDeveloperProviderName :: Lens' IdentityPool (Maybe Text)
ipDeveloperProviderName = lens _ipDeveloperProviderName (\ s a -> s{_ipDeveloperProviderName = a});
@@ -321,9 +325,9 @@ data IdentityPoolShortDescription = IdentityPoolShortDescription'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ipsdIdentityPoolId'
+-- * 'ipsdIdentityPoolId' - An identity pool ID in the format REGION:GUID.
--
--- * 'ipsdIdentityPoolName'
+-- * 'ipsdIdentityPoolName' - A string that you provide.
identityPoolShortDescription
:: IdentityPoolShortDescription
identityPoolShortDescription =
@@ -354,6 +358,8 @@ instance NFData IdentityPoolShortDescription
-- | An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
--
+--
+--
-- /See:/ 'unprocessedIdentityId' smart constructor.
data UnprocessedIdentityId = UnprocessedIdentityId'
{ _uiiErrorCode :: !(Maybe CognitoErrorCode)
@@ -364,9 +370,9 @@ data UnprocessedIdentityId = UnprocessedIdentityId'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'uiiErrorCode'
+-- * 'uiiErrorCode' - The error code indicating the type of error that occurred.
--
--- * 'uiiIdentityId'
+-- * 'uiiIdentityId' - A unique identifier in the format REGION:GUID.
unprocessedIdentityId
:: UnprocessedIdentityId
unprocessedIdentityId =
diff --git a/gen/Network/AWS/CognitoIdentity/UnlinkDeveloperIdentity.hs b/gen/Network/AWS/CognitoIdentity/UnlinkDeveloperIdentity.hs
index 4b764ce..01e978d 100644
--- a/gen/Network/AWS/CognitoIdentity/UnlinkDeveloperIdentity.hs
+++ b/gen/Network/AWS/CognitoIdentity/UnlinkDeveloperIdentity.hs
@@ -18,9 +18,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Unlinks a 'DeveloperUserIdentifier' 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.
+-- Unlinks a @DeveloperUserIdentifier@ 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.
+--
--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.UnlinkDeveloperIdentity
(
-- * Creating a Request
@@ -44,7 +46,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | Input to the 'UnlinkDeveloperIdentity' action.
+-- | Input to the @UnlinkDeveloperIdentity@ action.
+--
+--
--
-- /See:/ 'unlinkDeveloperIdentity' smart constructor.
data UnlinkDeveloperIdentity = UnlinkDeveloperIdentity'
@@ -58,13 +62,13 @@ data UnlinkDeveloperIdentity = UnlinkDeveloperIdentity'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'udiIdentityId'
+-- * 'udiIdentityId' - A unique identifier in the format REGION:GUID.
--
--- * 'udiIdentityPoolId'
+-- * 'udiIdentityPoolId' - An identity pool ID in the format REGION:GUID.
--
--- * 'udiDeveloperProviderName'
+-- * 'udiDeveloperProviderName' - The "domain" by which Cognito will refer to your users.
--
--- * 'udiDeveloperUserIdentifier'
+-- * 'udiDeveloperUserIdentifier' - A unique ID used by your backend authentication process to identify a user.
unlinkDeveloperIdentity
:: Text -- ^ 'udiIdentityId'
-> Text -- ^ 'udiIdentityPoolId'
@@ -87,7 +91,7 @@ udiIdentityId = lens _udiIdentityId (\ s a -> s{_udiIdentityId = a});
udiIdentityPoolId :: Lens' UnlinkDeveloperIdentity Text
udiIdentityPoolId = lens _udiIdentityPoolId (\ s a -> s{_udiIdentityPoolId = a});
--- | The \"domain\" by which Cognito will refer to your users.
+-- | The "domain" by which Cognito will refer to your users.
udiDeveloperProviderName :: Lens' UnlinkDeveloperIdentity Text
udiDeveloperProviderName = lens _udiDeveloperProviderName (\ s a -> s{_udiDeveloperProviderName = a});
diff --git a/gen/Network/AWS/CognitoIdentity/UnlinkIdentity.hs b/gen/Network/AWS/CognitoIdentity/UnlinkIdentity.hs
index 1cbd9b8..ca41aed 100644
--- a/gen/Network/AWS/CognitoIdentity/UnlinkIdentity.hs
+++ b/gen/Network/AWS/CognitoIdentity/UnlinkIdentity.hs
@@ -20,7 +20,9 @@
--
-- 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.
--
+--
-- This is a public API. You do not need any credentials to call this API.
+--
module Network.AWS.CognitoIdentity.UnlinkIdentity
(
-- * Creating a Request
@@ -56,11 +58,11 @@ data UnlinkIdentity = UnlinkIdentity'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'uiIdentityId'
+-- * 'uiIdentityId' - A unique identifier in the format REGION:GUID.
--
--- * 'uiLogins'
+-- * 'uiLogins' - A set of optional name-value pairs that map provider names to provider tokens.
--
--- * 'uiLoginsToRemove'
+-- * 'uiLoginsToRemove' - Provider names to unlink from this identity.
unlinkIdentity
:: Text -- ^ 'uiIdentityId'
-> UnlinkIdentity
diff --git a/gen/Network/AWS/CognitoIdentity/UpdateIdentityPool.hs b/gen/Network/AWS/CognitoIdentity/UpdateIdentityPool.hs
index 7a82a13..8d1766d 100644
--- a/gen/Network/AWS/CognitoIdentity/UpdateIdentityPool.hs
+++ b/gen/Network/AWS/CognitoIdentity/UpdateIdentityPool.hs
@@ -20,7 +20,9 @@
--
-- Updates a user pool.
--
+--
-- You must use AWS Developer credentials to call this API.
+--
module Network.AWS.CognitoIdentity.UpdateIdentityPool
(
-- * Creating a Request
@@ -75,21 +77,21 @@ data UpdateIdentityPool = UpdateIdentityPool'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'uipSamlProviderARNs'
+-- * 'uipSamlProviderARNs' - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
--
--- * 'uipSupportedLoginProviders'
+-- * 'uipSupportedLoginProviders' - Optional key:value pairs mapping provider names to provider app IDs.
--
--- * 'uipDeveloperProviderName'
+-- * 'uipDeveloperProviderName' - The "domain" by which Cognito will refer to your users.
--
--- * 'uipOpenIdConnectProviderARNs'
+-- * 'uipOpenIdConnectProviderARNs' - A list of OpendID Connect provider ARNs.
--
--- * 'uipCognitoIdentityProviders'
+-- * 'uipCognitoIdentityProviders' - A list representing an Amazon Cognito Identity User Pool and its client ID.
--
--- * 'uipIdentityPoolId'
+-- * 'uipIdentityPoolId' - An identity pool ID in the format REGION:GUID.
--
--- * 'uipIdentityPoolName'
+-- * 'uipIdentityPoolName' - A string that you provide.
--
--- * 'uipAllowUnauthenticatedIdentities'
+-- * 'uipAllowUnauthenticatedIdentities' - TRUE if the identity pool supports unauthenticated logins.
updateIdentityPool
:: Text -- ^ 'uipIdentityPoolId'
-> Text -- ^ 'uipIdentityPoolName'
@@ -115,7 +117,7 @@ uipSamlProviderARNs = lens _uipSamlProviderARNs (\ s a -> s{_uipSamlProviderARNs
uipSupportedLoginProviders :: Lens' UpdateIdentityPool (HashMap Text Text)
uipSupportedLoginProviders = lens _uipSupportedLoginProviders (\ s a -> s{_uipSupportedLoginProviders = a}) . _Default . _Map;
--- | The \"domain\" by which Cognito will refer to your users.
+-- | The "domain" by which Cognito will refer to your users.
uipDeveloperProviderName :: Lens' UpdateIdentityPool (Maybe Text)
uipDeveloperProviderName = lens _uipDeveloperProviderName (\ s a -> s{_uipDeveloperProviderName = a});