amazonka-alexa-business-2.0: Amazon Alexa For Business SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AlexaBusiness.ResolveRoom

Description

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.

Synopsis

Creating a Request

data ResolveRoom Source #

See: newResolveRoom smart constructor.

Constructors

ResolveRoom' 

Fields

  • userId :: Text

    The ARN of the user. Required.

  • skillId :: Text

    The ARN of the skill that was requested. Required.

Instances

Instances details
ToJSON ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

ToHeaders ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

Methods

toHeaders :: ResolveRoom -> [Header] #

ToPath ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

ToQuery ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

AWSRequest ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

Associated Types

type AWSResponse ResolveRoom #

Generic ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

Associated Types

type Rep ResolveRoom :: Type -> Type #

Read ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

Show ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

NFData ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

Methods

rnf :: ResolveRoom -> () #

Eq ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

Hashable ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

type AWSResponse ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

type Rep ResolveRoom Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

type Rep ResolveRoom = D1 ('MetaData "ResolveRoom" "Amazonka.AlexaBusiness.ResolveRoom" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "ResolveRoom'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "skillId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newResolveRoom Source #

Create a value of ResolveRoom 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:userId:ResolveRoom', resolveRoom_userId - The ARN of the user. Required.

ResolveRoom, resolveRoom_skillId - The ARN of the skill that was requested. Required.

Request Lenses

resolveRoom_userId :: Lens' ResolveRoom Text Source #

The ARN of the user. Required.

resolveRoom_skillId :: Lens' ResolveRoom Text Source #

The ARN of the skill that was requested. Required.

Destructuring the Response

data ResolveRoomResponse Source #

See: newResolveRoomResponse smart constructor.

Constructors

ResolveRoomResponse' 

Fields

Instances

Instances details
Generic ResolveRoomResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

Associated Types

type Rep ResolveRoomResponse :: Type -> Type #

Read ResolveRoomResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

Show ResolveRoomResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

NFData ResolveRoomResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

Methods

rnf :: ResolveRoomResponse -> () #

Eq ResolveRoomResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

type Rep ResolveRoomResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.ResolveRoom

type Rep ResolveRoomResponse = D1 ('MetaData "ResolveRoomResponse" "Amazonka.AlexaBusiness.ResolveRoom" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "ResolveRoomResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "roomArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roomName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "roomSkillParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RoomSkillParameter])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newResolveRoomResponse Source #

Create a value of ResolveRoomResponse 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:

ResolveRoomResponse, resolveRoomResponse_roomArn - The ARN of the room from which the skill request was invoked.

ResolveRoomResponse, resolveRoomResponse_roomName - The name of the room from which the skill request was invoked.

$sel:roomSkillParameters:ResolveRoomResponse', resolveRoomResponse_roomSkillParameters - Response to get the room profile request. Required.

$sel:httpStatus:ResolveRoomResponse', resolveRoomResponse_httpStatus - The response's http status code.

Response Lenses

resolveRoomResponse_roomArn :: Lens' ResolveRoomResponse (Maybe Text) Source #

The ARN of the room from which the skill request was invoked.

resolveRoomResponse_roomName :: Lens' ResolveRoomResponse (Maybe Text) Source #

The name of the room from which the skill request was invoked.

resolveRoomResponse_roomSkillParameters :: Lens' ResolveRoomResponse (Maybe [RoomSkillParameter]) Source #

Response to get the room profile request. Required.