UNPKG

152 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 the specified network profile.
32 */
33 associateDeviceWithNetworkProfile(params: AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileResponse, AWSError>;
34 /**
35 * Associates a device with the specified network profile.
36 */
37 associateDeviceWithNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileResponse, AWSError>;
38 /**
39 * 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.
40 */
41 associateDeviceWithRoom(params: AlexaForBusiness.Types.AssociateDeviceWithRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithRoomResponse, AWSError>;
42 /**
43 * 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.
44 */
45 associateDeviceWithRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithRoomResponse, AWSError>;
46 /**
47 * Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
48 */
49 associateSkillGroupWithRoom(params: AlexaForBusiness.Types.AssociateSkillGroupWithRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse, AWSError>;
50 /**
51 * Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
52 */
53 associateSkillGroupWithRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse, AWSError>;
54 /**
55 * Associates a skill with a skill group.
56 */
57 associateSkillWithSkillGroup(params: AlexaForBusiness.Types.AssociateSkillWithSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse, AWSError>;
58 /**
59 * Associates a skill with a skill group.
60 */
61 associateSkillWithSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse, AWSError>;
62 /**
63 * Makes a private skill available for enrolled users to enable on their devices.
64 */
65 associateSkillWithUsers(params: AlexaForBusiness.Types.AssociateSkillWithUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithUsersResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithUsersResponse, AWSError>;
66 /**
67 * Makes a private skill available for enrolled users to enable on their devices.
68 */
69 associateSkillWithUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithUsersResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithUsersResponse, AWSError>;
70 /**
71 * Creates an address book with the specified details.
72 */
73 createAddressBook(params: AlexaForBusiness.Types.CreateAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateAddressBookResponse) => void): Request<AlexaForBusiness.Types.CreateAddressBookResponse, AWSError>;
74 /**
75 * Creates an address book with the specified details.
76 */
77 createAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateAddressBookResponse) => void): Request<AlexaForBusiness.Types.CreateAddressBookResponse, AWSError>;
78 /**
79 * Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
80 */
81 createBusinessReportSchedule(params: AlexaForBusiness.Types.CreateBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.CreateBusinessReportScheduleResponse, AWSError>;
82 /**
83 * Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
84 */
85 createBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.CreateBusinessReportScheduleResponse, AWSError>;
86 /**
87 * Adds a new conference provider under the user's AWS account.
88 */
89 createConferenceProvider(params: AlexaForBusiness.Types.CreateConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.CreateConferenceProviderResponse, AWSError>;
90 /**
91 * Adds a new conference provider under the user's AWS account.
92 */
93 createConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.CreateConferenceProviderResponse, AWSError>;
94 /**
95 * Creates a contact with the specified details.
96 */
97 createContact(params: AlexaForBusiness.Types.CreateContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateContactResponse) => void): Request<AlexaForBusiness.Types.CreateContactResponse, AWSError>;
98 /**
99 * Creates a contact with the specified details.
100 */
101 createContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateContactResponse) => void): Request<AlexaForBusiness.Types.CreateContactResponse, AWSError>;
102 /**
103 * Creates a gateway group with the specified details.
104 */
105 createGatewayGroup(params: AlexaForBusiness.Types.CreateGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.CreateGatewayGroupResponse, AWSError>;
106 /**
107 * Creates a gateway group with the specified details.
108 */
109 createGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.CreateGatewayGroupResponse, AWSError>;
110 /**
111 * Creates a network profile with the specified details.
112 */
113 createNetworkProfile(params: AlexaForBusiness.Types.CreateNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.CreateNetworkProfileResponse, AWSError>;
114 /**
115 * Creates a network profile with the specified details.
116 */
117 createNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.CreateNetworkProfileResponse, AWSError>;
118 /**
119 * Creates a new room profile with the specified details.
120 */
121 createProfile(params: AlexaForBusiness.Types.CreateProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateProfileResponse) => void): Request<AlexaForBusiness.Types.CreateProfileResponse, AWSError>;
122 /**
123 * Creates a new room profile with the specified details.
124 */
125 createProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateProfileResponse) => void): Request<AlexaForBusiness.Types.CreateProfileResponse, AWSError>;
126 /**
127 * Creates a room with the specified details.
128 */
129 createRoom(params: AlexaForBusiness.Types.CreateRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateRoomResponse) => void): Request<AlexaForBusiness.Types.CreateRoomResponse, AWSError>;
130 /**
131 * Creates a room with the specified details.
132 */
133 createRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateRoomResponse) => void): Request<AlexaForBusiness.Types.CreateRoomResponse, AWSError>;
134 /**
135 * Creates a skill group with a specified name and description.
136 */
137 createSkillGroup(params: AlexaForBusiness.Types.CreateSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.CreateSkillGroupResponse, AWSError>;
138 /**
139 * Creates a skill group with a specified name and description.
140 */
141 createSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.CreateSkillGroupResponse, AWSError>;
142 /**
143 * Creates a user.
144 */
145 createUser(params: AlexaForBusiness.Types.CreateUserRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateUserResponse) => void): Request<AlexaForBusiness.Types.CreateUserResponse, AWSError>;
146 /**
147 * Creates a user.
148 */
149 createUser(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateUserResponse) => void): Request<AlexaForBusiness.Types.CreateUserResponse, AWSError>;
150 /**
151 * Deletes an address book by the address book ARN.
152 */
153 deleteAddressBook(params: AlexaForBusiness.Types.DeleteAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteAddressBookResponse) => void): Request<AlexaForBusiness.Types.DeleteAddressBookResponse, AWSError>;
154 /**
155 * Deletes an address book by the address book ARN.
156 */
157 deleteAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteAddressBookResponse) => void): Request<AlexaForBusiness.Types.DeleteAddressBookResponse, AWSError>;
158 /**
159 * Deletes the recurring report delivery schedule with the specified schedule ARN.
160 */
161 deleteBusinessReportSchedule(params: AlexaForBusiness.Types.DeleteBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse, AWSError>;
162 /**
163 * Deletes the recurring report delivery schedule with the specified schedule ARN.
164 */
165 deleteBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse, AWSError>;
166 /**
167 * Deletes a conference provider.
168 */
169 deleteConferenceProvider(params: AlexaForBusiness.Types.DeleteConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.DeleteConferenceProviderResponse, AWSError>;
170 /**
171 * Deletes a conference provider.
172 */
173 deleteConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.DeleteConferenceProviderResponse, AWSError>;
174 /**
175 * Deletes a contact by the contact ARN.
176 */
177 deleteContact(params: AlexaForBusiness.Types.DeleteContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteContactResponse) => void): Request<AlexaForBusiness.Types.DeleteContactResponse, AWSError>;
178 /**
179 * Deletes a contact by the contact ARN.
180 */
181 deleteContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteContactResponse) => void): Request<AlexaForBusiness.Types.DeleteContactResponse, AWSError>;
182 /**
183 * Removes a device from Alexa For Business.
184 */
185 deleteDevice(params: AlexaForBusiness.Types.DeleteDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceResponse, AWSError>;
186 /**
187 * Removes a device from Alexa For Business.
188 */
189 deleteDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceResponse, AWSError>;
190 /**
191 * When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.
192 */
193 deleteDeviceUsageData(params: AlexaForBusiness.Types.DeleteDeviceUsageDataRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceUsageDataResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceUsageDataResponse, AWSError>;
194 /**
195 * When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.
196 */
197 deleteDeviceUsageData(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceUsageDataResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceUsageDataResponse, AWSError>;
198 /**
199 * Deletes a gateway group.
200 */
201 deleteGatewayGroup(params: AlexaForBusiness.Types.DeleteGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteGatewayGroupResponse, AWSError>;
202 /**
203 * Deletes a gateway group.
204 */
205 deleteGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteGatewayGroupResponse, AWSError>;
206 /**
207 * Deletes a network profile by the network profile ARN.
208 */
209 deleteNetworkProfile(params: AlexaForBusiness.Types.DeleteNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteNetworkProfileResponse, AWSError>;
210 /**
211 * Deletes a network profile by the network profile ARN.
212 */
213 deleteNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteNetworkProfileResponse, AWSError>;
214 /**
215 * Deletes a room profile by the profile ARN.
216 */
217 deleteProfile(params: AlexaForBusiness.Types.DeleteProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteProfileResponse, AWSError>;
218 /**
219 * Deletes a room profile by the profile ARN.
220 */
221 deleteProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteProfileResponse, AWSError>;
222 /**
223 * Deletes a room by the room ARN.
224 */
225 deleteRoom(params: AlexaForBusiness.Types.DeleteRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomResponse, AWSError>;
226 /**
227 * Deletes a room by the room ARN.
228 */
229 deleteRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomResponse, AWSError>;
230 /**
231 * Deletes room skill parameter details by room, skill, and parameter key ID.
232 */
233 deleteRoomSkillParameter(params: AlexaForBusiness.Types.DeleteRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomSkillParameterResponse, AWSError>;
234 /**
235 * Deletes room skill parameter details by room, skill, and parameter key ID.
236 */
237 deleteRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomSkillParameterResponse, AWSError>;
238 /**
239 * Unlinks a third-party account from a skill.
240 */
241 deleteSkillAuthorization(params: AlexaForBusiness.Types.DeleteSkillAuthorizationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillAuthorizationResponse, AWSError>;
242 /**
243 * Unlinks a third-party account from a skill.
244 */
245 deleteSkillAuthorization(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillAuthorizationResponse, AWSError>;
246 /**
247 * Deletes a skill group by skill group ARN.
248 */
249 deleteSkillGroup(params: AlexaForBusiness.Types.DeleteSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillGroupResponse, AWSError>;
250 /**
251 * Deletes a skill group by skill group ARN.
252 */
253 deleteSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillGroupResponse, AWSError>;
254 /**
255 * Deletes a specified user by user ARN and enrollment ARN.
256 */
257 deleteUser(params: AlexaForBusiness.Types.DeleteUserRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteUserResponse) => void): Request<AlexaForBusiness.Types.DeleteUserResponse, AWSError>;
258 /**
259 * Deletes a specified user by user ARN and enrollment ARN.
260 */
261 deleteUser(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteUserResponse) => void): Request<AlexaForBusiness.Types.DeleteUserResponse, AWSError>;
262 /**
263 * Disassociates a contact from a given address book.
264 */
265 disassociateContactFromAddressBook(params: AlexaForBusiness.Types.DisassociateContactFromAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse) => void): Request<AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse, AWSError>;
266 /**
267 * Disassociates a contact from a given address book.
268 */
269 disassociateContactFromAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse) => void): Request<AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse, AWSError>;
270 /**
271 * 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.
272 */
273 disassociateDeviceFromRoom(params: AlexaForBusiness.Types.DisassociateDeviceFromRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse, AWSError>;
274 /**
275 * 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.
276 */
277 disassociateDeviceFromRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse, AWSError>;
278 /**
279 * Disassociates a skill from a skill group.
280 */
281 disassociateSkillFromSkillGroup(params: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse, AWSError>;
282 /**
283 * Disassociates a skill from a skill group.
284 */
285 disassociateSkillFromSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse, AWSError>;
286 /**
287 * Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
288 */
289 disassociateSkillFromUsers(params: AlexaForBusiness.Types.DisassociateSkillFromUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromUsersResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromUsersResponse, AWSError>;
290 /**
291 * Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
292 */
293 disassociateSkillFromUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromUsersResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromUsersResponse, AWSError>;
294 /**
295 * Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
296 */
297 disassociateSkillGroupFromRoom(params: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse, AWSError>;
298 /**
299 * Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
300 */
301 disassociateSkillGroupFromRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse, AWSError>;
302 /**
303 * Forgets smart home appliances associated to a room.
304 */
305 forgetSmartHomeAppliances(params: AlexaForBusiness.Types.ForgetSmartHomeAppliancesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse, AWSError>;
306 /**
307 * Forgets smart home appliances associated to a room.
308 */
309 forgetSmartHomeAppliances(callback?: (err: AWSError, data: AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse, AWSError>;
310 /**
311 * Gets address the book details by the address book ARN.
312 */
313 getAddressBook(params: AlexaForBusiness.Types.GetAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetAddressBookResponse) => void): Request<AlexaForBusiness.Types.GetAddressBookResponse, AWSError>;
314 /**
315 * Gets address the book details by the address book ARN.
316 */
317 getAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetAddressBookResponse) => void): Request<AlexaForBusiness.Types.GetAddressBookResponse, AWSError>;
318 /**
319 * Retrieves the existing conference preferences.
320 */
321 getConferencePreference(params: AlexaForBusiness.Types.GetConferencePreferenceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.GetConferencePreferenceResponse, AWSError>;
322 /**
323 * Retrieves the existing conference preferences.
324 */
325 getConferencePreference(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.GetConferencePreferenceResponse, AWSError>;
326 /**
327 * Gets details about a specific conference provider.
328 */
329 getConferenceProvider(params: AlexaForBusiness.Types.GetConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.GetConferenceProviderResponse, AWSError>;
330 /**
331 * Gets details about a specific conference provider.
332 */
333 getConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.GetConferenceProviderResponse, AWSError>;
334 /**
335 * Gets the contact details by the contact ARN.
336 */
337 getContact(params: AlexaForBusiness.Types.GetContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetContactResponse) => void): Request<AlexaForBusiness.Types.GetContactResponse, AWSError>;
338 /**
339 * Gets the contact details by the contact ARN.
340 */
341 getContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetContactResponse) => void): Request<AlexaForBusiness.Types.GetContactResponse, AWSError>;
342 /**
343 * Gets the details of a device by device ARN.
344 */
345 getDevice(params: AlexaForBusiness.Types.GetDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetDeviceResponse) => void): Request<AlexaForBusiness.Types.GetDeviceResponse, AWSError>;
346 /**
347 * Gets the details of a device by device ARN.
348 */
349 getDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetDeviceResponse) => void): Request<AlexaForBusiness.Types.GetDeviceResponse, AWSError>;
350 /**
351 * Retrieves the details of a gateway.
352 */
353 getGateway(params: AlexaForBusiness.Types.GetGatewayRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayResponse) => void): Request<AlexaForBusiness.Types.GetGatewayResponse, AWSError>;
354 /**
355 * Retrieves the details of a gateway.
356 */
357 getGateway(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayResponse) => void): Request<AlexaForBusiness.Types.GetGatewayResponse, AWSError>;
358 /**
359 * Retrieves the details of a gateway group.
360 */
361 getGatewayGroup(params: AlexaForBusiness.Types.GetGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.GetGatewayGroupResponse, AWSError>;
362 /**
363 * Retrieves the details of a gateway group.
364 */
365 getGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.GetGatewayGroupResponse, AWSError>;
366 /**
367 * Retrieves the configured values for the user enrollment invitation email template.
368 */
369 getInvitationConfiguration(params: AlexaForBusiness.Types.GetInvitationConfigurationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.GetInvitationConfigurationResponse, AWSError>;
370 /**
371 * Retrieves the configured values for the user enrollment invitation email template.
372 */
373 getInvitationConfiguration(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.GetInvitationConfigurationResponse, AWSError>;
374 /**
375 * Gets the network profile details by the network profile ARN.
376 */
377 getNetworkProfile(params: AlexaForBusiness.Types.GetNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.GetNetworkProfileResponse, AWSError>;
378 /**
379 * Gets the network profile details by the network profile ARN.
380 */
381 getNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.GetNetworkProfileResponse, AWSError>;
382 /**
383 * Gets the details of a room profile by profile ARN.
384 */
385 getProfile(params: AlexaForBusiness.Types.GetProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetProfileResponse) => void): Request<AlexaForBusiness.Types.GetProfileResponse, AWSError>;
386 /**
387 * Gets the details of a room profile by profile ARN.
388 */
389 getProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetProfileResponse) => void): Request<AlexaForBusiness.Types.GetProfileResponse, AWSError>;
390 /**
391 * Gets room details by room ARN.
392 */
393 getRoom(params: AlexaForBusiness.Types.GetRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomResponse) => void): Request<AlexaForBusiness.Types.GetRoomResponse, AWSError>;
394 /**
395 * Gets room details by room ARN.
396 */
397 getRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomResponse) => void): Request<AlexaForBusiness.Types.GetRoomResponse, AWSError>;
398 /**
399 * Gets room skill parameter details by room, skill, and parameter key ARN.
400 */
401 getRoomSkillParameter(params: AlexaForBusiness.Types.GetRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.GetRoomSkillParameterResponse, AWSError>;
402 /**
403 * Gets room skill parameter details by room, skill, and parameter key ARN.
404 */
405 getRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.GetRoomSkillParameterResponse, AWSError>;
406 /**
407 * Gets skill group details by skill group ARN.
408 */
409 getSkillGroup(params: AlexaForBusiness.Types.GetSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetSkillGroupResponse) => void): Request<AlexaForBusiness.Types.GetSkillGroupResponse, AWSError>;
410 /**
411 * Gets skill group details by skill group ARN.
412 */
413 getSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetSkillGroupResponse) => void): Request<AlexaForBusiness.Types.GetSkillGroupResponse, AWSError>;
414 /**
415 * Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
416 */
417 listBusinessReportSchedules(params: AlexaForBusiness.Types.ListBusinessReportSchedulesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListBusinessReportSchedulesResponse) => void): Request<AlexaForBusiness.Types.ListBusinessReportSchedulesResponse, AWSError>;
418 /**
419 * Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
420 */
421 listBusinessReportSchedules(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListBusinessReportSchedulesResponse) => void): Request<AlexaForBusiness.Types.ListBusinessReportSchedulesResponse, AWSError>;
422 /**
423 * Lists conference providers under a specific AWS account.
424 */
425 listConferenceProviders(params: AlexaForBusiness.Types.ListConferenceProvidersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListConferenceProvidersResponse) => void): Request<AlexaForBusiness.Types.ListConferenceProvidersResponse, AWSError>;
426 /**
427 * Lists conference providers under a specific AWS account.
428 */
429 listConferenceProviders(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListConferenceProvidersResponse) => void): Request<AlexaForBusiness.Types.ListConferenceProvidersResponse, AWSError>;
430 /**
431 * Lists the device event history, including device connection status, for up to 30 days.
432 */
433 listDeviceEvents(params: AlexaForBusiness.Types.ListDeviceEventsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListDeviceEventsResponse) => void): Request<AlexaForBusiness.Types.ListDeviceEventsResponse, AWSError>;
434 /**
435 * Lists the device event history, including device connection status, for up to 30 days.
436 */
437 listDeviceEvents(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListDeviceEventsResponse) => void): Request<AlexaForBusiness.Types.ListDeviceEventsResponse, AWSError>;
438 /**
439 * Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
440 */
441 listGatewayGroups(params: AlexaForBusiness.Types.ListGatewayGroupsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewayGroupsResponse) => void): Request<AlexaForBusiness.Types.ListGatewayGroupsResponse, AWSError>;
442 /**
443 * Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
444 */
445 listGatewayGroups(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewayGroupsResponse) => void): Request<AlexaForBusiness.Types.ListGatewayGroupsResponse, AWSError>;
446 /**
447 * Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
448 */
449 listGateways(params: AlexaForBusiness.Types.ListGatewaysRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewaysResponse) => void): Request<AlexaForBusiness.Types.ListGatewaysResponse, AWSError>;
450 /**
451 * Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
452 */
453 listGateways(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewaysResponse) => void): Request<AlexaForBusiness.Types.ListGatewaysResponse, AWSError>;
454 /**
455 * Lists all enabled skills in a specific skill group.
456 */
457 listSkills(params: AlexaForBusiness.Types.ListSkillsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsResponse) => void): Request<AlexaForBusiness.Types.ListSkillsResponse, AWSError>;
458 /**
459 * Lists all enabled skills in a specific skill group.
460 */
461 listSkills(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsResponse) => void): Request<AlexaForBusiness.Types.ListSkillsResponse, AWSError>;
462 /**
463 * Lists all categories in the Alexa skill store.
464 */
465 listSkillsStoreCategories(params: AlexaForBusiness.Types.ListSkillsStoreCategoriesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse, AWSError>;
466 /**
467 * Lists all categories in the Alexa skill store.
468 */
469 listSkillsStoreCategories(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse, AWSError>;
470 /**
471 * Lists all skills in the Alexa skill store by category.
472 */
473 listSkillsStoreSkillsByCategory(params: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse, AWSError>;
474 /**
475 * Lists all skills in the Alexa skill store by category.
476 */
477 listSkillsStoreSkillsByCategory(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse, AWSError>;
478 /**
479 * Lists all of the smart home appliances associated with a room.
480 */
481 listSmartHomeAppliances(params: AlexaForBusiness.Types.ListSmartHomeAppliancesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ListSmartHomeAppliancesResponse, AWSError>;
482 /**
483 * Lists all of the smart home appliances associated with a room.
484 */
485 listSmartHomeAppliances(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ListSmartHomeAppliancesResponse, AWSError>;
486 /**
487 * Lists all tags for the specified resource.
488 */
489 listTags(params: AlexaForBusiness.Types.ListTagsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListTagsResponse) => void): Request<AlexaForBusiness.Types.ListTagsResponse, AWSError>;
490 /**
491 * Lists all tags for the specified resource.
492 */
493 listTags(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListTagsResponse) => void): Request<AlexaForBusiness.Types.ListTagsResponse, AWSError>;
494 /**
495 * Sets the conference preferences on a specific conference provider at the account level.
496 */
497 putConferencePreference(params: AlexaForBusiness.Types.PutConferencePreferenceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.PutConferencePreferenceResponse, AWSError>;
498 /**
499 * Sets the conference preferences on a specific conference provider at the account level.
500 */
501 putConferencePreference(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.PutConferencePreferenceResponse, AWSError>;
502 /**
503 * Configures the email template for the user enrollment invitation with the specified attributes.
504 */
505 putInvitationConfiguration(params: AlexaForBusiness.Types.PutInvitationConfigurationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.PutInvitationConfigurationResponse, AWSError>;
506 /**
507 * Configures the email template for the user enrollment invitation with the specified attributes.
508 */
509 putInvitationConfiguration(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.PutInvitationConfigurationResponse, AWSError>;
510 /**
511 * Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
512 */
513 putRoomSkillParameter(params: AlexaForBusiness.Types.PutRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.PutRoomSkillParameterResponse, AWSError>;
514 /**
515 * Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
516 */
517 putRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.PutRoomSkillParameterResponse, AWSError>;
518 /**
519 * 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.
520 */
521 putSkillAuthorization(params: AlexaForBusiness.Types.PutSkillAuthorizationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.PutSkillAuthorizationResponse, AWSError>;
522 /**
523 * 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.
524 */
525 putSkillAuthorization(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.PutSkillAuthorizationResponse, AWSError>;
526 /**
527 * Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
528 */
529 registerAVSDevice(params: AlexaForBusiness.Types.RegisterAVSDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RegisterAVSDeviceResponse) => void): Request<AlexaForBusiness.Types.RegisterAVSDeviceResponse, AWSError>;
530 /**
531 * Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
532 */
533 registerAVSDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.RegisterAVSDeviceResponse) => void): Request<AlexaForBusiness.Types.RegisterAVSDeviceResponse, AWSError>;
534 /**
535 * 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.
536 */
537 rejectSkill(params: AlexaForBusiness.Types.RejectSkillRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RejectSkillResponse) => void): Request<AlexaForBusiness.Types.RejectSkillResponse, AWSError>;
538 /**
539 * 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.
540 */
541 rejectSkill(callback?: (err: AWSError, data: AlexaForBusiness.Types.RejectSkillResponse) => void): Request<AlexaForBusiness.Types.RejectSkillResponse, AWSError>;
542 /**
543 * Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
544 */
545 resolveRoom(params: AlexaForBusiness.Types.ResolveRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ResolveRoomResponse) => void): Request<AlexaForBusiness.Types.ResolveRoomResponse, AWSError>;
546 /**
547 * Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
548 */
549 resolveRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.ResolveRoomResponse) => void): Request<AlexaForBusiness.Types.ResolveRoomResponse, AWSError>;
550 /**
551 * Revokes an invitation and invalidates the enrollment URL.
552 */
553 revokeInvitation(params: AlexaForBusiness.Types.RevokeInvitationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RevokeInvitationResponse) => void): Request<AlexaForBusiness.Types.RevokeInvitationResponse, AWSError>;
554 /**
555 * Revokes an invitation and invalidates the enrollment URL.
556 */
557 revokeInvitation(callback?: (err: AWSError, data: AlexaForBusiness.Types.RevokeInvitationResponse) => void): Request<AlexaForBusiness.Types.RevokeInvitationResponse, AWSError>;
558 /**
559 * Searches address books and lists the ones that meet a set of filter and sort criteria.
560 */
561 searchAddressBooks(params: AlexaForBusiness.Types.SearchAddressBooksRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchAddressBooksResponse) => void): Request<AlexaForBusiness.Types.SearchAddressBooksResponse, AWSError>;
562 /**
563 * Searches address books and lists the ones that meet a set of filter and sort criteria.
564 */
565 searchAddressBooks(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchAddressBooksResponse) => void): Request<AlexaForBusiness.Types.SearchAddressBooksResponse, AWSError>;
566 /**
567 * Searches contacts and lists the ones that meet a set of filter and sort criteria.
568 */
569 searchContacts(params: AlexaForBusiness.Types.SearchContactsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchContactsResponse) => void): Request<AlexaForBusiness.Types.SearchContactsResponse, AWSError>;
570 /**
571 * Searches contacts and lists the ones that meet a set of filter and sort criteria.
572 */
573 searchContacts(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchContactsResponse) => void): Request<AlexaForBusiness.Types.SearchContactsResponse, AWSError>;
574 /**
575 * Searches devices and lists the ones that meet a set of filter criteria.
576 */
577 searchDevices(params: AlexaForBusiness.Types.SearchDevicesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchDevicesResponse) => void): Request<AlexaForBusiness.Types.SearchDevicesResponse, AWSError>;
578 /**
579 * Searches devices and lists the ones that meet a set of filter criteria.
580 */
581 searchDevices(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchDevicesResponse) => void): Request<AlexaForBusiness.Types.SearchDevicesResponse, AWSError>;
582 /**
583 * Searches network profiles and lists the ones that meet a set of filter and sort criteria.
584 */
585 searchNetworkProfiles(params: AlexaForBusiness.Types.SearchNetworkProfilesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchNetworkProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchNetworkProfilesResponse, AWSError>;
586 /**
587 * Searches network profiles and lists the ones that meet a set of filter and sort criteria.
588 */
589 searchNetworkProfiles(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchNetworkProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchNetworkProfilesResponse, AWSError>;
590 /**
591 * Searches room profiles and lists the ones that meet a set of filter criteria.
592 */
593 searchProfiles(params: AlexaForBusiness.Types.SearchProfilesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchProfilesResponse, AWSError>;
594 /**
595 * Searches room profiles and lists the ones that meet a set of filter criteria.
596 */
597 searchProfiles(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchProfilesResponse, AWSError>;
598 /**
599 * Searches rooms and lists the ones that meet a set of filter and sort criteria.
600 */
601 searchRooms(params: AlexaForBusiness.Types.SearchRoomsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchRoomsResponse) => void): Request<AlexaForBusiness.Types.SearchRoomsResponse, AWSError>;
602 /**
603 * Searches rooms and lists the ones that meet a set of filter and sort criteria.
604 */
605 searchRooms(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchRoomsResponse) => void): Request<AlexaForBusiness.Types.SearchRoomsResponse, AWSError>;
606 /**
607 * Searches skill groups and lists the ones that meet a set of filter and sort criteria.
608 */
609 searchSkillGroups(params: AlexaForBusiness.Types.SearchSkillGroupsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchSkillGroupsResponse) => void): Request<AlexaForBusiness.Types.SearchSkillGroupsResponse, AWSError>;
610 /**
611 * Searches skill groups and lists the ones that meet a set of filter and sort criteria.
612 */
613 searchSkillGroups(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchSkillGroupsResponse) => void): Request<AlexaForBusiness.Types.SearchSkillGroupsResponse, AWSError>;
614 /**
615 * Searches users and lists the ones that meet a set of filter and sort criteria.
616 */
617 searchUsers(params: AlexaForBusiness.Types.SearchUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchUsersResponse) => void): Request<AlexaForBusiness.Types.SearchUsersResponse, AWSError>;
618 /**
619 * Searches users and lists the ones that meet a set of filter and sort criteria.
620 */
621 searchUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchUsersResponse) => void): Request<AlexaForBusiness.Types.SearchUsersResponse, AWSError>;
622 /**
623 * Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
624 */
625 sendAnnouncement(params: AlexaForBusiness.Types.SendAnnouncementRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SendAnnouncementResponse) => void): Request<AlexaForBusiness.Types.SendAnnouncementResponse, AWSError>;
626 /**
627 * Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
628 */
629 sendAnnouncement(callback?: (err: AWSError, data: AlexaForBusiness.Types.SendAnnouncementResponse) => void): Request<AlexaForBusiness.Types.SendAnnouncementResponse, AWSError>;
630 /**
631 * Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
632 */
633 sendInvitation(params: AlexaForBusiness.Types.SendInvitationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SendInvitationResponse) => void): Request<AlexaForBusiness.Types.SendInvitationResponse, AWSError>;
634 /**
635 * Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
636 */
637 sendInvitation(callback?: (err: AWSError, data: AlexaForBusiness.Types.SendInvitationResponse) => void): Request<AlexaForBusiness.Types.SendInvitationResponse, AWSError>;
638 /**
639 * Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways: Bluetooth - This unpairs all bluetooth devices paired with your echo device. Volume - This resets the echo device's volume to the default value. Notifications - This clears all notifications from your echo device. Lists - This clears all to-do items from your echo device. Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).
640 */
641 startDeviceSync(params: AlexaForBusiness.Types.StartDeviceSyncRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.StartDeviceSyncResponse) => void): Request<AlexaForBusiness.Types.StartDeviceSyncResponse, AWSError>;
642 /**
643 * Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways: Bluetooth - This unpairs all bluetooth devices paired with your echo device. Volume - This resets the echo device's volume to the default value. Notifications - This clears all notifications from your echo device. Lists - This clears all to-do items from your echo device. Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).
644 */
645 startDeviceSync(callback?: (err: AWSError, data: AlexaForBusiness.Types.StartDeviceSyncResponse) => void): Request<AlexaForBusiness.Types.StartDeviceSyncResponse, AWSError>;
646 /**
647 * Initiates the discovery of any smart home appliances associated with the room.
648 */
649 startSmartHomeApplianceDiscovery(params: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse) => void): Request<AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse, AWSError>;
650 /**
651 * Initiates the discovery of any smart home appliances associated with the room.
652 */
653 startSmartHomeApplianceDiscovery(callback?: (err: AWSError, data: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse) => void): Request<AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse, AWSError>;
654 /**
655 * Adds metadata tags to a specified resource.
656 */
657 tagResource(params: AlexaForBusiness.Types.TagResourceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.TagResourceResponse) => void): Request<AlexaForBusiness.Types.TagResourceResponse, AWSError>;
658 /**
659 * Adds metadata tags to a specified resource.
660 */
661 tagResource(callback?: (err: AWSError, data: AlexaForBusiness.Types.TagResourceResponse) => void): Request<AlexaForBusiness.Types.TagResourceResponse, AWSError>;
662 /**
663 * Removes metadata tags from a specified resource.
664 */
665 untagResource(params: AlexaForBusiness.Types.UntagResourceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UntagResourceResponse) => void): Request<AlexaForBusiness.Types.UntagResourceResponse, AWSError>;
666 /**
667 * Removes metadata tags from a specified resource.
668 */
669 untagResource(callback?: (err: AWSError, data: AlexaForBusiness.Types.UntagResourceResponse) => void): Request<AlexaForBusiness.Types.UntagResourceResponse, AWSError>;
670 /**
671 * Updates address book details by the address book ARN.
672 */
673 updateAddressBook(params: AlexaForBusiness.Types.UpdateAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateAddressBookResponse) => void): Request<AlexaForBusiness.Types.UpdateAddressBookResponse, AWSError>;
674 /**
675 * Updates address book details by the address book ARN.
676 */
677 updateAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateAddressBookResponse) => void): Request<AlexaForBusiness.Types.UpdateAddressBookResponse, AWSError>;
678 /**
679 * Updates the configuration of the report delivery schedule with the specified schedule ARN.
680 */
681 updateBusinessReportSchedule(params: AlexaForBusiness.Types.UpdateBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse, AWSError>;
682 /**
683 * Updates the configuration of the report delivery schedule with the specified schedule ARN.
684 */
685 updateBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse, AWSError>;
686 /**
687 * Updates an existing conference provider's settings.
688 */
689 updateConferenceProvider(params: AlexaForBusiness.Types.UpdateConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.UpdateConferenceProviderResponse, AWSError>;
690 /**
691 * Updates an existing conference provider's settings.
692 */
693 updateConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.UpdateConferenceProviderResponse, AWSError>;
694 /**
695 * Updates the contact details by the contact ARN.
696 */
697 updateContact(params: AlexaForBusiness.Types.UpdateContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateContactResponse) => void): Request<AlexaForBusiness.Types.UpdateContactResponse, AWSError>;
698 /**
699 * Updates the contact details by the contact ARN.
700 */
701 updateContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateContactResponse) => void): Request<AlexaForBusiness.Types.UpdateContactResponse, AWSError>;
702 /**
703 * Updates the device name by device ARN.
704 */
705 updateDevice(params: AlexaForBusiness.Types.UpdateDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateDeviceResponse) => void): Request<AlexaForBusiness.Types.UpdateDeviceResponse, AWSError>;
706 /**
707 * Updates the device name by device ARN.
708 */
709 updateDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateDeviceResponse) => void): Request<AlexaForBusiness.Types.UpdateDeviceResponse, AWSError>;
710 /**
711 * Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
712 */
713 updateGateway(params: AlexaForBusiness.Types.UpdateGatewayRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayResponse) => void): Request<AlexaForBusiness.Types.UpdateGatewayResponse, AWSError>;
714 /**
715 * Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
716 */
717 updateGateway(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayResponse) => void): Request<AlexaForBusiness.Types.UpdateGatewayResponse, AWSError>;
718 /**
719 * Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
720 */
721 updateGatewayGroup(params: AlexaForBusiness.Types.UpdateGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateGatewayGroupResponse, AWSError>;
722 /**
723 * Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
724 */
725 updateGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateGatewayGroupResponse, AWSError>;
726 /**
727 * Updates a network profile by the network profile ARN.
728 */
729 updateNetworkProfile(params: AlexaForBusiness.Types.UpdateNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateNetworkProfileResponse, AWSError>;
730 /**
731 * Updates a network profile by the network profile ARN.
732 */
733 updateNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateNetworkProfileResponse, AWSError>;
734 /**
735 * Updates an existing room profile by room profile ARN.
736 */
737 updateProfile(params: AlexaForBusiness.Types.UpdateProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateProfileResponse, AWSError>;
738 /**
739 * Updates an existing room profile by room profile ARN.
740 */
741 updateProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateProfileResponse, AWSError>;
742 /**
743 * Updates room details by room ARN.
744 */
745 updateRoom(params: AlexaForBusiness.Types.UpdateRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateRoomResponse) => void): Request<AlexaForBusiness.Types.UpdateRoomResponse, AWSError>;
746 /**
747 * Updates room details by room ARN.
748 */
749 updateRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateRoomResponse) => void): Request<AlexaForBusiness.Types.UpdateRoomResponse, AWSError>;
750 /**
751 * Updates skill group details by skill group ARN.
752 */
753 updateSkillGroup(params: AlexaForBusiness.Types.UpdateSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateSkillGroupResponse, AWSError>;
754 /**
755 * Updates skill group details by skill group ARN.
756 */
757 updateSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateSkillGroupResponse, AWSError>;
758}
759declare namespace AlexaForBusiness {
760 export type Address = string;
761 export interface AddressBook {
762 /**
763 * The ARN of the address book.
764 */
765 AddressBookArn?: Arn;
766 /**
767 * The name of the address book.
768 */
769 Name?: AddressBookName;
770 /**
771 * The description of the address book.
772 */
773 Description?: AddressBookDescription;
774 }
775 export interface AddressBookData {
776 /**
777 * The ARN of the address book.
778 */
779 AddressBookArn?: Arn;
780 /**
781 * The name of the address book.
782 */
783 Name?: AddressBookName;
784 /**
785 * The description of the address book.
786 */
787 Description?: AddressBookDescription;
788 }
789 export type AddressBookDataList = AddressBookData[];
790 export type AddressBookDescription = string;
791 export type AddressBookName = string;
792 export type AmazonId = string;
793 export type ApplianceDescription = string;
794 export type ApplianceFriendlyName = string;
795 export type ApplianceManufacturerName = string;
796 export interface ApproveSkillRequest {
797 /**
798 * The unique identifier of the skill.
799 */
800 SkillId: SkillId;
801 }
802 export interface ApproveSkillResponse {
803 }
804 export type Arn = string;
805 export interface AssociateContactWithAddressBookRequest {
806 /**
807 * The ARN of the contact to associate with an address book.
808 */
809 ContactArn: Arn;
810 /**
811 * The ARN of the address book with which to associate the contact.
812 */
813 AddressBookArn: Arn;
814 }
815 export interface AssociateContactWithAddressBookResponse {
816 }
817 export interface AssociateDeviceWithNetworkProfileRequest {
818 /**
819 * The device ARN.
820 */
821 DeviceArn: Arn;
822 /**
823 * The ARN of the network profile to associate with a device.
824 */
825 NetworkProfileArn: Arn;
826 }
827 export interface AssociateDeviceWithNetworkProfileResponse {
828 }
829 export interface AssociateDeviceWithRoomRequest {
830 /**
831 * The ARN of the device to associate to a room. Required.
832 */
833 DeviceArn?: Arn;
834 /**
835 * The ARN of the room with which to associate the device. Required.
836 */
837 RoomArn?: Arn;
838 }
839 export interface AssociateDeviceWithRoomResponse {
840 }
841 export interface AssociateSkillGroupWithRoomRequest {
842 /**
843 * The ARN of the skill group to associate with a room. Required.
844 */
845 SkillGroupArn?: Arn;
846 /**
847 * The ARN of the room with which to associate the skill group. Required.
848 */
849 RoomArn?: Arn;
850 }
851 export interface AssociateSkillGroupWithRoomResponse {
852 }
853 export interface AssociateSkillWithSkillGroupRequest {
854 /**
855 * The ARN of the skill group to associate the skill to. Required.
856 */
857 SkillGroupArn?: Arn;
858 /**
859 * The unique identifier of the skill.
860 */
861 SkillId: SkillId;
862 }
863 export interface AssociateSkillWithSkillGroupResponse {
864 }
865 export interface AssociateSkillWithUsersRequest {
866 /**
867 * The private skill ID you want to make available to enrolled users.
868 */
869 SkillId: SkillId;
870 }
871 export interface AssociateSkillWithUsersResponse {
872 }
873 export interface Audio {
874 /**
875 * The locale of the audio message. Currently, en-US is supported.
876 */
877 Locale: Locale;
878 /**
879 * The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.
880 */
881 Location: AudioLocation;
882 }
883 export type AudioList = Audio[];
884 export type AudioLocation = string;
885 export type AuthorizationResult = {[key: string]: Value};
886 export type Boolean = boolean;
887 export type BulletPoint = string;
888 export type BulletPoints = BulletPoint[];
889 export interface BusinessReport {
890 /**
891 * The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
892 */
893 Status?: BusinessReportStatus;
894 /**
895 * The failure code.
896 */
897 FailureCode?: BusinessReportFailureCode;
898 /**
899 * The S3 location of the output reports.
900 */
901 S3Location?: BusinessReportS3Location;
902 /**
903 * The time of report delivery.
904 */
905 DeliveryTime?: BusinessReportDeliveryTime;
906 /**
907 * The download link where a user can download the report.
908 */
909 DownloadUrl?: BusinessReportDownloadUrl;
910 }
911 export interface BusinessReportContentRange {
912 /**
913 * The interval of the content range.
914 */
915 Interval?: BusinessReportInterval;
916 }
917 export type BusinessReportDeliveryTime = Date;
918 export type BusinessReportDownloadUrl = string;
919 export type BusinessReportFailureCode = "ACCESS_DENIED"|"NO_SUCH_BUCKET"|"INTERNAL_FAILURE"|string;
920 export type BusinessReportFormat = "CSV"|"CSV_ZIP"|string;
921 export type BusinessReportInterval = "ONE_DAY"|"ONE_WEEK"|"THIRTY_DAYS"|string;
922 export interface BusinessReportRecurrence {
923 /**
924 * The start date.
925 */
926 StartDate?: _Date;
927 }
928 export interface BusinessReportS3Location {
929 /**
930 * The path of the business report.
931 */
932 Path?: BusinessReportS3Path;
933 /**
934 * The S3 bucket name of the output reports.
935 */
936 BucketName?: CustomerS3BucketName;
937 }
938 export type BusinessReportS3Path = string;
939 export interface BusinessReportSchedule {
940 /**
941 * The ARN of the business report schedule.
942 */
943 ScheduleArn?: Arn;
944 /**
945 * The name identifier of the schedule.
946 */
947 ScheduleName?: BusinessReportScheduleName;
948 /**
949 * The S3 bucket name of the output reports.
950 */
951 S3BucketName?: CustomerS3BucketName;
952 /**
953 * The S3 key where the report is delivered.
954 */
955 S3KeyPrefix?: S3KeyPrefix;
956 /**
957 * The format of the generated report (individual CSV files or zipped files of individual files).
958 */
959 Format?: BusinessReportFormat;
960 /**
961 * The content range of the reports.
962 */
963 ContentRange?: BusinessReportContentRange;
964 /**
965 * The recurrence of the reports.
966 */
967 Recurrence?: BusinessReportRecurrence;
968 /**
969 * The details of the last business report delivery for a specified time interval.
970 */
971 LastBusinessReport?: BusinessReport;
972 }
973 export type BusinessReportScheduleList = BusinessReportSchedule[];
974 export type BusinessReportScheduleName = string;
975 export type BusinessReportStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|string;
976 export interface Category {
977 /**
978 * The ID of the skill store category.
979 */
980 CategoryId?: CategoryId;
981 /**
982 * The name of the skill store category.
983 */
984 CategoryName?: CategoryName;
985 }
986 export type CategoryId = number;
987 export type CategoryList = Category[];
988 export type CategoryName = string;
989 export type CertificateTime = Date;
990 export type ClientId = string;
991 export type ClientRequestToken = string;
992 export type CommsProtocol = "SIP"|"SIPS"|"H323"|string;
993 export interface ConferencePreference {
994 /**
995 * The ARN of the default conference provider.
996 */
997 DefaultConferenceProviderArn?: Arn;
998 }
999 export interface ConferenceProvider {
1000 /**
1001 * The ARN of the newly created conference provider.
1002 */
1003 Arn?: Arn;
1004 /**
1005 * The name of the conference provider.
1006 */
1007 Name?: ConferenceProviderName;
1008 /**
1009 * The type of conference providers.
1010 */
1011 Type?: ConferenceProviderType;
1012 /**
1013 * The IP endpoint and protocol for calling.
1014 */
1015 IPDialIn?: IPDialIn;
1016 /**
1017 * The information for PSTN conferencing.
1018 */
1019 PSTNDialIn?: PSTNDialIn;
1020 /**
1021 * The meeting settings for the conference provider.
1022 */
1023 MeetingSetting?: MeetingSetting;
1024 }
1025 export type ConferenceProviderName = string;
1026 export type ConferenceProviderType = "CHIME"|"BLUEJEANS"|"FUZE"|"GOOGLE_HANGOUTS"|"POLYCOM"|"RINGCENTRAL"|"SKYPE_FOR_BUSINESS"|"WEBEX"|"ZOOM"|"CUSTOM"|string;
1027 export type ConferenceProvidersList = ConferenceProvider[];
1028 export type ConnectionStatus = "ONLINE"|"OFFLINE"|string;
1029 export type ConnectionStatusUpdatedTime = Date;
1030 export interface Contact {
1031 /**
1032 * The ARN of the contact.
1033 */
1034 ContactArn?: Arn;
1035 /**
1036 * The name of the contact to display on the console.
1037 */
1038 DisplayName?: ContactName;
1039 /**
1040 * The first name of the contact, used to call the contact on the device.
1041 */
1042 FirstName?: ContactName;
1043 /**
1044 * The last name of the contact, used to call the contact on the device.
1045 */
1046 LastName?: ContactName;
1047 /**
1048 * The phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
1049 */
1050 PhoneNumber?: RawPhoneNumber;
1051 /**
1052 * The list of phone numbers for the contact.
1053 */
1054 PhoneNumbers?: PhoneNumberList;
1055 /**
1056 * The list of SIP addresses for the contact.
1057 */
1058 SipAddresses?: SipAddressList;
1059 }
1060 export interface ContactData {
1061 /**
1062 * The ARN of the contact.
1063 */
1064 ContactArn?: Arn;
1065 /**
1066 * The name of the contact to display on the console.
1067 */
1068 DisplayName?: ContactName;
1069 /**
1070 * The first name of the contact, used to call the contact on the device.
1071 */
1072 FirstName?: ContactName;
1073 /**
1074 * The last name of the contact, used to call the contact on the device.
1075 */
1076 LastName?: ContactName;
1077 /**
1078 * The phone number of the contact. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
1079 */
1080 PhoneNumber?: RawPhoneNumber;
1081 /**
1082 * The list of phone numbers for the contact.
1083 */
1084 PhoneNumbers?: PhoneNumberList;
1085 /**
1086 * The list of SIP addresses for the contact.
1087 */
1088 SipAddresses?: SipAddressList;
1089 }
1090 export type ContactDataList = ContactData[];
1091 export type ContactName = string;
1092 export interface Content {
1093 /**
1094 * The list of text messages.
1095 */
1096 TextList?: TextList;
1097 /**
1098 * The list of SSML messages.
1099 */
1100 SsmlList?: SsmlList;
1101 /**
1102 * The list of audio messages.
1103 */
1104 AudioList?: AudioList;
1105 }
1106 export type CountryCode = string;
1107 export interface CreateAddressBookRequest {
1108 /**
1109 * The name of the address book.
1110 */
1111 Name: AddressBookName;
1112 /**
1113 * The description of the address book.
1114 */
1115 Description?: AddressBookDescription;
1116 /**
1117 * A unique, user-specified identifier for the request that ensures idempotency.
1118 */
1119 ClientRequestToken?: ClientRequestToken;
1120 }
1121 export interface CreateAddressBookResponse {
1122 /**
1123 * The ARN of the newly created address book.
1124 */
1125 AddressBookArn?: Arn;
1126 }
1127 export interface CreateBusinessReportScheduleRequest {
1128 /**
1129 * The name identifier of the schedule.
1130 */
1131 ScheduleName?: BusinessReportScheduleName;
1132 /**
1133 * 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.
1134 */
1135 S3BucketName?: CustomerS3BucketName;
1136 /**
1137 * The S3 key where the report is delivered.
1138 */
1139 S3KeyPrefix?: S3KeyPrefix;
1140 /**
1141 * The format of the generated report (individual CSV files or zipped files of individual files).
1142 */
1143 Format: BusinessReportFormat;
1144 /**
1145 * The content range of the reports.
1146 */
1147 ContentRange: BusinessReportContentRange;
1148 /**
1149 * The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
1150 */
1151 Recurrence?: BusinessReportRecurrence;
1152 /**
1153 * The client request token.
1154 */
1155 ClientRequestToken?: ClientRequestToken;
1156 }
1157 export interface CreateBusinessReportScheduleResponse {
1158 /**
1159 * The ARN of the business report schedule.
1160 */
1161 ScheduleArn?: Arn;
1162 }
1163 export interface CreateConferenceProviderRequest {
1164 /**
1165 * The name of the conference provider.
1166 */
1167 ConferenceProviderName: ConferenceProviderName;
1168 /**
1169 * Represents a type within a list of predefined types.
1170 */
1171 ConferenceProviderType: ConferenceProviderType;
1172 /**
1173 * The IP endpoint and protocol for calling.
1174 */
1175 IPDialIn?: IPDialIn;
1176 /**
1177 * The information for PSTN conferencing.
1178 */
1179 PSTNDialIn?: PSTNDialIn;
1180 /**
1181 * The meeting settings for the conference provider.
1182 */
1183 MeetingSetting: MeetingSetting;
1184 /**
1185 * The request token of the client.
1186 */
1187 ClientRequestToken?: ClientRequestToken;
1188 }
1189 export interface CreateConferenceProviderResponse {
1190 /**
1191 * The ARN of the newly-created conference provider.
1192 */
1193 ConferenceProviderArn?: Arn;
1194 }
1195 export interface CreateContactRequest {
1196 /**
1197 * The name of the contact to display on the console.
1198 */
1199 DisplayName?: ContactName;
1200 /**
1201 * The first name of the contact that is used to call the contact on the device.
1202 */
1203 FirstName: ContactName;
1204 /**
1205 * The last name of the contact that is used to call the contact on the device.
1206 */
1207 LastName?: ContactName;
1208 /**
1209 * The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
1210 */
1211 PhoneNumber?: RawPhoneNumber;
1212 /**
1213 * The list of phone numbers for the contact.
1214 */
1215 PhoneNumbers?: PhoneNumberList;
1216 /**
1217 * The list of SIP addresses for the contact.
1218 */
1219 SipAddresses?: SipAddressList;
1220 /**
1221 * A unique, user-specified identifier for this request that ensures idempotency.
1222 */
1223 ClientRequestToken?: ClientRequestToken;
1224 }
1225 export interface CreateContactResponse {
1226 /**
1227 * The ARN of the newly created address book.
1228 */
1229 ContactArn?: Arn;
1230 }
1231 export interface CreateEndOfMeetingReminder {
1232 /**
1233 * A range of 3 to 15 minutes that determines when the reminder begins.
1234 */
1235 ReminderAtMinutes: EndOfMeetingReminderMinutesList;
1236 /**
1237 * The type of sound that users hear during the end of meeting reminder.
1238 */
1239 ReminderType: EndOfMeetingReminderType;
1240 /**
1241 * Whether an end of meeting reminder is enabled or not.
1242 */
1243 Enabled: Boolean;
1244 }
1245 export interface CreateGatewayGroupRequest {
1246 /**
1247 * The name of the gateway group.
1248 */
1249 Name: GatewayGroupName;
1250 /**
1251 * The description of the gateway group.
1252 */
1253 Description?: GatewayGroupDescription;
1254 /**
1255 * A unique, user-specified identifier for the request that ensures idempotency.
1256 */
1257 ClientRequestToken: ClientRequestToken;
1258 }
1259 export interface CreateGatewayGroupResponse {
1260 /**
1261 * The ARN of the created gateway group.
1262 */
1263 GatewayGroupArn?: Arn;
1264 }
1265 export interface CreateInstantBooking {
1266 /**
1267 * Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
1268 */
1269 DurationInMinutes: Minutes;
1270 /**
1271 * Whether instant booking is enabled or not.
1272 */
1273 Enabled: Boolean;
1274 }
1275 export interface CreateMeetingRoomConfiguration {
1276 /**
1277 * Whether room utilization metrics are enabled or not.
1278 */
1279 RoomUtilizationMetricsEnabled?: Boolean;
1280 EndOfMeetingReminder?: CreateEndOfMeetingReminder;
1281 /**
1282 * Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.
1283 */
1284 InstantBooking?: CreateInstantBooking;
1285 /**
1286 * Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
1287 */
1288 RequireCheckIn?: CreateRequireCheckIn;
1289 }
1290 export interface CreateNetworkProfileRequest {
1291 /**
1292 * The name of the network profile associated with a device.
1293 */
1294 NetworkProfileName: NetworkProfileName;
1295 /**
1296 * Detailed information about a device's network profile.
1297 */
1298 Description?: NetworkProfileDescription;
1299 /**
1300 * The SSID of the Wi-Fi network.
1301 */
1302 Ssid: NetworkSsid;
1303 /**
1304 * The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
1305 */
1306 SecurityType: NetworkSecurityType;
1307 /**
1308 * The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
1309 */
1310 EapMethod?: NetworkEapMethod;
1311 /**
1312 * The current password of the Wi-Fi network.
1313 */
1314 CurrentPassword?: CurrentWiFiPassword;
1315 /**
1316 * The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
1317 */
1318 NextPassword?: NextWiFiPassword;
1319 /**
1320 * The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
1321 */
1322 CertificateAuthorityArn?: Arn;
1323 /**
1324 * The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.
1325 */
1326 TrustAnchors?: TrustAnchorList;
1327 ClientRequestToken: ClientRequestToken;
1328 }
1329 export interface CreateNetworkProfileResponse {
1330 /**
1331 * The ARN of the network profile associated with a device.
1332 */
1333 NetworkProfileArn?: Arn;
1334 }
1335 export interface CreateProfileRequest {
1336 /**
1337 * The name of a room profile.
1338 */
1339 ProfileName: ProfileName;
1340 /**
1341 * The time zone used by a room profile.
1342 */
1343 Timezone: Timezone;
1344 /**
1345 * The valid address for the room.
1346 */
1347 Address: Address;
1348 /**
1349 * The distance unit to be used by devices in the profile.
1350 */
1351 DistanceUnit: DistanceUnit;
1352 /**
1353 * The temperature unit to be used by devices in the profile.
1354 */
1355 TemperatureUnit: TemperatureUnit;
1356 /**
1357 * A wake word for Alexa, Echo, Amazon, or a computer.
1358 */
1359 WakeWord: WakeWord;
1360 /**
1361 * The locale of the room profile. (This is currently only available to a limited preview audience.)
1362 */
1363 Locale?: DeviceLocale;
1364 /**
1365 * The user-specified token that is used during the creation of a profile.
1366 */
1367 ClientRequestToken?: ClientRequestToken;
1368 /**
1369 * Whether room profile setup is enabled.
1370 */
1371 SetupModeDisabled?: Boolean;
1372 /**
1373 * The maximum volume limit for a room profile.
1374 */
1375 MaxVolumeLimit?: MaxVolumeLimit;
1376 /**
1377 * Whether PSTN calling is enabled.
1378 */
1379 PSTNEnabled?: Boolean;
1380 /**
1381 * The meeting room settings of a room profile.
1382 */
1383 MeetingRoomConfiguration?: CreateMeetingRoomConfiguration;
1384 }
1385 export interface CreateProfileResponse {
1386 /**
1387 * The ARN of the newly created room profile in the response.
1388 */
1389 ProfileArn?: Arn;
1390 }
1391 export interface CreateRequireCheckIn {
1392 /**
1393 * Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
1394 */
1395 ReleaseAfterMinutes: Minutes;
1396 /**
1397 * Whether require check in is enabled or not.
1398 */
1399 Enabled: Boolean;
1400 }
1401 export interface CreateRoomRequest {
1402 /**
1403 * The name for the room.
1404 */
1405 RoomName: RoomName;
1406 /**
1407 * The description for the room.
1408 */
1409 Description?: RoomDescription;
1410 /**
1411 * The profile ARN for the room.
1412 */
1413 ProfileArn?: Arn;
1414 /**
1415 * The calendar ARN for the room.
1416 */
1417 ProviderCalendarId?: ProviderCalendarId;
1418 /**
1419 * A unique, user-specified identifier for this request that ensures idempotency.
1420 */
1421 ClientRequestToken?: ClientRequestToken;
1422 /**
1423 * The tags for the room.
1424 */
1425 Tags?: TagList;
1426 }
1427 export interface CreateRoomResponse {
1428 /**
1429 * The ARN of the newly created room in the response.
1430 */
1431 RoomArn?: Arn;
1432 }
1433 export interface CreateSkillGroupRequest {
1434 /**
1435 * The name for the skill group.
1436 */
1437 SkillGroupName: SkillGroupName;
1438 /**
1439 * The description for the skill group.
1440 */
1441 Description?: SkillGroupDescription;
1442 /**
1443 * A unique, user-specified identifier for this request that ensures idempotency.
1444 */
1445 ClientRequestToken?: ClientRequestToken;
1446 }
1447 export interface CreateSkillGroupResponse {
1448 /**
1449 * The ARN of the newly created skill group in the response.
1450 */
1451 SkillGroupArn?: Arn;
1452 }
1453 export interface CreateUserRequest {
1454 /**
1455 * The ARN for the user.
1456 */
1457 UserId: user_UserId;
1458 /**
1459 * The first name for the user.
1460 */
1461 FirstName?: user_FirstName;
1462 /**
1463 * The last name for the user.
1464 */
1465 LastName?: user_LastName;
1466 /**
1467 * The email address for the user.
1468 */
1469 Email?: Email;
1470 /**
1471 * A unique, user-specified identifier for this request that ensures idempotency.
1472 */
1473 ClientRequestToken?: ClientRequestToken;
1474 /**
1475 * The tags for the user.
1476 */
1477 Tags?: TagList;
1478 }
1479 export interface CreateUserResponse {
1480 /**
1481 * The ARN of the newly created user in the response.
1482 */
1483 UserArn?: Arn;
1484 }
1485 export type CurrentWiFiPassword = string;
1486 export type CustomerS3BucketName = string;
1487 export type _Date = string;
1488 export interface DeleteAddressBookRequest {
1489 /**
1490 * The ARN of the address book to delete.
1491 */
1492 AddressBookArn: Arn;
1493 }
1494 export interface DeleteAddressBookResponse {
1495 }
1496 export interface DeleteBusinessReportScheduleRequest {
1497 /**
1498 * The ARN of the business report schedule.
1499 */
1500 ScheduleArn: Arn;
1501 }
1502 export interface DeleteBusinessReportScheduleResponse {
1503 }
1504 export interface DeleteConferenceProviderRequest {
1505 /**
1506 * The ARN of the conference provider.
1507 */
1508 ConferenceProviderArn: Arn;
1509 }
1510 export interface DeleteConferenceProviderResponse {
1511 }
1512 export interface DeleteContactRequest {
1513 /**
1514 * The ARN of the contact to delete.
1515 */
1516 ContactArn: Arn;
1517 }
1518 export interface DeleteContactResponse {
1519 }
1520 export interface DeleteDeviceRequest {
1521 /**
1522 * The ARN of the device for which to request details.
1523 */
1524 DeviceArn: Arn;
1525 }
1526 export interface DeleteDeviceResponse {
1527 }
1528 export interface DeleteDeviceUsageDataRequest {
1529 /**
1530 * The ARN of the device.
1531 */
1532 DeviceArn: Arn;
1533 /**
1534 * The type of usage data to delete.
1535 */
1536 DeviceUsageType: DeviceUsageType;
1537 }
1538 export interface DeleteDeviceUsageDataResponse {
1539 }
1540 export interface DeleteGatewayGroupRequest {
1541 /**
1542 * The ARN of the gateway group to delete.
1543 */
1544 GatewayGroupArn: Arn;
1545 }
1546 export interface DeleteGatewayGroupResponse {
1547 }
1548 export interface DeleteNetworkProfileRequest {
1549 /**
1550 * The ARN of the network profile associated with a device.
1551 */
1552 NetworkProfileArn: Arn;
1553 }
1554 export interface DeleteNetworkProfileResponse {
1555 }
1556 export interface DeleteProfileRequest {
1557 /**
1558 * The ARN of the room profile to delete. Required.
1559 */
1560 ProfileArn?: Arn;
1561 }
1562 export interface DeleteProfileResponse {
1563 }
1564 export interface DeleteRoomRequest {
1565 /**
1566 * The ARN of the room to delete. Required.
1567 */
1568 RoomArn?: Arn;
1569 }
1570 export interface DeleteRoomResponse {
1571 }
1572 export interface DeleteRoomSkillParameterRequest {
1573 /**
1574 * The ARN of the room from which to remove the room skill parameter details.
1575 */
1576 RoomArn?: Arn;
1577 /**
1578 * The ID of the skill from which to remove the room skill parameter details.
1579 */
1580 SkillId: SkillId;
1581 /**
1582 * The room skill parameter key for which to remove details.
1583 */
1584 ParameterKey: RoomSkillParameterKey;
1585 }
1586 export interface DeleteRoomSkillParameterResponse {
1587 }
1588 export interface DeleteSkillAuthorizationRequest {
1589 /**
1590 * The unique identifier of a skill.
1591 */
1592 SkillId: SkillId;
1593 /**
1594 * The room that the skill is authorized for.
1595 */
1596 RoomArn?: Arn;
1597 }
1598 export interface DeleteSkillAuthorizationResponse {
1599 }
1600 export interface DeleteSkillGroupRequest {
1601 /**
1602 * The ARN of the skill group to delete. Required.
1603 */
1604 SkillGroupArn?: Arn;
1605 }
1606 export interface DeleteSkillGroupResponse {
1607 }
1608 export interface DeleteUserRequest {
1609 /**
1610 * The ARN of the user to delete in the organization. Required.
1611 */
1612 UserArn?: Arn;
1613 /**
1614 * The ARN of the user's enrollment in the organization. Required.
1615 */
1616 EnrollmentId: EnrollmentId;
1617 }
1618 export interface DeleteUserResponse {
1619 }
1620 export interface DeveloperInfo {
1621 /**
1622 * The name of the developer.
1623 */
1624 DeveloperName?: DeveloperName;
1625 /**
1626 * The URL of the privacy policy.
1627 */
1628 PrivacyPolicy?: PrivacyPolicy;
1629 /**
1630 * The email of the developer.
1631 */
1632 Email?: Email;
1633 /**
1634 * The website of the developer.
1635 */
1636 Url?: Url;
1637 }
1638 export type DeveloperName = string;
1639 export interface Device {
1640 /**
1641 * The ARN of a device.
1642 */
1643 DeviceArn?: Arn;
1644 /**
1645 * The serial number of a device.
1646 */
1647 DeviceSerialNumber?: DeviceSerialNumber;
1648 /**
1649 * The type of a device.
1650 */
1651 DeviceType?: DeviceType;
1652 /**
1653 * The name of a device.
1654 */
1655 DeviceName?: DeviceName;
1656 /**
1657 * The software version of a device.
1658 */
1659 SoftwareVersion?: SoftwareVersion;
1660 /**
1661 * The MAC address of a device.
1662 */
1663 MacAddress?: MacAddress;
1664 /**
1665 * The room ARN of a device.
1666 */
1667 RoomArn?: Arn;
1668 /**
1669 * The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
1670 */
1671 DeviceStatus?: DeviceStatus;
1672 /**
1673 * Detailed information about a device's status.
1674 */
1675 DeviceStatusInfo?: DeviceStatusInfo;
1676 /**
1677 * Detailed information about a device's network profile.
1678 */
1679 NetworkProfileInfo?: DeviceNetworkProfileInfo;
1680 }
1681 export interface DeviceData {
1682 /**
1683 * The ARN of a device.
1684 */
1685 DeviceArn?: Arn;
1686 /**
1687 * The serial number of a device.
1688 */
1689 DeviceSerialNumber?: DeviceSerialNumber;
1690 /**
1691 * The type of a device.
1692 */
1693 DeviceType?: DeviceType;
1694 /**
1695 * The name of a device.
1696 */
1697 DeviceName?: DeviceName;
1698 /**
1699 * The software version of a device.
1700 */
1701 SoftwareVersion?: SoftwareVersion;
1702 /**
1703 * The MAC address of a device.
1704 */
1705 MacAddress?: MacAddress;
1706 /**
1707 * The status of a device.
1708 */
1709 DeviceStatus?: DeviceStatus;
1710 /**
1711 * The ARN of the network profile associated with a device.
1712 */
1713 NetworkProfileArn?: Arn;
1714 /**
1715 * The name of the network profile associated with a device.
1716 */
1717 NetworkProfileName?: NetworkProfileName;
1718 /**
1719 * The room ARN associated with a device.
1720 */
1721 RoomArn?: Arn;
1722 /**
1723 * The name of the room associated with a device.
1724 */
1725 RoomName?: RoomName;
1726 /**
1727 * Detailed information about a device's status.
1728 */
1729 DeviceStatusInfo?: DeviceStatusInfo;
1730 /**
1731 * The time (in epoch) when the device data was created.
1732 */
1733 CreatedTime?: DeviceDataCreatedTime;
1734 }
1735 export type DeviceDataCreatedTime = Date;
1736 export type DeviceDataList = DeviceData[];
1737 export interface DeviceEvent {
1738 /**
1739 * The type of device event.
1740 */
1741 Type?: DeviceEventType;
1742 /**
1743 * The value of the event.
1744 */
1745 Value?: DeviceEventValue;
1746 /**
1747 * The time (in epoch) when the event occurred.
1748 */
1749 Timestamp?: DeviceEventTime;
1750 }
1751 export type DeviceEventList = DeviceEvent[];
1752 export type DeviceEventTime = Date;
1753 export type DeviceEventType = "CONNECTION_STATUS"|"DEVICE_STATUS"|string;
1754 export type DeviceEventValue = string;
1755 export type DeviceLocale = string;
1756 export type DeviceName = string;
1757 export interface DeviceNetworkProfileInfo {
1758 /**
1759 * The ARN of the network profile associated with a device.
1760 */
1761 NetworkProfileArn?: Arn;
1762 /**
1763 * The ARN of the certificate associated with a device.
1764 */
1765 CertificateArn?: Arn;
1766 /**
1767 * The time (in epoch) when the certificate expires.
1768 */
1769 CertificateExpirationTime?: CertificateTime;
1770 }
1771 export type DeviceSerialNumber = string;
1772 export type DeviceSerialNumberForAVS = string;
1773 export type DeviceStatus = "READY"|"PENDING"|"WAS_OFFLINE"|"DEREGISTERED"|"FAILED"|string;
1774 export interface DeviceStatusDetail {
1775 /**
1776 * The list of available features on the device.
1777 */
1778 Feature?: Feature;
1779 /**
1780 * The device status detail code.
1781 */
1782 Code?: DeviceStatusDetailCode;
1783 }
1784 export type DeviceStatusDetailCode = "DEVICE_SOFTWARE_UPDATE_NEEDED"|"DEVICE_WAS_OFFLINE"|"CREDENTIALS_ACCESS_FAILURE"|"TLS_VERSION_MISMATCH"|"ASSOCIATION_REJECTION"|"AUTHENTICATION_FAILURE"|"DHCP_FAILURE"|"INTERNET_UNAVAILABLE"|"DNS_FAILURE"|"UNKNOWN_FAILURE"|"CERTIFICATE_ISSUING_LIMIT_EXCEEDED"|"INVALID_CERTIFICATE_AUTHORITY"|"NETWORK_PROFILE_NOT_FOUND"|"INVALID_PASSWORD_STATE"|"PASSWORD_NOT_FOUND"|string;
1785 export type DeviceStatusDetails = DeviceStatusDetail[];
1786 export interface DeviceStatusInfo {
1787 /**
1788 * One or more device status detail descriptions.
1789 */
1790 DeviceStatusDetails?: DeviceStatusDetails;
1791 /**
1792 * The latest available information about the connection status of a device.
1793 */
1794 ConnectionStatus?: ConnectionStatus;
1795 /**
1796 * The time (in epoch) when the device connection status changed.
1797 */
1798 ConnectionStatusUpdatedTime?: ConnectionStatusUpdatedTime;
1799 }
1800 export type DeviceType = string;
1801 export type DeviceUsageType = "VOICE"|string;
1802 export interface DisassociateContactFromAddressBookRequest {
1803 /**
1804 * The ARN of the contact to disassociate from an address book.
1805 */
1806 ContactArn: Arn;
1807 /**
1808 * The ARN of the address from which to disassociate the contact.
1809 */
1810 AddressBookArn: Arn;
1811 }
1812 export interface DisassociateContactFromAddressBookResponse {
1813 }
1814 export interface DisassociateDeviceFromRoomRequest {
1815 /**
1816 * The ARN of the device to disassociate from a room. Required.
1817 */
1818 DeviceArn?: Arn;
1819 }
1820 export interface DisassociateDeviceFromRoomResponse {
1821 }
1822 export interface DisassociateSkillFromSkillGroupRequest {
1823 /**
1824 * The unique identifier of a skill. Required.
1825 */
1826 SkillGroupArn?: Arn;
1827 /**
1828 * The ARN of a skill group to associate to a skill.
1829 */
1830 SkillId: SkillId;
1831 }
1832 export interface DisassociateSkillFromSkillGroupResponse {
1833 }
1834 export interface DisassociateSkillFromUsersRequest {
1835 /**
1836 * The private skill ID you want to make unavailable for enrolled users.
1837 */
1838 SkillId: SkillId;
1839 }
1840 export interface DisassociateSkillFromUsersResponse {
1841 }
1842 export interface DisassociateSkillGroupFromRoomRequest {
1843 /**
1844 * The ARN of the skill group to disassociate from a room. Required.
1845 */
1846 SkillGroupArn?: Arn;
1847 /**
1848 * The ARN of the room from which the skill group is to be disassociated. Required.
1849 */
1850 RoomArn?: Arn;
1851 }
1852 export interface DisassociateSkillGroupFromRoomResponse {
1853 }
1854 export type DistanceUnit = "METRIC"|"IMPERIAL"|string;
1855 export type Email = string;
1856 export type EnablementType = "ENABLED"|"PENDING"|string;
1857 export type EnablementTypeFilter = "ENABLED"|"PENDING"|string;
1858 export interface EndOfMeetingReminder {
1859 /**
1860 * A range of 3 to 15 minutes that determines when the reminder begins.
1861 */
1862 ReminderAtMinutes?: EndOfMeetingReminderMinutesList;
1863 /**
1864 * The type of sound that users hear during the end of meeting reminder.
1865 */
1866 ReminderType?: EndOfMeetingReminderType;
1867 /**
1868 * Whether an end of meeting reminder is enabled or not.
1869 */
1870 Enabled?: Boolean;
1871 }
1872 export type EndOfMeetingReminderMinutesList = Minutes[];
1873 export type EndOfMeetingReminderType = "ANNOUNCEMENT_TIME_CHECK"|"ANNOUNCEMENT_VARIABLE_TIME_LEFT"|"CHIME"|"KNOCK"|string;
1874 export type EndUserLicenseAgreement = string;
1875 export type Endpoint = string;
1876 export type EnrollmentId = string;
1877 export type EnrollmentStatus = "INITIALIZED"|"PENDING"|"REGISTERED"|"DISASSOCIATING"|"DEREGISTERING"|string;
1878 export type Feature = "BLUETOOTH"|"VOLUME"|"NOTIFICATIONS"|"LISTS"|"SKILLS"|"NETWORK_PROFILE"|"SETTINGS"|"ALL"|string;
1879 export type Features = Feature[];
1880 export interface Filter {
1881 /**
1882 * The key of a filter.
1883 */
1884 Key: FilterKey;
1885 /**
1886 * The values of a filter.
1887 */
1888 Values: FilterValueList;
1889 }
1890 export type FilterKey = string;
1891 export type FilterList = Filter[];
1892 export type FilterValue = string;
1893 export type FilterValueList = FilterValue[];
1894 export interface ForgetSmartHomeAppliancesRequest {
1895 /**
1896 * The room that the appliances are associated with.
1897 */
1898 RoomArn: Arn;
1899 }
1900 export interface ForgetSmartHomeAppliancesResponse {
1901 }
1902 export interface Gateway {
1903 /**
1904 * The ARN of the gateway.
1905 */
1906 Arn?: Arn;
1907 /**
1908 * The name of the gateway.
1909 */
1910 Name?: GatewayName;
1911 /**
1912 * The description of the gateway.
1913 */
1914 Description?: GatewayDescription;
1915 /**
1916 * The ARN of the gateway group that the gateway is associated to.
1917 */
1918 GatewayGroupArn?: Arn;
1919 /**
1920 * The software version of the gateway. The gateway automatically updates its software version during normal operation.
1921 */
1922 SoftwareVersion?: GatewayVersion;
1923 }
1924 export type GatewayDescription = string;
1925 export interface GatewayGroup {
1926 /**
1927 * The ARN of the gateway group.
1928 */
1929 Arn?: Arn;
1930 /**
1931 * The name of the gateway group.
1932 */
1933 Name?: GatewayGroupName;
1934 /**
1935 * The description of the gateway group.
1936 */
1937 Description?: GatewayGroupDescription;
1938 }
1939 export type GatewayGroupDescription = string;
1940 export type GatewayGroupName = string;
1941 export type GatewayGroupSummaries = GatewayGroupSummary[];
1942 export interface GatewayGroupSummary {
1943 /**
1944 * The ARN of the gateway group.
1945 */
1946 Arn?: Arn;
1947 /**
1948 * The name of the gateway group.
1949 */
1950 Name?: GatewayGroupName;
1951 /**
1952 * The description of the gateway group.
1953 */
1954 Description?: GatewayGroupDescription;
1955 }
1956 export type GatewayName = string;
1957 export type GatewaySummaries = GatewaySummary[];
1958 export interface GatewaySummary {
1959 /**
1960 * The ARN of the gateway.
1961 */
1962 Arn?: Arn;
1963 /**
1964 * The name of the gateway.
1965 */
1966 Name?: GatewayName;
1967 /**
1968 * The description of the gateway.
1969 */
1970 Description?: GatewayDescription;
1971 /**
1972 * The ARN of the gateway group that the gateway is associated to.
1973 */
1974 GatewayGroupArn?: Arn;
1975 /**
1976 * The software version of the gateway. The gateway automatically updates its software version during normal operation.
1977 */
1978 SoftwareVersion?: GatewayVersion;
1979 }
1980 export type GatewayVersion = string;
1981 export type GenericKeyword = string;
1982 export type GenericKeywords = GenericKeyword[];
1983 export interface GetAddressBookRequest {
1984 /**
1985 * The ARN of the address book for which to request details.
1986 */
1987 AddressBookArn: Arn;
1988 }
1989 export interface GetAddressBookResponse {
1990 /**
1991 * The details of the requested address book.
1992 */
1993 AddressBook?: AddressBook;
1994 }
1995 export interface GetConferencePreferenceRequest {
1996 }
1997 export interface GetConferencePreferenceResponse {
1998 /**
1999 * The conference preference.
2000 */
2001 Preference?: ConferencePreference;
2002 }
2003 export interface GetConferenceProviderRequest {
2004 /**
2005 * The ARN of the newly created conference provider.
2006 */
2007 ConferenceProviderArn: Arn;
2008 }
2009 export interface GetConferenceProviderResponse {
2010 /**
2011 * The conference provider.
2012 */
2013 ConferenceProvider?: ConferenceProvider;
2014 }
2015 export interface GetContactRequest {
2016 /**
2017 * The ARN of the contact for which to request details.
2018 */
2019 ContactArn: Arn;
2020 }
2021 export interface GetContactResponse {
2022 /**
2023 * The details of the requested contact.
2024 */
2025 Contact?: Contact;
2026 }
2027 export interface GetDeviceRequest {
2028 /**
2029 * The ARN of the device for which to request details. Required.
2030 */
2031 DeviceArn?: Arn;
2032 }
2033 export interface GetDeviceResponse {
2034 /**
2035 * The details of the device requested. Required.
2036 */
2037 Device?: Device;
2038 }
2039 export interface GetGatewayGroupRequest {
2040 /**
2041 * The ARN of the gateway group to get.
2042 */
2043 GatewayGroupArn: Arn;
2044 }
2045 export interface GetGatewayGroupResponse {
2046 GatewayGroup?: GatewayGroup;
2047 }
2048 export interface GetGatewayRequest {
2049 /**
2050 * The ARN of the gateway to get.
2051 */
2052 GatewayArn: Arn;
2053 }
2054 export interface GetGatewayResponse {
2055 /**
2056 * The details of the gateway.
2057 */
2058 Gateway?: Gateway;
2059 }
2060 export interface GetInvitationConfigurationRequest {
2061 }
2062 export interface GetInvitationConfigurationResponse {
2063 /**
2064 * The name of the organization sending the enrollment invite to a user.
2065 */
2066 OrganizationName?: OrganizationName;
2067 /**
2068 * The email ID of the organization or individual contact that the enrolled user can use.
2069 */
2070 ContactEmail?: Email;
2071 /**
2072 * The list of private skill IDs that you want to recommend to the user to enable in the invitation.
2073 */
2074 PrivateSkillIds?: ShortSkillIdList;
2075 }
2076 export interface GetNetworkProfileRequest {
2077 /**
2078 * The ARN of the network profile associated with a device.
2079 */
2080 NetworkProfileArn: Arn;
2081 }
2082 export interface GetNetworkProfileResponse {
2083 /**
2084 * The network profile associated with a device.
2085 */
2086 NetworkProfile?: NetworkProfile;
2087 }
2088 export interface GetProfileRequest {
2089 /**
2090 * The ARN of the room profile for which to request details. Required.
2091 */
2092 ProfileArn?: Arn;
2093 }
2094 export interface GetProfileResponse {
2095 /**
2096 * The details of the room profile requested. Required.
2097 */
2098 Profile?: Profile;
2099 }
2100 export interface GetRoomRequest {
2101 /**
2102 * The ARN of the room for which to request details. Required.
2103 */
2104 RoomArn?: Arn;
2105 }
2106 export interface GetRoomResponse {
2107 /**
2108 * The details of the room requested.
2109 */
2110 Room?: Room;
2111 }
2112 export interface GetRoomSkillParameterRequest {
2113 /**
2114 * The ARN of the room from which to get the room skill parameter details.
2115 */
2116 RoomArn?: Arn;
2117 /**
2118 * The ARN of the skill from which to get the room skill parameter details. Required.
2119 */
2120 SkillId: SkillId;
2121 /**
2122 * The room skill parameter key for which to get details. Required.
2123 */
2124 ParameterKey: RoomSkillParameterKey;
2125 }
2126 export interface GetRoomSkillParameterResponse {
2127 /**
2128 * The details of the room skill parameter requested. Required.
2129 */
2130 RoomSkillParameter?: RoomSkillParameter;
2131 }
2132 export interface GetSkillGroupRequest {
2133 /**
2134 * The ARN of the skill group for which to get details. Required.
2135 */
2136 SkillGroupArn?: Arn;
2137 }
2138 export interface GetSkillGroupResponse {
2139 /**
2140 * The details of the skill group requested. Required.
2141 */
2142 SkillGroup?: SkillGroup;
2143 }
2144 export interface IPDialIn {
2145 /**
2146 * The IP address.
2147 */
2148 Endpoint: Endpoint;
2149 /**
2150 * The protocol, including SIP, SIPS, and H323.
2151 */
2152 CommsProtocol: CommsProtocol;
2153 }
2154 export type IconUrl = string;
2155 export interface InstantBooking {
2156 /**
2157 * Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
2158 */
2159 DurationInMinutes?: Minutes;
2160 /**
2161 * Whether instant booking is enabled or not.
2162 */
2163 Enabled?: Boolean;
2164 }
2165 export type InvocationPhrase = string;
2166 export type Key = string;
2167 export interface ListBusinessReportSchedulesRequest {
2168 /**
2169 * The token used to list the remaining schedules from the previous API call.
2170 */
2171 NextToken?: NextToken;
2172 /**
2173 * The maximum number of schedules listed in the call.
2174 */
2175 MaxResults?: MaxResults;
2176 }
2177 export interface ListBusinessReportSchedulesResponse {
2178 /**
2179 * The schedule of the reports.
2180 */
2181 BusinessReportSchedules?: BusinessReportScheduleList;
2182 /**
2183 * The token used to list the remaining schedules from the previous API call.
2184 */
2185 NextToken?: NextToken;
2186 }
2187 export interface ListConferenceProvidersRequest {
2188 /**
2189 * The tokens used for pagination.
2190 */
2191 NextToken?: NextToken;
2192 /**
2193 * The maximum number of conference providers to be returned, per paginated calls.
2194 */
2195 MaxResults?: MaxResults;
2196 }
2197 export interface ListConferenceProvidersResponse {
2198 /**
2199 * The conference providers.
2200 */
2201 ConferenceProviders?: ConferenceProvidersList;
2202 /**
2203 * The tokens used for pagination.
2204 */
2205 NextToken?: NextToken;
2206 }
2207 export interface ListDeviceEventsRequest {
2208 /**
2209 * The ARN of a device.
2210 */
2211 DeviceArn: Arn;
2212 /**
2213 * 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.
2214 */
2215 EventType?: DeviceEventType;
2216 /**
2217 * 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.
2218 */
2219 NextToken?: NextToken;
2220 /**
2221 * 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.
2222 */
2223 MaxResults?: MaxResults;
2224 }
2225 export interface ListDeviceEventsResponse {
2226 /**
2227 * The device events requested for the device ARN.
2228 */
2229 DeviceEvents?: DeviceEventList;
2230 /**
2231 * The token returned to indicate that there is more data available.
2232 */
2233 NextToken?: NextToken;
2234 }
2235 export interface ListGatewayGroupsRequest {
2236 /**
2237 * The token used to paginate though multiple pages of gateway group summaries.
2238 */
2239 NextToken?: NextToken;
2240 /**
2241 * The maximum number of gateway group summaries to return. The default is 50.
2242 */
2243 MaxResults?: MaxResults;
2244 }
2245 export interface ListGatewayGroupsResponse {
2246 /**
2247 * The gateway groups in the list.
2248 */
2249 GatewayGroups?: GatewayGroupSummaries;
2250 /**
2251 * The token used to paginate though multiple pages of gateway group summaries.
2252 */
2253 NextToken?: NextToken;
2254 }
2255 export interface ListGatewaysRequest {
2256 /**
2257 * The gateway group ARN for which to list gateways.
2258 */
2259 GatewayGroupArn?: Arn;
2260 /**
2261 * The token used to paginate though multiple pages of gateway summaries.
2262 */
2263 NextToken?: NextToken;
2264 /**
2265 * The maximum number of gateway summaries to return. The default is 50.
2266 */
2267 MaxResults?: MaxResults;
2268 }
2269 export interface ListGatewaysResponse {
2270 /**
2271 * The gateways in the list.
2272 */
2273 Gateways?: GatewaySummaries;
2274 /**
2275 * The token used to paginate though multiple pages of gateway summaries.
2276 */
2277 NextToken?: NextToken;
2278 }
2279 export interface ListSkillsRequest {
2280 /**
2281 * The ARN of the skill group for which to list enabled skills.
2282 */
2283 SkillGroupArn?: Arn;
2284 /**
2285 * Whether the skill is enabled under the user's account.
2286 */
2287 EnablementType?: EnablementTypeFilter;
2288 /**
2289 * Whether the skill is publicly available or is a private skill.
2290 */
2291 SkillType?: SkillTypeFilter;
2292 /**
2293 * 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.
2294 */
2295 NextToken?: NextToken;
2296 /**
2297 * 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.
2298 */
2299 MaxResults?: SkillListMaxResults;
2300 }
2301 export interface ListSkillsResponse {
2302 /**
2303 * The list of enabled skills requested. Required.
2304 */
2305 SkillSummaries?: SkillSummaryList;
2306 /**
2307 * The token returned to indicate that there is more data available.
2308 */
2309 NextToken?: NextToken;
2310 }
2311 export interface ListSkillsStoreCategoriesRequest {
2312 /**
2313 * The tokens used for pagination.
2314 */
2315 NextToken?: NextToken;
2316 /**
2317 * The maximum number of categories returned, per paginated calls.
2318 */
2319 MaxResults?: MaxResults;
2320 }
2321 export interface ListSkillsStoreCategoriesResponse {
2322 /**
2323 * The list of categories.
2324 */
2325 CategoryList?: CategoryList;
2326 /**
2327 * The tokens used for pagination.
2328 */
2329 NextToken?: NextToken;
2330 }
2331 export interface ListSkillsStoreSkillsByCategoryRequest {
2332 /**
2333 * The category ID for which the skills are being retrieved from the skill store.
2334 */
2335 CategoryId: CategoryId;
2336 /**
2337 * The tokens used for pagination.
2338 */
2339 NextToken?: NextToken;
2340 /**
2341 * The maximum number of skills returned per paginated calls.
2342 */
2343 MaxResults?: SkillListMaxResults;
2344 }
2345 export interface ListSkillsStoreSkillsByCategoryResponse {
2346 /**
2347 * The skill store skills.
2348 */
2349 SkillsStoreSkills?: SkillsStoreSkillList;
2350 /**
2351 * The tokens used for pagination.
2352 */
2353 NextToken?: NextToken;
2354 }
2355 export interface ListSmartHomeAppliancesRequest {
2356 /**
2357 * The room that the appliances are associated with.
2358 */
2359 RoomArn: Arn;
2360 /**
2361 * The maximum number of appliances to be returned, per paginated calls.
2362 */
2363 MaxResults?: MaxResults;
2364 /**
2365 * The tokens used for pagination.
2366 */
2367 NextToken?: NextToken;
2368 }
2369 export interface ListSmartHomeAppliancesResponse {
2370 /**
2371 * The smart home appliances.
2372 */
2373 SmartHomeAppliances?: SmartHomeApplianceList;
2374 /**
2375 * The tokens used for pagination.
2376 */
2377 NextToken?: NextToken;
2378 }
2379 export interface ListTagsRequest {
2380 /**
2381 * The ARN of the specified resource for which to list tags.
2382 */
2383 Arn: Arn;
2384 /**
2385 * 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.
2386 */
2387 NextToken?: NextToken;
2388 /**
2389 * 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.
2390 */
2391 MaxResults?: MaxResults;
2392 }
2393 export interface ListTagsResponse {
2394 /**
2395 * The tags requested for the specified resource.
2396 */
2397 Tags?: TagList;
2398 /**
2399 * The token returned to indicate that there is more data available.
2400 */
2401 NextToken?: NextToken;
2402 }
2403 export type Locale = "en-US"|string;
2404 export type MacAddress = string;
2405 export type MaxResults = number;
2406 export type MaxVolumeLimit = number;
2407 export interface MeetingRoomConfiguration {
2408 /**
2409 * Whether room utilization metrics are enabled or not.
2410 */
2411 RoomUtilizationMetricsEnabled?: Boolean;
2412 /**
2413 * Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
2414 */
2415 EndOfMeetingReminder?: EndOfMeetingReminder;
2416 /**
2417 * Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.
2418 */
2419 InstantBooking?: InstantBooking;
2420 /**
2421 * Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
2422 */
2423 RequireCheckIn?: RequireCheckIn;
2424 }
2425 export interface MeetingSetting {
2426 /**
2427 * The values that indicate whether the pin is always required.
2428 */
2429 RequirePin: RequirePin;
2430 }
2431 export type Minutes = number;
2432 export type NetworkEapMethod = "EAP_TLS"|string;
2433 export interface NetworkProfile {
2434 /**
2435 * The ARN of the network profile associated with a device.
2436 */
2437 NetworkProfileArn?: Arn;
2438 /**
2439 * The name of the network profile associated with a device.
2440 */
2441 NetworkProfileName?: NetworkProfileName;
2442 /**
2443 * Detailed information about a device's network profile.
2444 */
2445 Description?: NetworkProfileDescription;
2446 /**
2447 * The SSID of the Wi-Fi network.
2448 */
2449 Ssid?: NetworkSsid;
2450 /**
2451 * The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
2452 */
2453 SecurityType?: NetworkSecurityType;
2454 /**
2455 * The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
2456 */
2457 EapMethod?: NetworkEapMethod;
2458 /**
2459 * The current password of the Wi-Fi network.
2460 */
2461 CurrentPassword?: CurrentWiFiPassword;
2462 /**
2463 * The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
2464 */
2465 NextPassword?: NextWiFiPassword;
2466 /**
2467 * The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
2468 */
2469 CertificateAuthorityArn?: Arn;
2470 /**
2471 * The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.
2472 */
2473 TrustAnchors?: TrustAnchorList;
2474 }
2475 export interface NetworkProfileData {
2476 /**
2477 * The ARN of the network profile associated with a device.
2478 */
2479 NetworkProfileArn?: Arn;
2480 /**
2481 * The name of the network profile associated with a device.
2482 */
2483 NetworkProfileName?: NetworkProfileName;
2484 /**
2485 * Detailed information about a device's network profile.
2486 */
2487 Description?: NetworkProfileDescription;
2488 /**
2489 * The SSID of the Wi-Fi network.
2490 */
2491 Ssid?: NetworkSsid;
2492 /**
2493 * The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
2494 */
2495 SecurityType?: NetworkSecurityType;
2496 /**
2497 * The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
2498 */
2499 EapMethod?: NetworkEapMethod;
2500 /**
2501 * The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
2502 */
2503 CertificateAuthorityArn?: Arn;
2504 }
2505 export type NetworkProfileDataList = NetworkProfileData[];
2506 export type NetworkProfileDescription = string;
2507 export type NetworkProfileName = string;
2508 export type NetworkSecurityType = "OPEN"|"WEP"|"WPA_PSK"|"WPA2_PSK"|"WPA2_ENTERPRISE"|string;
2509 export type NetworkSsid = string;
2510 export type NewInThisVersionBulletPoints = BulletPoint[];
2511 export type NextToken = string;
2512 export type NextWiFiPassword = string;
2513 export type OneClickIdDelay = string;
2514 export type OneClickPinDelay = string;
2515 export type OrganizationName = string;
2516 export type OutboundPhoneNumber = string;
2517 export interface PSTNDialIn {
2518 /**
2519 * The zip code.
2520 */
2521 CountryCode: CountryCode;
2522 /**
2523 * The phone number to call to join the conference.
2524 */
2525 PhoneNumber: OutboundPhoneNumber;
2526 /**
2527 * 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.
2528 */
2529 OneClickIdDelay: OneClickIdDelay;
2530 /**
2531 * 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.
2532 */
2533 OneClickPinDelay: OneClickPinDelay;
2534 }
2535 export interface PhoneNumber {
2536 /**
2537 * The raw value of the phone number.
2538 */
2539 Number: RawPhoneNumber;
2540 /**
2541 * The type of the phone number.
2542 */
2543 Type: PhoneNumberType;
2544 }
2545 export type PhoneNumberList = PhoneNumber[];
2546 export type PhoneNumberType = "MOBILE"|"WORK"|"HOME"|string;
2547 export type PrivacyPolicy = string;
2548 export type ProductDescription = string;
2549 export type ProductId = string;
2550 export interface Profile {
2551 /**
2552 * The ARN of a room profile.
2553 */
2554 ProfileArn?: Arn;
2555 /**
2556 * The name of a room profile.
2557 */
2558 ProfileName?: ProfileName;
2559 /**
2560 * Retrieves if the profile is default or not.
2561 */
2562 IsDefault?: Boolean;
2563 /**
2564 * The address of a room profile.
2565 */
2566 Address?: Address;
2567 /**
2568 * The time zone of a room profile.
2569 */
2570 Timezone?: Timezone;
2571 /**
2572 * The distance unit of a room profile.
2573 */
2574 DistanceUnit?: DistanceUnit;
2575 /**
2576 * The temperature unit of a room profile.
2577 */
2578 TemperatureUnit?: TemperatureUnit;
2579 /**
2580 * The wake word of a room profile.
2581 */
2582 WakeWord?: WakeWord;
2583 /**
2584 * The locale of a room profile. (This is currently available only to a limited preview audience.)
2585 */
2586 Locale?: DeviceLocale;
2587 /**
2588 * The setup mode of a room profile.
2589 */
2590 SetupModeDisabled?: Boolean;
2591 /**
2592 * The max volume limit of a room profile.
2593 */
2594 MaxVolumeLimit?: MaxVolumeLimit;
2595 /**
2596 * The PSTN setting of a room profile.
2597 */
2598 PSTNEnabled?: Boolean;
2599 /**
2600 * The ARN of the address book.
2601 */
2602 AddressBookArn?: Arn;
2603 /**
2604 * Meeting room settings of a room profile.
2605 */
2606 MeetingRoomConfiguration?: MeetingRoomConfiguration;
2607 }
2608 export interface ProfileData {
2609 /**
2610 * The ARN of a room profile.
2611 */
2612 ProfileArn?: Arn;
2613 /**
2614 * The name of a room profile.
2615 */
2616 ProfileName?: ProfileName;
2617 /**
2618 * Retrieves if the profile data is default or not.
2619 */
2620 IsDefault?: Boolean;
2621 /**
2622 * The address of a room profile.
2623 */
2624 Address?: Address;
2625 /**
2626 * The time zone of a room profile.
2627 */
2628 Timezone?: Timezone;
2629 /**
2630 * The distance unit of a room profile.
2631 */
2632 DistanceUnit?: DistanceUnit;
2633 /**
2634 * The temperature unit of a room profile.
2635 */
2636 TemperatureUnit?: TemperatureUnit;
2637 /**
2638 * The wake word of a room profile.
2639 */
2640 WakeWord?: WakeWord;
2641 /**
2642 * The locale of a room profile. (This is currently available only to a limited preview audience.)
2643 */
2644 Locale?: DeviceLocale;
2645 }
2646 export type ProfileDataList = ProfileData[];
2647 export type ProfileName = string;
2648 export type ProviderCalendarId = string;
2649 export interface PutConferencePreferenceRequest {
2650 /**
2651 * The conference preference of a specific conference provider.
2652 */
2653 ConferencePreference: ConferencePreference;
2654 }
2655 export interface PutConferencePreferenceResponse {
2656 }
2657 export interface PutInvitationConfigurationRequest {
2658 /**
2659 * The name of the organization sending the enrollment invite to a user.
2660 */
2661 OrganizationName: OrganizationName;
2662 /**
2663 * The email ID of the organization or individual contact that the enrolled user can use.
2664 */
2665 ContactEmail?: Email;
2666 /**
2667 * The list of private skill IDs that you want to recommend to the user to enable in the invitation.
2668 */
2669 PrivateSkillIds?: ShortSkillIdList;
2670 }
2671 export interface PutInvitationConfigurationResponse {
2672 }
2673 export interface PutRoomSkillParameterRequest {
2674 /**
2675 * The ARN of the room associated with the room skill parameter. Required.
2676 */
2677 RoomArn?: Arn;
2678 /**
2679 * The ARN of the skill associated with the room skill parameter. Required.
2680 */
2681 SkillId: SkillId;
2682 /**
2683 * The updated room skill parameter. Required.
2684 */
2685 RoomSkillParameter: RoomSkillParameter;
2686 }
2687 export interface PutRoomSkillParameterResponse {
2688 }
2689 export interface PutSkillAuthorizationRequest {
2690 /**
2691 * The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.
2692 */
2693 AuthorizationResult: AuthorizationResult;
2694 /**
2695 * The unique identifier of a skill.
2696 */
2697 SkillId: SkillId;
2698 /**
2699 * The room that the skill is authorized for.
2700 */
2701 RoomArn?: Arn;
2702 }
2703 export interface PutSkillAuthorizationResponse {
2704 }
2705 export type RawPhoneNumber = string;
2706 export interface RegisterAVSDeviceRequest {
2707 /**
2708 * The client ID of the OEM used for code-based linking authorization on an AVS device.
2709 */
2710 ClientId: ClientId;
2711 /**
2712 * 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.
2713 */
2714 UserCode: UserCode;
2715 /**
2716 * The product ID used to identify your AVS device during authorization.
2717 */
2718 ProductId: ProductId;
2719 /**
2720 * The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
2721 */
2722 DeviceSerialNumber: DeviceSerialNumberForAVS;
2723 /**
2724 * The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
2725 */
2726 AmazonId: AmazonId;
2727 }
2728 export interface RegisterAVSDeviceResponse {
2729 /**
2730 * The ARN of the device.
2731 */
2732 DeviceArn?: Arn;
2733 }
2734 export interface RejectSkillRequest {
2735 /**
2736 * The unique identifier of the skill.
2737 */
2738 SkillId: SkillId;
2739 }
2740 export interface RejectSkillResponse {
2741 }
2742 export type ReleaseDate = string;
2743 export interface RequireCheckIn {
2744 /**
2745 * Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
2746 */
2747 ReleaseAfterMinutes?: Minutes;
2748 /**
2749 * Whether require check in is enabled or not.
2750 */
2751 Enabled?: Boolean;
2752 }
2753 export type RequirePin = "YES"|"NO"|"OPTIONAL"|string;
2754 export interface ResolveRoomRequest {
2755 /**
2756 * The ARN of the user. Required.
2757 */
2758 UserId: UserId;
2759 /**
2760 * The ARN of the skill that was requested. Required.
2761 */
2762 SkillId: SkillId;
2763 }
2764 export interface ResolveRoomResponse {
2765 /**
2766 * The ARN of the room from which the skill request was invoked.
2767 */
2768 RoomArn?: Arn;
2769 /**
2770 * The name of the room from which the skill request was invoked.
2771 */
2772 RoomName?: RoomName;
2773 /**
2774 * Response to get the room profile request. Required.
2775 */
2776 RoomSkillParameters?: RoomSkillParameters;
2777 }
2778 export type ReviewKey = string;
2779 export type ReviewValue = string;
2780 export type Reviews = {[key: string]: ReviewValue};
2781 export interface RevokeInvitationRequest {
2782 /**
2783 * The ARN of the user for whom to revoke an enrollment invitation. Required.
2784 */
2785 UserArn?: Arn;
2786 /**
2787 * The ARN of the enrollment invitation to revoke. Required.
2788 */
2789 EnrollmentId?: EnrollmentId;
2790 }
2791 export interface RevokeInvitationResponse {
2792 }
2793 export interface Room {
2794 /**
2795 * The ARN of a room.
2796 */
2797 RoomArn?: Arn;
2798 /**
2799 * The name of a room.
2800 */
2801 RoomName?: RoomName;
2802 /**
2803 * The description of a room.
2804 */
2805 Description?: RoomDescription;
2806 /**
2807 * The provider calendar ARN of a room.
2808 */
2809 ProviderCalendarId?: ProviderCalendarId;
2810 /**
2811 * The profile ARN of a room.
2812 */
2813 ProfileArn?: Arn;
2814 }
2815 export interface RoomData {
2816 /**
2817 * The ARN of a room.
2818 */
2819 RoomArn?: Arn;
2820 /**
2821 * The name of a room.
2822 */
2823 RoomName?: RoomName;
2824 /**
2825 * The description of a room.
2826 */
2827 Description?: RoomDescription;
2828 /**
2829 * The provider calendar ARN of a room.
2830 */
2831 ProviderCalendarId?: ProviderCalendarId;
2832 /**
2833 * The profile ARN of a room.
2834 */
2835 ProfileArn?: Arn;
2836 /**
2837 * The profile name of a room.
2838 */
2839 ProfileName?: ProfileName;
2840 }
2841 export type RoomDataList = RoomData[];
2842 export type RoomDescription = string;
2843 export type RoomName = string;
2844 export interface RoomSkillParameter {
2845 /**
2846 * The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
2847 */
2848 ParameterKey: RoomSkillParameterKey;
2849 /**
2850 * The parameter value of a room skill parameter.
2851 */
2852 ParameterValue: RoomSkillParameterValue;
2853 }
2854 export type RoomSkillParameterKey = string;
2855 export type RoomSkillParameterValue = string;
2856 export type RoomSkillParameters = RoomSkillParameter[];
2857 export type S3KeyPrefix = string;
2858 export type SampleUtterances = Utterance[];
2859 export interface SearchAddressBooksRequest {
2860 /**
2861 * The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
2862 */
2863 Filters?: FilterList;
2864 /**
2865 * The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
2866 */
2867 SortCriteria?: SortList;
2868 /**
2869 * 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.
2870 */
2871 NextToken?: NextToken;
2872 /**
2873 * 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.
2874 */
2875 MaxResults?: MaxResults;
2876 }
2877 export interface SearchAddressBooksResponse {
2878 /**
2879 * The address books that meet the specified set of filter criteria, in sort order.
2880 */
2881 AddressBooks?: AddressBookDataList;
2882 /**
2883 * The token returned to indicate that there is more data available.
2884 */
2885 NextToken?: NextToken;
2886 /**
2887 * The total number of address books returned.
2888 */
2889 TotalCount?: TotalCount;
2890 }
2891 export interface SearchContactsRequest {
2892 /**
2893 * The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
2894 */
2895 Filters?: FilterList;
2896 /**
2897 * The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
2898 */
2899 SortCriteria?: SortList;
2900 /**
2901 * 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.
2902 */
2903 NextToken?: NextToken;
2904 /**
2905 * 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.
2906 */
2907 MaxResults?: MaxResults;
2908 }
2909 export interface SearchContactsResponse {
2910 /**
2911 * The contacts that meet the specified set of filter criteria, in sort order.
2912 */
2913 Contacts?: ContactDataList;
2914 /**
2915 * The token returned to indicate that there is more data available.
2916 */
2917 NextToken?: NextToken;
2918 /**
2919 * The total number of contacts returned.
2920 */
2921 TotalCount?: TotalCount;
2922 }
2923 export interface SearchDevicesRequest {
2924 /**
2925 * 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.
2926 */
2927 NextToken?: NextToken;
2928 /**
2929 * 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.
2930 */
2931 MaxResults?: MaxResults;
2932 /**
2933 * The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
2934 */
2935 Filters?: FilterList;
2936 /**
2937 * The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
2938 */
2939 SortCriteria?: SortList;
2940 }
2941 export interface SearchDevicesResponse {
2942 /**
2943 * The devices that meet the specified set of filter criteria, in sort order.
2944 */
2945 Devices?: DeviceDataList;
2946 /**
2947 * The token returned to indicate that there is more data available.
2948 */
2949 NextToken?: NextToken;
2950 /**
2951 * The total number of devices returned.
2952 */
2953 TotalCount?: TotalCount;
2954 }
2955 export interface SearchNetworkProfilesRequest {
2956 /**
2957 * 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.
2958 */
2959 NextToken?: NextToken;
2960 /**
2961 * 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.
2962 */
2963 MaxResults?: MaxResults;
2964 /**
2965 * The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.
2966 */
2967 Filters?: FilterList;
2968 /**
2969 * The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.
2970 */
2971 SortCriteria?: SortList;
2972 }
2973 export interface SearchNetworkProfilesResponse {
2974 /**
2975 * The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.
2976 */
2977 NetworkProfiles?: NetworkProfileDataList;
2978 /**
2979 * 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.
2980 */
2981 NextToken?: NextToken;
2982 /**
2983 * The total number of network profiles returned.
2984 */
2985 TotalCount?: TotalCount;
2986 }
2987 export interface SearchProfilesRequest {
2988 /**
2989 * 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.
2990 */
2991 NextToken?: NextToken;
2992 /**
2993 * 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.
2994 */
2995 MaxResults?: MaxResults;
2996 /**
2997 * The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
2998 */
2999 Filters?: FilterList;
3000 /**
3001 * The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
3002 */
3003 SortCriteria?: SortList;
3004 }
3005 export interface SearchProfilesResponse {
3006 /**
3007 * The profiles that meet the specified set of filter criteria, in sort order.
3008 */
3009 Profiles?: ProfileDataList;
3010 /**
3011 * The token returned to indicate that there is more data available.
3012 */
3013 NextToken?: NextToken;
3014 /**
3015 * The total number of room profiles returned.
3016 */
3017 TotalCount?: TotalCount;
3018 }
3019 export interface SearchRoomsRequest {
3020 /**
3021 * 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.
3022 */
3023 NextToken?: NextToken;
3024 /**
3025 * 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.
3026 */
3027 MaxResults?: MaxResults;
3028 /**
3029 * The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
3030 */
3031 Filters?: FilterList;
3032 /**
3033 * The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
3034 */
3035 SortCriteria?: SortList;
3036 }
3037 export interface SearchRoomsResponse {
3038 /**
3039 * The rooms that meet the specified set of filter criteria, in sort order.
3040 */
3041 Rooms?: RoomDataList;
3042 /**
3043 * The token returned to indicate that there is more data available.
3044 */
3045 NextToken?: NextToken;
3046 /**
3047 * The total number of rooms returned.
3048 */
3049 TotalCount?: TotalCount;
3050 }
3051 export interface SearchSkillGroupsRequest {
3052 /**
3053 * 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.
3054 */
3055 NextToken?: NextToken;
3056 /**
3057 * 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.
3058 */
3059 MaxResults?: MaxResults;
3060 /**
3061 * The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
3062 */
3063 Filters?: FilterList;
3064 /**
3065 * The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
3066 */
3067 SortCriteria?: SortList;
3068 }
3069 export interface SearchSkillGroupsResponse {
3070 /**
3071 * The skill groups that meet the filter criteria, in sort order.
3072 */
3073 SkillGroups?: SkillGroupDataList;
3074 /**
3075 * The token returned to indicate that there is more data available.
3076 */
3077 NextToken?: NextToken;
3078 /**
3079 * The total number of skill groups returned.
3080 */
3081 TotalCount?: TotalCount;
3082 }
3083 export interface SearchUsersRequest {
3084 /**
3085 * 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.
3086 */
3087 NextToken?: NextToken;
3088 /**
3089 * 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.
3090 */
3091 MaxResults?: MaxResults;
3092 /**
3093 * The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
3094 */
3095 Filters?: FilterList;
3096 /**
3097 * The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
3098 */
3099 SortCriteria?: SortList;
3100 }
3101 export interface SearchUsersResponse {
3102 /**
3103 * The users that meet the specified set of filter criteria, in sort order.
3104 */
3105 Users?: UserDataList;
3106 /**
3107 * The token returned to indicate that there is more data available.
3108 */
3109 NextToken?: NextToken;
3110 /**
3111 * The total number of users returned.
3112 */
3113 TotalCount?: TotalCount;
3114 }
3115 export interface SendAnnouncementRequest {
3116 /**
3117 * The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.
3118 */
3119 RoomFilters: FilterList;
3120 /**
3121 * The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
3122 */
3123 Content: Content;
3124 /**
3125 * The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.
3126 */
3127 TimeToLiveInSeconds?: TimeToLiveInSeconds;
3128 /**
3129 * The unique, user-specified identifier for the request that ensures idempotency.
3130 */
3131 ClientRequestToken: ClientRequestToken;
3132 }
3133 export interface SendAnnouncementResponse {
3134 /**
3135 * The identifier of the announcement.
3136 */
3137 AnnouncementArn?: Arn;
3138 }
3139 export interface SendInvitationRequest {
3140 /**
3141 * The ARN of the user to whom to send an invitation. Required.
3142 */
3143 UserArn?: Arn;
3144 }
3145 export interface SendInvitationResponse {
3146 }
3147 export type ShortDescription = string;
3148 export type ShortSkillIdList = SkillId[];
3149 export interface SipAddress {
3150 /**
3151 * The URI for the SIP address.
3152 */
3153 Uri: SipUri;
3154 /**
3155 * The type of the SIP address.
3156 */
3157 Type: SipType;
3158 }
3159 export type SipAddressList = SipAddress[];
3160 export type SipType = "WORK"|string;
3161 export type SipUri = string;
3162 export interface SkillDetails {
3163 /**
3164 * The description of the product.
3165 */
3166 ProductDescription?: ProductDescription;
3167 /**
3168 * The phrase used to trigger the skill.
3169 */
3170 InvocationPhrase?: InvocationPhrase;
3171 /**
3172 * The date when the skill was released.
3173 */
3174 ReleaseDate?: ReleaseDate;
3175 /**
3176 * The URL of the end user license agreement.
3177 */
3178 EndUserLicenseAgreement?: EndUserLicenseAgreement;
3179 /**
3180 * The generic keywords associated with the skill that can be used to find a skill.
3181 */
3182 GenericKeywords?: GenericKeywords;
3183 /**
3184 * The details about what the skill supports organized as bullet points.
3185 */
3186 BulletPoints?: BulletPoints;
3187 /**
3188 * The updates added in bullet points.
3189 */
3190 NewInThisVersionBulletPoints?: NewInThisVersionBulletPoints;
3191 /**
3192 * The types of skills.
3193 */
3194 SkillTypes?: SkillTypes;
3195 /**
3196 * The list of reviews for the skill, including Key and Value pair.
3197 */
3198 Reviews?: Reviews;
3199 /**
3200 * The details about the developer that published the skill.
3201 */
3202 DeveloperInfo?: DeveloperInfo;
3203 }
3204 export interface SkillGroup {
3205 /**
3206 * The ARN of a skill group.
3207 */
3208 SkillGroupArn?: Arn;
3209 /**
3210 * The name of a skill group.
3211 */
3212 SkillGroupName?: SkillGroupName;
3213 /**
3214 * The description of a skill group.
3215 */
3216 Description?: SkillGroupDescription;
3217 }
3218 export interface SkillGroupData {
3219 /**
3220 * The skill group ARN of a skill group.
3221 */
3222 SkillGroupArn?: Arn;
3223 /**
3224 * The skill group name of a skill group.
3225 */
3226 SkillGroupName?: SkillGroupName;
3227 /**
3228 * The description of a skill group.
3229 */
3230 Description?: SkillGroupDescription;
3231 }
3232 export type SkillGroupDataList = SkillGroupData[];
3233 export type SkillGroupDescription = string;
3234 export type SkillGroupName = string;
3235 export type SkillId = string;
3236 export type SkillListMaxResults = number;
3237 export type SkillName = string;
3238 export type SkillStoreType = string;
3239 export interface SkillSummary {
3240 /**
3241 * The ARN of the skill summary.
3242 */
3243 SkillId?: SkillId;
3244 /**
3245 * The name of the skill.
3246 */
3247 SkillName?: SkillName;
3248 /**
3249 * Linking support for a skill.
3250 */
3251 SupportsLinking?: boolean;
3252 /**
3253 * Whether the skill is enabled under the user's account, or if it requires linking to be used.
3254 */
3255 EnablementType?: EnablementType;
3256 /**
3257 * Whether the skill is publicly available or is a private skill.
3258 */
3259 SkillType?: SkillType;
3260 }
3261 export type SkillSummaryList = SkillSummary[];
3262 export type SkillType = "PUBLIC"|"PRIVATE"|string;
3263 export type SkillTypeFilter = "PUBLIC"|"PRIVATE"|"ALL"|string;
3264 export type SkillTypes = SkillStoreType[];
3265 export interface SkillsStoreSkill {
3266 /**
3267 * The ARN of the skill.
3268 */
3269 SkillId?: SkillId;
3270 /**
3271 * The name of the skill.
3272 */
3273 SkillName?: SkillName;
3274 /**
3275 * Short description about the skill.
3276 */
3277 ShortDescription?: ShortDescription;
3278 /**
3279 * The URL where the skill icon resides.
3280 */
3281 IconUrl?: IconUrl;
3282 /**
3283 * Sample utterances that interact with the skill.
3284 */
3285 SampleUtterances?: SampleUtterances;
3286 /**
3287 * Information about the skill.
3288 */
3289 SkillDetails?: SkillDetails;
3290 /**
3291 * Linking support for a skill.
3292 */
3293 SupportsLinking?: boolean;
3294 }
3295 export type SkillsStoreSkillList = SkillsStoreSkill[];
3296 export interface SmartHomeAppliance {
3297 /**
3298 * The friendly name of the smart home appliance.
3299 */
3300 FriendlyName?: ApplianceFriendlyName;
3301 /**
3302 * The description of the smart home appliance.
3303 */
3304 Description?: ApplianceDescription;
3305 /**
3306 * The name of the manufacturer of the smart home appliance.
3307 */
3308 ManufacturerName?: ApplianceManufacturerName;
3309 }
3310 export type SmartHomeApplianceList = SmartHomeAppliance[];
3311 export type SoftwareVersion = string;
3312 export interface Sort {
3313 /**
3314 * The sort key of a sort object.
3315 */
3316 Key: SortKey;
3317 /**
3318 * The sort value of a sort object.
3319 */
3320 Value: SortValue;
3321 }
3322 export type SortKey = string;
3323 export type SortList = Sort[];
3324 export type SortValue = "ASC"|"DESC"|string;
3325 export interface Ssml {
3326 /**
3327 * The locale of the SSML message. Currently, en-US is supported.
3328 */
3329 Locale: Locale;
3330 /**
3331 * The value of the SSML message in the correct SSML format. The audio tag is not supported.
3332 */
3333 Value: SsmlValue;
3334 }
3335 export type SsmlList = Ssml[];
3336 export type SsmlValue = string;
3337 export interface StartDeviceSyncRequest {
3338 /**
3339 * The ARN of the room with which the device to sync is associated. Required.
3340 */
3341 RoomArn?: Arn;
3342 /**
3343 * The ARN of the device to sync. Required.
3344 */
3345 DeviceArn?: Arn;
3346 /**
3347 * Request structure to start the device sync. Required.
3348 */
3349 Features: Features;
3350 }
3351 export interface StartDeviceSyncResponse {
3352 }
3353 export interface StartSmartHomeApplianceDiscoveryRequest {
3354 /**
3355 * The room where smart home appliance discovery was initiated.
3356 */
3357 RoomArn: Arn;
3358 }
3359 export interface StartSmartHomeApplianceDiscoveryResponse {
3360 }
3361 export interface Tag {
3362 /**
3363 * The key of a tag. Tag keys are case-sensitive.
3364 */
3365 Key: TagKey;
3366 /**
3367 * The value of a tag. Tag values are case sensitive and can be null.
3368 */
3369 Value: TagValue;
3370 }
3371 export type TagKey = string;
3372 export type TagKeyList = TagKey[];
3373 export type TagList = Tag[];
3374 export interface TagResourceRequest {
3375 /**
3376 * The ARN of the resource to which to add metadata tags. Required.
3377 */
3378 Arn: Arn;
3379 /**
3380 * The tags to be added to the specified resource. Do not provide system tags. Required.
3381 */
3382 Tags: TagList;
3383 }
3384 export interface TagResourceResponse {
3385 }
3386 export type TagValue = string;
3387 export type TemperatureUnit = "FAHRENHEIT"|"CELSIUS"|string;
3388 export interface Text {
3389 /**
3390 * The locale of the text message. Currently, en-US is supported.
3391 */
3392 Locale: Locale;
3393 /**
3394 * The value of the text message.
3395 */
3396 Value: TextValue;
3397 }
3398 export type TextList = Text[];
3399 export type TextValue = string;
3400 export type TimeToLiveInSeconds = number;
3401 export type Timezone = string;
3402 export type TotalCount = number;
3403 export type TrustAnchor = string;
3404 export type TrustAnchorList = TrustAnchor[];
3405 export interface UntagResourceRequest {
3406 /**
3407 * The ARN of the resource from which to remove metadata tags. Required.
3408 */
3409 Arn: Arn;
3410 /**
3411 * The tags to be removed from the specified resource. Do not provide system tags. Required.
3412 */
3413 TagKeys: TagKeyList;
3414 }
3415 export interface UntagResourceResponse {
3416 }
3417 export interface UpdateAddressBookRequest {
3418 /**
3419 * The ARN of the room to update.
3420 */
3421 AddressBookArn: Arn;
3422 /**
3423 * The updated name of the room.
3424 */
3425 Name?: AddressBookName;
3426 /**
3427 * The updated description of the room.
3428 */
3429 Description?: AddressBookDescription;
3430 }
3431 export interface UpdateAddressBookResponse {
3432 }
3433 export interface UpdateBusinessReportScheduleRequest {
3434 /**
3435 * The ARN of the business report schedule.
3436 */
3437 ScheduleArn: Arn;
3438 /**
3439 * The S3 location of the output reports.
3440 */
3441 S3BucketName?: CustomerS3BucketName;
3442 /**
3443 * The S3 key where the report is delivered.
3444 */
3445 S3KeyPrefix?: S3KeyPrefix;
3446 /**
3447 * The format of the generated report (individual CSV files or zipped files of individual files).
3448 */
3449 Format?: BusinessReportFormat;
3450 /**
3451 * The name identifier of the schedule.
3452 */
3453 ScheduleName?: BusinessReportScheduleName;
3454 /**
3455 * The recurrence of the reports.
3456 */
3457 Recurrence?: BusinessReportRecurrence;
3458 }
3459 export interface UpdateBusinessReportScheduleResponse {
3460 }
3461 export interface UpdateConferenceProviderRequest {
3462 /**
3463 * The ARN of the conference provider.
3464 */
3465 ConferenceProviderArn: Arn;
3466 /**
3467 * The type of the conference provider.
3468 */
3469 ConferenceProviderType: ConferenceProviderType;
3470 /**
3471 * The IP endpoint and protocol for calling.
3472 */
3473 IPDialIn?: IPDialIn;
3474 /**
3475 * The information for PSTN conferencing.
3476 */
3477 PSTNDialIn?: PSTNDialIn;
3478 /**
3479 * The meeting settings for the conference provider.
3480 */
3481 MeetingSetting: MeetingSetting;
3482 }
3483 export interface UpdateConferenceProviderResponse {
3484 }
3485 export interface UpdateContactRequest {
3486 /**
3487 * The ARN of the contact to update.
3488 */
3489 ContactArn: Arn;
3490 /**
3491 * The updated display name of the contact.
3492 */
3493 DisplayName?: ContactName;
3494 /**
3495 * The updated first name of the contact.
3496 */
3497 FirstName?: ContactName;
3498 /**
3499 * The updated last name of the contact.
3500 */
3501 LastName?: ContactName;
3502 /**
3503 * The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
3504 */
3505 PhoneNumber?: RawPhoneNumber;
3506 /**
3507 * The list of phone numbers for the contact.
3508 */
3509 PhoneNumbers?: PhoneNumberList;
3510 /**
3511 * The list of SIP addresses for the contact.
3512 */
3513 SipAddresses?: SipAddressList;
3514 }
3515 export interface UpdateContactResponse {
3516 }
3517 export interface UpdateDeviceRequest {
3518 /**
3519 * The ARN of the device to update. Required.
3520 */
3521 DeviceArn?: Arn;
3522 /**
3523 * The updated device name. Required.
3524 */
3525 DeviceName?: DeviceName;
3526 }
3527 export interface UpdateDeviceResponse {
3528 }
3529 export interface UpdateEndOfMeetingReminder {
3530 /**
3531 * Updates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
3532 */
3533 ReminderAtMinutes?: EndOfMeetingReminderMinutesList;
3534 /**
3535 * The type of sound that users hear during the end of meeting reminder.
3536 */
3537 ReminderType?: EndOfMeetingReminderType;
3538 /**
3539 * Whether an end of meeting reminder is enabled or not.
3540 */
3541 Enabled?: Boolean;
3542 }
3543 export interface UpdateGatewayGroupRequest {
3544 /**
3545 * The ARN of the gateway group to update.
3546 */
3547 GatewayGroupArn: Arn;
3548 /**
3549 * The updated name of the gateway group.
3550 */
3551 Name?: GatewayGroupName;
3552 /**
3553 * The updated description of the gateway group.
3554 */
3555 Description?: GatewayGroupDescription;
3556 }
3557 export interface UpdateGatewayGroupResponse {
3558 }
3559 export interface UpdateGatewayRequest {
3560 /**
3561 * The ARN of the gateway to update.
3562 */
3563 GatewayArn: Arn;
3564 /**
3565 * The updated name of the gateway.
3566 */
3567 Name?: GatewayName;
3568 /**
3569 * The updated description of the gateway.
3570 */
3571 Description?: GatewayDescription;
3572 /**
3573 * The updated software version of the gateway. The gateway automatically updates its software version during normal operation.
3574 */
3575 SoftwareVersion?: GatewayVersion;
3576 }
3577 export interface UpdateGatewayResponse {
3578 }
3579 export interface UpdateInstantBooking {
3580 /**
3581 * Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
3582 */
3583 DurationInMinutes?: Minutes;
3584 /**
3585 * Whether instant booking is enabled or not.
3586 */
3587 Enabled?: Boolean;
3588 }
3589 export interface UpdateMeetingRoomConfiguration {
3590 /**
3591 * Whether room utilization metrics are enabled or not.
3592 */
3593 RoomUtilizationMetricsEnabled?: Boolean;
3594 /**
3595 * Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
3596 */
3597 EndOfMeetingReminder?: UpdateEndOfMeetingReminder;
3598 /**
3599 * Settings to automatically book an available room available for a configured duration when joining a meeting with Alexa.
3600 */
3601 InstantBooking?: UpdateInstantBooking;
3602 /**
3603 * Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
3604 */
3605 RequireCheckIn?: UpdateRequireCheckIn;
3606 }
3607 export interface UpdateNetworkProfileRequest {
3608 /**
3609 * The ARN of the network profile associated with a device.
3610 */
3611 NetworkProfileArn: Arn;
3612 /**
3613 * The name of the network profile associated with a device.
3614 */
3615 NetworkProfileName?: NetworkProfileName;
3616 /**
3617 * Detailed information about a device's network profile.
3618 */
3619 Description?: NetworkProfileDescription;
3620 /**
3621 * The current password of the Wi-Fi network.
3622 */
3623 CurrentPassword?: CurrentWiFiPassword;
3624 /**
3625 * The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
3626 */
3627 NextPassword?: NextWiFiPassword;
3628 /**
3629 * The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
3630 */
3631 CertificateAuthorityArn?: Arn;
3632 /**
3633 * The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.
3634 */
3635 TrustAnchors?: TrustAnchorList;
3636 }
3637 export interface UpdateNetworkProfileResponse {
3638 }
3639 export interface UpdateProfileRequest {
3640 /**
3641 * The ARN of the room profile to update. Required.
3642 */
3643 ProfileArn?: Arn;
3644 /**
3645 * The updated name for the room profile.
3646 */
3647 ProfileName?: ProfileName;
3648 /**
3649 * Sets the profile as default if selected. If this is missing, no update is done to the default status.
3650 */
3651 IsDefault?: Boolean;
3652 /**
3653 * The updated timezone for the room profile.
3654 */
3655 Timezone?: Timezone;
3656 /**
3657 * The updated address for the room profile.
3658 */
3659 Address?: Address;
3660 /**
3661 * The updated distance unit for the room profile.
3662 */
3663 DistanceUnit?: DistanceUnit;
3664 /**
3665 * The updated temperature unit for the room profile.
3666 */
3667 TemperatureUnit?: TemperatureUnit;
3668 /**
3669 * The updated wake word for the room profile.
3670 */
3671 WakeWord?: WakeWord;
3672 /**
3673 * The updated locale for the room profile. (This is currently only available to a limited preview audience.)
3674 */
3675 Locale?: DeviceLocale;
3676 /**
3677 * Whether the setup mode of the profile is enabled.
3678 */
3679 SetupModeDisabled?: Boolean;
3680 /**
3681 * The updated maximum volume limit for the room profile.
3682 */
3683 MaxVolumeLimit?: MaxVolumeLimit;
3684 /**
3685 * Whether the PSTN setting of the room profile is enabled.
3686 */
3687 PSTNEnabled?: Boolean;
3688 /**
3689 * The updated meeting room settings of a room profile.
3690 */
3691 MeetingRoomConfiguration?: UpdateMeetingRoomConfiguration;
3692 }
3693 export interface UpdateProfileResponse {
3694 }
3695 export interface UpdateRequireCheckIn {
3696 /**
3697 * Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
3698 */
3699 ReleaseAfterMinutes?: Minutes;
3700 /**
3701 * Whether require check in is enabled or not.
3702 */
3703 Enabled?: Boolean;
3704 }
3705 export interface UpdateRoomRequest {
3706 /**
3707 * The ARN of the room to update.
3708 */
3709 RoomArn?: Arn;
3710 /**
3711 * The updated name for the room.
3712 */
3713 RoomName?: RoomName;
3714 /**
3715 * The updated description for the room.
3716 */
3717 Description?: RoomDescription;
3718 /**
3719 * The updated provider calendar ARN for the room.
3720 */
3721 ProviderCalendarId?: ProviderCalendarId;
3722 /**
3723 * The updated profile ARN for the room.
3724 */
3725 ProfileArn?: Arn;
3726 }
3727 export interface UpdateRoomResponse {
3728 }
3729 export interface UpdateSkillGroupRequest {
3730 /**
3731 * The ARN of the skill group to update.
3732 */
3733 SkillGroupArn?: Arn;
3734 /**
3735 * The updated name for the skill group.
3736 */
3737 SkillGroupName?: SkillGroupName;
3738 /**
3739 * The updated description for the skill group.
3740 */
3741 Description?: SkillGroupDescription;
3742 }
3743 export interface UpdateSkillGroupResponse {
3744 }
3745 export type Url = string;
3746 export type UserCode = string;
3747 export interface UserData {
3748 /**
3749 * The ARN of a user.
3750 */
3751 UserArn?: Arn;
3752 /**
3753 * The first name of a user.
3754 */
3755 FirstName?: user_FirstName;
3756 /**
3757 * The last name of a user.
3758 */
3759 LastName?: user_LastName;
3760 /**
3761 * The email of a user.
3762 */
3763 Email?: Email;
3764 /**
3765 * The enrollment status of a user.
3766 */
3767 EnrollmentStatus?: EnrollmentStatus;
3768 /**
3769 * The enrollment ARN of a user.
3770 */
3771 EnrollmentId?: EnrollmentId;
3772 }
3773 export type UserDataList = UserData[];
3774 export type UserId = string;
3775 export type Utterance = string;
3776 export type Value = string;
3777 export type WakeWord = "ALEXA"|"AMAZON"|"ECHO"|"COMPUTER"|string;
3778 export type user_FirstName = string;
3779 export type user_LastName = string;
3780 export type user_UserId = string;
3781 /**
3782 * 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.
3783 */
3784 export type apiVersion = "2017-11-09"|"latest"|string;
3785 export interface ClientApiVersions {
3786 /**
3787 * 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.
3788 */
3789 apiVersion?: apiVersion;
3790 }
3791 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
3792 /**
3793 * Contains interfaces for use with the AlexaForBusiness client.
3794 */
3795 export import Types = AlexaForBusiness;
3796}
3797export = AlexaForBusiness;