Alexa For Business

approve_skill(skill_id)
approve_skill(skill_id, params::Dict{String,<:Any})

Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.

Arguments

• skill_id: The unique identifier of the skill.

associate_contact_with_address_book(address_book_arn, contact_arn)
associate_contact_with_address_book(address_book_arn, contact_arn, params::Dict{String,<:Any})

Associates a contact with a given address book.

Arguments

• address_book_arn: The ARN of the address book with which to associate the contact.
• contact_arn: The ARN of the contact to associate with an address book.

associate_device_with_network_profile(device_arn, network_profile_arn)
associate_device_with_network_profile(device_arn, network_profile_arn, params::Dict{String,<:Any})

Associates a device with the specified network profile.

Arguments

• device_arn: The device ARN.
• network_profile_arn: The ARN of the network profile to associate with a device.

associate_device_with_room()
associate_device_with_room(params::Dict{String,<:Any})

Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeviceArn": The ARN of the device to associate to a room. Required.
• "RoomArn": The ARN of the room with which to associate the device. Required.

associate_skill_group_with_room()
associate_skill_group_with_room(params::Dict{String,<:Any})

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RoomArn": The ARN of the room with which to associate the skill group. Required.
• "SkillGroupArn": The ARN of the skill group to associate with a room. Required.

associate_skill_with_skill_group(skill_id)
associate_skill_with_skill_group(skill_id, params::Dict{String,<:Any})

Associates a skill with a skill group.

Arguments

• skill_id: The unique identifier of the skill.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "SkillGroupArn": The ARN of the skill group to associate the skill to. Required.

associate_skill_with_users(skill_id)
associate_skill_with_users(skill_id, params::Dict{String,<:Any})

Makes a private skill available for enrolled users to enable on their devices.

Arguments

• skill_id: The private skill ID you want to make available to enrolled users.

create_address_book(name)
create_address_book(name, params::Dict{String,<:Any})

Creates an address book with the specified details.

Arguments

• name: The name of the address book.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientRequestToken": A unique, user-specified identifier for the request that ensures idempotency.
• "Description": The description of the address book.
• "Tags": The tags to be added to the specified resource. Do not provide system tags.

create_business_report_schedule(content_range, format)
create_business_report_schedule(content_range, format, params::Dict{String,<:Any})

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

Arguments

• content_range: The content range of the reports.
• format: The format of the generated report (individual CSV files or zipped files of individual files).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientRequestToken": The client request token.
• "Recurrence": The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
• "S3BucketName": The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.
• "S3KeyPrefix": The S3 key where the report is delivered.
• "ScheduleName": The name identifier of the schedule.
• "Tags": The tags for the business report schedule.

create_conference_provider(conference_provider_name, conference_provider_type, meeting_setting)
create_conference_provider(conference_provider_name, conference_provider_type, meeting_setting, params::Dict{String,<:Any})

Adds a new conference provider under the user's AWS account.

Arguments

• conference_provider_name: The name of the conference provider.
• conference_provider_type: Represents a type within a list of predefined types.
• meeting_setting: The meeting settings for the conference provider.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientRequestToken": The request token of the client.
• "IPDialIn": The IP endpoint and protocol for calling.
• "PSTNDialIn": The information for PSTN conferencing.
• "Tags": The tags to be added to the specified resource. Do not provide system tags.

create_contact(first_name)
create_contact(first_name, params::Dict{String,<:Any})

Creates a contact with the specified details.

Arguments

• first_name: The first name of the contact that is used to call the contact on the device.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientRequestToken": A unique, user-specified identifier for this request that ensures idempotency.
• "DisplayName": The name of the contact to display on the console.
• "LastName": The last name of the contact that is used to call the contact on the device.
• "PhoneNumber": The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
• "PhoneNumbers": The list of phone numbers for the contact.
• "SipAddresses": The list of SIP addresses for the contact.
• "Tags": The tags to be added to the specified resource. Do not provide system tags.

