Alexa for Business makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need for managing Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can make also these available as private skills for your organization. Alexa for Business makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.
", "operations": { "AssociateContactWithAddressBook": "Associates a contact with a given address book.
", "AssociateDeviceWithRoom": "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.
", "AssociateSkillGroupWithRoom": "Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
", "CreateAddressBook": "Creates an address book with the specified details.
", "CreateContact": "Creates a contact with the specified details.
", "CreateProfile": "Creates a new room profile with the specified details.
", "CreateRoom": "Creates a room with the specified details.
", "CreateSkillGroup": "Creates a skill group with a specified name and description.
", "CreateUser": "Creates a user.
", "DeleteAddressBook": "Deletes an address book by the address book ARN.
", "DeleteContact": "Deletes a contact by the contact ARN.
", "DeleteProfile": "Deletes a room profile by the profile ARN.
", "DeleteRoom": "Deletes a room by the room ARN.
", "DeleteRoomSkillParameter": "Deletes room skill parameter details by room, skill, and parameter key ID.
", "DeleteSkillGroup": "Deletes a skill group by skill group ARN.
", "DeleteUser": "Deletes a specified user by user ARN and enrollment ARN.
", "DisassociateContactFromAddressBook": "Disassociates a contact from a given address book.
", "DisassociateDeviceFromRoom": "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.
", "DisassociateSkillGroupFromRoom": "Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
", "GetAddressBook": "Gets address the book details by the address book ARN.
", "GetContact": "Gets the contact details by the contact ARN.
", "GetDevice": "Gets the details of a device by device ARN.
", "GetProfile": "Gets the details of a room profile by profile ARN.
", "GetRoom": "Gets room details by room ARN.
", "GetRoomSkillParameter": "Gets room skill parameter details by room, skill, and parameter key ARN.
", "GetSkillGroup": "Gets skill group details by skill group ARN.
", "ListDeviceEvents": "Lists the device event history, including device connection status, for up to 30 days.
", "ListSkills": "Lists all enabled skills in a specific skill group.
", "ListTags": "Lists all tags for the specified resource.
", "PutRoomSkillParameter": "Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
", "ResolveRoom": "Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
", "RevokeInvitation": "Revokes an invitation and invalidates the enrollment URL.
", "SearchAddressBooks": "Searches address books and lists the ones that meet a set of filter and sort criteria.
", "SearchContacts": "Searches contacts and lists the ones that meet a set of filter and sort criteria.
", "SearchDevices": "Searches devices and lists the ones that meet a set of filter criteria.
", "SearchProfiles": "Searches room profiles and lists the ones that meet a set of filter criteria.
", "SearchRooms": "Searches rooms and lists the ones that meet a set of filter and sort criteria.
", "SearchSkillGroups": "Searches skill groups and lists the ones that meet a set of filter and sort criteria.
", "SearchUsers": "Searches users and lists the ones that meet a set of filter and sort criteria.
", "SendInvitation": "Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.
", "StartDeviceSync": "Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.
", "TagResource": "Adds metadata tags to a specified resource.
", "UntagResource": "Removes metadata tags from a specified resource.
", "UpdateAddressBook": "Updates address book details by the address book ARN.
", "UpdateContact": "Updates the contact details by the contact ARN.
", "UpdateDevice": "Updates the device name by device ARN.
", "UpdateProfile": "Updates an existing room profile by room profile ARN.
", "UpdateRoom": "Updates room details by room ARN.
", "UpdateSkillGroup": "Updates skill group details by skill group ARN.
" }, "shapes": { "Address": { "base": null, "refs": { "CreateProfileRequest$Address": "The valid address for the room.
", "Profile$Address": "The address of a room profile.
", "ProfileData$Address": "The address of a room profile.
", "UpdateProfileRequest$Address": "The updated address for the room profile.
" } }, "AddressBook": { "base": "An address book with attributes.
", "refs": { "GetAddressBookResponse$AddressBook": "The details of the requested address book.
" } }, "AddressBookData": { "base": "Information related to an address book.
", "refs": { "AddressBookDataList$member": null } }, "AddressBookDataList": { "base": null, "refs": { "SearchAddressBooksResponse$AddressBooks": "The address books that meet the specified set of filter criteria, in sort order.
" } }, "AddressBookDescription": { "base": null, "refs": { "AddressBook$Description": "The description of the address book.
", "AddressBookData$Description": "The description of the address book.
", "CreateAddressBookRequest$Description": "The description of the address book.
", "UpdateAddressBookRequest$Description": "The updated description of the room.
" } }, "AddressBookName": { "base": null, "refs": { "AddressBook$Name": "The name of the address book.
", "AddressBookData$Name": "The name of the address book.
", "CreateAddressBookRequest$Name": "The name of the address book.
", "UpdateAddressBookRequest$Name": "The updated name of the room.
" } }, "AlreadyExistsException": { "base": "The resource being created already exists. HTTP Status Code: 400
", "refs": { } }, "Arn": { "base": null, "refs": { "AddressBook$AddressBookArn": "The ARN of the address book.
", "AddressBookData$AddressBookArn": "The ARN of the address book.
", "AssociateContactWithAddressBookRequest$ContactArn": "The ARN of the contact to associate with an address book.
", "AssociateContactWithAddressBookRequest$AddressBookArn": "The ARN of the address book with which to associate the contact.
", "AssociateDeviceWithRoomRequest$DeviceArn": "The ARN of the device to associate to a room. Required.
", "AssociateDeviceWithRoomRequest$RoomArn": "The ARN of the room with which to associate the device. Required.
", "AssociateSkillGroupWithRoomRequest$SkillGroupArn": "The ARN of the skill group to associate with a room. Required.
", "AssociateSkillGroupWithRoomRequest$RoomArn": "The ARN of the room with which to associate the skill group. Required.
", "Contact$ContactArn": "The ARN of the contact.
", "ContactData$ContactArn": "The ARN of the contact.
", "CreateAddressBookResponse$AddressBookArn": "The ARN of the newly created address book.
", "CreateContactResponse$ContactArn": "The ARN of the newly created address book.
", "CreateProfileResponse$ProfileArn": "The ARN of the newly created room profile in the response.
", "CreateRoomRequest$ProfileArn": "The profile ARN for the room.
", "CreateRoomResponse$RoomArn": "The ARN of the newly created room in the response.
", "CreateSkillGroupResponse$SkillGroupArn": "The ARN of the newly created skill group in the response.
", "CreateUserResponse$UserArn": "The ARN of the newly created user in the response.
", "DeleteAddressBookRequest$AddressBookArn": "The ARN of the address book to delete.
", "DeleteContactRequest$ContactArn": "The ARN of the contact to delete.
", "DeleteProfileRequest$ProfileArn": "The ARN of the room profile to delete. Required.
", "DeleteRoomRequest$RoomArn": "The ARN of the room to delete. Required.
", "DeleteRoomSkillParameterRequest$RoomArn": "The ARN of the room from which to remove the room skill parameter details.
", "DeleteSkillGroupRequest$SkillGroupArn": "The ARN of the skill group to delete. Required.
", "DeleteUserRequest$UserArn": "The ARN of the user to delete in the organization. Required.
", "Device$DeviceArn": "The ARN of a device.
", "Device$RoomArn": "The room ARN of a device.
", "DeviceData$DeviceArn": "The ARN of a device.
", "DeviceData$RoomArn": "The room ARN associated with a device.
", "DisassociateContactFromAddressBookRequest$ContactArn": "The ARN of the contact to disassociate from an address book.
", "DisassociateContactFromAddressBookRequest$AddressBookArn": "The ARN of the address from which to disassociate the contact.
", "DisassociateDeviceFromRoomRequest$DeviceArn": "The ARN of the device to disassociate from a room. Required.
", "DisassociateSkillGroupFromRoomRequest$SkillGroupArn": "The ARN of the skill group to disassociate from a room. Required.
", "DisassociateSkillGroupFromRoomRequest$RoomArn": "The ARN of the room from which the skill group is to be disassociated. Required.
", "GetAddressBookRequest$AddressBookArn": "The ARN of the address book for which to request details.
", "GetContactRequest$ContactArn": "The ARN of the contact for which to request details.
", "GetDeviceRequest$DeviceArn": "The ARN of the device for which to request details. Required.
", "GetProfileRequest$ProfileArn": "The ARN of the room profile for which to request details. Required.
", "GetRoomRequest$RoomArn": "The ARN of the room for which to request details. Required.
", "GetRoomSkillParameterRequest$RoomArn": "The ARN of the room from which to get the room skill parameter details.
", "GetSkillGroupRequest$SkillGroupArn": "The ARN of the skill group for which to get details. Required.
", "ListDeviceEventsRequest$DeviceArn": "The ARN of a device.
", "ListSkillsRequest$SkillGroupArn": "The ARN of the skill group for which to list enabled skills. Required.
", "ListTagsRequest$Arn": "The ARN of the specified resource for which to list tags.
", "Profile$ProfileArn": "The ARN of a room profile.
", "ProfileData$ProfileArn": "The ARN of a room profile.
", "PutRoomSkillParameterRequest$RoomArn": "The ARN of the room associated with the room skill parameter. Required.
", "ResolveRoomResponse$RoomArn": "The ARN of the room from which the skill request was invoked.
", "RevokeInvitationRequest$UserArn": "The ARN of the user for whom to revoke an enrollment invitation. Required.
", "Room$RoomArn": "The ARN of a room.
", "Room$ProfileArn": "The profile ARN of a room.
", "RoomData$RoomArn": "The ARN of a room.
", "RoomData$ProfileArn": "The profile ARN of a room.
", "SendInvitationRequest$UserArn": "The ARN of the user to whom to send an invitation. Required.
", "SkillGroup$SkillGroupArn": "The ARN of a skill group.
", "SkillGroupData$SkillGroupArn": "The skill group ARN of a skill group.
", "StartDeviceSyncRequest$RoomArn": "The ARN of the room with which the device to sync is associated. Required.
", "StartDeviceSyncRequest$DeviceArn": "The ARN of the device to sync. Required.
", "TagResourceRequest$Arn": "The ARN of the resource to which to add metadata tags. Required.
", "UntagResourceRequest$Arn": "The ARN of the resource from which to remove metadata tags. Required.
", "UpdateAddressBookRequest$AddressBookArn": "The ARN of the room to update.
", "UpdateContactRequest$ContactArn": "The ARN of the contact to update.
", "UpdateDeviceRequest$DeviceArn": "The ARN of the device to update. Required.
", "UpdateProfileRequest$ProfileArn": "The ARN of the room profile to update. Required.
", "UpdateRoomRequest$RoomArn": "The ARN of the room to update.
", "UpdateRoomRequest$ProfileArn": "The updated profile ARN for the room.
", "UpdateSkillGroupRequest$SkillGroupArn": "The ARN of the skill group to update.
", "UserData$UserArn": "The ARN of a user.
" } }, "AssociateContactWithAddressBookRequest": { "base": null, "refs": { } }, "AssociateContactWithAddressBookResponse": { "base": null, "refs": { } }, "AssociateDeviceWithRoomRequest": { "base": null, "refs": { } }, "AssociateDeviceWithRoomResponse": { "base": null, "refs": { } }, "AssociateSkillGroupWithRoomRequest": { "base": null, "refs": { } }, "AssociateSkillGroupWithRoomResponse": { "base": null, "refs": { } }, "Boolean": { "base": null, "refs": { "CreateProfileRequest$SetupModeDisabled": "Whether room profile setup is enabled.
", "CreateProfileRequest$PSTNEnabled": "Whether PSTN calling is enabled.
", "Profile$SetupModeDisabled": "The setup mode of a room profile.
", "Profile$PSTNEnabled": "The PSTN setting of a room profile.
", "UpdateProfileRequest$SetupModeDisabled": "Whether the setup mode of the profile is enabled.
", "UpdateProfileRequest$PSTNEnabled": "Whether the PSTN setting of the room profile is enabled.
" } }, "ClientRequestToken": { "base": "User specified token that is used to support idempotency during Create Resource", "refs": { "CreateAddressBookRequest$ClientRequestToken": "A unique, user-specified identifier for the request that ensures idempotency.
", "CreateContactRequest$ClientRequestToken": "A unique, user-specified identifier for this request that ensures idempotency.
", "CreateProfileRequest$ClientRequestToken": "The user-specified token that is used during the creation of a profile.
", "CreateRoomRequest$ClientRequestToken": "A unique, user-specified identifier for this request that ensures idempotency.
", "CreateSkillGroupRequest$ClientRequestToken": "A unique, user-specified identifier for this request that ensures idempotency.
", "CreateUserRequest$ClientRequestToken": "A unique, user-specified identifier for this request that ensures idempotency.
", "ResourceInUseException$ClientRequestToken": null } }, "ConnectionStatus": { "base": null, "refs": { "DeviceStatusInfo$ConnectionStatus": "The latest available information about the connection status of a device.
" } }, "Contact": { "base": "A contact with attributes.
", "refs": { "GetContactResponse$Contact": "The details of the requested contact.
" } }, "ContactData": { "base": "Information related to a contact.
", "refs": { "ContactDataList$member": null } }, "ContactDataList": { "base": null, "refs": { "SearchContactsResponse$Contacts": "The contacts that meet the specified set of filter criteria, in sort order.
" } }, "ContactName": { "base": null, "refs": { "Contact$DisplayName": "The name of the contact to display on the console.
", "Contact$FirstName": "The first name of the contact, used to call the contact on the device.
", "Contact$LastName": "The last name of the contact, used to call the contact on the device.
", "ContactData$DisplayName": "The name of the contact to display on the console.
", "ContactData$FirstName": "The first name of the contact, used to call the contact on the device.
", "ContactData$LastName": "The last name of the contact, used to call the contact on the device.
", "CreateContactRequest$DisplayName": "The name of the contact to display on the console.
", "CreateContactRequest$FirstName": "The first name of the contact that is used to call the contact on the device.
", "CreateContactRequest$LastName": "The last name of the contact that is used to call the contact on the device.
", "UpdateContactRequest$DisplayName": "The updated display name of the contact.
", "UpdateContactRequest$FirstName": "The updated first name of the contact.
", "UpdateContactRequest$LastName": "The updated last name of the contact.
" } }, "CreateAddressBookRequest": { "base": null, "refs": { } }, "CreateAddressBookResponse": { "base": null, "refs": { } }, "CreateContactRequest": { "base": null, "refs": { } }, "CreateContactResponse": { "base": null, "refs": { } }, "CreateProfileRequest": { "base": null, "refs": { } }, "CreateProfileResponse": { "base": null, "refs": { } }, "CreateRoomRequest": { "base": null, "refs": { } }, "CreateRoomResponse": { "base": null, "refs": { } }, "CreateSkillGroupRequest": { "base": null, "refs": { } }, "CreateSkillGroupResponse": { "base": null, "refs": { } }, "CreateUserRequest": { "base": null, "refs": { } }, "CreateUserResponse": { "base": null, "refs": { } }, "DeleteAddressBookRequest": { "base": null, "refs": { } }, "DeleteAddressBookResponse": { "base": null, "refs": { } }, "DeleteContactRequest": { "base": null, "refs": { } }, "DeleteContactResponse": { "base": null, "refs": { } }, "DeleteProfileRequest": { "base": null, "refs": { } }, "DeleteProfileResponse": { "base": null, "refs": { } }, "DeleteRoomRequest": { "base": null, "refs": { } }, "DeleteRoomResponse": { "base": null, "refs": { } }, "DeleteRoomSkillParameterRequest": { "base": null, "refs": { } }, "DeleteRoomSkillParameterResponse": { "base": null, "refs": { } }, "DeleteSkillGroupRequest": { "base": null, "refs": { } }, "DeleteSkillGroupResponse": { "base": null, "refs": { } }, "DeleteUserRequest": { "base": null, "refs": { } }, "DeleteUserResponse": { "base": null, "refs": { } }, "Device": { "base": "A device with attributes.
", "refs": { "GetDeviceResponse$Device": "The details of the device requested. Required.
" } }, "DeviceData": { "base": "Device attributes.
", "refs": { "DeviceDataList$member": null } }, "DeviceDataList": { "base": null, "refs": { "SearchDevicesResponse$Devices": "The devices that meet the specified set of filter criteria, in sort order.
" } }, "DeviceEvent": { "base": "The list of device events.
", "refs": { "DeviceEventList$member": null } }, "DeviceEventList": { "base": null, "refs": { "ListDeviceEventsResponse$DeviceEvents": "The device events requested for the device ARN.
" } }, "DeviceEventType": { "base": null, "refs": { "DeviceEvent$Type": "The type of device event.
", "ListDeviceEventsRequest$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.
" } }, "DeviceEventValue": { "base": null, "refs": { "DeviceEvent$Value": "The value of the event.
" } }, "DeviceName": { "base": null, "refs": { "Device$DeviceName": "The name of a device.
", "DeviceData$DeviceName": "The name of a device.
", "UpdateDeviceRequest$DeviceName": "The updated device name. Required.
" } }, "DeviceNotRegisteredException": { "base": "The request failed because this device is no longer registered and therefore no longer managed by this account.
", "refs": { } }, "DeviceSerialNumber": { "base": null, "refs": { "Device$DeviceSerialNumber": "The serial number of a device.
", "DeviceData$DeviceSerialNumber": "The serial number of a device.
" } }, "DeviceStatus": { "base": null, "refs": { "Device$DeviceStatus": "The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
", "DeviceData$DeviceStatus": "The status of a device.
" } }, "DeviceStatusDetail": { "base": "Details of a device’s status.
", "refs": { "DeviceStatusDetails$member": null } }, "DeviceStatusDetailCode": { "base": null, "refs": { "DeviceStatusDetail$Code": "The device status detail code.
" } }, "DeviceStatusDetails": { "base": null, "refs": { "DeviceStatusInfo$DeviceStatusDetails": "One or more device status detail descriptions.
" } }, "DeviceStatusInfo": { "base": "Detailed information about a device's status.
", "refs": { "Device$DeviceStatusInfo": "Detailed information about a device's status.
", "DeviceData$DeviceStatusInfo": "Detailed information about a device's status.
" } }, "DeviceType": { "base": null, "refs": { "Device$DeviceType": "The type of a device.
", "DeviceData$DeviceType": "The type of a device.
" } }, "DisassociateContactFromAddressBookRequest": { "base": null, "refs": { } }, "DisassociateContactFromAddressBookResponse": { "base": null, "refs": { } }, "DisassociateDeviceFromRoomRequest": { "base": null, "refs": { } }, "DisassociateDeviceFromRoomResponse": { "base": null, "refs": { } }, "DisassociateSkillGroupFromRoomRequest": { "base": null, "refs": { } }, "DisassociateSkillGroupFromRoomResponse": { "base": null, "refs": { } }, "DistanceUnit": { "base": null, "refs": { "CreateProfileRequest$DistanceUnit": "The distance unit to be used by devices in the profile.
", "Profile$DistanceUnit": "The distance unit of a room profile.
", "ProfileData$DistanceUnit": "The distance unit of a room profile.
", "UpdateProfileRequest$DistanceUnit": "The updated distance unit for the room profile.
" } }, "E164PhoneNumber": { "base": null, "refs": { "Contact$PhoneNumber": "The phone number of the contact.
", "ContactData$PhoneNumber": "The phone number of the contact.
", "CreateContactRequest$PhoneNumber": "The phone number of the contact in E.164 format.
", "UpdateContactRequest$PhoneNumber": "The updated phone number of the contact.
" } }, "Email": { "base": null, "refs": { "CreateUserRequest$Email": "The email address for the user.
", "UserData$Email": "The email of a user.
" } }, "EnrollmentId": { "base": null, "refs": { "DeleteUserRequest$EnrollmentId": "The ARN of the user's enrollment in the organization. Required.
", "RevokeInvitationRequest$EnrollmentId": "The ARN of the enrollment invitation to revoke. Required.
", "UserData$EnrollmentId": "The enrollment ARN of a user.
" } }, "EnrollmentStatus": { "base": null, "refs": { "UserData$EnrollmentStatus": "The enrollment status of a user.
" } }, "ErrorMessage": { "base": null, "refs": { "AlreadyExistsException$Message": null, "DeviceNotRegisteredException$Message": null, "InvalidUserStatusException$Message": null, "LimitExceededException$Message": null, "NameInUseException$Message": null, "NotFoundException$Message": null, "ResourceInUseException$Message": null } }, "Feature": { "base": null, "refs": { "Features$member": null } }, "Features": { "base": null, "refs": { "StartDeviceSyncRequest$Features": "Request structure to start the device sync. Required.
" } }, "Filter": { "base": "A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
", "refs": { "FilterList$member": null } }, "FilterKey": { "base": null, "refs": { "Filter$Key": "The key of a filter.
" } }, "FilterList": { "base": null, "refs": { "SearchAddressBooksRequest$Filters": "The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
", "SearchContactsRequest$Filters": "The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
", "SearchDevicesRequest$Filters": "The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).
", "SearchProfilesRequest$Filters": "The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
", "SearchRoomsRequest$Filters": "The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
", "SearchSkillGroupsRequest$Filters": "The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
", "SearchUsersRequest$Filters": "The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
" } }, "FilterValue": { "base": null, "refs": { "FilterValueList$member": null } }, "FilterValueList": { "base": null, "refs": { "Filter$Values": "The values of a filter.
" } }, "GetAddressBookRequest": { "base": null, "refs": { } }, "GetAddressBookResponse": { "base": null, "refs": { } }, "GetContactRequest": { "base": null, "refs": { } }, "GetContactResponse": { "base": null, "refs": { } }, "GetDeviceRequest": { "base": null, "refs": { } }, "GetDeviceResponse": { "base": null, "refs": { } }, "GetProfileRequest": { "base": null, "refs": { } }, "GetProfileResponse": { "base": null, "refs": { } }, "GetRoomRequest": { "base": null, "refs": { } }, "GetRoomResponse": { "base": null, "refs": { } }, "GetRoomSkillParameterRequest": { "base": null, "refs": { } }, "GetRoomSkillParameterResponse": { "base": null, "refs": { } }, "GetSkillGroupRequest": { "base": null, "refs": { } }, "GetSkillGroupResponse": { "base": null, "refs": { } }, "InvalidUserStatusException": { "base": "The attempt to update a user is invalid due to the user's current status. HTTP Status Code: 400
", "refs": { } }, "LimitExceededException": { "base": "You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400
", "refs": { } }, "ListDeviceEventsRequest": { "base": null, "refs": { } }, "ListDeviceEventsResponse": { "base": null, "refs": { } }, "ListSkillsRequest": { "base": null, "refs": { } }, "ListSkillsResponse": { "base": null, "refs": { } }, "ListTagsRequest": { "base": null, "refs": { } }, "ListTagsResponse": { "base": null, "refs": { } }, "MacAddress": { "base": null, "refs": { "Device$MacAddress": "The MAC address of a device.
", "DeviceData$MacAddress": "The MAC address of a device.
" } }, "MaxResults": { "base": null, "refs": { "ListDeviceEventsRequest$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.
", "ListTagsRequest$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.
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.
", "SearchContactsRequest$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.
", "SearchDevicesRequest$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.
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.
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.
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.
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.
The maximum volume limit for a room profile.
", "Profile$MaxVolumeLimit": "The max volume limit of a room profile.
", "UpdateProfileRequest$MaxVolumeLimit": "The updated maximum volume limit for the room profile.
" } }, "NameInUseException": { "base": "The name sent in the request is already in use. HTTP Status Code: 400
", "refs": { } }, "NextToken": { "base": null, "refs": { "ListDeviceEventsRequest$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.
", "ListDeviceEventsResponse$NextToken": "The token returned to indicate that there is more data available.
", "ListSkillsRequest$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.
The token returned to indicate that there is more data available.
", "ListTagsRequest$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.
The token returned to indicate that there is more data available.
", "SearchAddressBooksRequest$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.
", "SearchAddressBooksResponse$NextToken": "The token returned to indicate that there is more data available.
", "SearchContactsRequest$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.
", "SearchContactsResponse$NextToken": "The token returned to indicate that there is more data available.
", "SearchDevicesRequest$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.
The token returned to indicate that there is more data available.
", "SearchProfilesRequest$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.
The token returned to indicate that there is more data available.
", "SearchRoomsRequest$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.
The token returned to indicate that there is more data available.
", "SearchSkillGroupsRequest$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.
The token returned to indicate that there is more data available.
", "SearchUsersRequest$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.
The token returned to indicate that there is more data available.
" } }, "NotFoundException": { "base": "The resource is not found. HTTP Status Code: 400
", "refs": { } }, "Profile": { "base": "A room profile with attributes.
", "refs": { "GetProfileResponse$Profile": "The details of the room profile requested. Required.
" } }, "ProfileData": { "base": "The data of a room profile.
", "refs": { "ProfileDataList$member": null } }, "ProfileDataList": { "base": null, "refs": { "SearchProfilesResponse$Profiles": "The profiles that meet the specified set of filter criteria, in sort order.
" } }, "ProfileName": { "base": null, "refs": { "CreateProfileRequest$ProfileName": "The name of a room profile.
", "Profile$ProfileName": "The name of a room profile.
", "ProfileData$ProfileName": "The name of a room profile.
", "RoomData$ProfileName": "The profile name of a room.
", "UpdateProfileRequest$ProfileName": "The updated name for the room profile.
" } }, "ProviderCalendarId": { "base": null, "refs": { "CreateRoomRequest$ProviderCalendarId": "The calendar ARN for the room.
", "Room$ProviderCalendarId": "The provider calendar ARN of a room.
", "RoomData$ProviderCalendarId": "The provider calendar ARN of a room.
", "UpdateRoomRequest$ProviderCalendarId": "The updated provider calendar ARN for the room.
" } }, "PutRoomSkillParameterRequest": { "base": null, "refs": { } }, "PutRoomSkillParameterResponse": { "base": null, "refs": { } }, "ResolveRoomRequest": { "base": null, "refs": { } }, "ResolveRoomResponse": { "base": null, "refs": { } }, "ResourceInUseException": { "base": "The resource in the request is already in use. HTTP Status Code: 400
", "refs": { } }, "RevokeInvitationRequest": { "base": null, "refs": { } }, "RevokeInvitationResponse": { "base": null, "refs": { } }, "Room": { "base": "A room with attributes.
", "refs": { "GetRoomResponse$Room": "The details of the room requested.
" } }, "RoomData": { "base": "The data of a room.
", "refs": { "RoomDataList$member": null } }, "RoomDataList": { "base": null, "refs": { "SearchRoomsResponse$Rooms": "The rooms that meet the specified set of filter criteria, in sort order.
" } }, "RoomDescription": { "base": null, "refs": { "CreateRoomRequest$Description": "The description for the room.
", "Room$Description": "The description of a room.
", "RoomData$Description": "The description of a room.
", "UpdateRoomRequest$Description": "The updated description for the room.
" } }, "RoomName": { "base": null, "refs": { "CreateRoomRequest$RoomName": "The name for the room.
", "DeviceData$RoomName": "The name of the room associated with a device.
", "ResolveRoomResponse$RoomName": "The name of the room from which the skill request was invoked.
", "Room$RoomName": "The name of a room.
", "RoomData$RoomName": "The name of a room.
", "UpdateRoomRequest$RoomName": "The updated name for the room.
" } }, "RoomSkillParameter": { "base": "A skill parameter associated with a room.
", "refs": { "GetRoomSkillParameterResponse$RoomSkillParameter": "The details of the room skill parameter requested. Required.
", "PutRoomSkillParameterRequest$RoomSkillParameter": "The updated room skill parameter. Required.
", "RoomSkillParameters$member": null } }, "RoomSkillParameterKey": { "base": null, "refs": { "DeleteRoomSkillParameterRequest$ParameterKey": "The room skill parameter key for which to remove details.
", "GetRoomSkillParameterRequest$ParameterKey": "The room skill parameter key for which to get details. Required.
", "RoomSkillParameter$ParameterKey": "The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
" } }, "RoomSkillParameterValue": { "base": null, "refs": { "RoomSkillParameter$ParameterValue": "The parameter value of a room skill parameter.
" } }, "RoomSkillParameters": { "base": null, "refs": { "ResolveRoomResponse$RoomSkillParameters": "Response to get the room profile request. Required.
" } }, "SearchAddressBooksRequest": { "base": null, "refs": { } }, "SearchAddressBooksResponse": { "base": null, "refs": { } }, "SearchContactsRequest": { "base": null, "refs": { } }, "SearchContactsResponse": { "base": null, "refs": { } }, "SearchDevicesRequest": { "base": null, "refs": { } }, "SearchDevicesResponse": { "base": null, "refs": { } }, "SearchProfilesRequest": { "base": null, "refs": { } }, "SearchProfilesResponse": { "base": null, "refs": { } }, "SearchRoomsRequest": { "base": null, "refs": { } }, "SearchRoomsResponse": { "base": null, "refs": { } }, "SearchSkillGroupsRequest": { "base": null, "refs": { } }, "SearchSkillGroupsResponse": { "base": null, "refs": { } }, "SearchUsersRequest": { "base": null, "refs": { } }, "SearchUsersResponse": { "base": null, "refs": { } }, "SendInvitationRequest": { "base": null, "refs": { } }, "SendInvitationResponse": { "base": null, "refs": { } }, "SkillGroup": { "base": "A skill group with attributes.
", "refs": { "GetSkillGroupResponse$SkillGroup": "The details of the skill group requested. Required.
" } }, "SkillGroupData": { "base": "The attributes of a skill group.
", "refs": { "SkillGroupDataList$member": null } }, "SkillGroupDataList": { "base": null, "refs": { "SearchSkillGroupsResponse$SkillGroups": "The skill groups that meet the filter criteria, in sort order.
" } }, "SkillGroupDescription": { "base": null, "refs": { "CreateSkillGroupRequest$Description": "The description for the skill group.
", "SkillGroup$Description": "The description of a skill group.
", "SkillGroupData$Description": "The description of a skill group.
", "UpdateSkillGroupRequest$Description": "The updated description for the skill group.
" } }, "SkillGroupName": { "base": null, "refs": { "CreateSkillGroupRequest$SkillGroupName": "The name for the skill group.
", "SkillGroup$SkillGroupName": "The name of a skill group.
", "SkillGroupData$SkillGroupName": "The skill group name of a skill group.
", "UpdateSkillGroupRequest$SkillGroupName": "The updated name for the skill group.
" } }, "SkillId": { "base": null, "refs": { "DeleteRoomSkillParameterRequest$SkillId": "The ID of the skill from which to remove the room skill parameter details.
", "GetRoomSkillParameterRequest$SkillId": "The ARN of the skill from which to get the room skill parameter details. Required.
", "PutRoomSkillParameterRequest$SkillId": "The ARN of the skill associated with the room skill parameter. Required.
", "ResolveRoomRequest$SkillId": "The ARN of the skill that was requested. Required.
", "SkillSummary$SkillId": "The ARN of the skill summary.
" } }, "SkillListMaxResults": { "base": null, "refs": { "ListSkillsRequest$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.
The name of the skill.
" } }, "SkillSummary": { "base": "The summary of skills.
", "refs": { "SkillSummaryList$member": null } }, "SkillSummaryList": { "base": null, "refs": { "ListSkillsResponse$SkillSummaries": "The list of enabled skills requested. Required.
" } }, "SoftwareVersion": { "base": null, "refs": { "Device$SoftwareVersion": "The software version of a device.
", "DeviceData$SoftwareVersion": "The software version of a device.
" } }, "Sort": { "base": "An object representing a sort criteria.
", "refs": { "SortList$member": null } }, "SortKey": { "base": null, "refs": { "Sort$Key": "The sort key of a sort object.
" } }, "SortList": { "base": null, "refs": { "SearchAddressBooksRequest$SortCriteria": "The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
", "SearchContactsRequest$SortCriteria": "The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
", "SearchDevicesRequest$SortCriteria": "The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.
", "SearchProfilesRequest$SortCriteria": "The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
", "SearchRoomsRequest$SortCriteria": "The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
", "SearchSkillGroupsRequest$SortCriteria": "The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
", "SearchUsersRequest$SortCriteria": "The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
" } }, "SortValue": { "base": null, "refs": { "Sort$Value": "The sort value of a sort object.
" } }, "StartDeviceSyncRequest": { "base": null, "refs": { } }, "StartDeviceSyncResponse": { "base": null, "refs": { } }, "Tag": { "base": "A key-value pair that can be associated with a resource.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The key of a tag. Tag keys are case-sensitive.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "The tags to be removed from the specified resource. Do not provide system tags. Required.
" } }, "TagList": { "base": null, "refs": { "CreateRoomRequest$Tags": "The tags for the room.
", "CreateUserRequest$Tags": "The tags for the user.
", "ListTagsResponse$Tags": "The tags requested for the specified resource.
", "TagResourceRequest$Tags": "The tags to be added to the specified resource. Do not provide system tags. Required.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$Value": "The value of a tag. Tag values are case-sensitive and can be null.
" } }, "TemperatureUnit": { "base": null, "refs": { "CreateProfileRequest$TemperatureUnit": "The temperature unit to be used by devices in the profile.
", "Profile$TemperatureUnit": "The temperature unit of a room profile.
", "ProfileData$TemperatureUnit": "The temperature unit of a room profile.
", "UpdateProfileRequest$TemperatureUnit": "The updated temperature unit for the room profile.
" } }, "Timestamp": { "base": null, "refs": { "DeviceEvent$Timestamp": "The time (in epoch) when the event occurred.
" } }, "Timezone": { "base": null, "refs": { "CreateProfileRequest$Timezone": "The time zone used by a room profile.
", "Profile$Timezone": "The time zone of a room profile.
", "ProfileData$Timezone": "The timezone of a room profile.
", "UpdateProfileRequest$Timezone": "The updated timezone for the room profile.
" } }, "TotalCount": { "base": null, "refs": { "SearchAddressBooksResponse$TotalCount": "The total number of address books returned.
", "SearchContactsResponse$TotalCount": "The total number of contacts returned.
", "SearchDevicesResponse$TotalCount": "The total number of devices returned.
", "SearchProfilesResponse$TotalCount": "The total number of room profiles returned.
", "SearchRoomsResponse$TotalCount": "The total number of rooms returned.
", "SearchSkillGroupsResponse$TotalCount": "The total number of skill groups returned.
", "SearchUsersResponse$TotalCount": "The total number of users returned.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateAddressBookRequest": { "base": null, "refs": { } }, "UpdateAddressBookResponse": { "base": null, "refs": { } }, "UpdateContactRequest": { "base": null, "refs": { } }, "UpdateContactResponse": { "base": null, "refs": { } }, "UpdateDeviceRequest": { "base": null, "refs": { } }, "UpdateDeviceResponse": { "base": null, "refs": { } }, "UpdateProfileRequest": { "base": null, "refs": { } }, "UpdateProfileResponse": { "base": null, "refs": { } }, "UpdateRoomRequest": { "base": null, "refs": { } }, "UpdateRoomResponse": { "base": null, "refs": { } }, "UpdateSkillGroupRequest": { "base": null, "refs": { } }, "UpdateSkillGroupResponse": { "base": null, "refs": { } }, "UserData": { "base": "Information related to a user.
", "refs": { "UserDataList$member": null } }, "UserDataList": { "base": null, "refs": { "SearchUsersResponse$Users": "The users that meet the specified set of filter criteria, in sort order.
" } }, "UserId": { "base": null, "refs": { "ResolveRoomRequest$UserId": "The ARN of the user. Required.
" } }, "WakeWord": { "base": null, "refs": { "CreateProfileRequest$WakeWord": "A wake word for Alexa, Echo, Amazon, or a computer.
", "Profile$WakeWord": "The wake word of a room profile.
", "ProfileData$WakeWord": "The wake word of a room profile.
", "UpdateProfileRequest$WakeWord": "The updated wake word for the room profile.
" } }, "boolean": { "base": null, "refs": { "SkillSummary$SupportsLinking": "Linking support for a skill.
" } }, "user_FirstName": { "base": null, "refs": { "CreateUserRequest$FirstName": "The first name for the user.
", "UserData$FirstName": "The first name of a user.
" } }, "user_LastName": { "base": null, "refs": { "CreateUserRequest$LastName": "The last name for the user.
", "UserData$LastName": "The last name of a user.
" } }, "user_UserId": { "base": null, "refs": { "CreateUserRequest$UserId": "The ARN for the user.
" } } } }