AlexaForBusiness / Client / create_room

create_room#

AlexaForBusiness.Client.create_room(**kwargs)#

Creates a room with the specified details.

See also: AWS API Documentation

Request Syntax

response = client.create_room(
    RoomName='string',
    Description='string',
    ProfileArn='string',
    ProviderCalendarId='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • RoomName (string) –

    [REQUIRED]

    The name for the room.

  • Description (string) – The description for the room.

  • ProfileArn (string) – The profile ARN for the room. This is required.

  • ProviderCalendarId (string) – The calendar ARN for the room.

  • ClientRequestToken (string) –

    A unique, user-specified identifier for this request that ensures idempotency.

    This field is autopopulated if not provided.

  • Tags (list) –

    The tags for the room.

    • (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

{
    'RoomArn': 'string'
}

Response Structure

  • (dict) –

    • RoomArn (string) –

      The ARN of the newly created room in the response.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException

  • AlexaForBusiness.Client.exceptions.LimitExceededException