create_gateway_group(client_request_token, name)
create_gateway_group(client_request_token, name, params::Dict{String,<:Any})

Creates a gateway group with the specified details.

Arguments

• client_request_token: A unique, user-specified identifier for the request that ensures idempotency.
• name: The name of the gateway group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": The description of the gateway group.
• "Tags": The tags to be added to the specified resource. Do not provide system tags.

create_network_profile(client_request_token, network_profile_name, security_type, ssid)
create_network_profile(client_request_token, network_profile_name, security_type, ssid, params::Dict{String,<:Any})

Creates a network profile with the specified details.

Arguments

• client_request_token:
• network_profile_name: The name of the network profile associated with a device.
• security_type: The security type of the Wi-Fi network. This can be WPA2ENTERPRISE, WPA2PSK, WPA_PSK, WEP, or OPEN.
• ssid: The SSID of the Wi-Fi network.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "CertificateAuthorityArn": The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
• "CurrentPassword": The current password of the Wi-Fi network.
• "Description": Detailed information about a device's network profile.
• "EapMethod": The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
• "NextPassword": The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
• "Tags": The tags to be added to the specified resource. Do not provide system tags.
• "TrustAnchors": The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

create_profile(address, distance_unit, profile_name, temperature_unit, timezone, wake_word)
create_profile(address, distance_unit, profile_name, temperature_unit, timezone, wake_word, params::Dict{String,<:Any})

Creates a new room profile with the specified details.

Arguments

• address: The valid address for the room.
• distance_unit: The distance unit to be used by devices in the profile.
• profile_name: The name of a room profile.
• temperature_unit: The temperature unit to be used by devices in the profile.
• timezone: The time zone used by a room profile.
• wake_word: A wake word for Alexa, Echo, Amazon, or a computer.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientRequestToken": The user-specified token that is used during the creation of a profile.
• "Locale": The locale of the room profile. (This is currently only available to a limited preview audience.)
• "MaxVolumeLimit": The maximum volume limit for a room profile.
• "MeetingRoomConfiguration": The meeting room settings of a room profile.
• "PSTNEnabled": Whether PSTN calling is enabled.
• "SetupModeDisabled": Whether room profile setup is enabled.
• "Tags": The tags for the profile.

create_room(room_name)
create_room(room_name, params::Dict{String,<:Any})

Creates a room with the specified details.

Arguments

• room_name: The name for the room.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientRequestToken": A unique, user-specified identifier for this request that ensures idempotency.
• "Description": The description for the room.
• "ProfileArn": The profile ARN for the room. This is required.
• "ProviderCalendarId": The calendar ARN for the room.
• "Tags": The tags for the room.

create_skill_group(skill_group_name)
create_skill_group(skill_group_name, params::Dict{String,<:Any})

Creates a skill group with a specified name and description.

Arguments

• skill_group_name: The name for the skill group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientRequestToken": A unique, user-specified identifier for this request that ensures idempotency.
• "Description": The description for the skill group.
• "Tags": The tags for the skill group.

create_user(user_id)
create_user(user_id, params::Dict{String,<:Any})

Creates a user.

Arguments

• user_id: The ARN for the user.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientRequestToken": A unique, user-specified identifier for this request that ensures idempotency.
• "Email": The email address for the user.
• "FirstName": The first name for the user.
• "LastName": The last name for the user.
• "Tags": The tags for the user.

delete_address_book(address_book_arn)
delete_address_book(address_book_arn, params::Dict{String,<:Any})

Deletes an address book by the address book ARN.

Arguments

• address_book_arn: The ARN of the address book to delete.

delete_business_report_schedule(schedule_arn)
delete_business_report_schedule(schedule_arn, params::Dict{String,<:Any})

Deletes the recurring report delivery schedule with the specified schedule ARN.

Arguments

• schedule_arn: The ARN of the business report schedule.

delete_conference_provider(conference_provider_arn)
delete_conference_provider(conference_provider_arn, params::Dict{String,<:Any})

Deletes a conference provider.

Arguments

• conference_provider_arn: The ARN of the conference provider.

delete_contact(contact_arn)
delete_contact(contact_arn, params::Dict{String,<:Any})

Deletes a contact by the contact ARN.

Arguments

• contact_arn: The ARN of the contact to delete.

delete_device(device_arn)
delete_device(device_arn, params::Dict{String,<:Any})

Removes a device from Alexa For Business.

Arguments

• device_arn: The ARN of the device for which to request details.

delete_device_usage_data(device_arn, device_usage_type)
delete_device_usage_data(device_arn, device_usage_type, params::Dict{String,<:Any})

When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.

Arguments

• device_arn: The ARN of the device.
• device_usage_type: The type of usage data to delete.

delete_gateway_group(gateway_group_arn)
delete_gateway_group(gateway_group_arn, params::Dict{String,<:Any})

Deletes a gateway group.

Arguments

• gateway_group_arn: The ARN of the gateway group to delete.

delete_network_profile(network_profile_arn)
delete_network_profile(network_profile_arn, params::Dict{String,<:Any})

Deletes a network profile by the network profile ARN.

Arguments

• network_profile_arn: The ARN of the network profile associated with a device.

delete_profile()
delete_profile(params::Dict{String,<:Any})

Deletes a room profile by the profile ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ProfileArn": The ARN of the room profile to delete. Required.

delete_room()
delete_room(params::Dict{String,<:Any})

Deletes a room by the room ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RoomArn": The ARN of the room to delete. Required.

delete_room_skill_parameter(parameter_key, skill_id)
delete_room_skill_parameter(parameter_key, skill_id, params::Dict{String,<:Any})

Deletes room skill parameter details by room, skill, and parameter key ID.

Arguments

• parameter_key: The room skill parameter key for which to remove details.
• skill_id: The ID of the skill from which to remove the room skill parameter details.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RoomArn": The ARN of the room from which to remove the room skill parameter details.

delete_skill_authorization(skill_id)
delete_skill_authorization(skill_id, params::Dict{String,<:Any})

Unlinks a third-party account from a skill.

Arguments

• skill_id: The unique identifier of a skill.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RoomArn": The room that the skill is authorized for.

delete_skill_group()
delete_skill_group(params::Dict{String,<:Any})

Deletes a skill group by skill group ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "SkillGroupArn": The ARN of the skill group to delete. Required.

delete_user(enrollment_id)
delete_user(enrollment_id, params::Dict{String,<:Any})

Deletes a specified user by user ARN and enrollment ARN.

Arguments

• enrollment_id: The ARN of the user's enrollment in the organization. Required.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "UserArn": The ARN of the user to delete in the organization. Required.

disassociate_contact_from_address_book(address_book_arn, contact_arn)
disassociate_contact_from_address_book(address_book_arn, contact_arn, params::Dict{String,<:Any})

Disassociates a contact from a given address book.

Arguments

• address_book_arn: The ARN of the address from which to disassociate the contact.
• contact_arn: The ARN of the contact to disassociate from an address book.

disassociate_device_from_room()
disassociate_device_from_room(params::Dict{String,<:Any})

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeviceArn": The ARN of the device to disassociate from a room. Required.

disassociate_skill_from_skill_group(skill_id)
disassociate_skill_from_skill_group(skill_id, params::Dict{String,<:Any})

Disassociates a skill from a skill group.

Arguments

• skill_id: The ARN of a skill group to associate to a skill.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "SkillGroupArn": The unique identifier of a skill. Required.

disassociate_skill_from_users(skill_id)
disassociate_skill_from_users(skill_id, params::Dict{String,<:Any})

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

Arguments

• skill_id: The private skill ID you want to make unavailable for enrolled users.

disassociate_skill_group_from_room()
disassociate_skill_group_from_room(params::Dict{String,<:Any})

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RoomArn": The ARN of the room from which the skill group is to be disassociated. Required.
• "SkillGroupArn": The ARN of the skill group to disassociate from a room. Required.

forget_smart_home_appliances(room_arn)
forget_smart_home_appliances(room_arn, params::Dict{String,<:Any})

Forgets smart home appliances associated to a room.

Arguments

• room_arn: The room that the appliances are associated with.

get_address_book(address_book_arn)
get_address_book(address_book_arn, params::Dict{String,<:Any})

Gets address the book details by the address book ARN.

Arguments

• address_book_arn: The ARN of the address book for which to request details.

get_conference_preference()
get_conference_preference(params::Dict{String,<:Any})

Retrieves the existing conference preferences.

get_conference_provider(conference_provider_arn)
get_conference_provider(conference_provider_arn, params::Dict{String,<:Any})

Gets details about a specific conference provider.

Arguments

• conference_provider_arn: The ARN of the newly created conference provider.

get_contact(contact_arn)
get_contact(contact_arn, params::Dict{String,<:Any})

Gets the contact details by the contact ARN.

Arguments

• contact_arn: The ARN of the contact for which to request details.

get_device()
get_device(params::Dict{String,<:Any})

Gets the details of a device by device ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeviceArn": The ARN of the device for which to request details. Required.

get_gateway(gateway_arn)
get_gateway(gateway_arn, params::Dict{String,<:Any})

Retrieves the details of a gateway.

Arguments

• gateway_arn: The ARN of the gateway to get.

get_gateway_group(gateway_group_arn)
get_gateway_group(gateway_group_arn, params::Dict{String,<:Any})

Retrieves the details of a gateway group.

Arguments

• gateway_group_arn: The ARN of the gateway group to get.

get_invitation_configuration()
get_invitation_configuration(params::Dict{String,<:Any})

Retrieves the configured values for the user enrollment invitation email template.

get_network_profile(network_profile_arn)
get_network_profile(network_profile_arn, params::Dict{String,<:Any})

Gets the network profile details by the network profile ARN.

Arguments

• network_profile_arn: The ARN of the network profile associated with a device.

get_profile()
get_profile(params::Dict{String,<:Any})

Gets the details of a room profile by profile ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ProfileArn": The ARN of the room profile for which to request details. Required.

get_room()
get_room(params::Dict{String,<:Any})

Gets room details by room ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RoomArn": The ARN of the room for which to request details. Required.

get_room_skill_parameter(parameter_key, skill_id)
get_room_skill_parameter(parameter_key, skill_id, params::Dict{String,<:Any})

Gets room skill parameter details by room, skill, and parameter key ARN.

Arguments

• parameter_key: The room skill parameter key for which to get details. Required.
• skill_id: The ARN of the skill from which to get the room skill parameter details. Required.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RoomArn": The ARN of the room from which to get the room skill parameter details.

get_skill_group()
get_skill_group(params::Dict{String,<:Any})

Gets skill group details by skill group ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "SkillGroupArn": The ARN of the skill group for which to get details. Required.

list_business_report_schedules()
list_business_report_schedules(params::Dict{String,<:Any})

Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of schedules listed in the call.
• "NextToken": The token used to list the remaining schedules from the previous API call.

list_conference_providers()
list_conference_providers(params::Dict{String,<:Any})

Lists conference providers under a specific AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of conference providers to be returned, per paginated calls.
• "NextToken": The tokens used for pagination.

list_device_events(device_arn)
list_device_events(device_arn, params::Dict{String,<:Any})

Lists the device event history, including device connection status, for up to 30 days.

Arguments

• device_arn: The ARN of a device.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "EventType": The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
• "MaxResults": The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

list_gateway_groups()
list_gateway_groups(params::Dict{String,<:Any})

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of gateway group summaries to return. The default is
• "NextToken": The token used to paginate though multiple pages of gateway group summaries.

list_gateways()
list_gateways(params::Dict{String,<:Any})

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "GatewayGroupArn": The gateway group ARN for which to list gateways.
• "MaxResults": The maximum number of gateway summaries to return. The default is 50.
• "NextToken": The token used to paginate though multiple pages of gateway summaries.

list_skills()
list_skills(params::Dict{String,<:Any})

Lists all enabled skills in a specific skill group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "EnablementType": Whether the skill is enabled under the user's account.
• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
• "SkillGroupArn": The ARN of the skill group for which to list enabled skills.
• "SkillType": Whether the skill is publicly available or is a private skill.

list_skills_store_categories()
list_skills_store_categories(params::Dict{String,<:Any})

Lists all categories in the Alexa skill store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of categories returned, per paginated calls.
• "NextToken": The tokens used for pagination.

list_skills_store_skills_by_category(category_id)
list_skills_store_skills_by_category(category_id, params::Dict{String,<:Any})

Lists all skills in the Alexa skill store by category.

Arguments

• category_id: The category ID for which the skills are being retrieved from the skill store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of skills returned per paginated calls.
• "NextToken": The tokens used for pagination.

list_smart_home_appliances(room_arn)
list_smart_home_appliances(room_arn, params::Dict{String,<:Any})

Lists all of the smart home appliances associated with a room.

Arguments

• room_arn: The room that the appliances are associated with.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of appliances to be returned, per paginated calls.
• "NextToken": The tokens used for pagination.

list_tags(arn)
list_tags(arn, params::Dict{String,<:Any})

Lists all tags for the specified resource.

Arguments

• arn: The ARN of the specified resource for which to list tags.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

put_conference_preference(conference_preference)
put_conference_preference(conference_preference, params::Dict{String,<:Any})

Sets the conference preferences on a specific conference provider at the account level.

Arguments

• conference_preference: The conference preference of a specific conference provider.

put_invitation_configuration(organization_name)
put_invitation_configuration(organization_name, params::Dict{String,<:Any})

Configures the email template for the user enrollment invitation with the specified attributes.

Arguments

• organization_name: The name of the organization sending the enrollment invite to a user.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ContactEmail": The email ID of the organization or individual contact that the enrolled user can use.
• "PrivateSkillIds": The list of private skill IDs that you want to recommend to the user to enable in the invitation.

put_room_skill_parameter(room_skill_parameter, skill_id)
put_room_skill_parameter(room_skill_parameter, skill_id, params::Dict{String,<:Any})

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

Arguments

• room_skill_parameter: The updated room skill parameter. Required.
• skill_id: The ARN of the skill associated with the room skill parameter. Required.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RoomArn": The ARN of the room associated with the room skill parameter. Required.

put_skill_authorization(authorization_result, skill_id)
put_skill_authorization(authorization_result, skill_id, params::Dict{String,<:Any})

Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.

Arguments

• authorization_result: The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.
• skill_id: The unique identifier of a skill.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "RoomArn": The room that the skill is authorized for.

register_avsdevice(amazon_id, client_id, product_id, user_code)
register_avsdevice(amazon_id, client_id, product_id, user_code, params::Dict{String,<:Any})

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

Arguments

• amazon_id: The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
• client_id: The client ID of the OEM used for code-based linking authorization on an AVS device.
• product_id: The product ID used to identify your AVS device during authorization.
• user_code: The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeviceSerialNumber": The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
• "RoomArn": The Amazon Resource Name (ARN) of the room with which to associate your AVS device.
• "Tags": The tags to be added to the specified resource. Do not provide system tags.

reject_skill(skill_id)
reject_skill(skill_id, params::Dict{String,<:Any})

Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.

Arguments

• skill_id: The unique identifier of the skill.

resolve_room(skill_id, user_id)
resolve_room(skill_id, user_id, params::Dict{String,<:Any})

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.

Arguments

• skill_id: The ARN of the skill that was requested. Required.
• user_id: The ARN of the user. Required.

revoke_invitation()
revoke_invitation(params::Dict{String,<:Any})

Revokes an invitation and invalidates the enrollment URL.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "EnrollmentId": The ARN of the enrollment invitation to revoke. Required.
• "UserArn": The ARN of the user for whom to revoke an enrollment invitation. Required.

search_address_books()
search_address_books(params::Dict{String,<:Any})

Searches address books and lists the ones that meet a set of filter and sort criteria.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
• "SortCriteria": The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

search_contacts()
search_contacts(params::Dict{String,<:Any})

Searches contacts and lists the ones that meet a set of filter and sort criteria.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
• "SortCriteria": The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

search_devices()
search_devices(params::Dict{String,<:Any})

Searches devices and lists the ones that meet a set of filter criteria.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
• "SortCriteria": The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

search_network_profiles()
search_network_profiles(params::Dict{String,<:Any})

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.
• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
• "SortCriteria": The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

search_profiles()
search_profiles(params::Dict{String,<:Any})

Searches room profiles and lists the ones that meet a set of filter criteria.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
• "SortCriteria": The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

search_rooms()
search_rooms(params::Dict{String,<:Any})

Searches rooms and lists the ones that meet a set of filter and sort criteria.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
• "SortCriteria": The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

search_skill_groups()
search_skill_groups(params::Dict{String,<:Any})

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
• "SortCriteria": The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.

search_users()
search_users(params::Dict{String,<:Any})

Searches users and lists the ones that meet a set of filter and sort criteria.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
• "MaxResults": The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
• "NextToken": An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
• "SortCriteria": The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

send_announcement(client_request_token, content, room_filters)
send_announcement(client_request_token, content, room_filters, params::Dict{String,<:Any})

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

Arguments

• client_request_token: The unique, user-specified identifier for the request that ensures idempotency.
• content: The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
• room_filters: The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "TimeToLiveInSeconds": The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

send_invitation()
send_invitation(params::Dict{String,<:Any})

Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "UserArn": The ARN of the user to whom to send an invitation. Required.

start_device_sync(features)
start_device_sync(features, params::Dict{String,<:Any})

Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways: Bluetooth - This unpairs all bluetooth devices paired with your echo device. Volume - This resets the echo device's volume to the default value. Notifications - This clears all notifications from your echo device. Lists - This clears all to-do items from your echo device. Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).

Arguments

• features: Request structure to start the device sync. Required.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeviceArn": The ARN of the device to sync. Required.
• "RoomArn": The ARN of the room with which the device to sync is associated. Required.

start_smart_home_appliance_discovery(room_arn)
start_smart_home_appliance_discovery(room_arn, params::Dict{String,<:Any})

Initiates the discovery of any smart home appliances associated with the room.

Arguments

• room_arn: The room where smart home appliance discovery was initiated.

tag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})

Adds metadata tags to a specified resource.

Arguments

• arn: The ARN of the resource to which to add metadata tags. Required.
• tags: The tags to be added to the specified resource. Do not provide system tags. Required.

untag_resource(arn, tag_keys)
untag_resource(arn, tag_keys, params::Dict{String,<:Any})

Removes metadata tags from a specified resource.

Arguments

• arn: The ARN of the resource from which to remove metadata tags. Required.
• tag_keys: The tags to be removed from the specified resource. Do not provide system tags. Required.

update_address_book(address_book_arn)
update_address_book(address_book_arn, params::Dict{String,<:Any})

Updates address book details by the address book ARN.

Arguments

• address_book_arn: The ARN of the room to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": The updated description of the room.
• "Name": The updated name of the room.

update_business_report_schedule(schedule_arn)
update_business_report_schedule(schedule_arn, params::Dict{String,<:Any})

Updates the configuration of the report delivery schedule with the specified schedule ARN.

Arguments

• schedule_arn: The ARN of the business report schedule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Format": The format of the generated report (individual CSV files or zipped files of individual files).
• "Recurrence": The recurrence of the reports.
• "S3BucketName": The S3 location of the output reports.
• "S3KeyPrefix": The S3 key where the report is delivered.
• "ScheduleName": The name identifier of the schedule.

