AlexaForBusiness / Client / create_profile

create_profile#

AlexaForBusiness.Client.create_profile(**kwargs)#

Creates a new room profile with the specified details.

See also: AWS API Documentation

Request Syntax

response = client.create_profile(
    ProfileName='string',
    Timezone='string',
    Address='string',
    DistanceUnit='METRIC'|'IMPERIAL',
    TemperatureUnit='FAHRENHEIT'|'CELSIUS',
    WakeWord='ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
    Locale='string',
    ClientRequestToken='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
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ProfileName (string) –

    [REQUIRED]

    The name of a room profile.

  • Timezone (string) –

    [REQUIRED]

    The time zone used by a room profile.

  • Address (string) –

    [REQUIRED]

    The valid address for the room.

  • DistanceUnit (string) –

    [REQUIRED]

    The distance unit to be used by devices in the profile.

  • TemperatureUnit (string) –

    [REQUIRED]

    The temperature unit to be used by devices in the profile.

  • WakeWord (string) –

    [REQUIRED]

    A wake word for Alexa, Echo, Amazon, or a computer.

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

  • ClientRequestToken (string) –

    The user-specified token that is used during the creation of a profile.

    This field is autopopulated if not provided.

  • SetupModeDisabled (boolean) – Whether room profile setup is enabled.

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

  • PSTNEnabled (boolean) – Whether PSTN calling is enabled.

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

  • MeetingRoomConfiguration (dict) –

    The meeting room settings of a room profile.

    • RoomUtilizationMetricsEnabled (boolean) –

      Whether room utilization metrics are enabled or not.

    • EndOfMeetingReminder (dict) –

      Creates 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) – [REQUIRED]

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

        • (integer) –

      • ReminderType (string) – [REQUIRED]

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

      • Enabled (boolean) – [REQUIRED]

        Whether an end of meeting reminder is enabled or not.

    • InstantBooking (dict) –

      Settings to automatically book a room for a configured duration if it’s free when joining a meeting with Alexa.

      • DurationInMinutes (integer) – [REQUIRED]

        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) – [REQUIRED]

        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) – [REQUIRED]

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

      • Enabled (boolean) – [REQUIRED]

        Whether require check in is enabled or not.

  • Tags (list) –

    The tags for the profile.

    • (dict) –

      A key-value pair that can be associated with a resource.

      • Key (string) – [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) – [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type:

dict

Returns:

Response Syntax

{
    'ProfileArn': 'string'
}

Response Structure

  • (dict) –

    • ProfileArn (string) –

      The ARN of the newly created room profile in the response.

Exceptions

  • AlexaForBusiness.Client.exceptions.LimitExceededException

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException

  • AlexaForBusiness.Client.exceptions.ConcurrentModificationException