AlexaForBusiness / Client / update_profile

update_profile#

AlexaForBusiness.Client.update_profile(**kwargs)#

Updates an existing room profile by room 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.update_profile(
    ProfileArn='string',
    ProfileName='string',
    IsDefault=True|False,
    Timezone='string',
    Address='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,
    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
        }
    }
)
Parameters:

  • ProfileArn (string) – The ARN of the room profile to update. Required.

  • ProfileName (string) – The updated name for the room profile.

  • IsDefault (boolean) – Sets the profile as default if selected. If this is missing, no update is done to the default status.

  • Timezone (string) – The updated timezone for the room profile.

  • Address (string) – The updated address for the room profile.

  • DistanceUnit (string) – The updated distance unit for the room profile.

  • TemperatureUnit (string) – The updated temperature unit for the room profile.

  • WakeWord (string) – The updated wake word for the room profile.

  • Locale (string) – The updated locale for the room profile. (This is currently only available to a limited preview audience.)

  • SetupModeDisabled (boolean) – Whether the setup mode of the profile is enabled.

  • MaxVolumeLimit (integer) – The updated maximum volume limit for the room profile.

  • PSTNEnabled (boolean) – Whether the PSTN setting of the room profile is enabled.

  • DataRetentionOptIn (boolean) – Whether data retention of the profile is enabled.

  • MeetingRoomConfiguration (dict) –

    The updated 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) –

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

        • (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 an available room 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 to make 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) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException

  • AlexaForBusiness.Client.exceptions.NameInUseException

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException