AlexaForBusiness / Client / resolve_room

resolve_room#

AlexaForBusiness.Client.resolve_room(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.resolve_room(
    UserId='string',
    SkillId='string'
)
Parameters:

  • UserId (string) –

    [REQUIRED]

    The ARN of the user. Required.

  • SkillId (string) –

    [REQUIRED]

    The ARN of the skill that was requested. Required.

Return type:

dict

Returns:

Response Syntax

{
    'RoomArn': 'string',
    'RoomName': 'string',
    'RoomSkillParameters': [
        {
            'ParameterKey': 'string',
            'ParameterValue': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • RoomArn (string) –

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

    • RoomName (string) –

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

    • RoomSkillParameters (list) –

      Response to get the room profile request. Required.

      • (dict) –

        A skill parameter associated with a room.

        • ParameterKey (string) –

          The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.

        • ParameterValue (string) –

          The parameter value of a room skill parameter.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException