libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentity.GetId

Description

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.

Synopsis

Creating a Request

data GetId Source #

Input to the GetId action.

See: newGetId smart constructor.

Constructors

GetId' 

Fields

  • accountId :: Maybe Text

    A standard AWS account ID (9+ digits).

  • logins :: Maybe (HashMap Text Text)

    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
    • Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>, for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
    • Google: accounts.google.com
    • Amazon: www.amazon.com
    • Twitter: api.twitter.com
    • Digits: www.digits.com
  • identityPoolId :: Text

    An identity pool ID in the format REGION:GUID.

Instances

Instances details
Eq GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

(==) :: GetId -> GetId -> Bool #

(/=) :: GetId -> GetId -> Bool #

Read GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

readsPrec :: Int -> ReadS GetId #

readList :: ReadS [GetId] #

readPrec :: ReadPrec GetId #

readListPrec :: ReadPrec [GetId] #

Show GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

showsPrec :: Int -> GetId -> ShowS #

show :: GetId -> String #

showList :: [GetId] -> ShowS #

Generic GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Associated Types

type Rep GetId :: Type -> Type #

Methods

from :: GetId -> Rep GetId x #

to :: Rep GetId x -> GetId #

NFData GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

rnf :: GetId -> () #

Hashable GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

hashWithSalt :: Int -> GetId -> Int #

hash :: GetId -> Int #

ToJSON GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

toJSON :: GetId -> Value #

toEncoding :: GetId -> Encoding #

toJSONList :: [GetId] -> Value #

toEncodingList :: [GetId] -> Encoding #

AWSRequest GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Associated Types

type AWSResponse GetId #

Methods

request :: GetId -> Request GetId #

response :: MonadResource m => Logger -> Service -> Proxy GetId -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetId))) #

ToHeaders GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

toHeaders :: GetId -> [Header] #

ToPath GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

toPath :: GetId -> ByteString #

ToQuery GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

toQuery :: GetId -> QueryString #

type Rep GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

type Rep GetId = D1 ('MetaData "GetId" "Amazonka.CognitoIdentity.GetId" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "GetId'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "logins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetId Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

type AWSResponse GetId = GetIdResponse

newGetId Source #

Arguments

:: Text

$sel:identityPoolId:GetId'

-> GetId 

Create a value of GetId with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountId:GetId', getId_accountId - A standard AWS account ID (9+ digits).

$sel:logins:GetId', getId_logins - 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
  • Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>, for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
  • Google: accounts.google.com
  • Amazon: www.amazon.com
  • Twitter: api.twitter.com
  • Digits: www.digits.com

$sel:identityPoolId:GetId', getId_identityPoolId - An identity pool ID in the format REGION:GUID.

Request Lenses

getId_accountId :: Lens' GetId (Maybe Text) Source #

A standard AWS account ID (9+ digits).

getId_logins :: Lens' GetId (Maybe (HashMap Text Text)) Source #

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
  • Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>, for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
  • Google: accounts.google.com
  • Amazon: www.amazon.com
  • Twitter: api.twitter.com
  • Digits: www.digits.com

getId_identityPoolId :: Lens' GetId Text Source #

An identity pool ID in the format REGION:GUID.

Destructuring the Response

data GetIdResponse Source #

Returned in response to a GetId request.

See: newGetIdResponse smart constructor.

Constructors

GetIdResponse' 

Fields

Instances

Instances details
Eq GetIdResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

(==) :: GetIdResponse -> GetIdResponse -> Bool #

(/=) :: GetIdResponse -> GetIdResponse -> Bool #

Read GetIdResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

readsPrec :: Int -> ReadS GetIdResponse #

readList :: ReadS [GetIdResponse] #

readPrec :: ReadPrec GetIdResponse #

readListPrec :: ReadPrec [GetIdResponse] #

Show GetIdResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

showsPrec :: Int -> GetIdResponse -> ShowS #

show :: GetIdResponse -> String #

showList :: [GetIdResponse] -> ShowS #

Generic GetIdResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Associated Types

type Rep GetIdResponse :: Type -> Type #

Methods

from :: GetIdResponse -> Rep GetIdResponse x #

to :: Rep GetIdResponse x -> GetIdResponse #

NFData GetIdResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

Methods

rnf :: GetIdResponse -> () #

type Rep GetIdResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetId

type Rep GetIdResponse = D1 ('MetaData "GetIdResponse" "Amazonka.CognitoIdentity.GetId" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "GetIdResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetIdResponse Source #

Arguments

:: Int

$sel:httpStatus:GetIdResponse'

-> GetIdResponse 

Create a value of GetIdResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:identityId:GetIdResponse', getIdResponse_identityId - A unique identifier in the format REGION:GUID.

$sel:httpStatus:GetIdResponse', getIdResponse_httpStatus - The response's http status code.

Response Lenses

getIdResponse_identityId :: Lens' GetIdResponse (Maybe Text) Source #

A unique identifier in the format REGION:GUID.

getIdResponse_httpStatus :: Lens' GetIdResponse Int Source #

The response's http status code.