AlexaForBusiness / Client / get_profile

get_profile

AlexaForBusiness.Client.get_profile(**kwargs)

Gets the details of a room profile by profile ARN.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.get_profile(
    ProfileArn='string'
)

Parameters:

ProfileArn (string) – The ARN of the room profile for which to request details. Required.

Return type:

dict

Returns:

Response Syntax

{
    'Profile': {
        'ProfileArn': 'string',
        'ProfileName': 'string',
        'IsDefault': True|False,
        'Address': 'string',
        'Timezone': 'string',
        'DistanceUnit': 'METRIC'|'IMPERIAL',
        'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
        'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
        'Locale': 'string',
        'SetupModeDisabled': True|False,
        'MaxVolumeLimit': 123,
        'PSTNEnabled': True|False,
        'DataRetentionOptIn': True|False,
        'AddressBookArn': 'string',
        'MeetingRoomConfiguration': {
            'RoomUtilizationMetricsEnabled': True|False,
            'EndOfMeetingReminder': {
                'ReminderAtMinutes': [
                    123,
                ],
                'ReminderType': 'ANNOUNCEMENT_TIME_CHECK'|'ANNOUNCEMENT_VARIABLE_TIME_LEFT'|'CHIME'|'KNOCK',
                'Enabled': True|False
            },
            'InstantBooking': {
                'DurationInMinutes': 123,
                'Enabled': True|False
            },
            'RequireCheckIn': {
                'ReleaseAfterMinutes': 123,
                'Enabled': True|False
            },
            'ProactiveJoin': {
                'EnabledByMotion': True|False
            }
        }
    }
}

Response Structure

• (dict) –

  • Profile (dict) –

    The details of the room profile requested. Required.

    • ProfileArn (string) –

      The ARN of a room profile.

    • ProfileName (string) –

      The name of a room profile.

    • IsDefault (boolean) –

      Retrieves if the profile is default or not.

    • Address (string) –

      The address of a room profile.

    • Timezone (string) –

      The time zone of a room profile.

    • DistanceUnit (string) –

      The distance unit of a room profile.

    • TemperatureUnit (string) –

      The temperature unit of a room profile.

    • WakeWord (string) –

      The wake word of a room profile.

    • Locale (string) –

      The locale of a room profile. (This is currently available only to a limited preview audience.)

    • SetupModeDisabled (boolean) –

      The setup mode of a room profile.

    • MaxVolumeLimit (integer) –

      The max volume limit of a room profile.

    • PSTNEnabled (boolean) –

      The PSTN setting of a room profile.

    • DataRetentionOptIn (boolean) –

      Whether data retention of the profile is enabled.

    • AddressBookArn (string) –

      The ARN of the address book.

    • MeetingRoomConfiguration (dict) –

      Meeting room settings of a room profile.

      • RoomUtilizationMetricsEnabled (boolean) –

        Whether room utilization metrics are enabled or not.

      • EndOfMeetingReminder (dict) –

        Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

        • ReminderAtMinutes (list) –

          A range of 3 to 15 minutes that determines when the reminder begins.

          • (integer) –

        • ReminderType (string) –

          The type of sound that users hear during the end of meeting reminder.

        • Enabled (boolean) –

          Whether an end of meeting reminder is enabled or not.

      • InstantBooking (dict) –

        Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.

        • DurationInMinutes (integer) –

          Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

        • Enabled (boolean) –

          Whether instant booking is enabled or not.

      • RequireCheckIn (dict) –

        Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it’s not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

        • ReleaseAfterMinutes (integer) –

          Duration between 5 and 20 minutes to determine when to release the room if it’s not checked into.

        • Enabled (boolean) –

          Whether require check in is enabled or not.

      • ProactiveJoin (dict) –

        • EnabledByMotion (boolean) –

Exceptions

• AlexaForBusiness.Client.exceptions.NotFoundException