"documentation":"<p>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. </p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Lists the Device Event history for up to 30 days. If EventType isn't specified in the request, 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. </p>"
"documentation":"<p>Searches devices and lists the ones that meet a set of filter criteria.</p>"
},
"SearchProfiles":{
"name":"SearchProfiles",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SearchProfilesRequest"},
"output":{"shape":"SearchProfilesResponse"},
"documentation":"<p>Searches room profiles and lists the ones that meet a set of filter criteria.</p>"
},
"SearchRooms":{
"name":"SearchRooms",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SearchRoomsRequest"},
"output":{"shape":"SearchRoomsResponse"},
"documentation":"<p>Searches rooms and lists the ones that meet a set of filter and sort criteria.</p>"
},
"SearchSkillGroups":{
"name":"SearchSkillGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SearchSkillGroupsRequest"},
"output":{"shape":"SearchSkillGroupsResponse"},
"documentation":"<p>Searches skill groups and lists the ones that meet a set of filter and sort criteria.</p>"
},
"SearchUsers":{
"name":"SearchUsers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SearchUsersRequest"},
"output":{"shape":"SearchUsersResponse"},
"documentation":"<p>Searches users and lists the ones that meet a set of filter and sort criteria.</p>"
},
"SendInvitation":{
"name":"SendInvitation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SendInvitationRequest"},
"output":{"shape":"SendInvitationResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"InvalidUserStatusException"}
],
"documentation":"<p>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. </p>"
"documentation":"<p>Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The event type to filter device events.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>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. </p>"
"documentation":"<p>The ARN of the skill group for which to list enabled skills. Required.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>MaxResults</code>. Required.</p>"
},
"MaxResults":{
"shape":"SkillListMaxResults",
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved. Required.</p>"
}
}
},
"ListSkillsResponse":{
"type":"structure",
"members":{
"SkillSummaries":{
"shape":"SkillSummaryList",
"documentation":"<p>The list of enabled skills requested. Required.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
}
}
},
"ListTagsRequest":{
"type":"structure",
"required":["Arn"],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the specific resource for which to list tags. Required.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>MaxResults</code>. </p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
}
}
},
"ListTagsResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>The list of tags requested for the specific resource.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
}
}
},
"MacAddress":{"type":"string"},
"MaxResults":{
"type":"integer",
"max":50,
"min":1
},
"MaxVolumeLimit":{"type":"integer"},
"NameInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The name sent in the request is already in use. HTTP Status Code: 400</p>",
"exception":true
},
"NextToken":{
"type":"string",
"max":1000,
"min":1
},
"NotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The resource is not found. HTTP Status Code: 400</p>",
"exception":true
},
"Profile":{
"type":"structure",
"members":{
"ProfileArn":{
"shape":"Arn",
"documentation":"<p>The ARN of a room profile.</p>"
},
"ProfileName":{
"shape":"ProfileName",
"documentation":"<p>The name of a room profile.</p>"
},
"Address":{
"shape":"Address",
"documentation":"<p>The address of a room profile.</p>"
},
"Timezone":{
"shape":"Timezone",
"documentation":"<p>The time zone of a room profile.</p>"
},
"DistanceUnit":{
"shape":"DistanceUnit",
"documentation":"<p>The distance unit of a room profile.</p>"
},
"TemperatureUnit":{
"shape":"TemperatureUnit",
"documentation":"<p>The temperature unit of a room profile.</p>"
},
"WakeWord":{
"shape":"WakeWord",
"documentation":"<p>The wake word of a room profile.</p>"
},
"SetupModeDisabled":{
"shape":"Boolean",
"documentation":"<p>The setup mode of a room profile.</p>"
},
"MaxVolumeLimit":{
"shape":"MaxVolumeLimit",
"documentation":"<p>The max volume limit of a room profile.</p>"
},
"PSTNEnabled":{
"shape":"Boolean",
"documentation":"<p>The PSTN setting of a room profile.</p>"
}
},
"documentation":"<p>A room profile with attributes.</p>"
},
"ProfileData":{
"type":"structure",
"members":{
"ProfileArn":{
"shape":"Arn",
"documentation":"<p>The ARN of a room profile.</p>"
},
"ProfileName":{
"shape":"ProfileName",
"documentation":"<p>The name of a room profile.</p>"
},
"Address":{
"shape":"Address",
"documentation":"<p>The address of a room profile.</p>"
},
"Timezone":{
"shape":"Timezone",
"documentation":"<p>The timezone of a room profile.</p>"
},
"DistanceUnit":{
"shape":"DistanceUnit",
"documentation":"<p>The distance unit of a room profile.</p>"
},
"TemperatureUnit":{
"shape":"TemperatureUnit",
"documentation":"<p>The temperature unit of a room profile.</p>"
},
"WakeWord":{
"shape":"WakeWord",
"documentation":"<p>The wake word of a room profile.</p>"
}
},
"documentation":"<p>The data of a room profile.</p>"
"documentation":"<p>The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.</p>"
},
"ParameterValue":{
"shape":"RoomSkillParameterValue",
"documentation":"<p>The parameter value of a room skill parameter.</p>"
}
},
"documentation":"<p>A skill parameter associated with a room.</p>"
"documentation":"<p>The filters to use to list a specified set of address books. The supported filter key is AddressBookName.</p>"
},
"SortCriteria":{
"shape":"SortList",
"documentation":"<p>The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>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.</p>"
}
}
},
"SearchAddressBooksResponse":{
"type":"structure",
"members":{
"AddressBooks":{
"shape":"AddressBookDataList",
"documentation":"<p>The address books that meet the specified set of filter criteria, in sort order.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
},
"TotalCount":{
"shape":"TotalCount",
"documentation":"<p>The total number of address books returned.</p>"
}
}
},
"SearchContactsRequest":{
"type":"structure",
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"<p>The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.</p>"
},
"SortCriteria":{
"shape":"SortList",
"documentation":"<p>The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>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.</p>"
}
}
},
"SearchContactsResponse":{
"type":"structure",
"members":{
"Contacts":{
"shape":"ContactDataList",
"documentation":"<p>The contacts that meet the specified set of filter criteria, in sort order.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
},
"TotalCount":{
"shape":"TotalCount",
"documentation":"<p>The total number of contacts returned.</p>"
"documentation":"<p>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 <code>MaxResults</code>.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
"documentation":"<p>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).</p>"
"documentation":"<p>The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.</p>"
"documentation":"<p>The devices that meet the specified set of filter criteria, in sort order.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
},
"TotalCount":{
"shape":"TotalCount",
"documentation":"<p>The total number of devices returned.</p>"
}
}
},
"SearchProfilesRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>MaxResults</code>.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required. </p>"
},
"SortCriteria":{
"shape":"SortList",
"documentation":"<p>The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.</p>"
}
}
},
"SearchProfilesResponse":{
"type":"structure",
"members":{
"Profiles":{
"shape":"ProfileDataList",
"documentation":"<p>The profiles that meet the specified set of filter criteria, in sort order.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
},
"TotalCount":{
"shape":"TotalCount",
"documentation":"<p>The total number of room profiles returned.</p>"
}
}
},
"SearchRoomsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>MaxResults</code>.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved. </p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.</p>"
},
"SortCriteria":{
"shape":"SortList",
"documentation":"<p>The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.</p>"
}
}
},
"SearchRoomsResponse":{
"type":"structure",
"members":{
"Rooms":{
"shape":"RoomDataList",
"documentation":"<p>The rooms that meet the specified set of filter criteria, in sort order.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
},
"TotalCount":{
"shape":"TotalCount",
"documentation":"<p>The total number of rooms returned.</p>"
}
}
},
"SearchSkillGroupsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>MaxResults</code>. Required.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved. </p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName. </p>"
},
"SortCriteria":{
"shape":"SortList",
"documentation":"<p>The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName. </p>"
}
}
},
"SearchSkillGroupsResponse":{
"type":"structure",
"members":{
"SkillGroups":{
"shape":"SkillGroupDataList",
"documentation":"<p>The skill groups that meet the filter criteria, in sort order.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
},
"TotalCount":{
"shape":"TotalCount",
"documentation":"<p>The total number of skill groups returned.</p>"
}
}
},
"SearchUsersRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>MaxResults</code>. Required.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved. Required.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.</p>"
},
"SortCriteria":{
"shape":"SortList",
"documentation":"<p>The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.</p>"
}
}
},
"SearchUsersResponse":{
"type":"structure",
"members":{
"Users":{
"shape":"UserDataList",
"documentation":"<p>The users that meet the specified set of filter criteria, in sort order.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
},
"TotalCount":{
"shape":"TotalCount",
"documentation":"<p>The total number of users returned.</p>"
}
}
},
"SendInvitationRequest":{
"type":"structure",
"members":{
"UserArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the user to whom to send an invitation. Required.</p>"
}
}
},
"SendInvitationResponse":{
"type":"structure",
"members":{
}
},
"SkillGroup":{
"type":"structure",
"members":{
"SkillGroupArn":{
"shape":"Arn",
"documentation":"<p>The ARN of a skill group.</p>"
},
"SkillGroupName":{
"shape":"SkillGroupName",
"documentation":"<p>The name of a skill group.</p>"
},
"Description":{
"shape":"SkillGroupDescription",
"documentation":"<p>The description of a skill group.</p>"
}
},
"documentation":"<p>A skill group with attributes.</p>"
},
"SkillGroupData":{
"type":"structure",
"members":{
"SkillGroupArn":{
"shape":"Arn",
"documentation":"<p>The skill group ARN of a skill group.</p>"
},
"SkillGroupName":{
"shape":"SkillGroupName",
"documentation":"<p>The skill group name of a skill group.</p>"
},
"Description":{
"shape":"SkillGroupDescription",
"documentation":"<p>The description of a skill group.</p>"
}
},
"documentation":"<p>The attributes of a skill group.</p>"
"documentation":"<p>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.</p>"