UNPKG

113 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class AlexaForBusiness extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: AlexaForBusiness.Types.ClientConfiguration)
13 config: Config & AlexaForBusiness.Types.ClientConfiguration;
14 /**
15 * 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.
16 */
17 approveSkill(params: AlexaForBusiness.Types.ApproveSkillRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ApproveSkillResponse) => void): Request<AlexaForBusiness.Types.ApproveSkillResponse, AWSError>;
18 /**
19 * 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.
20 */
21 approveSkill(callback?: (err: AWSError, data: AlexaForBusiness.Types.ApproveSkillResponse) => void): Request<AlexaForBusiness.Types.ApproveSkillResponse, AWSError>;
22 /**
23 * Associates a contact with a given address book.
24 */
25 associateContactWithAddressBook(params: AlexaForBusiness.Types.AssociateContactWithAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateContactWithAddressBookResponse) => void): Request<AlexaForBusiness.Types.AssociateContactWithAddressBookResponse, AWSError>;
26 /**
27 * Associates a contact with a given address book.
28 */
29 associateContactWithAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateContactWithAddressBookResponse) => void): Request<AlexaForBusiness.Types.AssociateContactWithAddressBookResponse, AWSError>;
30 /**
31 * 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.
32 */
33 associateDeviceWithRoom(params: AlexaForBusiness.Types.AssociateDeviceWithRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithRoomResponse, AWSError>;
34 /**
35 * 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.
36 */
37 associateDeviceWithRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithRoomResponse, AWSError>;
38 /**
39 * Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
40 */
41 associateSkillGroupWithRoom(params: AlexaForBusiness.Types.AssociateSkillGroupWithRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse, AWSError>;
42 /**
43 * Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
44 */
45 associateSkillGroupWithRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse, AWSError>;
46 /**
47 * Associates a skill with a skill group.
48 */
49 associateSkillWithSkillGroup(params: AlexaForBusiness.Types.AssociateSkillWithSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse, AWSError>;
50 /**
51 * Associates a skill with a skill group.
52 */
53 associateSkillWithSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse, AWSError>;
54 /**
55 * Makes a private skill available for enrolled users to enable on their devices.
56 */
57 associateSkillWithUsers(params: AlexaForBusiness.Types.AssociateSkillWithUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithUsersResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithUsersResponse, AWSError>;
58 /**
59 * Makes a private skill available for enrolled users to enable on their devices.
60 */
61 associateSkillWithUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithUsersResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithUsersResponse, AWSError>;
62 /**
63 * Creates an address book with the specified details.
64 */
65 createAddressBook(params: AlexaForBusiness.Types.CreateAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateAddressBookResponse) => void): Request<AlexaForBusiness.Types.CreateAddressBookResponse, AWSError>;
66 /**
67 * Creates an address book with the specified details.
68 */
69 createAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateAddressBookResponse) => void): Request<AlexaForBusiness.Types.CreateAddressBookResponse, AWSError>;
70 /**
71 * Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
72 */
73 createBusinessReportSchedule(params: AlexaForBusiness.Types.CreateBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.CreateBusinessReportScheduleResponse, AWSError>;
74 /**
75 * Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
76 */
77 createBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.CreateBusinessReportScheduleResponse, AWSError>;
78 /**
79 * Adds a new conference provider under the user's AWS account.
80 */
81 createConferenceProvider(params: AlexaForBusiness.Types.CreateConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.CreateConferenceProviderResponse, AWSError>;
82 /**
83 * Adds a new conference provider under the user's AWS account.
84 */
85 createConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.CreateConferenceProviderResponse, AWSError>;
86 /**
87 * Creates a contact with the specified details.
88 */
89 createContact(params: AlexaForBusiness.Types.CreateContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateContactResponse) => void): Request<AlexaForBusiness.Types.CreateContactResponse, AWSError>;
90 /**
91 * Creates a contact with the specified details.
92 */
93 createContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateContactResponse) => void): Request<AlexaForBusiness.Types.CreateContactResponse, AWSError>;
94 /**
95 * Creates a new room profile with the specified details.
96 */
97 createProfile(params: AlexaForBusiness.Types.CreateProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateProfileResponse) => void): Request<AlexaForBusiness.Types.CreateProfileResponse, AWSError>;
98 /**
99 * Creates a new room profile with the specified details.
100 */
101 createProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateProfileResponse) => void): Request<AlexaForBusiness.Types.CreateProfileResponse, AWSError>;
102 /**
103 * Creates a room with the specified details.
104 */
105 createRoom(params: AlexaForBusiness.Types.CreateRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateRoomResponse) => void): Request<AlexaForBusiness.Types.CreateRoomResponse, AWSError>;
106 /**
107 * Creates a room with the specified details.
108 */
109 createRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateRoomResponse) => void): Request<AlexaForBusiness.Types.CreateRoomResponse, AWSError>;
110 /**
111 * Creates a skill group with a specified name and description.
112 */
113 createSkillGroup(params: AlexaForBusiness.Types.CreateSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.CreateSkillGroupResponse, AWSError>;
114 /**
115 * Creates a skill group with a specified name and description.
116 */
117 createSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.CreateSkillGroupResponse, AWSError>;
118 /**
119 * Creates a user.
120 */
121 createUser(params: AlexaForBusiness.Types.CreateUserRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateUserResponse) => void): Request<AlexaForBusiness.Types.CreateUserResponse, AWSError>;
122 /**
123 * Creates a user.
124 */
125 createUser(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateUserResponse) => void): Request<AlexaForBusiness.Types.CreateUserResponse, AWSError>;
126 /**
127 * Deletes an address book by the address book ARN.
128 */
129 deleteAddressBook(params: AlexaForBusiness.Types.DeleteAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteAddressBookResponse) => void): Request<AlexaForBusiness.Types.DeleteAddressBookResponse, AWSError>;
130 /**
131 * Deletes an address book by the address book ARN.
132 */
133 deleteAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteAddressBookResponse) => void): Request<AlexaForBusiness.Types.DeleteAddressBookResponse, AWSError>;
134 /**
135 * Deletes the recurring report delivery schedule with the specified schedule ARN.
136 */
137 deleteBusinessReportSchedule(params: AlexaForBusiness.Types.DeleteBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse, AWSError>;
138 /**
139 * Deletes the recurring report delivery schedule with the specified schedule ARN.
140 */
141 deleteBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse, AWSError>;
142 /**
143 * Deletes a conference provider.
144 */
145 deleteConferenceProvider(params: AlexaForBusiness.Types.DeleteConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.DeleteConferenceProviderResponse, AWSError>;
146 /**
147 * Deletes a conference provider.
148 */
149 deleteConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.DeleteConferenceProviderResponse, AWSError>;
150 /**
151 * Deletes a contact by the contact ARN.
152 */
153 deleteContact(params: AlexaForBusiness.Types.DeleteContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteContactResponse) => void): Request<AlexaForBusiness.Types.DeleteContactResponse, AWSError>;
154 /**
155 * Deletes a contact by the contact ARN.
156 */
157 deleteContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteContactResponse) => void): Request<AlexaForBusiness.Types.DeleteContactResponse, AWSError>;
158 /**
159 * Removes a device from Alexa For Business.
160 */
161 deleteDevice(params: AlexaForBusiness.Types.DeleteDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceResponse, AWSError>;
162 /**
163 * Removes a device from Alexa For Business.
164 */
165 deleteDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceResponse, AWSError>;
166 /**
167 * Deletes a room profile by the profile ARN.
168 */
169 deleteProfile(params: AlexaForBusiness.Types.DeleteProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteProfileResponse, AWSError>;
170 /**
171 * Deletes a room profile by the profile ARN.
172 */
173 deleteProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteProfileResponse, AWSError>;
174 /**
175 * Deletes a room by the room ARN.
176 */
177 deleteRoom(params: AlexaForBusiness.Types.DeleteRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomResponse, AWSError>;
178 /**
179 * Deletes a room by the room ARN.
180 */
181 deleteRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomResponse, AWSError>;
182 /**
183 * Deletes room skill parameter details by room, skill, and parameter key ID.
184 */
185 deleteRoomSkillParameter(params: AlexaForBusiness.Types.DeleteRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomSkillParameterResponse, AWSError>;
186 /**
187 * Deletes room skill parameter details by room, skill, and parameter key ID.
188 */
189 deleteRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomSkillParameterResponse, AWSError>;
190 /**
191 * Unlinks a third-party account from a skill.
192 */
193 deleteSkillAuthorization(params: AlexaForBusiness.Types.DeleteSkillAuthorizationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillAuthorizationResponse, AWSError>;
194 /**
195 * Unlinks a third-party account from a skill.
196 */
197 deleteSkillAuthorization(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillAuthorizationResponse, AWSError>;
198 /**
199 * Deletes a skill group by skill group ARN.
200 */
201 deleteSkillGroup(params: AlexaForBusiness.Types.DeleteSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillGroupResponse, AWSError>;
202 /**
203 * Deletes a skill group by skill group ARN.
204 */
205 deleteSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillGroupResponse, AWSError>;
206 /**
207 * Deletes a specified user by user ARN and enrollment ARN.
208 */
209 deleteUser(params: AlexaForBusiness.Types.DeleteUserRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteUserResponse) => void): Request<AlexaForBusiness.Types.DeleteUserResponse, AWSError>;
210 /**
211 * Deletes a specified user by user ARN and enrollment ARN.
212 */
213 deleteUser(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteUserResponse) => void): Request<AlexaForBusiness.Types.DeleteUserResponse, AWSError>;
214 /**
215 * Disassociates a contact from a given address book.
216 */
217 disassociateContactFromAddressBook(params: AlexaForBusiness.Types.DisassociateContactFromAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse) => void): Request<AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse, AWSError>;
218 /**
219 * Disassociates a contact from a given address book.
220 */
221 disassociateContactFromAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse) => void): Request<AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse, AWSError>;
222 /**
223 * 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.
224 */
225 disassociateDeviceFromRoom(params: AlexaForBusiness.Types.DisassociateDeviceFromRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse, AWSError>;
226 /**
227 * 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.
228 */
229 disassociateDeviceFromRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse, AWSError>;
230 /**
231 * Disassociates a skill from a skill group.
232 */
233 disassociateSkillFromSkillGroup(params: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse, AWSError>;
234 /**
235 * Disassociates a skill from a skill group.
236 */
237 disassociateSkillFromSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse, AWSError>;
238 /**
239 * Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
240 */
241 disassociateSkillFromUsers(params: AlexaForBusiness.Types.DisassociateSkillFromUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromUsersResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromUsersResponse, AWSError>;
242 /**
243 * Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
244 */
245 disassociateSkillFromUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromUsersResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromUsersResponse, AWSError>;
246 /**
247 * Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
248 */
249 disassociateSkillGroupFromRoom(params: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse, AWSError>;
250 /**
251 * Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
252 */
253 disassociateSkillGroupFromRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse, AWSError>;
254 /**
255 * Forgets smart home appliances associated to a room.
256 */
257 forgetSmartHomeAppliances(params: AlexaForBusiness.Types.ForgetSmartHomeAppliancesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse, AWSError>;
258 /**
259 * Forgets smart home appliances associated to a room.
260 */
261 forgetSmartHomeAppliances(callback?: (err: AWSError, data: AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse, AWSError>;
262 /**
263 * Gets address the book details by the address book ARN.
264 */
265 getAddressBook(params: AlexaForBusiness.Types.GetAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetAddressBookResponse) => void): Request<AlexaForBusiness.Types.GetAddressBookResponse, AWSError>;
266 /**
267 * Gets address the book details by the address book ARN.
268 */
269 getAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetAddressBookResponse) => void): Request<AlexaForBusiness.Types.GetAddressBookResponse, AWSError>;
270 /**
271 * Retrieves the existing conference preferences.
272 */
273 getConferencePreference(params: AlexaForBusiness.Types.GetConferencePreferenceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.GetConferencePreferenceResponse, AWSError>;
274 /**
275 * Retrieves the existing conference preferences.
276 */
277 getConferencePreference(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.GetConferencePreferenceResponse, AWSError>;
278 /**
279 * Gets details about a specific conference provider.
280 */
281 getConferenceProvider(params: AlexaForBusiness.Types.GetConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.GetConferenceProviderResponse, AWSError>;
282 /**
283 * Gets details about a specific conference provider.
284 */
285 getConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.GetConferenceProviderResponse, AWSError>;
286 /**
287 * Gets the contact details by the contact ARN.
288 */
289 getContact(params: AlexaForBusiness.Types.GetContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetContactResponse) => void): Request<AlexaForBusiness.Types.GetContactResponse, AWSError>;
290 /**
291 * Gets the contact details by the contact ARN.
292 */
293 getContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetContactResponse) => void): Request<AlexaForBusiness.Types.GetContactResponse, AWSError>;
294 /**
295 * Gets the details of a device by device ARN.
296 */
297 getDevice(params: AlexaForBusiness.Types.GetDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetDeviceResponse) => void): Request<AlexaForBusiness.Types.GetDeviceResponse, AWSError>;
298 /**
299 * Gets the details of a device by device ARN.
300 */
301 getDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetDeviceResponse) => void): Request<AlexaForBusiness.Types.GetDeviceResponse, AWSError>;
302 /**
303 * Retrieves the configured values for the user enrollment invitation email template.
304 */
305 getInvitationConfiguration(params: AlexaForBusiness.Types.GetInvitationConfigurationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.GetInvitationConfigurationResponse, AWSError>;
306 /**
307 * Retrieves the configured values for the user enrollment invitation email template.
308 */
309 getInvitationConfiguration(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.GetInvitationConfigurationResponse, AWSError>;
310 /**
311 * Gets the details of a room profile by profile ARN.
312 */
313 getProfile(params: AlexaForBusiness.Types.GetProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetProfileResponse) => void): Request<AlexaForBusiness.Types.GetProfileResponse, AWSError>;
314 /**
315 * Gets the details of a room profile by profile ARN.
316 */
317 getProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetProfileResponse) => void): Request<AlexaForBusiness.Types.GetProfileResponse, AWSError>;
318 /**
319 * Gets room details by room ARN.
320 */
321 getRoom(params: AlexaForBusiness.Types.GetRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomResponse) => void): Request<AlexaForBusiness.Types.GetRoomResponse, AWSError>;
322 /**
323 * Gets room details by room ARN.
324 */
325 getRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomResponse) => void): Request<AlexaForBusiness.Types.GetRoomResponse, AWSError>;
326 /**
327 * Gets room skill parameter details by room, skill, and parameter key ARN.
328 */
329 getRoomSkillParameter(params: AlexaForBusiness.Types.GetRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.GetRoomSkillParameterResponse, AWSError>;
330 /**
331 * Gets room skill parameter details by room, skill, and parameter key ARN.
332 */
333 getRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.GetRoomSkillParameterResponse, AWSError>;
334 /**
335 * Gets skill group details by skill group ARN.
336 */
337 getSkillGroup(params: AlexaForBusiness.Types.GetSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetSkillGroupResponse) => void): Request<AlexaForBusiness.Types.GetSkillGroupResponse, AWSError>;
338 /**
339 * Gets skill group details by skill group ARN.
340 */
341 getSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetSkillGroupResponse) => void): Request<AlexaForBusiness.Types.GetSkillGroupResponse, AWSError>;
342 /**
343 * Lists the details of the schedules that a user configured.
344 */
345 listBusinessReportSchedules(params: AlexaForBusiness.Types.ListBusinessReportSchedulesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListBusinessReportSchedulesResponse) => void): Request<AlexaForBusiness.Types.ListBusinessReportSchedulesResponse, AWSError>;
346 /**
347 * Lists the details of the schedules that a user configured.
348 */
349 listBusinessReportSchedules(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListBusinessReportSchedulesResponse) => void): Request<AlexaForBusiness.Types.ListBusinessReportSchedulesResponse, AWSError>;
350 /**
351 * Lists conference providers under a specific AWS account.
352 */
353 listConferenceProviders(params: AlexaForBusiness.Types.ListConferenceProvidersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListConferenceProvidersResponse) => void): Request<AlexaForBusiness.Types.ListConferenceProvidersResponse, AWSError>;
354 /**
355 * Lists conference providers under a specific AWS account.
356 */
357 listConferenceProviders(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListConferenceProvidersResponse) => void): Request<AlexaForBusiness.Types.ListConferenceProvidersResponse, AWSError>;
358 /**
359 * Lists the device event history, including device connection status, for up to 30 days.
360 */
361 listDeviceEvents(params: AlexaForBusiness.Types.ListDeviceEventsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListDeviceEventsResponse) => void): Request<AlexaForBusiness.Types.ListDeviceEventsResponse, AWSError>;
362 /**
363 * Lists the device event history, including device connection status, for up to 30 days.
364 */
365 listDeviceEvents(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListDeviceEventsResponse) => void): Request<AlexaForBusiness.Types.ListDeviceEventsResponse, AWSError>;
366 /**
367 * Lists all enabled skills in a specific skill group.
368 */
369 listSkills(params: AlexaForBusiness.Types.ListSkillsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsResponse) => void): Request<AlexaForBusiness.Types.ListSkillsResponse, AWSError>;
370 /**
371 * Lists all enabled skills in a specific skill group.
372 */
373 listSkills(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsResponse) => void): Request<AlexaForBusiness.Types.ListSkillsResponse, AWSError>;
374 /**
375 * Lists all categories in the Alexa skill store.
376 */
377 listSkillsStoreCategories(params: AlexaForBusiness.Types.ListSkillsStoreCategoriesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse, AWSError>;
378 /**
379 * Lists all categories in the Alexa skill store.
380 */
381 listSkillsStoreCategories(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse, AWSError>;
382 /**
383 * Lists all skills in the Alexa skill store by category.
384 */
385 listSkillsStoreSkillsByCategory(params: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse, AWSError>;
386 /**
387 * Lists all skills in the Alexa skill store by category.
388 */
389 listSkillsStoreSkillsByCategory(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse, AWSError>;
390 /**
391 * Lists all of the smart home appliances associated with a room.
392 */
393 listSmartHomeAppliances(params: AlexaForBusiness.Types.ListSmartHomeAppliancesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ListSmartHomeAppliancesResponse, AWSError>;
394 /**
395 * Lists all of the smart home appliances associated with a room.
396 */
397 listSmartHomeAppliances(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ListSmartHomeAppliancesResponse, AWSError>;
398 /**
399 * Lists all tags for the specified resource.
400 */
401 listTags(params: AlexaForBusiness.Types.ListTagsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListTagsResponse) => void): Request<AlexaForBusiness.Types.ListTagsResponse, AWSError>;
402 /**
403 * Lists all tags for the specified resource.
404 */
405 listTags(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListTagsResponse) => void): Request<AlexaForBusiness.Types.ListTagsResponse, AWSError>;
406 /**
407 * Sets the conference preferences on a specific conference provider at the account level.
408 */
409 putConferencePreference(params: AlexaForBusiness.Types.PutConferencePreferenceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.PutConferencePreferenceResponse, AWSError>;
410 /**
411 * Sets the conference preferences on a specific conference provider at the account level.
412 */
413 putConferencePreference(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.PutConferencePreferenceResponse, AWSError>;
414 /**
415 * Configures the email template for the user enrollment invitation with the specified attributes.
416 */
417 putInvitationConfiguration(params: AlexaForBusiness.Types.PutInvitationConfigurationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.PutInvitationConfigurationResponse, AWSError>;
418 /**
419 * Configures the email template for the user enrollment invitation with the specified attributes.
420 */
421 putInvitationConfiguration(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.PutInvitationConfigurationResponse, AWSError>;
422 /**
423 * Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
424 */
425 putRoomSkillParameter(params: AlexaForBusiness.Types.PutRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.PutRoomSkillParameterResponse, AWSError>;
426 /**
427 * Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
428 */
429 putRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.PutRoomSkillParameterResponse, AWSError>;
430 /**
431 * 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.
432 */
433 putSkillAuthorization(params: AlexaForBusiness.Types.PutSkillAuthorizationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.PutSkillAuthorizationResponse, AWSError>;
434 /**
435 * 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.
436 */
437 putSkillAuthorization(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.PutSkillAuthorizationResponse, AWSError>;
438 /**
439 * Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
440 */
441 registerAVSDevice(params: AlexaForBusiness.Types.RegisterAVSDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RegisterAVSDeviceResponse) => void): Request<AlexaForBusiness.Types.RegisterAVSDeviceResponse, AWSError>;
442 /**
443 * Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
444 */
445 registerAVSDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.RegisterAVSDeviceResponse) => void): Request<AlexaForBusiness.Types.RegisterAVSDeviceResponse, AWSError>;
446 /**
447 * 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.
448 */
449 rejectSkill(params: AlexaForBusiness.Types.RejectSkillRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RejectSkillResponse) => void): Request<AlexaForBusiness.Types.RejectSkillResponse, AWSError>;
450 /**
451 * 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.
452 */
453 rejectSkill(callback?: (err: AWSError, data: AlexaForBusiness.Types.RejectSkillResponse) => void): Request<AlexaForBusiness.Types.RejectSkillResponse, AWSError>;
454 /**
455 * Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
456 */
457 resolveRoom(params: AlexaForBusiness.Types.ResolveRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ResolveRoomResponse) => void): Request<AlexaForBusiness.Types.ResolveRoomResponse, AWSError>;
458 /**
459 * Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
460 */
461 resolveRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.ResolveRoomResponse) => void): Request<AlexaForBusiness.Types.ResolveRoomResponse, AWSError>;
462 /**
463 * Revokes an invitation and invalidates the enrollment URL.
464 */
465 revokeInvitation(params: AlexaForBusiness.Types.RevokeInvitationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RevokeInvitationResponse) => void): Request<AlexaForBusiness.Types.RevokeInvitationResponse, AWSError>;
466 /**
467 * Revokes an invitation and invalidates the enrollment URL.
468 */
469 revokeInvitation(callback?: (err: AWSError, data: AlexaForBusiness.Types.RevokeInvitationResponse) => void): Request<AlexaForBusiness.Types.RevokeInvitationResponse, AWSError>;
470 /**
471 * Searches address books and lists the ones that meet a set of filter and sort criteria.
472 */
473 searchAddressBooks(params: AlexaForBusiness.Types.SearchAddressBooksRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchAddressBooksResponse) => void): Request<AlexaForBusiness.Types.SearchAddressBooksResponse, AWSError>;
474 /**
475 * Searches address books and lists the ones that meet a set of filter and sort criteria.
476 */
477 searchAddressBooks(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchAddressBooksResponse) => void): Request<AlexaForBusiness.Types.SearchAddressBooksResponse, AWSError>;
478 /**
479 * Searches contacts and lists the ones that meet a set of filter and sort criteria.
480 */
481 searchContacts(params: AlexaForBusiness.Types.SearchContactsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchContactsResponse) => void): Request<AlexaForBusiness.Types.SearchContactsResponse, AWSError>;
482 /**
483 * Searches contacts and lists the ones that meet a set of filter and sort criteria.
484 */
485 searchContacts(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchContactsResponse) => void): Request<AlexaForBusiness.Types.SearchContactsResponse, AWSError>;
486 /**
487 * Searches devices and lists the ones that meet a set of filter criteria.
488 */
489 searchDevices(params: AlexaForBusiness.Types.SearchDevicesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchDevicesResponse) => void): Request<AlexaForBusiness.Types.SearchDevicesResponse, AWSError>;
490 /**
491 * Searches devices and lists the ones that meet a set of filter criteria.
492 */
493 searchDevices(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchDevicesResponse) => void): Request<AlexaForBusiness.Types.SearchDevicesResponse, AWSError>;
494 /**
495 * Searches room profiles and lists the ones that meet a set of filter criteria.
496 */
497 searchProfiles(params: AlexaForBusiness.Types.SearchProfilesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchProfilesResponse, AWSError>;
498 /**
499 * Searches room profiles and lists the ones that meet a set of filter criteria.
500 */
501 searchProfiles(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchProfilesResponse, AWSError>;
502 /**
503 * Searches rooms and lists the ones that meet a set of filter and sort criteria.
504 */
505 searchRooms(params: AlexaForBusiness.Types.SearchRoomsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchRoomsResponse) => void): Request<AlexaForBusiness.Types.SearchRoomsResponse, AWSError>;
506 /**
507 * Searches rooms and lists the ones that meet a set of filter and sort criteria.
508 */
509 searchRooms(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchRoomsResponse) => void): Request<AlexaForBusiness.Types.SearchRoomsResponse, AWSError>;
510 /**
511 * Searches skill groups and lists the ones that meet a set of filter and sort criteria.
512 */
513 searchSkillGroups(params: AlexaForBusiness.Types.SearchSkillGroupsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchSkillGroupsResponse) => void): Request<AlexaForBusiness.Types.SearchSkillGroupsResponse, AWSError>;
514 /**
515 * Searches skill groups and lists the ones that meet a set of filter and sort criteria.
516 */
517 searchSkillGroups(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchSkillGroupsResponse) => void): Request<AlexaForBusiness.Types.SearchSkillGroupsResponse, AWSError>;
518 /**
519 * Searches users and lists the ones that meet a set of filter and sort criteria.
520 */
521 searchUsers(params: AlexaForBusiness.Types.SearchUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchUsersResponse) => void): Request<AlexaForBusiness.Types.SearchUsersResponse, AWSError>;
522 /**
523 * Searches users and lists the ones that meet a set of filter and sort criteria.
524 */
525 searchUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchUsersResponse) => void): Request<AlexaForBusiness.Types.SearchUsersResponse, AWSError>;
526 /**
527 * 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.
528 */
529 sendInvitation(params: AlexaForBusiness.Types.SendInvitationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SendInvitationResponse) => void): Request<AlexaForBusiness.Types.SendInvitationResponse, AWSError>;
530 /**
531 * 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.
532 */
533 sendInvitation(callback?: (err: AWSError, data: AlexaForBusiness.Types.SendInvitationResponse) => void): Request<AlexaForBusiness.Types.SendInvitationResponse, AWSError>;
534 /**
535 * Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.
536 */
537 startDeviceSync(params: AlexaForBusiness.Types.StartDeviceSyncRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.StartDeviceSyncResponse) => void): Request<AlexaForBusiness.Types.StartDeviceSyncResponse, AWSError>;
538 /**
539 * Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.
540 */
541 startDeviceSync(callback?: (err: AWSError, data: AlexaForBusiness.Types.StartDeviceSyncResponse) => void): Request<AlexaForBusiness.Types.StartDeviceSyncResponse, AWSError>;
542 /**
543 * Initiates the discovery of any smart home appliances associated with the room.
544 */
545 startSmartHomeApplianceDiscovery(params: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse) => void): Request<AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse, AWSError>;
546 /**
547 * Initiates the discovery of any smart home appliances associated with the room.
548 */
549 startSmartHomeApplianceDiscovery(callback?: (err: AWSError, data: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse) => void): Request<AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse, AWSError>;
550 /**
551 * Adds metadata tags to a specified resource.
552 */
553 tagResource(params: AlexaForBusiness.Types.TagResourceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.TagResourceResponse) => void): Request<AlexaForBusiness.Types.TagResourceResponse, AWSError>;
554 /**
555 * Adds metadata tags to a specified resource.
556 */
557 tagResource(callback?: (err: AWSError, data: AlexaForBusiness.Types.TagResourceResponse) => void): Request<AlexaForBusiness.Types.TagResourceResponse, AWSError>;
558 /**
559 * Removes metadata tags from a specified resource.
560 */
561 untagResource(params: AlexaForBusiness.Types.UntagResourceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UntagResourceResponse) => void): Request<AlexaForBusiness.Types.UntagResourceResponse, AWSError>;
562 /**
563 * Removes metadata tags from a specified resource.
564 */
565 untagResource(callback?: (err: AWSError, data: AlexaForBusiness.Types.UntagResourceResponse) => void): Request<AlexaForBusiness.Types.UntagResourceResponse, AWSError>;
566 /**
567 * Updates address book details by the address book ARN.
568 */
569 updateAddressBook(params: AlexaForBusiness.Types.UpdateAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateAddressBookResponse) => void): Request<AlexaForBusiness.Types.UpdateAddressBookResponse, AWSError>;
570 /**
571 * Updates address book details by the address book ARN.
572 */
573 updateAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateAddressBookResponse) => void): Request<AlexaForBusiness.Types.UpdateAddressBookResponse, AWSError>;
574 /**
575 * Updates the configuration of the report delivery schedule with the specified schedule ARN.
576 */
577 updateBusinessReportSchedule(params: AlexaForBusiness.Types.UpdateBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse, AWSError>;
578 /**
579 * Updates the configuration of the report delivery schedule with the specified schedule ARN.
580 */
581 updateBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse, AWSError>;
582 /**
583 * Updates an existing conference provider's settings.
584 */
585 updateConferenceProvider(params: AlexaForBusiness.Types.UpdateConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.UpdateConferenceProviderResponse, AWSError>;
586 /**
587 * Updates an existing conference provider's settings.
588 */
589 updateConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.UpdateConferenceProviderResponse, AWSError>;
590 /**
591 * Updates the contact details by the contact ARN.
592 */
593 updateContact(params: AlexaForBusiness.Types.UpdateContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateContactResponse) => void): Request<AlexaForBusiness.Types.UpdateContactResponse, AWSError>;
594 /**
595 * Updates the contact details by the contact ARN.
596 */
597 updateContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateContactResponse) => void): Request<AlexaForBusiness.Types.UpdateContactResponse, AWSError>;
598 /**
599 * Updates the device name by device ARN.
600 */
601 updateDevice(params: AlexaForBusiness.Types.UpdateDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateDeviceResponse) => void): Request<AlexaForBusiness.Types.UpdateDeviceResponse, AWSError>;
602 /**
603 * Updates the device name by device ARN.
604 */
605 updateDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateDeviceResponse) => void): Request<AlexaForBusiness.Types.UpdateDeviceResponse, AWSError>;
606 /**
607 * Updates an existing room profile by room profile ARN.
608 */
609 updateProfile(params: AlexaForBusiness.Types.UpdateProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateProfileResponse, AWSError>;
610 /**
611 * Updates an existing room profile by room profile ARN.
612 */
613 updateProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateProfileResponse, AWSError>;
614 /**
615 * Updates room details by room ARN.
616 */
617 updateRoom(params: AlexaForBusiness.Types.UpdateRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateRoomResponse) => void): Request<AlexaForBusiness.Types.UpdateRoomResponse, AWSError>;
618 /**
619 * Updates room details by room ARN.
620 */
621 updateRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateRoomResponse) => void): Request<AlexaForBusiness.Types.UpdateRoomResponse, AWSError>;
622 /**
623 * Updates skill group details by skill group ARN.
624 */
625 updateSkillGroup(params: AlexaForBusiness.Types.UpdateSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateSkillGroupResponse, AWSError>;
626 /**
627 * Updates skill group details by skill group ARN.
628 */
629 updateSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateSkillGroupResponse, AWSError>;
630}
631declare namespace AlexaForBusiness {
632 export type Address = string;
633 export interface AddressBook {
634 /**
635 * The ARN of the address book.
636 */
637 AddressBookArn?: Arn;
638 /**
639 * The name of the address book.
640 */
641 Name?: AddressBookName;
642 /**
643 * The description of the address book.
644 */
645 Description?: AddressBookDescription;
646 }
647 export interface AddressBookData {
648 /**
649 * The ARN of the address book.
650 */
651 AddressBookArn?: Arn;
652 /**
653 * The name of the address book.
654 */
655 Name?: AddressBookName;
656 /**
657 * The description of the address book.
658 */
659 Description?: AddressBookDescription;
660 }
661 export type AddressBookDataList = AddressBookData[];
662 export type AddressBookDescription = string;
663 export type AddressBookName = string;
664 export type AmazonId = string;
665 export type ApplianceDescription = string;
666 export type ApplianceFriendlyName = string;
667 export type ApplianceManufacturerName = string;
668 export interface ApproveSkillRequest {
669 /**
670 * The unique identifier of the skill.
671 */
672 SkillId: SkillId;
673 }
674 export interface ApproveSkillResponse {
675 }
676 export type Arn = string;
677 export interface AssociateContactWithAddressBookRequest {
678 /**
679 * The ARN of the contact to associate with an address book.
680 */
681 ContactArn: Arn;
682 /**
683 * The ARN of the address book with which to associate the contact.
684 */
685 AddressBookArn: Arn;
686 }
687 export interface AssociateContactWithAddressBookResponse {
688 }
689 export interface AssociateDeviceWithRoomRequest {
690 /**
691 * The ARN of the device to associate to a room. Required.
692 */
693 DeviceArn?: Arn;
694 /**
695 * The ARN of the room with which to associate the device. Required.
696 */
697 RoomArn?: Arn;
698 }
699 export interface AssociateDeviceWithRoomResponse {
700 }
701 export interface AssociateSkillGroupWithRoomRequest {
702 /**
703 * The ARN of the skill group to associate with a room. Required.
704 */
705 SkillGroupArn?: Arn;
706 /**
707 * The ARN of the room with which to associate the skill group. Required.
708 */
709 RoomArn?: Arn;
710 }
711 export interface AssociateSkillGroupWithRoomResponse {
712 }
713 export interface AssociateSkillWithSkillGroupRequest {
714 /**
715 * The ARN of the skill group to associate the skill to. Required.
716 */
717 SkillGroupArn?: Arn;
718 /**
719 * The unique identifier of the skill.
720 */
721 SkillId: SkillId;
722 }
723 export interface AssociateSkillWithSkillGroupResponse {
724 }
725 export interface AssociateSkillWithUsersRequest {
726 /**
727 * The private skill ID you want to make available to enrolled users.
728 */
729 SkillId: SkillId;
730 }
731 export interface AssociateSkillWithUsersResponse {
732 }
733 export type AuthorizationResult = {[key: string]: Value};
734 export type Boolean = boolean;
735 export type BulletPoint = string;
736 export type BulletPoints = BulletPoint[];
737 export interface BusinessReport {
738 /**
739 * The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
740 */
741 Status?: BusinessReportStatus;
742 /**
743 * The failure code.
744 */
745 FailureCode?: BusinessReportFailureCode;
746 /**
747 * The S3 location of the output reports.
748 */
749 S3Location?: BusinessReportS3Location;
750 /**
751 * The time of report delivery.
752 */
753 DeliveryTime?: Timestamp;
754 /**
755 * The download link where a user can download the report.
756 */
757 DownloadUrl?: BusinessReportDownloadUrl;
758 }
759 export interface BusinessReportContentRange {
760 /**
761 * The interval of the content range.
762 */
763 Interval?: BusinessReportInterval;
764 }
765 export type BusinessReportDownloadUrl = string;
766 export type BusinessReportFailureCode = "ACCESS_DENIED"|"NO_SUCH_BUCKET"|"INTERNAL_FAILURE"|string;
767 export type BusinessReportFormat = "CSV"|"CSV_ZIP"|string;
768 export type BusinessReportInterval = "ONE_DAY"|"ONE_WEEK"|string;
769 export interface BusinessReportRecurrence {
770 /**
771 * The start date.
772 */
773 StartDate?: _Date;
774 }
775 export interface BusinessReportS3Location {
776 /**
777 * The path of the business report.
778 */
779 Path?: BusinessReportS3Path;
780 /**
781 * The S3 bucket name of the output reports.
782 */
783 BucketName?: CustomerS3BucketName;
784 }
785 export type BusinessReportS3Path = string;
786 export interface BusinessReportSchedule {
787 /**
788 * The ARN of the business report schedule.
789 */
790 ScheduleArn?: Arn;
791 /**
792 * The name identifier of the schedule.
793 */
794 ScheduleName?: BusinessReportScheduleName;
795 /**
796 * The S3 bucket name of the output reports.
797 */
798 S3BucketName?: CustomerS3BucketName;
799 /**
800 * The S3 key where the report is delivered.
801 */
802 S3KeyPrefix?: S3KeyPrefix;
803 /**
804 * The format of the generated report (individual CSV files or zipped files of individual files).
805 */
806 Format?: BusinessReportFormat;
807 /**
808 * The content range of the reports.
809 */
810 ContentRange?: BusinessReportContentRange;
811 /**
812 * The recurrence of the reports.
813 */
814 Recurrence?: BusinessReportRecurrence;
815 /**
816 * The details of the last business report delivery for a specified time interval.
817 */
818 LastBusinessReport?: BusinessReport;
819 }
820 export type BusinessReportScheduleList = BusinessReportSchedule[];
821 export type BusinessReportScheduleName = string;
822 export type BusinessReportStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|string;
823 export interface Category {
824 /**
825 * The ID of the skill store category.
826 */
827 CategoryId?: CategoryId;
828 /**
829 * The name of the skill store category.
830 */
831 CategoryName?: CategoryName;
832 }
833 export type CategoryId = number;
834 export type CategoryList = Category[];
835 export type CategoryName = string;
836 export type ClientId = string;
837 export type ClientRequestToken = string;
838 export type CommsProtocol = "SIP"|"SIPS"|"H323"|string;
839 export interface ConferencePreference {
840 /**
841 * The ARN of the default conference provider.
842 */
843 DefaultConferenceProviderArn?: Arn;
844 }
845 export interface ConferenceProvider {
846 /**
847 * The ARN of the newly created conference provider.
848 */
849 Arn?: Arn;
850 /**
851 * The name of the conference provider.
852 */
853 Name?: ConferenceProviderName;
854 /**
855 * The type of conference providers.
856 */
857 Type?: ConferenceProviderType;
858 /**
859 * The IP endpoint and protocol for calling.
860 */
861 IPDialIn?: IPDialIn;
862 /**
863 * The information for PSTN conferencing.
864 */
865 PSTNDialIn?: PSTNDialIn;
866 /**
867 * The meeting settings for the conference provider.
868 */
869 MeetingSetting?: MeetingSetting;
870 }
871 export type ConferenceProviderName = string;
872 export type ConferenceProviderType = "CHIME"|"BLUEJEANS"|"FUZE"|"GOOGLE_HANGOUTS"|"POLYCOM"|"RINGCENTRAL"|"SKYPE_FOR_BUSINESS"|"WEBEX"|"ZOOM"|"CUSTOM"|string;
873 export type ConferenceProvidersList = ConferenceProvider[];
874 export type ConnectionStatus = "ONLINE"|"OFFLINE"|string;
875 export interface Contact {
876 /**
877 * The ARN of the contact.
878 */
879 ContactArn?: Arn;
880 /**
881 * The name of the contact to display on the console.
882 */
883 DisplayName?: ContactName;
884 /**
885 * The first name of the contact, used to call the contact on the device.
886 */
887 FirstName?: ContactName;
888 /**
889 * The last name of the contact, used to call the contact on the device.
890 */
891 LastName?: ContactName;
892 /**
893 * The phone number of the contact.
894 */
895 PhoneNumber?: E164PhoneNumber;
896 }
897 export interface ContactData {
898 /**
899 * The ARN of the contact.
900 */
901 ContactArn?: Arn;
902 /**
903 * The name of the contact to display on the console.
904 */
905 DisplayName?: ContactName;
906 /**
907 * The first name of the contact, used to call the contact on the device.
908 */
909 FirstName?: ContactName;
910 /**
911 * The last name of the contact, used to call the contact on the device.
912 */
913 LastName?: ContactName;
914 /**
915 * The phone number of the contact.
916 */
917 PhoneNumber?: E164PhoneNumber;
918 }
919 export type ContactDataList = ContactData[];
920 export type ContactName = string;
921 export type CountryCode = string;
922 export interface CreateAddressBookRequest {
923 /**
924 * The name of the address book.
925 */
926 Name: AddressBookName;
927 /**
928 * The description of the address book.
929 */
930 Description?: AddressBookDescription;
931 /**
932 * A unique, user-specified identifier for the request that ensures idempotency.
933 */
934 ClientRequestToken?: ClientRequestToken;
935 }
936 export interface CreateAddressBookResponse {
937 /**
938 * The ARN of the newly created address book.
939 */
940 AddressBookArn?: Arn;
941 }
942 export interface CreateBusinessReportScheduleRequest {
943 /**
944 * The name identifier of the schedule.
945 */
946 ScheduleName?: BusinessReportScheduleName;
947 /**
948 * 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.
949 */
950 S3BucketName?: CustomerS3BucketName;
951 /**
952 * The S3 key where the report is delivered.
953 */
954 S3KeyPrefix?: S3KeyPrefix;
955 /**
956 * The format of the generated report (individual CSV files or zipped files of individual files).
957 */
958 Format: BusinessReportFormat;
959 /**
960 * The content range of the reports.
961 */
962 ContentRange: BusinessReportContentRange;
963 /**
964 * The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
965 */
966 Recurrence?: BusinessReportRecurrence;
967 /**
968 * The client request token.
969 */
970 ClientRequestToken?: ClientRequestToken;
971 }
972 export interface CreateBusinessReportScheduleResponse {
973 /**
974 * The ARN of the business report schedule.
975 */
976 ScheduleArn?: Arn;
977 }
978 export interface CreateConferenceProviderRequest {
979 /**
980 * The name of the conference provider.
981 */
982 ConferenceProviderName: ConferenceProviderName;
983 /**
984 * Represents a type within a list of predefined types.
985 */
986 ConferenceProviderType: ConferenceProviderType;
987 /**
988 * The IP endpoint and protocol for calling.
989 */
990 IPDialIn?: IPDialIn;
991 /**
992 * The information for PSTN conferencing.
993 */
994 PSTNDialIn?: PSTNDialIn;
995 /**
996 * The meeting settings for the conference provider.
997 */
998 MeetingSetting: MeetingSetting;
999 /**
1000 * The request token of the client.
1001 */
1002 ClientRequestToken?: ClientRequestToken;
1003 }
1004 export interface CreateConferenceProviderResponse {
1005 /**
1006 * The ARN of the newly-created conference provider.
1007 */
1008 ConferenceProviderArn?: Arn;
1009 }
1010 export interface CreateContactRequest {
1011 /**
1012 * The name of the contact to display on the console.
1013 */
1014 DisplayName?: ContactName;
1015 /**
1016 * The first name of the contact that is used to call the contact on the device.
1017 */
1018 FirstName: ContactName;
1019 /**
1020 * The last name of the contact that is used to call the contact on the device.
1021 */
1022 LastName?: ContactName;
1023 /**
1024 * The phone number of the contact in E.164 format.
1025 */
1026 PhoneNumber?: E164PhoneNumber;
1027 /**
1028 * A unique, user-specified identifier for this request that ensures idempotency.
1029 */
1030 ClientRequestToken?: ClientRequestToken;
1031 }
1032 export interface CreateContactResponse {
1033 /**
1034 * The ARN of the newly created address book.
1035 */
1036 ContactArn?: Arn;
1037 }
1038 export interface CreateProfileRequest {
1039 /**
1040 * The name of a room profile.
1041 */
1042 ProfileName: ProfileName;
1043 /**
1044 * The time zone used by a room profile.
1045 */
1046 Timezone: Timezone;
1047 /**
1048 * The valid address for the room.
1049 */
1050 Address: Address;
1051 /**
1052 * The distance unit to be used by devices in the profile.
1053 */
1054 DistanceUnit: DistanceUnit;
1055 /**
1056 * The temperature unit to be used by devices in the profile.
1057 */
1058 TemperatureUnit: TemperatureUnit;
1059 /**
1060 * A wake word for Alexa, Echo, Amazon, or a computer.
1061 */
1062 WakeWord: WakeWord;
1063 /**
1064 * The user-specified token that is used during the creation of a profile.
1065 */
1066 ClientRequestToken?: ClientRequestToken;
1067 /**
1068 * Whether room profile setup is enabled.
1069 */
1070 SetupModeDisabled?: Boolean;
1071 /**
1072 * The maximum volume limit for a room profile.
1073 */
1074 MaxVolumeLimit?: MaxVolumeLimit;
1075 /**
1076 * Whether PSTN calling is enabled.
1077 */
1078 PSTNEnabled?: Boolean;
1079 }
1080 export interface CreateProfileResponse {
1081 /**
1082 * The ARN of the newly created room profile in the response.
1083 */
1084 ProfileArn?: Arn;
1085 }
1086 export interface CreateRoomRequest {
1087 /**
1088 * The name for the room.
1089 */
1090 RoomName: RoomName;
1091 /**
1092 * The description for the room.
1093 */
1094 Description?: RoomDescription;
1095 /**
1096 * The profile ARN for the room.
1097 */
1098 ProfileArn?: Arn;
1099 /**
1100 * The calendar ARN for the room.
1101 */
1102 ProviderCalendarId?: ProviderCalendarId;
1103 /**
1104 * A unique, user-specified identifier for this request that ensures idempotency.
1105 */
1106 ClientRequestToken?: ClientRequestToken;
1107 /**
1108 * The tags for the room.
1109 */
1110 Tags?: TagList;
1111 }
1112 export interface CreateRoomResponse {
1113 /**
1114 * The ARN of the newly created room in the response.
1115 */
1116 RoomArn?: Arn;
1117 }
1118 export interface CreateSkillGroupRequest {
1119 /**
1120 * The name for the skill group.
1121 */
1122 SkillGroupName: SkillGroupName;
1123 /**
1124 * The description for the skill group.
1125 */
1126 Description?: SkillGroupDescription;
1127 /**
1128 * A unique, user-specified identifier for this request that ensures idempotency.
1129 */
1130 ClientRequestToken?: ClientRequestToken;
1131 }
1132 export interface CreateSkillGroupResponse {
1133 /**
1134 * The ARN of the newly created skill group in the response.
1135 */
1136 SkillGroupArn?: Arn;
1137 }
1138 export interface CreateUserRequest {
1139 /**
1140 * The ARN for the user.
1141 */
1142 UserId: user_UserId;
1143 /**
1144 * The first name for the user.
1145 */
1146 FirstName?: user_FirstName;
1147 /**
1148 * The last name for the user.
1149 */
1150 LastName?: user_LastName;
1151 /**
1152 * The email address for the user.
1153 */
1154 Email?: Email;
1155 /**
1156 * A unique, user-specified identifier for this request that ensures idempotency.
1157 */
1158 ClientRequestToken?: ClientRequestToken;
1159 /**
1160 * The tags for the user.
1161 */
1162 Tags?: TagList;
1163 }
1164 export interface CreateUserResponse {
1165 /**
1166 * The ARN of the newly created user in the response.
1167 */
1168 UserArn?: Arn;
1169 }
1170 export type CustomerS3BucketName = string;
1171 export type _Date = string;
1172 export interface DeleteAddressBookRequest {
1173 /**
1174 * The ARN of the address book to delete.
1175 */
1176 AddressBookArn: Arn;
1177 }
1178 export interface DeleteAddressBookResponse {
1179 }
1180 export interface DeleteBusinessReportScheduleRequest {
1181 /**
1182 * The ARN of the business report schedule.
1183 */
1184 ScheduleArn: Arn;
1185 }
1186 export interface DeleteBusinessReportScheduleResponse {
1187 }
1188 export interface DeleteConferenceProviderRequest {
1189 /**
1190 * The ARN of the conference provider.
1191 */
1192 ConferenceProviderArn: Arn;
1193 }
1194 export interface DeleteConferenceProviderResponse {
1195 }
1196 export interface DeleteContactRequest {
1197 /**
1198 * The ARN of the contact to delete.
1199 */
1200 ContactArn: Arn;
1201 }
1202 export interface DeleteContactResponse {
1203 }
1204 export interface DeleteDeviceRequest {
1205 /**
1206 * The ARN of the device for which to request details.
1207 */
1208 DeviceArn: Arn;
1209 }
1210 export interface DeleteDeviceResponse {
1211 }
1212 export interface DeleteProfileRequest {
1213 /**
1214 * The ARN of the room profile to delete. Required.
1215 */
1216 ProfileArn?: Arn;
1217 }
1218 export interface DeleteProfileResponse {
1219 }
1220 export interface DeleteRoomRequest {
1221 /**
1222 * The ARN of the room to delete. Required.
1223 */
1224 RoomArn?: Arn;
1225 }
1226 export interface DeleteRoomResponse {
1227 }
1228 export interface DeleteRoomSkillParameterRequest {
1229 /**
1230 * The ARN of the room from which to remove the room skill parameter details.
1231 */
1232 RoomArn?: Arn;
1233 /**
1234 * The ID of the skill from which to remove the room skill parameter details.
1235 */
1236 SkillId: SkillId;
1237 /**
1238 * The room skill parameter key for which to remove details.
1239 */
1240 ParameterKey: RoomSkillParameterKey;
1241 }
1242 export interface DeleteRoomSkillParameterResponse {
1243 }
1244 export interface DeleteSkillAuthorizationRequest {
1245 /**
1246 * The unique identifier of a skill.
1247 */
1248 SkillId: SkillId;
1249 /**
1250 * The room that the skill is authorized for.
1251 */
1252 RoomArn?: Arn;
1253 }
1254 export interface DeleteSkillAuthorizationResponse {
1255 }
1256 export interface DeleteSkillGroupRequest {
1257 /**
1258 * The ARN of the skill group to delete. Required.
1259 */
1260 SkillGroupArn?: Arn;
1261 }
1262 export interface DeleteSkillGroupResponse {
1263 }
1264 export interface DeleteUserRequest {
1265 /**
1266 * The ARN of the user to delete in the organization. Required.
1267 */
1268 UserArn?: Arn;
1269 /**
1270 * The ARN of the user's enrollment in the organization. Required.
1271 */
1272 EnrollmentId: EnrollmentId;
1273 }
1274 export interface DeleteUserResponse {
1275 }
1276 export interface DeveloperInfo {
1277 /**
1278 * The name of the developer.
1279 */
1280 DeveloperName?: DeveloperName;
1281 /**
1282 * The URL of the privacy policy.
1283 */
1284 PrivacyPolicy?: PrivacyPolicy;
1285 /**
1286 * The email of the developer.
1287 */
1288 Email?: Email;
1289 /**
1290 * The website of the developer.
1291 */
1292 Url?: Url;
1293 }
1294 export type DeveloperName = string;
1295 export interface Device {
1296 /**
1297 * The ARN of a device.
1298 */
1299 DeviceArn?: Arn;
1300 /**
1301 * The serial number of a device.
1302 */
1303 DeviceSerialNumber?: DeviceSerialNumber;
1304 /**
1305 * The type of a device.
1306 */
1307 DeviceType?: DeviceType;
1308 /**
1309 * The name of a device.
1310 */
1311 DeviceName?: DeviceName;
1312 /**
1313 * The software version of a device.
1314 */
1315 SoftwareVersion?: SoftwareVersion;
1316 /**
1317 * The MAC address of a device.
1318 */
1319 MacAddress?: MacAddress;
1320 /**
1321 * The room ARN of a device.
1322 */
1323 RoomArn?: Arn;
1324 /**
1325 * The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
1326 */
1327 DeviceStatus?: DeviceStatus;
1328 /**
1329 * Detailed information about a device's status.
1330 */
1331 DeviceStatusInfo?: DeviceStatusInfo;
1332 }
1333 export interface DeviceData {
1334 /**
1335 * The ARN of a device.
1336 */
1337 DeviceArn?: Arn;
1338 /**
1339 * The serial number of a device.
1340 */
1341 DeviceSerialNumber?: DeviceSerialNumber;
1342 /**
1343 * The type of a device.
1344 */
1345 DeviceType?: DeviceType;
1346 /**
1347 * The name of a device.
1348 */
1349 DeviceName?: DeviceName;
1350 /**
1351 * The software version of a device.
1352 */
1353 SoftwareVersion?: SoftwareVersion;
1354 /**
1355 * The MAC address of a device.
1356 */
1357 MacAddress?: MacAddress;
1358 /**
1359 * The status of a device.
1360 */
1361 DeviceStatus?: DeviceStatus;
1362 /**
1363 * The room ARN associated with a device.
1364 */
1365 RoomArn?: Arn;
1366 /**
1367 * The name of the room associated with a device.
1368 */
1369 RoomName?: RoomName;
1370 /**
1371 * Detailed information about a device's status.
1372 */
1373 DeviceStatusInfo?: DeviceStatusInfo;
1374 }
1375 export type DeviceDataList = DeviceData[];
1376 export interface DeviceEvent {
1377 /**
1378 * The type of device event.
1379 */
1380 Type?: DeviceEventType;
1381 /**
1382 * The value of the event.
1383 */
1384 Value?: DeviceEventValue;
1385 /**
1386 * The time (in epoch) when the event occurred.
1387 */
1388 Timestamp?: Timestamp;
1389 }
1390 export type DeviceEventList = DeviceEvent[];
1391 export type DeviceEventType = "CONNECTION_STATUS"|"DEVICE_STATUS"|string;
1392 export type DeviceEventValue = string;
1393 export type DeviceName = string;
1394 export type DeviceSerialNumber = string;
1395 export type DeviceSerialNumberForAVS = string;
1396 export type DeviceStatus = "READY"|"PENDING"|"WAS_OFFLINE"|"DEREGISTERED"|string;
1397 export interface DeviceStatusDetail {
1398 /**
1399 * The device status detail code.
1400 */
1401 Code?: DeviceStatusDetailCode;
1402 }
1403 export type DeviceStatusDetailCode = "DEVICE_SOFTWARE_UPDATE_NEEDED"|"DEVICE_WAS_OFFLINE"|string;
1404 export type DeviceStatusDetails = DeviceStatusDetail[];
1405 export interface DeviceStatusInfo {
1406 /**
1407 * One or more device status detail descriptions.
1408 */
1409 DeviceStatusDetails?: DeviceStatusDetails;
1410 /**
1411 * The latest available information about the connection status of a device.
1412 */
1413 ConnectionStatus?: ConnectionStatus;
1414 }
1415 export type DeviceType = string;
1416 export interface DisassociateContactFromAddressBookRequest {
1417 /**
1418 * The ARN of the contact to disassociate from an address book.
1419 */
1420 ContactArn: Arn;
1421 /**
1422 * The ARN of the address from which to disassociate the contact.
1423 */
1424 AddressBookArn: Arn;
1425 }
1426 export interface DisassociateContactFromAddressBookResponse {
1427 }
1428 export interface DisassociateDeviceFromRoomRequest {
1429 /**
1430 * The ARN of the device to disassociate from a room. Required.
1431 */
1432 DeviceArn?: Arn;
1433 }
1434 export interface DisassociateDeviceFromRoomResponse {
1435 }
1436 export interface DisassociateSkillFromSkillGroupRequest {
1437 /**
1438 * The unique identifier of a skill. Required.
1439 */
1440 SkillGroupArn?: Arn;
1441 /**
1442 * The ARN of a skill group to associate to a skill.
1443 */
1444 SkillId: SkillId;
1445 }
1446 export interface DisassociateSkillFromSkillGroupResponse {
1447 }
1448 export interface DisassociateSkillFromUsersRequest {
1449 /**
1450 * The private skill ID you want to make unavailable for enrolled users.
1451 */
1452 SkillId: SkillId;
1453 }
1454 export interface DisassociateSkillFromUsersResponse {
1455 }
1456 export interface DisassociateSkillGroupFromRoomRequest {
1457 /**
1458 * The ARN of the skill group to disassociate from a room. Required.
1459 */
1460 SkillGroupArn?: Arn;
1461 /**
1462 * The ARN of the room from which the skill group is to be disassociated. Required.
1463 */
1464 RoomArn?: Arn;
1465 }
1466 export interface DisassociateSkillGroupFromRoomResponse {
1467 }
1468 export type DistanceUnit = "METRIC"|"IMPERIAL"|string;
1469 export type E164PhoneNumber = string;
1470 export type Email = string;
1471 export type EnablementType = "ENABLED"|"PENDING"|string;
1472 export type EnablementTypeFilter = "ENABLED"|"PENDING"|string;
1473 export type EndUserLicenseAgreement = string;
1474 export type Endpoint = string;
1475 export type EnrollmentId = string;
1476 export type EnrollmentStatus = "INITIALIZED"|"PENDING"|"REGISTERED"|"DISASSOCIATING"|"DEREGISTERING"|string;
1477 export type Feature = "BLUETOOTH"|"VOLUME"|"NOTIFICATIONS"|"LISTS"|"SKILLS"|"ALL"|string;
1478 export type Features = Feature[];
1479 export interface Filter {
1480 /**
1481 * The key of a filter.
1482 */
1483 Key: FilterKey;
1484 /**
1485 * The values of a filter.
1486 */
1487 Values: FilterValueList;
1488 }
1489 export type FilterKey = string;
1490 export type FilterList = Filter[];
1491 export type FilterValue = string;
1492 export type FilterValueList = FilterValue[];
1493 export interface ForgetSmartHomeAppliancesRequest {
1494 /**
1495 * The room that the appliances are associated with.
1496 */
1497 RoomArn: Arn;
1498 }
1499 export interface ForgetSmartHomeAppliancesResponse {
1500 }
1501 export type GenericKeyword = string;
1502 export type GenericKeywords = GenericKeyword[];
1503 export interface GetAddressBookRequest {
1504 /**
1505 * The ARN of the address book for which to request details.
1506 */
1507 AddressBookArn: Arn;
1508 }
1509 export interface GetAddressBookResponse {
1510 /**
1511 * The details of the requested address book.
1512 */
1513 AddressBook?: AddressBook;
1514 }
1515 export interface GetConferencePreferenceRequest {
1516 }
1517 export interface GetConferencePreferenceResponse {
1518 /**
1519 * The conference preference.
1520 */
1521 Preference?: ConferencePreference;
1522 }
1523 export interface GetConferenceProviderRequest {
1524 /**
1525 * The ARN of the newly created conference provider.
1526 */
1527 ConferenceProviderArn: Arn;
1528 }
1529 export interface GetConferenceProviderResponse {
1530 /**
1531 * The conference provider.
1532 */
1533 ConferenceProvider?: ConferenceProvider;
1534 }
1535 export interface GetContactRequest {
1536 /**
1537 * The ARN of the contact for which to request details.
1538 */
1539 ContactArn: Arn;
1540 }
1541 export interface GetContactResponse {
1542 /**
1543 * The details of the requested contact.
1544 */
1545 Contact?: Contact;
1546 }
1547 export interface GetDeviceRequest {
1548 /**
1549 * The ARN of the device for which to request details. Required.
1550 */
1551 DeviceArn?: Arn;
1552 }
1553 export interface GetDeviceResponse {
1554 /**
1555 * The details of the device requested. Required.
1556 */
1557 Device?: Device;
1558 }
1559 export interface GetInvitationConfigurationRequest {
1560 }
1561 export interface GetInvitationConfigurationResponse {
1562 /**
1563 * The name of the organization sending the enrollment invite to a user.
1564 */
1565 OrganizationName?: OrganizationName;
1566 /**
1567 * The email ID of the organization or individual contact that the enrolled user can use.
1568 */
1569 ContactEmail?: Email;
1570 /**
1571 * The list of private skill IDs that you want to recommend to the user to enable in the invitation.
1572 */
1573 PrivateSkillIds?: ShortSkillIdList;
1574 }
1575 export interface GetProfileRequest {
1576 /**
1577 * The ARN of the room profile for which to request details. Required.
1578 */
1579 ProfileArn?: Arn;
1580 }
1581 export interface GetProfileResponse {
1582 /**
1583 * The details of the room profile requested. Required.
1584 */
1585 Profile?: Profile;
1586 }
1587 export interface GetRoomRequest {
1588 /**
1589 * The ARN of the room for which to request details. Required.
1590 */
1591 RoomArn?: Arn;
1592 }
1593 export interface GetRoomResponse {
1594 /**
1595 * The details of the room requested.
1596 */
1597 Room?: Room;
1598 }
1599 export interface GetRoomSkillParameterRequest {
1600 /**
1601 * The ARN of the room from which to get the room skill parameter details.
1602 */
1603 RoomArn?: Arn;
1604 /**
1605 * The ARN of the skill from which to get the room skill parameter details. Required.
1606 */
1607 SkillId: SkillId;
1608 /**
1609 * The room skill parameter key for which to get details. Required.
1610 */
1611 ParameterKey: RoomSkillParameterKey;
1612 }
1613 export interface GetRoomSkillParameterResponse {
1614 /**
1615 * The details of the room skill parameter requested. Required.
1616 */
1617 RoomSkillParameter?: RoomSkillParameter;
1618 }
1619 export interface GetSkillGroupRequest {
1620 /**
1621 * The ARN of the skill group for which to get details. Required.
1622 */
1623 SkillGroupArn?: Arn;
1624 }
1625 export interface GetSkillGroupResponse {
1626 /**
1627 * The details of the skill group requested. Required.
1628 */
1629 SkillGroup?: SkillGroup;
1630 }
1631 export interface IPDialIn {
1632 /**
1633 * The IP address.
1634 */
1635 Endpoint: Endpoint;
1636 /**
1637 * The protocol, including SIP, SIPS, and H323.
1638 */
1639 CommsProtocol: CommsProtocol;
1640 }
1641 export type IconUrl = string;
1642 export type InvocationPhrase = string;
1643 export type Key = string;
1644 export interface ListBusinessReportSchedulesRequest {
1645 /**
1646 * The token used to list the remaining schedules from the previous API call.
1647 */
1648 NextToken?: NextToken;
1649 /**
1650 * The maximum number of schedules listed in the call.
1651 */
1652 MaxResults?: MaxResults;
1653 }
1654 export interface ListBusinessReportSchedulesResponse {
1655 /**
1656 * The schedule of the reports.
1657 */
1658 BusinessReportSchedules?: BusinessReportScheduleList;
1659 /**
1660 * The token used to list the remaining schedules from the previous API call.
1661 */
1662 NextToken?: NextToken;
1663 }
1664 export interface ListConferenceProvidersRequest {
1665 /**
1666 * The tokens used for pagination.
1667 */
1668 NextToken?: NextToken;
1669 /**
1670 * The maximum number of conference providers to be returned, per paginated calls.
1671 */
1672 MaxResults?: MaxResults;
1673 }
1674 export interface ListConferenceProvidersResponse {
1675 /**
1676 * The conference providers.
1677 */
1678 ConferenceProviders?: ConferenceProvidersList;
1679 /**
1680 * The tokens used for pagination.
1681 */
1682 NextToken?: NextToken;
1683 }
1684 export interface ListDeviceEventsRequest {
1685 /**
1686 * The ARN of a device.
1687 */
1688 DeviceArn: Arn;
1689 /**
1690 * 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.
1691 */
1692 EventType?: DeviceEventType;
1693 /**
1694 * 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.
1695 */
1696 NextToken?: NextToken;
1697 /**
1698 * 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.
1699 */
1700 MaxResults?: MaxResults;
1701 }
1702 export interface ListDeviceEventsResponse {
1703 /**
1704 * The device events requested for the device ARN.
1705 */
1706 DeviceEvents?: DeviceEventList;
1707 /**
1708 * The token returned to indicate that there is more data available.
1709 */
1710 NextToken?: NextToken;
1711 }
1712 export interface ListSkillsRequest {
1713 /**
1714 * The ARN of the skill group for which to list enabled skills. Required.
1715 */
1716 SkillGroupArn?: Arn;
1717 /**
1718 * Whether the skill is enabled under the user's account, or if it requires linking to be used.
1719 */
1720 EnablementType?: EnablementTypeFilter;
1721 /**
1722 * Whether the skill is publicly available or is a private skill.
1723 */
1724 SkillType?: SkillTypeFilter;
1725 /**
1726 * 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.
1727 */
1728 NextToken?: NextToken;
1729 /**
1730 * 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.
1731 */
1732 MaxResults?: SkillListMaxResults;
1733 }
1734 export interface ListSkillsResponse {
1735 /**
1736 * The list of enabled skills requested. Required.
1737 */
1738 SkillSummaries?: SkillSummaryList;
1739 /**
1740 * The token returned to indicate that there is more data available.
1741 */
1742 NextToken?: NextToken;
1743 }
1744 export interface ListSkillsStoreCategoriesRequest {
1745 /**
1746 * The tokens used for pagination.
1747 */
1748 NextToken?: NextToken;
1749 /**
1750 * The maximum number of categories returned, per paginated calls.
1751 */
1752 MaxResults?: MaxResults;
1753 }
1754 export interface ListSkillsStoreCategoriesResponse {
1755 /**
1756 * The list of categories.
1757 */
1758 CategoryList?: CategoryList;
1759 /**
1760 * The tokens used for pagination.
1761 */
1762 NextToken?: NextToken;
1763 }
1764 export interface ListSkillsStoreSkillsByCategoryRequest {
1765 /**
1766 * The category ID for which the skills are being retrieved from the skill store.
1767 */
1768 CategoryId: CategoryId;
1769 /**
1770 * The tokens used for pagination.
1771 */
1772 NextToken?: NextToken;
1773 /**
1774 * The maximum number of skills returned per paginated calls.
1775 */
1776 MaxResults?: SkillListMaxResults;
1777 }
1778 export interface ListSkillsStoreSkillsByCategoryResponse {
1779 /**
1780 * The skill store skills.
1781 */
1782 SkillsStoreSkills?: SkillsStoreSkillList;
1783 /**
1784 * The tokens used for pagination.
1785 */
1786 NextToken?: NextToken;
1787 }
1788 export interface ListSmartHomeAppliancesRequest {
1789 /**
1790 * The room that the appliances are associated with.
1791 */
1792 RoomArn: Arn;
1793 /**
1794 * The maximum number of appliances to be returned, per paginated calls.
1795 */
1796 MaxResults?: MaxResults;
1797 /**
1798 * The tokens used for pagination.
1799 */
1800 NextToken?: NextToken;
1801 }
1802 export interface ListSmartHomeAppliancesResponse {
1803 /**
1804 * The smart home appliances.
1805 */
1806 SmartHomeAppliances?: SmartHomeApplianceList;
1807 /**
1808 * The tokens used for pagination.
1809 */
1810 NextToken?: NextToken;
1811 }
1812 export interface ListTagsRequest {
1813 /**
1814 * The ARN of the specified resource for which to list tags.
1815 */
1816 Arn: Arn;
1817 /**
1818 * 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.
1819 */
1820 NextToken?: NextToken;
1821 /**
1822 * 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.
1823 */
1824 MaxResults?: MaxResults;
1825 }
1826 export interface ListTagsResponse {
1827 /**
1828 * The tags requested for the specified resource.
1829 */
1830 Tags?: TagList;
1831 /**
1832 * The token returned to indicate that there is more data available.
1833 */
1834 NextToken?: NextToken;
1835 }
1836 export type MacAddress = string;
1837 export type MaxResults = number;
1838 export type MaxVolumeLimit = number;
1839 export interface MeetingSetting {
1840 /**
1841 * The values that indicate whether the pin is always required.
1842 */
1843 RequirePin: RequirePin;
1844 }
1845 export type NewInThisVersionBulletPoints = BulletPoint[];
1846 export type NextToken = string;
1847 export type OneClickIdDelay = string;
1848 export type OneClickPinDelay = string;
1849 export type OrganizationName = string;
1850 export type OutboundPhoneNumber = string;
1851 export interface PSTNDialIn {
1852 /**
1853 * The zip code.
1854 */
1855 CountryCode: CountryCode;
1856 /**
1857 * The phone number to call to join the conference.
1858 */
1859 PhoneNumber: OutboundPhoneNumber;
1860 /**
1861 * The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
1862 */
1863 OneClickIdDelay: OneClickIdDelay;
1864 /**
1865 * The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
1866 */
1867 OneClickPinDelay: OneClickPinDelay;
1868 }
1869 export type PrivacyPolicy = string;
1870 export type ProductDescription = string;
1871 export type ProductId = string;
1872 export interface Profile {
1873 /**
1874 * The ARN of a room profile.
1875 */
1876 ProfileArn?: Arn;
1877 /**
1878 * The name of a room profile.
1879 */
1880 ProfileName?: ProfileName;
1881 /**
1882 * Retrieves if the profile is default or not.
1883 */
1884 IsDefault?: Boolean;
1885 /**
1886 * The address of a room profile.
1887 */
1888 Address?: Address;
1889 /**
1890 * The time zone of a room profile.
1891 */
1892 Timezone?: Timezone;
1893 /**
1894 * The distance unit of a room profile.
1895 */
1896 DistanceUnit?: DistanceUnit;
1897 /**
1898 * The temperature unit of a room profile.
1899 */
1900 TemperatureUnit?: TemperatureUnit;
1901 /**
1902 * The wake word of a room profile.
1903 */
1904 WakeWord?: WakeWord;
1905 /**
1906 * The setup mode of a room profile.
1907 */
1908 SetupModeDisabled?: Boolean;
1909 /**
1910 * The max volume limit of a room profile.
1911 */
1912 MaxVolumeLimit?: MaxVolumeLimit;
1913 /**
1914 * The PSTN setting of a room profile.
1915 */
1916 PSTNEnabled?: Boolean;
1917 /**
1918 * The ARN of the address book.
1919 */
1920 AddressBookArn?: Arn;
1921 }
1922 export interface ProfileData {
1923 /**
1924 * The ARN of a room profile.
1925 */
1926 ProfileArn?: Arn;
1927 /**
1928 * The name of a room profile.
1929 */
1930 ProfileName?: ProfileName;
1931 /**
1932 * Retrieves if the profile data is default or not.
1933 */
1934 IsDefault?: Boolean;
1935 /**
1936 * The address of a room profile.
1937 */
1938 Address?: Address;
1939 /**
1940 * The timezone of a room profile.
1941 */
1942 Timezone?: Timezone;
1943 /**
1944 * The distance unit of a room profile.
1945 */
1946 DistanceUnit?: DistanceUnit;
1947 /**
1948 * The temperature unit of a room profile.
1949 */
1950 TemperatureUnit?: TemperatureUnit;
1951 /**
1952 * The wake word of a room profile.
1953 */
1954 WakeWord?: WakeWord;
1955 }
1956 export type ProfileDataList = ProfileData[];
1957 export type ProfileName = string;
1958 export type ProviderCalendarId = string;
1959 export interface PutConferencePreferenceRequest {
1960 /**
1961 * The conference preference of a specific conference provider.
1962 */
1963 ConferencePreference: ConferencePreference;
1964 }
1965 export interface PutConferencePreferenceResponse {
1966 }
1967 export interface PutInvitationConfigurationRequest {
1968 /**
1969 * The name of the organization sending the enrollment invite to a user.
1970 */
1971 OrganizationName: OrganizationName;
1972 /**
1973 * The email ID of the organization or individual contact that the enrolled user can use.
1974 */
1975 ContactEmail?: Email;
1976 /**
1977 * The list of private skill IDs that you want to recommend to the user to enable in the invitation.
1978 */
1979 PrivateSkillIds?: ShortSkillIdList;
1980 }
1981 export interface PutInvitationConfigurationResponse {
1982 }
1983 export interface PutRoomSkillParameterRequest {
1984 /**
1985 * The ARN of the room associated with the room skill parameter. Required.
1986 */
1987 RoomArn?: Arn;
1988 /**
1989 * The ARN of the skill associated with the room skill parameter. Required.
1990 */
1991 SkillId: SkillId;
1992 /**
1993 * The updated room skill parameter. Required.
1994 */
1995 RoomSkillParameter: RoomSkillParameter;
1996 }
1997 export interface PutRoomSkillParameterResponse {
1998 }
1999 export interface PutSkillAuthorizationRequest {
2000 /**
2001 * The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.
2002 */
2003 AuthorizationResult: AuthorizationResult;
2004 /**
2005 * The unique identifier of a skill.
2006 */
2007 SkillId: SkillId;
2008 /**
2009 * The room that the skill is authorized for.
2010 */
2011 RoomArn?: Arn;
2012 }
2013 export interface PutSkillAuthorizationResponse {
2014 }
2015 export interface RegisterAVSDeviceRequest {
2016 /**
2017 * The client ID of the OEM used for code-based linking authorization on an AVS device.
2018 */
2019 ClientId: ClientId;
2020 /**
2021 * 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.
2022 */
2023 UserCode: UserCode;
2024 /**
2025 * The product ID used to identify your AVS device during authorization.
2026 */
2027 ProductId: ProductId;
2028 /**
2029 * The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
2030 */
2031 DeviceSerialNumber: DeviceSerialNumberForAVS;
2032 /**
2033 * The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
2034 */
2035 AmazonId: AmazonId;
2036 }
2037 export interface RegisterAVSDeviceResponse {
2038 /**
2039 * The ARN of the device.
2040 */
2041 DeviceArn?: Arn;
2042 }
2043 export interface RejectSkillRequest {
2044 /**
2045 * The unique identifier of the skill.
2046 */
2047 SkillId: SkillId;
2048 }
2049 export interface RejectSkillResponse {
2050 }
2051 export type ReleaseDate = string;
2052 export type RequirePin = "YES"|"NO"|"OPTIONAL"|string;
2053 export interface ResolveRoomRequest {
2054 /**
2055 * The ARN of the user. Required.
2056 */
2057 UserId: UserId;
2058 /**
2059 * The ARN of the skill that was requested. Required.
2060 */
2061 SkillId: SkillId;
2062 }
2063 export interface ResolveRoomResponse {
2064 /**
2065 * The ARN of the room from which the skill request was invoked.
2066 */
2067 RoomArn?: Arn;
2068 /**
2069 * The name of the room from which the skill request was invoked.
2070 */
2071 RoomName?: RoomName;
2072 /**
2073 * Response to get the room profile request. Required.
2074 */
2075 RoomSkillParameters?: RoomSkillParameters;
2076 }
2077 export type ReviewKey = string;
2078 export type ReviewValue = string;
2079 export type Reviews = {[key: string]: ReviewValue};
2080 export interface RevokeInvitationRequest {
2081 /**
2082 * The ARN of the user for whom to revoke an enrollment invitation. Required.
2083 */
2084 UserArn?: Arn;
2085 /**
2086 * The ARN of the enrollment invitation to revoke. Required.
2087 */
2088 EnrollmentId?: EnrollmentId;
2089 }
2090 export interface RevokeInvitationResponse {
2091 }
2092 export interface Room {
2093 /**
2094 * The ARN of a room.
2095 */
2096 RoomArn?: Arn;
2097 /**
2098 * The name of a room.
2099 */
2100 RoomName?: RoomName;
2101 /**
2102 * The description of a room.
2103 */
2104 Description?: RoomDescription;
2105 /**
2106 * The provider calendar ARN of a room.
2107 */
2108 ProviderCalendarId?: ProviderCalendarId;
2109 /**
2110 * The profile ARN of a room.
2111 */
2112 ProfileArn?: Arn;
2113 }
2114 export interface RoomData {
2115 /**
2116 * The ARN of a room.
2117 */
2118 RoomArn?: Arn;
2119 /**
2120 * The name of a room.
2121 */
2122 RoomName?: RoomName;
2123 /**
2124 * The description of a room.
2125 */
2126 Description?: RoomDescription;
2127 /**
2128 * The provider calendar ARN of a room.
2129 */
2130 ProviderCalendarId?: ProviderCalendarId;
2131 /**
2132 * The profile ARN of a room.
2133 */
2134 ProfileArn?: Arn;
2135 /**
2136 * The profile name of a room.
2137 */
2138 ProfileName?: ProfileName;
2139 }
2140 export type RoomDataList = RoomData[];
2141 export type RoomDescription = string;
2142 export type RoomName = string;
2143 export interface RoomSkillParameter {
2144 /**
2145 * The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
2146 */
2147 ParameterKey: RoomSkillParameterKey;
2148 /**
2149 * The parameter value of a room skill parameter.
2150 */
2151 ParameterValue: RoomSkillParameterValue;
2152 }
2153 export type RoomSkillParameterKey = string;
2154 export type RoomSkillParameterValue = string;
2155 export type RoomSkillParameters = RoomSkillParameter[];
2156 export type S3KeyPrefix = string;
2157 export type SampleUtterances = Utterance[];
2158 export interface SearchAddressBooksRequest {
2159 /**
2160 * The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
2161 */
2162 Filters?: FilterList;
2163 /**
2164 * The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
2165 */
2166 SortCriteria?: SortList;
2167 /**
2168 * 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.
2169 */
2170 NextToken?: NextToken;
2171 /**
2172 * 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.
2173 */
2174 MaxResults?: MaxResults;
2175 }
2176 export interface SearchAddressBooksResponse {
2177 /**
2178 * The address books that meet the specified set of filter criteria, in sort order.
2179 */
2180 AddressBooks?: AddressBookDataList;
2181 /**
2182 * The token returned to indicate that there is more data available.
2183 */
2184 NextToken?: NextToken;
2185 /**
2186 * The total number of address books returned.
2187 */
2188 TotalCount?: TotalCount;
2189 }
2190 export interface SearchContactsRequest {
2191 /**
2192 * The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
2193 */
2194 Filters?: FilterList;
2195 /**
2196 * The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
2197 */
2198 SortCriteria?: SortList;
2199 /**
2200 * 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.
2201 */
2202 NextToken?: NextToken;
2203 /**
2204 * 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.
2205 */
2206 MaxResults?: MaxResults;
2207 }
2208 export interface SearchContactsResponse {
2209 /**
2210 * The contacts that meet the specified set of filter criteria, in sort order.
2211 */
2212 Contacts?: ContactDataList;
2213 /**
2214 * The token returned to indicate that there is more data available.
2215 */
2216 NextToken?: NextToken;
2217 /**
2218 * The total number of contacts returned.
2219 */
2220 TotalCount?: TotalCount;
2221 }
2222 export interface SearchDevicesRequest {
2223 /**
2224 * 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.
2225 */
2226 NextToken?: NextToken;
2227 /**
2228 * 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.
2229 */
2230 MaxResults?: MaxResults;
2231 /**
2232 * 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).
2233 */
2234 Filters?: FilterList;
2235 /**
2236 * The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.
2237 */
2238 SortCriteria?: SortList;
2239 }
2240 export interface SearchDevicesResponse {
2241 /**
2242 * The devices that meet the specified set of filter criteria, in sort order.
2243 */
2244 Devices?: DeviceDataList;
2245 /**
2246 * The token returned to indicate that there is more data available.
2247 */
2248 NextToken?: NextToken;
2249 /**
2250 * The total number of devices returned.
2251 */
2252 TotalCount?: TotalCount;
2253 }
2254 export interface SearchProfilesRequest {
2255 /**
2256 * 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.
2257 */
2258 NextToken?: NextToken;
2259 /**
2260 * 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.
2261 */
2262 MaxResults?: MaxResults;
2263 /**
2264 * The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
2265 */
2266 Filters?: FilterList;
2267 /**
2268 * The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
2269 */
2270 SortCriteria?: SortList;
2271 }
2272 export interface SearchProfilesResponse {
2273 /**
2274 * The profiles that meet the specified set of filter criteria, in sort order.
2275 */
2276 Profiles?: ProfileDataList;
2277 /**
2278 * The token returned to indicate that there is more data available.
2279 */
2280 NextToken?: NextToken;
2281 /**
2282 * The total number of room profiles returned.
2283 */
2284 TotalCount?: TotalCount;
2285 }
2286 export interface SearchRoomsRequest {
2287 /**
2288 * 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.
2289 */
2290 NextToken?: NextToken;
2291 /**
2292 * 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.
2293 */
2294 MaxResults?: MaxResults;
2295 /**
2296 * The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
2297 */
2298 Filters?: FilterList;
2299 /**
2300 * The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
2301 */
2302 SortCriteria?: SortList;
2303 }
2304 export interface SearchRoomsResponse {
2305 /**
2306 * The rooms that meet the specified set of filter criteria, in sort order.
2307 */
2308 Rooms?: RoomDataList;
2309 /**
2310 * The token returned to indicate that there is more data available.
2311 */
2312 NextToken?: NextToken;
2313 /**
2314 * The total number of rooms returned.
2315 */
2316 TotalCount?: TotalCount;
2317 }
2318 export interface SearchSkillGroupsRequest {
2319 /**
2320 * 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.
2321 */
2322 NextToken?: NextToken;
2323 /**
2324 * 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.
2325 */
2326 MaxResults?: MaxResults;
2327 /**
2328 * The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
2329 */
2330 Filters?: FilterList;
2331 /**
2332 * The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
2333 */
2334 SortCriteria?: SortList;
2335 }
2336 export interface SearchSkillGroupsResponse {
2337 /**
2338 * The skill groups that meet the filter criteria, in sort order.
2339 */
2340 SkillGroups?: SkillGroupDataList;
2341 /**
2342 * The token returned to indicate that there is more data available.
2343 */
2344 NextToken?: NextToken;
2345 /**
2346 * The total number of skill groups returned.
2347 */
2348 TotalCount?: TotalCount;
2349 }
2350 export interface SearchUsersRequest {
2351 /**
2352 * 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.
2353 */
2354 NextToken?: NextToken;
2355 /**
2356 * 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.
2357 */
2358 MaxResults?: MaxResults;
2359 /**
2360 * The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
2361 */
2362 Filters?: FilterList;
2363 /**
2364 * The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
2365 */
2366 SortCriteria?: SortList;
2367 }
2368 export interface SearchUsersResponse {
2369 /**
2370 * The users that meet the specified set of filter criteria, in sort order.
2371 */
2372 Users?: UserDataList;
2373 /**
2374 * The token returned to indicate that there is more data available.
2375 */
2376 NextToken?: NextToken;
2377 /**
2378 * The total number of users returned.
2379 */
2380 TotalCount?: TotalCount;
2381 }
2382 export interface SendInvitationRequest {
2383 /**
2384 * The ARN of the user to whom to send an invitation. Required.
2385 */
2386 UserArn?: Arn;
2387 }
2388 export interface SendInvitationResponse {
2389 }
2390 export type ShortDescription = string;
2391 export type ShortSkillIdList = SkillId[];
2392 export interface SkillDetails {
2393 /**
2394 * The description of the product.
2395 */
2396 ProductDescription?: ProductDescription;
2397 /**
2398 * The phrase used to trigger the skill.
2399 */
2400 InvocationPhrase?: InvocationPhrase;
2401 /**
2402 * The date when the skill was released.
2403 */
2404 ReleaseDate?: ReleaseDate;
2405 /**
2406 * The URL of the end user license agreement.
2407 */
2408 EndUserLicenseAgreement?: EndUserLicenseAgreement;
2409 /**
2410 * The generic keywords associated with the skill that can be used to find a skill.
2411 */
2412 GenericKeywords?: GenericKeywords;
2413 /**
2414 * The details about what the skill supports organized as bullet points.
2415 */
2416 BulletPoints?: BulletPoints;
2417 /**
2418 * The updates added in bullet points.
2419 */
2420 NewInThisVersionBulletPoints?: NewInThisVersionBulletPoints;
2421 /**
2422 * The types of skills.
2423 */
2424 SkillTypes?: SkillTypes;
2425 /**
2426 * The list of reviews for the skill, including Key and Value pair.
2427 */
2428 Reviews?: Reviews;
2429 /**
2430 * The details about the developer that published the skill.
2431 */
2432 DeveloperInfo?: DeveloperInfo;
2433 }
2434 export interface SkillGroup {
2435 /**
2436 * The ARN of a skill group.
2437 */
2438 SkillGroupArn?: Arn;
2439 /**
2440 * The name of a skill group.
2441 */
2442 SkillGroupName?: SkillGroupName;
2443 /**
2444 * The description of a skill group.
2445 */
2446 Description?: SkillGroupDescription;
2447 }
2448 export interface SkillGroupData {
2449 /**
2450 * The skill group ARN of a skill group.
2451 */
2452 SkillGroupArn?: Arn;
2453 /**
2454 * The skill group name of a skill group.
2455 */
2456 SkillGroupName?: SkillGroupName;
2457 /**
2458 * The description of a skill group.
2459 */
2460 Description?: SkillGroupDescription;
2461 }
2462 export type SkillGroupDataList = SkillGroupData[];
2463 export type SkillGroupDescription = string;
2464 export type SkillGroupName = string;
2465 export type SkillId = string;
2466 export type SkillListMaxResults = number;
2467 export type SkillName = string;
2468 export type SkillStoreType = string;
2469 export interface SkillSummary {
2470 /**
2471 * The ARN of the skill summary.
2472 */
2473 SkillId?: SkillId;
2474 /**
2475 * The name of the skill.
2476 */
2477 SkillName?: SkillName;
2478 /**
2479 * Linking support for a skill.
2480 */
2481 SupportsLinking?: boolean;
2482 /**
2483 * Whether the skill is enabled under the user's account, or if it requires linking to be used.
2484 */
2485 EnablementType?: EnablementType;
2486 /**
2487 * Whether the skill is publicly available or is a private skill.
2488 */
2489 SkillType?: SkillType;
2490 }
2491 export type SkillSummaryList = SkillSummary[];
2492 export type SkillType = "PUBLIC"|"PRIVATE"|string;
2493 export type SkillTypeFilter = "PUBLIC"|"PRIVATE"|"ALL"|string;
2494 export type SkillTypes = SkillStoreType[];
2495 export interface SkillsStoreSkill {
2496 /**
2497 * The ARN of the skill.
2498 */
2499 SkillId?: SkillId;
2500 /**
2501 * The name of the skill.
2502 */
2503 SkillName?: SkillName;
2504 /**
2505 * Short description about the skill.
2506 */
2507 ShortDescription?: ShortDescription;
2508 /**
2509 * The URL where the skill icon resides.
2510 */
2511 IconUrl?: IconUrl;
2512 /**
2513 * Sample utterances that interact with the skill.
2514 */
2515 SampleUtterances?: SampleUtterances;
2516 /**
2517 * Information about the skill.
2518 */
2519 SkillDetails?: SkillDetails;
2520 /**
2521 * Linking support for a skill.
2522 */
2523 SupportsLinking?: boolean;
2524 }
2525 export type SkillsStoreSkillList = SkillsStoreSkill[];
2526 export interface SmartHomeAppliance {
2527 /**
2528 * The friendly name of the smart home appliance.
2529 */
2530 FriendlyName?: ApplianceFriendlyName;
2531 /**
2532 * The description of the smart home appliance.
2533 */
2534 Description?: ApplianceDescription;
2535 /**
2536 * The name of the manufacturer of the smart home appliance.
2537 */
2538 ManufacturerName?: ApplianceManufacturerName;
2539 }
2540 export type SmartHomeApplianceList = SmartHomeAppliance[];
2541 export type SoftwareVersion = string;
2542 export interface Sort {
2543 /**
2544 * The sort key of a sort object.
2545 */
2546 Key: SortKey;
2547 /**
2548 * The sort value of a sort object.
2549 */
2550 Value: SortValue;
2551 }
2552 export type SortKey = string;
2553 export type SortList = Sort[];
2554 export type SortValue = "ASC"|"DESC"|string;
2555 export interface StartDeviceSyncRequest {
2556 /**
2557 * The ARN of the room with which the device to sync is associated. Required.
2558 */
2559 RoomArn?: Arn;
2560 /**
2561 * The ARN of the device to sync. Required.
2562 */
2563 DeviceArn?: Arn;
2564 /**
2565 * Request structure to start the device sync. Required.
2566 */
2567 Features: Features;
2568 }
2569 export interface StartDeviceSyncResponse {
2570 }
2571 export interface StartSmartHomeApplianceDiscoveryRequest {
2572 /**
2573 * The room where smart home appliance discovery was initiated.
2574 */
2575 RoomArn: Arn;
2576 }
2577 export interface StartSmartHomeApplianceDiscoveryResponse {
2578 }
2579 export interface Tag {
2580 /**
2581 * The key of a tag. Tag keys are case-sensitive.
2582 */
2583 Key: TagKey;
2584 /**
2585 * The value of a tag. Tag values are case-sensitive and can be null.
2586 */
2587 Value: TagValue;
2588 }
2589 export type TagKey = string;
2590 export type TagKeyList = TagKey[];
2591 export type TagList = Tag[];
2592 export interface TagResourceRequest {
2593 /**
2594 * The ARN of the resource to which to add metadata tags. Required.
2595 */
2596 Arn: Arn;
2597 /**
2598 * The tags to be added to the specified resource. Do not provide system tags. Required.
2599 */
2600 Tags: TagList;
2601 }
2602 export interface TagResourceResponse {
2603 }
2604 export type TagValue = string;
2605 export type TemperatureUnit = "FAHRENHEIT"|"CELSIUS"|string;
2606 export type Timestamp = Date;
2607 export type Timezone = string;
2608 export type TotalCount = number;
2609 export interface UntagResourceRequest {
2610 /**
2611 * The ARN of the resource from which to remove metadata tags. Required.
2612 */
2613 Arn: Arn;
2614 /**
2615 * The tags to be removed from the specified resource. Do not provide system tags. Required.
2616 */
2617 TagKeys: TagKeyList;
2618 }
2619 export interface UntagResourceResponse {
2620 }
2621 export interface UpdateAddressBookRequest {
2622 /**
2623 * The ARN of the room to update.
2624 */
2625 AddressBookArn: Arn;
2626 /**
2627 * The updated name of the room.
2628 */
2629 Name?: AddressBookName;
2630 /**
2631 * The updated description of the room.
2632 */
2633 Description?: AddressBookDescription;
2634 }
2635 export interface UpdateAddressBookResponse {
2636 }
2637 export interface UpdateBusinessReportScheduleRequest {
2638 /**
2639 * The ARN of the business report schedule.
2640 */
2641 ScheduleArn: Arn;
2642 /**
2643 * The S3 location of the output reports.
2644 */
2645 S3BucketName?: CustomerS3BucketName;
2646 /**
2647 * The S3 key where the report is delivered.
2648 */
2649 S3KeyPrefix?: S3KeyPrefix;
2650 /**
2651 * The format of the generated report (individual CSV files or zipped files of individual files).
2652 */
2653 Format?: BusinessReportFormat;
2654 /**
2655 * The name identifier of the schedule.
2656 */
2657 ScheduleName?: BusinessReportScheduleName;
2658 /**
2659 * The recurrence of the reports.
2660 */
2661 Recurrence?: BusinessReportRecurrence;
2662 }
2663 export interface UpdateBusinessReportScheduleResponse {
2664 }
2665 export interface UpdateConferenceProviderRequest {
2666 /**
2667 * The ARN of the conference provider.
2668 */
2669 ConferenceProviderArn: Arn;
2670 /**
2671 * The type of the conference provider.
2672 */
2673 ConferenceProviderType: ConferenceProviderType;
2674 /**
2675 * The IP endpoint and protocol for calling.
2676 */
2677 IPDialIn?: IPDialIn;
2678 /**
2679 * The information for PSTN conferencing.
2680 */
2681 PSTNDialIn?: PSTNDialIn;
2682 /**
2683 * The meeting settings for the conference provider.
2684 */
2685 MeetingSetting: MeetingSetting;
2686 }
2687 export interface UpdateConferenceProviderResponse {
2688 }
2689 export interface UpdateContactRequest {
2690 /**
2691 * The ARN of the contact to update.
2692 */
2693 ContactArn: Arn;
2694 /**
2695 * The updated display name of the contact.
2696 */
2697 DisplayName?: ContactName;
2698 /**
2699 * The updated first name of the contact.
2700 */
2701 FirstName?: ContactName;
2702 /**
2703 * The updated last name of the contact.
2704 */
2705 LastName?: ContactName;
2706 /**
2707 * The updated phone number of the contact.
2708 */
2709 PhoneNumber?: E164PhoneNumber;
2710 }
2711 export interface UpdateContactResponse {
2712 }
2713 export interface UpdateDeviceRequest {
2714 /**
2715 * The ARN of the device to update. Required.
2716 */
2717 DeviceArn?: Arn;
2718 /**
2719 * The updated device name. Required.
2720 */
2721 DeviceName?: DeviceName;
2722 }
2723 export interface UpdateDeviceResponse {
2724 }
2725 export interface UpdateProfileRequest {
2726 /**
2727 * The ARN of the room profile to update. Required.
2728 */
2729 ProfileArn?: Arn;
2730 /**
2731 * The updated name for the room profile.
2732 */
2733 ProfileName?: ProfileName;
2734 /**
2735 * Sets the profile as default if selected. If this is missing, no update is done to the default status.
2736 */
2737 IsDefault?: Boolean;
2738 /**
2739 * The updated timezone for the room profile.
2740 */
2741 Timezone?: Timezone;
2742 /**
2743 * The updated address for the room profile.
2744 */
2745 Address?: Address;
2746 /**
2747 * The updated distance unit for the room profile.
2748 */
2749 DistanceUnit?: DistanceUnit;
2750 /**
2751 * The updated temperature unit for the room profile.
2752 */
2753 TemperatureUnit?: TemperatureUnit;
2754 /**
2755 * The updated wake word for the room profile.
2756 */
2757 WakeWord?: WakeWord;
2758 /**
2759 * Whether the setup mode of the profile is enabled.
2760 */
2761 SetupModeDisabled?: Boolean;
2762 /**
2763 * The updated maximum volume limit for the room profile.
2764 */
2765 MaxVolumeLimit?: MaxVolumeLimit;
2766 /**
2767 * Whether the PSTN setting of the room profile is enabled.
2768 */
2769 PSTNEnabled?: Boolean;
2770 }
2771 export interface UpdateProfileResponse {
2772 }
2773 export interface UpdateRoomRequest {
2774 /**
2775 * The ARN of the room to update.
2776 */
2777 RoomArn?: Arn;
2778 /**
2779 * The updated name for the room.
2780 */
2781 RoomName?: RoomName;
2782 /**
2783 * The updated description for the room.
2784 */
2785 Description?: RoomDescription;
2786 /**
2787 * The updated provider calendar ARN for the room.
2788 */
2789 ProviderCalendarId?: ProviderCalendarId;
2790 /**
2791 * The updated profile ARN for the room.
2792 */
2793 ProfileArn?: Arn;
2794 }
2795 export interface UpdateRoomResponse {
2796 }
2797 export interface UpdateSkillGroupRequest {
2798 /**
2799 * The ARN of the skill group to update.
2800 */
2801 SkillGroupArn?: Arn;
2802 /**
2803 * The updated name for the skill group.
2804 */
2805 SkillGroupName?: SkillGroupName;
2806 /**
2807 * The updated description for the skill group.
2808 */
2809 Description?: SkillGroupDescription;
2810 }
2811 export interface UpdateSkillGroupResponse {
2812 }
2813 export type Url = string;
2814 export type UserCode = string;
2815 export interface UserData {
2816 /**
2817 * The ARN of a user.
2818 */
2819 UserArn?: Arn;
2820 /**
2821 * The first name of a user.
2822 */
2823 FirstName?: user_FirstName;
2824 /**
2825 * The last name of a user.
2826 */
2827 LastName?: user_LastName;
2828 /**
2829 * The email of a user.
2830 */
2831 Email?: Email;
2832 /**
2833 * The enrollment status of a user.
2834 */
2835 EnrollmentStatus?: EnrollmentStatus;
2836 /**
2837 * The enrollment ARN of a user.
2838 */
2839 EnrollmentId?: EnrollmentId;
2840 }
2841 export type UserDataList = UserData[];
2842 export type UserId = string;
2843 export type Utterance = string;
2844 export type Value = string;
2845 export type WakeWord = "ALEXA"|"AMAZON"|"ECHO"|"COMPUTER"|string;
2846 export type user_FirstName = string;
2847 export type user_LastName = string;
2848 export type user_UserId = string;
2849 /**
2850 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2851 */
2852 export type apiVersion = "2017-11-09"|"latest"|string;
2853 export interface ClientApiVersions {
2854 /**
2855 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2856 */
2857 apiVersion?: apiVersion;
2858 }
2859 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2860 /**
2861 * Contains interfaces for use with the AlexaForBusiness client.
2862 */
2863 export import Types = AlexaForBusiness;
2864}
2865export = AlexaForBusiness;