Amazonka.CognitoIdentity.GetId

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.

Creating a Request

data GetId

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

ToJSON GetId

Defined in Amazonka.CognitoIdentity.GetId

Methods

toJSON :: GetId -> Value

toEncoding :: GetId -> Encoding

toJSONList :: [GetId] -> Value

toEncodingList :: [GetId] -> Encoding

ToHeaders GetId

Defined in Amazonka.CognitoIdentity.GetId

Methods

toHeaders :: GetId -> [Header]

ToPath GetId

Defined in Amazonka.CognitoIdentity.GetId

Methods

toPath :: GetId -> ByteString

ToQuery GetId

Defined in Amazonka.CognitoIdentity.GetId

Methods

toQuery :: GetId -> QueryString

AWSRequest GetId

Defined in Amazonka.CognitoIdentity.GetId

Associated Types

type AWSResponse GetId

Methods

request :: (Service -> Service) -> GetId -> Request GetId

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

Generic GetId

Defined in Amazonka.CognitoIdentity.GetId

Associated Types

type Rep GetId :: Type -> Type

Methods

from :: GetId -> Rep GetId x

to :: Rep GetId x -> GetId

Read GetId

Defined in Amazonka.CognitoIdentity.GetId

Methods

readsPrec :: Int -> ReadS GetId

readList :: ReadS [GetId]

readPrec :: ReadPrec GetId

readListPrec :: ReadPrec [GetId]

Show GetId

Defined in Amazonka.CognitoIdentity.GetId

Methods

showsPrec :: Int -> GetId -> ShowS

show :: GetId -> String

showList :: [GetId] -> ShowS

NFData GetId

Defined in Amazonka.CognitoIdentity.GetId

Methods

rnf :: GetId -> ()

Eq GetId

Defined in Amazonka.CognitoIdentity.GetId

Methods

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

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

Hashable GetId

Defined in Amazonka.CognitoIdentity.GetId

Methods

hashWithSalt :: Int -> GetId -> Int

hash :: GetId -> Int

type AWSResponse GetId

Defined in Amazonka.CognitoIdentity.GetId

type AWSResponse GetId = GetIdResponse

type Rep GetId

Defined in Amazonka.CognitoIdentity.GetId

type Rep GetId = D1 ('MetaData "GetId" "Amazonka.CognitoIdentity.GetId" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" '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))))

newGetId

Arguments

:: Text

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).

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

GetId, getId_identityPoolId - An identity pool ID in the format REGION:GUID.

Request Lenses

getId_accountId :: Lens' GetId (Maybe Text)

A standard AWS account ID (9+ digits).

getId_logins :: Lens' GetId (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

getId_identityPoolId :: Lens' GetId Text

An identity pool ID in the format REGION:GUID.

Destructuring the Response

data GetIdResponse

Returned in response to a GetId request.

See: newGetIdResponse smart constructor.

Constructors

GetIdResponse'

Fields

• identityId :: Maybe Text

  A unique identifier in the format REGION:GUID.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetIdResponse

Defined in Amazonka.CognitoIdentity.GetId

Associated Types

type Rep GetIdResponse :: Type -> Type

Methods

from :: GetIdResponse -> Rep GetIdResponse x

to :: Rep GetIdResponse x -> GetIdResponse

Read GetIdResponse

Defined in Amazonka.CognitoIdentity.GetId

Methods

readsPrec :: Int -> ReadS GetIdResponse

readList :: ReadS [GetIdResponse]

readPrec :: ReadPrec GetIdResponse

readListPrec :: ReadPrec [GetIdResponse]

Show GetIdResponse

Defined in Amazonka.CognitoIdentity.GetId

Methods

showsPrec :: Int -> GetIdResponse -> ShowS

show :: GetIdResponse -> String

showList :: [GetIdResponse] -> ShowS

NFData GetIdResponse

Defined in Amazonka.CognitoIdentity.GetId

Methods

rnf :: GetIdResponse -> ()

Eq GetIdResponse

Defined in Amazonka.CognitoIdentity.GetId

Methods

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

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

type Rep GetIdResponse

Defined in Amazonka.CognitoIdentity.GetId

type Rep GetIdResponse = D1 ('MetaData "GetIdResponse" "Amazonka.CognitoIdentity.GetId" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" '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

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:

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)

A unique identifier in the format REGION:GUID.

getIdResponse_httpStatus :: Lens' GetIdResponse Int

The response's http status code.