diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,7 +8,16 @@ ## Description -Amazon Cognito is a web service that facilitates the delivery of scoped, temporary credentials to mobile devices or other untrusted environments. Amazon Cognito uniquely identifies a device or user and supplies the user with a consistent identity throughout the lifetime of an application. Amazon Cognito lets users authenticate with third-party identity providers (Facebook, Google, or Login with Amazon). As a developer, you decide which identity providers to trust. You can also choose to support unauthenticated access from your application. Your users are provided with Cognito tokens that uniquely identify their device and any information provided about third-party logins. + Amazon Cognito is a web service that facilitates the delivery of scoped, + temporary credentials to mobile devices or other untrusted environments. + Amazon Cognito uniquely identifies a device or user and supplies the user + with a consistent identity throughout the lifetime of an application. Amazon + Cognito lets users authenticate with third-party identity providers + (Facebook, Google, or Login with Amazon). As a developer, you decide which + identity providers to trust. You can also choose to support unauthenticated + access from your application. Your users are provided with Cognito tokens + that uniquely identify their device and any information provided about + third-party logins. Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-cognito-identity) and [AWS API Reference](http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html). diff --git a/amazonka-cognito-identity.cabal b/amazonka-cognito-identity.cabal --- a/amazonka-cognito-identity.cabal +++ b/amazonka-cognito-identity.cabal @@ -1,5 +1,5 @@ name: amazonka-cognito-identity -version: 0.0.1 +version: 0.0.2 synopsis: Amazon Cognito Identity SDK. homepage: https://github.com/brendanhay/amazonka license: OtherLicense @@ -13,16 +13,16 @@ cabal-version: >= 1.10 description: - Amazon Cognito is a web service that facilitates the delivery of - scoped, temporary credentials to mobile devices or other untrusted - environments. Amazon Cognito uniquely identifies a device or user and - supplies the user with a consistent identity throughout the lifetime of - an application. Amazon Cognito lets users authenticate with third-party - identity providers (Facebook, Google, or Login with Amazon). As a - developer, you decide which identity providers to trust. You can also - choose to support unauthenticated access from your application. Your - users are provided with Cognito tokens that uniquely identify their - device and any information provided about third-party logins. + Amazon Cognito is a web service that facilitates the delivery of scoped, + temporary credentials to mobile devices or other untrusted environments. + Amazon Cognito uniquely identifies a device or user and supplies the user + with a consistent identity throughout the lifetime of an application. Amazon + Cognito lets users authenticate with third-party identity providers + (Facebook, Google, or Login with Amazon). As a developer, you decide which + identity providers to trust. You can also choose to support unauthenticated + access from your application. Your users are provided with Cognito tokens + that uniquely identify their device and any information provided about + third-party logins. . /See:/ . @@ -59,5 +59,5 @@ other-modules: build-depends: - amazonka-core == 0.0.1.* + amazonka-core == 0.0.2.* , base >= 4.7 && < 5 diff --git a/gen/Network/AWS/CognitoIdentity.hs b/gen/Network/AWS/CognitoIdentity.hs --- a/gen/Network/AWS/CognitoIdentity.hs +++ b/gen/Network/AWS/CognitoIdentity.hs @@ -11,8 +11,8 @@ -- | Amazon Cognito is a web service that facilitates the delivery of scoped, -- temporary credentials to mobile devices or other untrusted environments. -- Amazon Cognito uniquely identifies a device or user and supplies the user --- with a consistent identity throughout the lifetime of an application. --- Amazon Cognito lets users authenticate with third-party identity providers +-- with a consistent identity throughout the lifetime of an application. Amazon +-- Cognito lets users authenticate with third-party identity providers -- (Facebook, Google, or Login with Amazon). As a developer, you decide which -- identity providers to trust. You can also choose to support unauthenticated -- access from your application. Your users are provided with Cognito tokens diff --git a/gen/Network/AWS/CognitoIdentity/CreateIdentityPool.hs b/gen/Network/AWS/CognitoIdentity/CreateIdentityPool.hs --- a/gen/Network/AWS/CognitoIdentity/CreateIdentityPool.hs +++ b/gen/Network/AWS/CognitoIdentity/CreateIdentityPool.hs @@ -21,8 +21,8 @@ -- 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. +-- information that is specific to your AWS account. The limit on identity pools +-- is 60 per account. -- -- module Network.AWS.CognitoIdentity.CreateIdentityPool @@ -95,10 +95,11 @@ lens _cipAllowUnauthenticatedIdentities (\s a -> s { _cipAllowUnauthenticatedIdentities = a }) --- | 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 (-). +-- | 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) diff --git a/gen/Network/AWS/CognitoIdentity/GetId.hs b/gen/Network/AWS/CognitoIdentity/GetId.hs --- a/gen/Network/AWS/CognitoIdentity/GetId.hs +++ b/gen/Network/AWS/CognitoIdentity/GetId.hs @@ -20,8 +20,8 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Generates (or retrieves) a Cognito ID. Supplying multiple logins will --- create an implicit linked account. +-- | Generates (or retrieves) a Cognito ID. Supplying multiple logins will create +-- an implicit linked account. -- -- module Network.AWS.CognitoIdentity.GetId @@ -81,9 +81,9 @@ giIdentityPoolId :: Lens' GetId Text giIdentityPoolId = lens _giIdentityPoolId (\s a -> s { _giIdentityPoolId = 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. +-- | 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' giLogins :: Lens' GetId (HashMap Text Text) giLogins = lens _giLogins (\s a -> s { _giLogins = a }) . _Map diff --git a/gen/Network/AWS/CognitoIdentity/GetOpenIdToken.hs b/gen/Network/AWS/CognitoIdentity/GetOpenIdToken.hs --- a/gen/Network/AWS/CognitoIdentity/GetOpenIdToken.hs +++ b/gen/Network/AWS/CognitoIdentity/GetOpenIdToken.hs @@ -21,10 +21,11 @@ -- 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. The OpenId --- token is valid for 15 minutes. +-- 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. +-- -- module Network.AWS.CognitoIdentity.GetOpenIdToken ( @@ -74,8 +75,7 @@ goitIdentityId :: Lens' GetOpenIdToken Text goitIdentityId = lens _goitIdentityId (\s a -> s { _goitIdentityId = a }) --- | A set of optional name-value pairs that map provider names to provider --- tokens. +-- | A set of optional name-value pairs that map provider names to provider tokens. goitLogins :: Lens' GetOpenIdToken (HashMap Text Text) goitLogins = lens _goitLogins (\s a -> s { _goitLogins = a }) . _Map diff --git a/gen/Network/AWS/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.hs b/gen/Network/AWS/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.hs --- a/gen/Network/AWS/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.hs +++ b/gen/Network/AWS/CognitoIdentity/GetOpenIdTokenForDeveloperIdentity.hs @@ -20,20 +20,21 @@ -- Stability : experimental -- 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. 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. +-- | 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'. +-- -- module Network.AWS.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity ( @@ -101,25 +102,23 @@ -- | 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 +-- 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. +-- 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 -- | 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. +-- 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 }) diff --git a/gen/Network/AWS/CognitoIdentity/LookupDeveloperIdentity.hs b/gen/Network/AWS/CognitoIdentity/LookupDeveloperIdentity.hs --- a/gen/Network/AWS/CognitoIdentity/LookupDeveloperIdentity.hs +++ b/gen/Network/AWS/CognitoIdentity/LookupDeveloperIdentity.hs @@ -20,15 +20,15 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Retrieves the IdentityID associated with a DeveloperUserIdentifier or the --- list of DeveloperUserIdentifiers associated with an IdentityId for an --- existing identity. Either IdentityID or DeveloperUserIdentifier must not be +-- | 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 +-- 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. +-- values and is the same as the request. Otherwise a 'ResourceConflictException' +-- is thrown. -- -- module Network.AWS.CognitoIdentity.LookupDeveloperIdentity @@ -91,9 +91,9 @@ , _ldiNextToken = Nothing } --- | 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. +-- | 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. ldiDeveloperUserIdentifier :: Lens' LookupDeveloperIdentity (Maybe Text) ldiDeveloperUserIdentifier = lens _ldiDeveloperUserIdentifier @@ -112,12 +112,12 @@ ldiMaxResults :: Lens' LookupDeveloperIdentity (Maybe Natural) ldiMaxResults = lens _ldiMaxResults (\s a -> s { _ldiMaxResults = a }) . mapping _Nat --- | 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 }) @@ -144,9 +144,9 @@ , _ldirNextToken = Nothing } --- | 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. +-- | 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. ldirDeveloperUserIdentifierList :: Lens' LookupDeveloperIdentityResponse [Text] ldirDeveloperUserIdentifierList = lens _ldirDeveloperUserIdentifierList @@ -157,12 +157,12 @@ ldirIdentityId :: Lens' LookupDeveloperIdentityResponse (Maybe Text) ldirIdentityId = lens _ldirIdentityId (\s a -> s { _ldirIdentityId = 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. ldirNextToken :: Lens' LookupDeveloperIdentityResponse (Maybe Text) ldirNextToken = lens _ldirNextToken (\s a -> s { _ldirNextToken = a }) diff --git a/gen/Network/AWS/CognitoIdentity/MergeDeveloperIdentities.hs b/gen/Network/AWS/CognitoIdentity/MergeDeveloperIdentities.hs --- a/gen/Network/AWS/CognitoIdentity/MergeDeveloperIdentities.hs +++ b/gen/Network/AWS/CognitoIdentity/MergeDeveloperIdentities.hs @@ -20,14 +20,13 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Merges two users having different IdentityIds, 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. -- -- module Network.AWS.CognitoIdentity.MergeDeveloperIdentities @@ -86,19 +85,17 @@ , _mdiIdentityPoolId = p4 } --- | 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 @@ -109,8 +106,7 @@ mdiIdentityPoolId = lens _mdiIdentityPoolId (\s a -> s { _mdiIdentityPoolId = a }) --- | 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 }) diff --git a/gen/Network/AWS/CognitoIdentity/Types.hs b/gen/Network/AWS/CognitoIdentity/Types.hs --- a/gen/Network/AWS/CognitoIdentity/Types.hs +++ b/gen/Network/AWS/CognitoIdentity/Types.hs @@ -97,8 +97,7 @@ idIdentityId :: Lens' IdentityDescription (Maybe Text) idIdentityId = lens _idIdentityId (\s a -> s { _idIdentityId = a }) --- | A set of optional name-value pairs that map provider names to provider --- tokens. +-- | A set of optional name-value pairs that map provider names to provider tokens. idLogins :: Lens' IdentityDescription [Text] idLogins = lens _idLogins (\s a -> s { _idLogins = a }) . _List diff --git a/gen/Network/AWS/CognitoIdentity/UnlinkDeveloperIdentity.hs b/gen/Network/AWS/CognitoIdentity/UnlinkDeveloperIdentity.hs --- a/gen/Network/AWS/CognitoIdentity/UnlinkDeveloperIdentity.hs +++ b/gen/Network/AWS/CognitoIdentity/UnlinkDeveloperIdentity.hs @@ -20,11 +20,10 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked +-- | 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. +-- If, for a given Cognito identity, you remove all federated identities as well +-- as the developer user identifier, the Cognito identity becomes inaccessible. -- -- module Network.AWS.CognitoIdentity.UnlinkDeveloperIdentity @@ -87,8 +86,7 @@ lens _udiDeveloperProviderName (\s a -> s { _udiDeveloperProviderName = a }) --- | A unique ID used by your backend authentication process to identify a --- user. +-- | A unique ID used by your backend authentication process to identify a user. udiDeveloperUserIdentifier :: Lens' UnlinkDeveloperIdentity Text udiDeveloperUserIdentifier = lens _udiDeveloperUserIdentifier diff --git a/gen/Network/AWS/CognitoIdentity/UnlinkIdentity.hs b/gen/Network/AWS/CognitoIdentity/UnlinkIdentity.hs --- a/gen/Network/AWS/CognitoIdentity/UnlinkIdentity.hs +++ b/gen/Network/AWS/CognitoIdentity/UnlinkIdentity.hs @@ -75,8 +75,7 @@ uiIdentityId :: Lens' UnlinkIdentity Text uiIdentityId = lens _uiIdentityId (\s a -> s { _uiIdentityId = a }) --- | A set of optional name-value pairs that map provider names to provider --- tokens. +-- | A set of optional name-value pairs that map provider names to provider tokens. uiLogins :: Lens' UnlinkIdentity (HashMap Text Text) uiLogins = lens _uiLogins (\s a -> s { _uiLogins = a }) . _Map