update_conference_provider(conference_provider_arn, conference_provider_type, meeting_setting)
update_conference_provider(conference_provider_arn, conference_provider_type, meeting_setting, params::Dict{String,<:Any})

Updates an existing conference provider's settings.

Arguments

• conference_provider_arn: The ARN of the conference provider.
• conference_provider_type: The type of the conference provider.
• meeting_setting: The meeting settings for the conference provider.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "IPDialIn": The IP endpoint and protocol for calling.
• "PSTNDialIn": The information for PSTN conferencing.

update_contact(contact_arn)
update_contact(contact_arn, params::Dict{String,<:Any})

Updates the contact details by the contact ARN.

Arguments

• contact_arn: The ARN of the contact to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DisplayName": The updated display name of the contact.
• "FirstName": The updated first name of the contact.
• "LastName": The updated last name of the contact.
• "PhoneNumber": The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
• "PhoneNumbers": The list of phone numbers for the contact.
• "SipAddresses": The list of SIP addresses for the contact.

update_device()
update_device(params::Dict{String,<:Any})

Updates the device name by device ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeviceArn": The ARN of the device to update. Required.
• "DeviceName": The updated device name. Required.

update_gateway(gateway_arn)
update_gateway(gateway_arn, params::Dict{String,<:Any})

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

Arguments

• gateway_arn: The ARN of the gateway to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": The updated description of the gateway.
• "Name": The updated name of the gateway.
• "SoftwareVersion": The updated software version of the gateway. The gateway automatically updates its software version during normal operation.

update_gateway_group(gateway_group_arn)
update_gateway_group(gateway_group_arn, params::Dict{String,<:Any})

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

Arguments

• gateway_group_arn: The ARN of the gateway group to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": The updated description of the gateway group.
• "Name": The updated name of the gateway group.

update_network_profile(network_profile_arn)
update_network_profile(network_profile_arn, params::Dict{String,<:Any})

Updates a network profile by the network profile ARN.

Arguments

• network_profile_arn: The ARN of the network profile associated with a device.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "CertificateAuthorityArn": The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
• "CurrentPassword": The current password of the Wi-Fi network.
• "Description": Detailed information about a device's network profile.
• "NetworkProfileName": The name of the network profile associated with a device.
• "NextPassword": The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
• "TrustAnchors": The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.

update_profile()
update_profile(params::Dict{String,<:Any})

Updates an existing room profile by room profile ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Address": The updated address for the room profile.
• "DistanceUnit": The updated distance unit for the room profile.
• "IsDefault": Sets the profile as default if selected. If this is missing, no update is done to the default status.
• "Locale": The updated locale for the room profile. (This is currently only available to a limited preview audience.)
• "MaxVolumeLimit": The updated maximum volume limit for the room profile.
• "MeetingRoomConfiguration": The updated meeting room settings of a room profile.
• "PSTNEnabled": Whether the PSTN setting of the room profile is enabled.
• "ProfileArn": The ARN of the room profile to update. Required.
• "ProfileName": The updated name for the room profile.
• "SetupModeDisabled": Whether the setup mode of the profile is enabled.
• "TemperatureUnit": The updated temperature unit for the room profile.
• "Timezone": The updated timezone for the room profile.
• "WakeWord": The updated wake word for the room profile.

update_room()
update_room(params::Dict{String,<:Any})

Updates room details by room ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": The updated description for the room.
• "ProfileArn": The updated profile ARN for the room.
• "ProviderCalendarId": The updated provider calendar ARN for the room.
• "RoomArn": The ARN of the room to update.
• "RoomName": The updated name for the room.

update_skill_group()
update_skill_group(params::Dict{String,<:Any})

Updates skill group details by skill group ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": The updated description for the skill group.
• "SkillGroupArn": The ARN of the skill group to update.
• "SkillGroupName": The updated name for the skill group.