UNPKG

144 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.
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.
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"|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 interface Contact {
1030 /**
1031 * The ARN of the contact.
1032 */
1033 ContactArn?: Arn;
1034 /**
1035 * The name of the contact to display on the console.
1036 */
1037 DisplayName?: ContactName;
1038 /**
1039 * The first name of the contact, used to call the contact on the device.
1040 */
1041 FirstName?: ContactName;
1042 /**
1043 * The last name of the contact, used to call the contact on the device.
1044 */
1045 LastName?: ContactName;
1046 /**
1047 * 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.
1048 */
1049 PhoneNumber?: RawPhoneNumber;
1050 /**
1051 * The list of phone numbers for the contact.
1052 */
1053 PhoneNumbers?: PhoneNumberList;
1054 /**
1055 * The list of SIP addresses for the contact.
1056 */
1057 SipAddresses?: SipAddressList;
1058 }
1059 export interface ContactData {
1060 /**
1061 * The ARN of the contact.
1062 */
1063 ContactArn?: Arn;
1064 /**
1065 * The name of the contact to display on the console.
1066 */
1067 DisplayName?: ContactName;
1068 /**
1069 * The first name of the contact, used to call the contact on the device.
1070 */
1071 FirstName?: ContactName;
1072 /**
1073 * The last name of the contact, used to call the contact on the device.
1074 */
1075 LastName?: ContactName;
1076 /**
1077 * 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.
1078 */
1079 PhoneNumber?: RawPhoneNumber;
1080 /**
1081 * The list of phone numbers for the contact.
1082 */
1083 PhoneNumbers?: PhoneNumberList;
1084 /**
1085 * The list of SIP addresses for the contact.
1086 */
1087 SipAddresses?: SipAddressList;
1088 }
1089 export type ContactDataList = ContactData[];
1090 export type ContactName = string;
1091 export interface Content {
1092 /**
1093 * The list of text messages.
1094 */
1095 TextList?: TextList;
1096 /**
1097 * The list of SSML messages.
1098 */
1099 SsmlList?: SsmlList;
1100 /**
1101 * The list of audio messages.
1102 */
1103 AudioList?: AudioList;
1104 }
1105 export type CountryCode = string;
1106 export interface CreateAddressBookRequest {
1107 /**
1108 * The name of the address book.
1109 */
1110 Name: AddressBookName;
1111 /**
1112 * The description of the address book.
1113 */
1114 Description?: AddressBookDescription;
1115 /**
1116 * A unique, user-specified identifier for the request that ensures idempotency.
1117 */
1118 ClientRequestToken?: ClientRequestToken;
1119 }
1120 export interface CreateAddressBookResponse {
1121 /**
1122 * The ARN of the newly created address book.
1123 */
1124 AddressBookArn?: Arn;
1125 }
1126 export interface CreateBusinessReportScheduleRequest {
1127 /**
1128 * The name identifier of the schedule.
1129 */
1130 ScheduleName?: BusinessReportScheduleName;
1131 /**
1132 * 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.
1133 */
1134 S3BucketName?: CustomerS3BucketName;
1135 /**
1136 * The S3 key where the report is delivered.
1137 */
1138 S3KeyPrefix?: S3KeyPrefix;
1139 /**
1140 * The format of the generated report (individual CSV files or zipped files of individual files).
1141 */
1142 Format: BusinessReportFormat;
1143 /**
1144 * The content range of the reports.
1145 */
1146 ContentRange: BusinessReportContentRange;
1147 /**
1148 * The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
1149 */
1150 Recurrence?: BusinessReportRecurrence;
1151 /**
1152 * The client request token.
1153 */
1154 ClientRequestToken?: ClientRequestToken;
1155 }
1156 export interface CreateBusinessReportScheduleResponse {
1157 /**
1158 * The ARN of the business report schedule.
1159 */
1160 ScheduleArn?: Arn;
1161 }
1162 export interface CreateConferenceProviderRequest {
1163 /**
1164 * The name of the conference provider.
1165 */
1166 ConferenceProviderName: ConferenceProviderName;
1167 /**
1168 * Represents a type within a list of predefined types.
1169 */
1170 ConferenceProviderType: ConferenceProviderType;
1171 /**
1172 * The IP endpoint and protocol for calling.
1173 */
1174 IPDialIn?: IPDialIn;
1175 /**
1176 * The information for PSTN conferencing.
1177 */
1178 PSTNDialIn?: PSTNDialIn;
1179 /**
1180 * The meeting settings for the conference provider.
1181 */
1182 MeetingSetting: MeetingSetting;
1183 /**
1184 * The request token of the client.
1185 */
1186 ClientRequestToken?: ClientRequestToken;
1187 }
1188 export interface CreateConferenceProviderResponse {
1189 /**
1190 * The ARN of the newly-created conference provider.
1191 */
1192 ConferenceProviderArn?: Arn;
1193 }
1194 export interface CreateContactRequest {
1195 /**
1196 * The name of the contact to display on the console.
1197 */
1198 DisplayName?: ContactName;
1199 /**
1200 * The first name of the contact that is used to call the contact on the device.
1201 */
1202 FirstName: ContactName;
1203 /**
1204 * The last name of the contact that is used to call the contact on the device.
1205 */
1206 LastName?: ContactName;
1207 /**
1208 * 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.
1209 */
1210 PhoneNumber?: RawPhoneNumber;
1211 /**
1212 * The list of phone numbers for the contact.
1213 */
1214 PhoneNumbers?: PhoneNumberList;
1215 /**
1216 * The list of SIP addresses for the contact.
1217 */
1218 SipAddresses?: SipAddressList;
1219 /**
1220 * A unique, user-specified identifier for this request that ensures idempotency.
1221 */
1222 ClientRequestToken?: ClientRequestToken;
1223 }
1224 export interface CreateContactResponse {
1225 /**
1226 * The ARN of the newly created address book.
1227 */
1228 ContactArn?: Arn;
1229 }
1230 export interface CreateGatewayGroupRequest {
1231 /**
1232 * The name of the gateway group.
1233 */
1234 Name: GatewayGroupName;
1235 /**
1236 * The description of the gateway group.
1237 */
1238 Description?: GatewayGroupDescription;
1239 /**
1240 * A unique, user-specified identifier for the request that ensures idempotency.
1241 */
1242 ClientRequestToken: ClientRequestToken;
1243 }
1244 export interface CreateGatewayGroupResponse {
1245 /**
1246 * The ARN of the created gateway group.
1247 */
1248 GatewayGroupArn?: Arn;
1249 }
1250 export interface CreateNetworkProfileRequest {
1251 /**
1252 * The name of the network profile associated with a device.
1253 */
1254 NetworkProfileName: NetworkProfileName;
1255 /**
1256 * Detailed information about a device's network profile.
1257 */
1258 Description?: NetworkProfileDescription;
1259 /**
1260 * The SSID of the Wi-Fi network.
1261 */
1262 Ssid: NetworkSsid;
1263 /**
1264 * The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
1265 */
1266 SecurityType: NetworkSecurityType;
1267 /**
1268 * The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
1269 */
1270 EapMethod?: NetworkEapMethod;
1271 /**
1272 * The current password of the Wi-Fi network.
1273 */
1274 CurrentPassword?: CurrentWiFiPassword;
1275 /**
1276 * 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.
1277 */
1278 NextPassword?: NextWiFiPassword;
1279 /**
1280 * The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
1281 */
1282 CertificateAuthorityArn?: Arn;
1283 /**
1284 * The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.
1285 */
1286 TrustAnchors?: TrustAnchorList;
1287 ClientRequestToken: ClientRequestToken;
1288 }
1289 export interface CreateNetworkProfileResponse {
1290 /**
1291 * The ARN of the network profile associated with a device.
1292 */
1293 NetworkProfileArn?: Arn;
1294 }
1295 export interface CreateProfileRequest {
1296 /**
1297 * The name of a room profile.
1298 */
1299 ProfileName: ProfileName;
1300 /**
1301 * The time zone used by a room profile.
1302 */
1303 Timezone: Timezone;
1304 /**
1305 * The valid address for the room.
1306 */
1307 Address: Address;
1308 /**
1309 * The distance unit to be used by devices in the profile.
1310 */
1311 DistanceUnit: DistanceUnit;
1312 /**
1313 * The temperature unit to be used by devices in the profile.
1314 */
1315 TemperatureUnit: TemperatureUnit;
1316 /**
1317 * A wake word for Alexa, Echo, Amazon, or a computer.
1318 */
1319 WakeWord: WakeWord;
1320 /**
1321 * The locale of the room profile.
1322 */
1323 Locale?: DeviceLocale;
1324 /**
1325 * The user-specified token that is used during the creation of a profile.
1326 */
1327 ClientRequestToken?: ClientRequestToken;
1328 /**
1329 * Whether room profile setup is enabled.
1330 */
1331 SetupModeDisabled?: Boolean;
1332 /**
1333 * The maximum volume limit for a room profile.
1334 */
1335 MaxVolumeLimit?: MaxVolumeLimit;
1336 /**
1337 * Whether PSTN calling is enabled.
1338 */
1339 PSTNEnabled?: Boolean;
1340 }
1341 export interface CreateProfileResponse {
1342 /**
1343 * The ARN of the newly created room profile in the response.
1344 */
1345 ProfileArn?: Arn;
1346 }
1347 export interface CreateRoomRequest {
1348 /**
1349 * The name for the room.
1350 */
1351 RoomName: RoomName;
1352 /**
1353 * The description for the room.
1354 */
1355 Description?: RoomDescription;
1356 /**
1357 * The profile ARN for the room.
1358 */
1359 ProfileArn?: Arn;
1360 /**
1361 * The calendar ARN for the room.
1362 */
1363 ProviderCalendarId?: ProviderCalendarId;
1364 /**
1365 * A unique, user-specified identifier for this request that ensures idempotency.
1366 */
1367 ClientRequestToken?: ClientRequestToken;
1368 /**
1369 * The tags for the room.
1370 */
1371 Tags?: TagList;
1372 }
1373 export interface CreateRoomResponse {
1374 /**
1375 * The ARN of the newly created room in the response.
1376 */
1377 RoomArn?: Arn;
1378 }
1379 export interface CreateSkillGroupRequest {
1380 /**
1381 * The name for the skill group.
1382 */
1383 SkillGroupName: SkillGroupName;
1384 /**
1385 * The description for the skill group.
1386 */
1387 Description?: SkillGroupDescription;
1388 /**
1389 * A unique, user-specified identifier for this request that ensures idempotency.
1390 */
1391 ClientRequestToken?: ClientRequestToken;
1392 }
1393 export interface CreateSkillGroupResponse {
1394 /**
1395 * The ARN of the newly created skill group in the response.
1396 */
1397 SkillGroupArn?: Arn;
1398 }
1399 export interface CreateUserRequest {
1400 /**
1401 * The ARN for the user.
1402 */
1403 UserId: user_UserId;
1404 /**
1405 * The first name for the user.
1406 */
1407 FirstName?: user_FirstName;
1408 /**
1409 * The last name for the user.
1410 */
1411 LastName?: user_LastName;
1412 /**
1413 * The email address for the user.
1414 */
1415 Email?: Email;
1416 /**
1417 * A unique, user-specified identifier for this request that ensures idempotency.
1418 */
1419 ClientRequestToken?: ClientRequestToken;
1420 /**
1421 * The tags for the user.
1422 */
1423 Tags?: TagList;
1424 }
1425 export interface CreateUserResponse {
1426 /**
1427 * The ARN of the newly created user in the response.
1428 */
1429 UserArn?: Arn;
1430 }
1431 export type CurrentWiFiPassword = string;
1432 export type CustomerS3BucketName = string;
1433 export type _Date = string;
1434 export interface DeleteAddressBookRequest {
1435 /**
1436 * The ARN of the address book to delete.
1437 */
1438 AddressBookArn: Arn;
1439 }
1440 export interface DeleteAddressBookResponse {
1441 }
1442 export interface DeleteBusinessReportScheduleRequest {
1443 /**
1444 * The ARN of the business report schedule.
1445 */
1446 ScheduleArn: Arn;
1447 }
1448 export interface DeleteBusinessReportScheduleResponse {
1449 }
1450 export interface DeleteConferenceProviderRequest {
1451 /**
1452 * The ARN of the conference provider.
1453 */
1454 ConferenceProviderArn: Arn;
1455 }
1456 export interface DeleteConferenceProviderResponse {
1457 }
1458 export interface DeleteContactRequest {
1459 /**
1460 * The ARN of the contact to delete.
1461 */
1462 ContactArn: Arn;
1463 }
1464 export interface DeleteContactResponse {
1465 }
1466 export interface DeleteDeviceRequest {
1467 /**
1468 * The ARN of the device for which to request details.
1469 */
1470 DeviceArn: Arn;
1471 }
1472 export interface DeleteDeviceResponse {
1473 }
1474 export interface DeleteDeviceUsageDataRequest {
1475 /**
1476 * The ARN of the device.
1477 */
1478 DeviceArn: Arn;
1479 /**
1480 * The type of usage data to delete.
1481 */
1482 DeviceUsageType: DeviceUsageType;
1483 }
1484 export interface DeleteDeviceUsageDataResponse {
1485 }
1486 export interface DeleteGatewayGroupRequest {
1487 /**
1488 * The ARN of the gateway group to delete.
1489 */
1490 GatewayGroupArn: Arn;
1491 }
1492 export interface DeleteGatewayGroupResponse {
1493 }
1494 export interface DeleteNetworkProfileRequest {
1495 /**
1496 * The ARN of the network profile associated with a device.
1497 */
1498 NetworkProfileArn: Arn;
1499 }
1500 export interface DeleteNetworkProfileResponse {
1501 }
1502 export interface DeleteProfileRequest {
1503 /**
1504 * The ARN of the room profile to delete. Required.
1505 */
1506 ProfileArn?: Arn;
1507 }
1508 export interface DeleteProfileResponse {
1509 }
1510 export interface DeleteRoomRequest {
1511 /**
1512 * The ARN of the room to delete. Required.
1513 */
1514 RoomArn?: Arn;
1515 }
1516 export interface DeleteRoomResponse {
1517 }
1518 export interface DeleteRoomSkillParameterRequest {
1519 /**
1520 * The ARN of the room from which to remove the room skill parameter details.
1521 */
1522 RoomArn?: Arn;
1523 /**
1524 * The ID of the skill from which to remove the room skill parameter details.
1525 */
1526 SkillId: SkillId;
1527 /**
1528 * The room skill parameter key for which to remove details.
1529 */
1530 ParameterKey: RoomSkillParameterKey;
1531 }
1532 export interface DeleteRoomSkillParameterResponse {
1533 }
1534 export interface DeleteSkillAuthorizationRequest {
1535 /**
1536 * The unique identifier of a skill.
1537 */
1538 SkillId: SkillId;
1539 /**
1540 * The room that the skill is authorized for.
1541 */
1542 RoomArn?: Arn;
1543 }
1544 export interface DeleteSkillAuthorizationResponse {
1545 }
1546 export interface DeleteSkillGroupRequest {
1547 /**
1548 * The ARN of the skill group to delete. Required.
1549 */
1550 SkillGroupArn?: Arn;
1551 }
1552 export interface DeleteSkillGroupResponse {
1553 }
1554 export interface DeleteUserRequest {
1555 /**
1556 * The ARN of the user to delete in the organization. Required.
1557 */
1558 UserArn?: Arn;
1559 /**
1560 * The ARN of the user's enrollment in the organization. Required.
1561 */
1562 EnrollmentId: EnrollmentId;
1563 }
1564 export interface DeleteUserResponse {
1565 }
1566 export interface DeveloperInfo {
1567 /**
1568 * The name of the developer.
1569 */
1570 DeveloperName?: DeveloperName;
1571 /**
1572 * The URL of the privacy policy.
1573 */
1574 PrivacyPolicy?: PrivacyPolicy;
1575 /**
1576 * The email of the developer.
1577 */
1578 Email?: Email;
1579 /**
1580 * The website of the developer.
1581 */
1582 Url?: Url;
1583 }
1584 export type DeveloperName = string;
1585 export interface Device {
1586 /**
1587 * The ARN of a device.
1588 */
1589 DeviceArn?: Arn;
1590 /**
1591 * The serial number of a device.
1592 */
1593 DeviceSerialNumber?: DeviceSerialNumber;
1594 /**
1595 * The type of a device.
1596 */
1597 DeviceType?: DeviceType;
1598 /**
1599 * The name of a device.
1600 */
1601 DeviceName?: DeviceName;
1602 /**
1603 * The software version of a device.
1604 */
1605 SoftwareVersion?: SoftwareVersion;
1606 /**
1607 * The MAC address of a device.
1608 */
1609 MacAddress?: MacAddress;
1610 /**
1611 * The room ARN of a device.
1612 */
1613 RoomArn?: Arn;
1614 /**
1615 * The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
1616 */
1617 DeviceStatus?: DeviceStatus;
1618 /**
1619 * Detailed information about a device's status.
1620 */
1621 DeviceStatusInfo?: DeviceStatusInfo;
1622 /**
1623 * Detailed information about a device's network profile.
1624 */
1625 NetworkProfileInfo?: DeviceNetworkProfileInfo;
1626 }
1627 export interface DeviceData {
1628 /**
1629 * The ARN of a device.
1630 */
1631 DeviceArn?: Arn;
1632 /**
1633 * The serial number of a device.
1634 */
1635 DeviceSerialNumber?: DeviceSerialNumber;
1636 /**
1637 * The type of a device.
1638 */
1639 DeviceType?: DeviceType;
1640 /**
1641 * The name of a device.
1642 */
1643 DeviceName?: DeviceName;
1644 /**
1645 * The software version of a device.
1646 */
1647 SoftwareVersion?: SoftwareVersion;
1648 /**
1649 * The MAC address of a device.
1650 */
1651 MacAddress?: MacAddress;
1652 /**
1653 * The status of a device.
1654 */
1655 DeviceStatus?: DeviceStatus;
1656 /**
1657 * The ARN of the network profile associated with a device.
1658 */
1659 NetworkProfileArn?: Arn;
1660 /**
1661 * The name of the network profile associated with a device.
1662 */
1663 NetworkProfileName?: NetworkProfileName;
1664 /**
1665 * The room ARN associated with a device.
1666 */
1667 RoomArn?: Arn;
1668 /**
1669 * The name of the room associated with a device.
1670 */
1671 RoomName?: RoomName;
1672 /**
1673 * Detailed information about a device's status.
1674 */
1675 DeviceStatusInfo?: DeviceStatusInfo;
1676 }
1677 export type DeviceDataList = DeviceData[];
1678 export interface DeviceEvent {
1679 /**
1680 * The type of device event.
1681 */
1682 Type?: DeviceEventType;
1683 /**
1684 * The value of the event.
1685 */
1686 Value?: DeviceEventValue;
1687 /**
1688 * The time (in epoch) when the event occurred.
1689 */
1690 Timestamp?: DeviceEventTime;
1691 }
1692 export type DeviceEventList = DeviceEvent[];
1693 export type DeviceEventTime = Date;
1694 export type DeviceEventType = "CONNECTION_STATUS"|"DEVICE_STATUS"|string;
1695 export type DeviceEventValue = string;
1696 export type DeviceLocale = string;
1697 export type DeviceName = string;
1698 export interface DeviceNetworkProfileInfo {
1699 /**
1700 * The ARN of the network profile associated with a device.
1701 */
1702 NetworkProfileArn?: Arn;
1703 /**
1704 * The ARN of the certificate associated with a device.
1705 */
1706 CertificateArn?: Arn;
1707 /**
1708 * The time (in epoch) when the certificate expires.
1709 */
1710 CertificateExpirationTime?: CertificateTime;
1711 }
1712 export type DeviceSerialNumber = string;
1713 export type DeviceSerialNumberForAVS = string;
1714 export type DeviceStatus = "READY"|"PENDING"|"WAS_OFFLINE"|"DEREGISTERED"|"FAILED"|string;
1715 export interface DeviceStatusDetail {
1716 /**
1717 * The list of available features on the device.
1718 */
1719 Feature?: Feature;
1720 /**
1721 * The device status detail code.
1722 */
1723 Code?: DeviceStatusDetailCode;
1724 }
1725 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;
1726 export type DeviceStatusDetails = DeviceStatusDetail[];
1727 export interface DeviceStatusInfo {
1728 /**
1729 * One or more device status detail descriptions.
1730 */
1731 DeviceStatusDetails?: DeviceStatusDetails;
1732 /**
1733 * The latest available information about the connection status of a device.
1734 */
1735 ConnectionStatus?: ConnectionStatus;
1736 }
1737 export type DeviceType = string;
1738 export type DeviceUsageType = "VOICE"|string;
1739 export interface DisassociateContactFromAddressBookRequest {
1740 /**
1741 * The ARN of the contact to disassociate from an address book.
1742 */
1743 ContactArn: Arn;
1744 /**
1745 * The ARN of the address from which to disassociate the contact.
1746 */
1747 AddressBookArn: Arn;
1748 }
1749 export interface DisassociateContactFromAddressBookResponse {
1750 }
1751 export interface DisassociateDeviceFromRoomRequest {
1752 /**
1753 * The ARN of the device to disassociate from a room. Required.
1754 */
1755 DeviceArn?: Arn;
1756 }
1757 export interface DisassociateDeviceFromRoomResponse {
1758 }
1759 export interface DisassociateSkillFromSkillGroupRequest {
1760 /**
1761 * The unique identifier of a skill. Required.
1762 */
1763 SkillGroupArn?: Arn;
1764 /**
1765 * The ARN of a skill group to associate to a skill.
1766 */
1767 SkillId: SkillId;
1768 }
1769 export interface DisassociateSkillFromSkillGroupResponse {
1770 }
1771 export interface DisassociateSkillFromUsersRequest {
1772 /**
1773 * The private skill ID you want to make unavailable for enrolled users.
1774 */
1775 SkillId: SkillId;
1776 }
1777 export interface DisassociateSkillFromUsersResponse {
1778 }
1779 export interface DisassociateSkillGroupFromRoomRequest {
1780 /**
1781 * The ARN of the skill group to disassociate from a room. Required.
1782 */
1783 SkillGroupArn?: Arn;
1784 /**
1785 * The ARN of the room from which the skill group is to be disassociated. Required.
1786 */
1787 RoomArn?: Arn;
1788 }
1789 export interface DisassociateSkillGroupFromRoomResponse {
1790 }
1791 export type DistanceUnit = "METRIC"|"IMPERIAL"|string;
1792 export type Email = string;
1793 export type EnablementType = "ENABLED"|"PENDING"|string;
1794 export type EnablementTypeFilter = "ENABLED"|"PENDING"|string;
1795 export type EndUserLicenseAgreement = string;
1796 export type Endpoint = string;
1797 export type EnrollmentId = string;
1798 export type EnrollmentStatus = "INITIALIZED"|"PENDING"|"REGISTERED"|"DISASSOCIATING"|"DEREGISTERING"|string;
1799 export type Feature = "BLUETOOTH"|"VOLUME"|"NOTIFICATIONS"|"LISTS"|"SKILLS"|"NETWORK_PROFILE"|"SETTINGS"|"ALL"|string;
1800 export type Features = Feature[];
1801 export interface Filter {
1802 /**
1803 * The key of a filter.
1804 */
1805 Key: FilterKey;
1806 /**
1807 * The values of a filter.
1808 */
1809 Values: FilterValueList;
1810 }
1811 export type FilterKey = string;
1812 export type FilterList = Filter[];
1813 export type FilterValue = string;
1814 export type FilterValueList = FilterValue[];
1815 export interface ForgetSmartHomeAppliancesRequest {
1816 /**
1817 * The room that the appliances are associated with.
1818 */
1819 RoomArn: Arn;
1820 }
1821 export interface ForgetSmartHomeAppliancesResponse {
1822 }
1823 export interface Gateway {
1824 /**
1825 * The ARN of the gateway.
1826 */
1827 Arn?: Arn;
1828 /**
1829 * The name of the gateway.
1830 */
1831 Name?: GatewayName;
1832 /**
1833 * The description of the gateway.
1834 */
1835 Description?: GatewayDescription;
1836 /**
1837 * The ARN of the gateway group that the gateway is associated to.
1838 */
1839 GatewayGroupArn?: Arn;
1840 /**
1841 * The software version of the gateway. The gateway automatically updates its software version during normal operation.
1842 */
1843 SoftwareVersion?: GatewayVersion;
1844 }
1845 export type GatewayDescription = string;
1846 export interface GatewayGroup {
1847 /**
1848 * The ARN of the gateway group.
1849 */
1850 Arn?: Arn;
1851 /**
1852 * The name of the gateway group.
1853 */
1854 Name?: GatewayGroupName;
1855 /**
1856 * The description of the gateway group.
1857 */
1858 Description?: GatewayGroupDescription;
1859 }
1860 export type GatewayGroupDescription = string;
1861 export type GatewayGroupName = string;
1862 export type GatewayGroupSummaries = GatewayGroupSummary[];
1863 export interface GatewayGroupSummary {
1864 /**
1865 * The ARN of the gateway group.
1866 */
1867 Arn?: Arn;
1868 /**
1869 * The name of the gateway group.
1870 */
1871 Name?: GatewayGroupName;
1872 /**
1873 * The description of the gateway group.
1874 */
1875 Description?: GatewayGroupDescription;
1876 }
1877 export type GatewayName = string;
1878 export type GatewaySummaries = GatewaySummary[];
1879 export interface GatewaySummary {
1880 /**
1881 * The ARN of the gateway.
1882 */
1883 Arn?: Arn;
1884 /**
1885 * The name of the gateway.
1886 */
1887 Name?: GatewayName;
1888 /**
1889 * The description of the gateway.
1890 */
1891 Description?: GatewayDescription;
1892 /**
1893 * The ARN of the gateway group that the gateway is associated to.
1894 */
1895 GatewayGroupArn?: Arn;
1896 /**
1897 * The software version of the gateway. The gateway automatically updates its software version during normal operation.
1898 */
1899 SoftwareVersion?: GatewayVersion;
1900 }
1901 export type GatewayVersion = string;
1902 export type GenericKeyword = string;
1903 export type GenericKeywords = GenericKeyword[];
1904 export interface GetAddressBookRequest {
1905 /**
1906 * The ARN of the address book for which to request details.
1907 */
1908 AddressBookArn: Arn;
1909 }
1910 export interface GetAddressBookResponse {
1911 /**
1912 * The details of the requested address book.
1913 */
1914 AddressBook?: AddressBook;
1915 }
1916 export interface GetConferencePreferenceRequest {
1917 }
1918 export interface GetConferencePreferenceResponse {
1919 /**
1920 * The conference preference.
1921 */
1922 Preference?: ConferencePreference;
1923 }
1924 export interface GetConferenceProviderRequest {
1925 /**
1926 * The ARN of the newly created conference provider.
1927 */
1928 ConferenceProviderArn: Arn;
1929 }
1930 export interface GetConferenceProviderResponse {
1931 /**
1932 * The conference provider.
1933 */
1934 ConferenceProvider?: ConferenceProvider;
1935 }
1936 export interface GetContactRequest {
1937 /**
1938 * The ARN of the contact for which to request details.
1939 */
1940 ContactArn: Arn;
1941 }
1942 export interface GetContactResponse {
1943 /**
1944 * The details of the requested contact.
1945 */
1946 Contact?: Contact;
1947 }
1948 export interface GetDeviceRequest {
1949 /**
1950 * The ARN of the device for which to request details. Required.
1951 */
1952 DeviceArn?: Arn;
1953 }
1954 export interface GetDeviceResponse {
1955 /**
1956 * The details of the device requested. Required.
1957 */
1958 Device?: Device;
1959 }
1960 export interface GetGatewayGroupRequest {
1961 /**
1962 * The ARN of the gateway group to get.
1963 */
1964 GatewayGroupArn: Arn;
1965 }
1966 export interface GetGatewayGroupResponse {
1967 GatewayGroup?: GatewayGroup;
1968 }
1969 export interface GetGatewayRequest {
1970 /**
1971 * The ARN of the gateway to get.
1972 */
1973 GatewayArn: Arn;
1974 }
1975 export interface GetGatewayResponse {
1976 /**
1977 * The details of the gateway.
1978 */
1979 Gateway?: Gateway;
1980 }
1981 export interface GetInvitationConfigurationRequest {
1982 }
1983 export interface GetInvitationConfigurationResponse {
1984 /**
1985 * The name of the organization sending the enrollment invite to a user.
1986 */
1987 OrganizationName?: OrganizationName;
1988 /**
1989 * The email ID of the organization or individual contact that the enrolled user can use.
1990 */
1991 ContactEmail?: Email;
1992 /**
1993 * The list of private skill IDs that you want to recommend to the user to enable in the invitation.
1994 */
1995 PrivateSkillIds?: ShortSkillIdList;
1996 }
1997 export interface GetNetworkProfileRequest {
1998 /**
1999 * The ARN of the network profile associated with a device.
2000 */
2001 NetworkProfileArn: Arn;
2002 }
2003 export interface GetNetworkProfileResponse {
2004 /**
2005 * The network profile associated with a device.
2006 */
2007 NetworkProfile?: NetworkProfile;
2008 }
2009 export interface GetProfileRequest {
2010 /**
2011 * The ARN of the room profile for which to request details. Required.
2012 */
2013 ProfileArn?: Arn;
2014 }
2015 export interface GetProfileResponse {
2016 /**
2017 * The details of the room profile requested. Required.
2018 */
2019 Profile?: Profile;
2020 }
2021 export interface GetRoomRequest {
2022 /**
2023 * The ARN of the room for which to request details. Required.
2024 */
2025 RoomArn?: Arn;
2026 }
2027 export interface GetRoomResponse {
2028 /**
2029 * The details of the room requested.
2030 */
2031 Room?: Room;
2032 }
2033 export interface GetRoomSkillParameterRequest {
2034 /**
2035 * The ARN of the room from which to get the room skill parameter details.
2036 */
2037 RoomArn?: Arn;
2038 /**
2039 * The ARN of the skill from which to get the room skill parameter details. Required.
2040 */
2041 SkillId: SkillId;
2042 /**
2043 * The room skill parameter key for which to get details. Required.
2044 */
2045 ParameterKey: RoomSkillParameterKey;
2046 }
2047 export interface GetRoomSkillParameterResponse {
2048 /**
2049 * The details of the room skill parameter requested. Required.
2050 */
2051 RoomSkillParameter?: RoomSkillParameter;
2052 }
2053 export interface GetSkillGroupRequest {
2054 /**
2055 * The ARN of the skill group for which to get details. Required.
2056 */
2057 SkillGroupArn?: Arn;
2058 }
2059 export interface GetSkillGroupResponse {
2060 /**
2061 * The details of the skill group requested. Required.
2062 */
2063 SkillGroup?: SkillGroup;
2064 }
2065 export interface IPDialIn {
2066 /**
2067 * The IP address.
2068 */
2069 Endpoint: Endpoint;
2070 /**
2071 * The protocol, including SIP, SIPS, and H323.
2072 */
2073 CommsProtocol: CommsProtocol;
2074 }
2075 export type IconUrl = string;
2076 export type InvocationPhrase = string;
2077 export type Key = string;
2078 export interface ListBusinessReportSchedulesRequest {
2079 /**
2080 * The token used to list the remaining schedules from the previous API call.
2081 */
2082 NextToken?: NextToken;
2083 /**
2084 * The maximum number of schedules listed in the call.
2085 */
2086 MaxResults?: MaxResults;
2087 }
2088 export interface ListBusinessReportSchedulesResponse {
2089 /**
2090 * The schedule of the reports.
2091 */
2092 BusinessReportSchedules?: BusinessReportScheduleList;
2093 /**
2094 * The token used to list the remaining schedules from the previous API call.
2095 */
2096 NextToken?: NextToken;
2097 }
2098 export interface ListConferenceProvidersRequest {
2099 /**
2100 * The tokens used for pagination.
2101 */
2102 NextToken?: NextToken;
2103 /**
2104 * The maximum number of conference providers to be returned, per paginated calls.
2105 */
2106 MaxResults?: MaxResults;
2107 }
2108 export interface ListConferenceProvidersResponse {
2109 /**
2110 * The conference providers.
2111 */
2112 ConferenceProviders?: ConferenceProvidersList;
2113 /**
2114 * The tokens used for pagination.
2115 */
2116 NextToken?: NextToken;
2117 }
2118 export interface ListDeviceEventsRequest {
2119 /**
2120 * The ARN of a device.
2121 */
2122 DeviceArn: Arn;
2123 /**
2124 * 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.
2125 */
2126 EventType?: DeviceEventType;
2127 /**
2128 * 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.
2129 */
2130 NextToken?: NextToken;
2131 /**
2132 * 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.
2133 */
2134 MaxResults?: MaxResults;
2135 }
2136 export interface ListDeviceEventsResponse {
2137 /**
2138 * The device events requested for the device ARN.
2139 */
2140 DeviceEvents?: DeviceEventList;
2141 /**
2142 * The token returned to indicate that there is more data available.
2143 */
2144 NextToken?: NextToken;
2145 }
2146 export interface ListGatewayGroupsRequest {
2147 /**
2148 * The token used to paginate though multiple pages of gateway group summaries.
2149 */
2150 NextToken?: NextToken;
2151 /**
2152 * The maximum number of gateway group summaries to return. The default is 50.
2153 */
2154 MaxResults?: MaxResults;
2155 }
2156 export interface ListGatewayGroupsResponse {
2157 /**
2158 * The gateway groups in the list.
2159 */
2160 GatewayGroups?: GatewayGroupSummaries;
2161 /**
2162 * The token used to paginate though multiple pages of gateway group summaries.
2163 */
2164 NextToken?: NextToken;
2165 }
2166 export interface ListGatewaysRequest {
2167 /**
2168 * The gateway group ARN for which to list gateways.
2169 */
2170 GatewayGroupArn?: Arn;
2171 /**
2172 * The token used to paginate though multiple pages of gateway summaries.
2173 */
2174 NextToken?: NextToken;
2175 /**
2176 * The maximum number of gateway summaries to return. The default is 50.
2177 */
2178 MaxResults?: MaxResults;
2179 }
2180 export interface ListGatewaysResponse {
2181 /**
2182 * The gateways in the list.
2183 */
2184 Gateways?: GatewaySummaries;
2185 /**
2186 * The token used to paginate though multiple pages of gateway summaries.
2187 */
2188 NextToken?: NextToken;
2189 }
2190 export interface ListSkillsRequest {
2191 /**
2192 * The ARN of the skill group for which to list enabled skills. Required.
2193 */
2194 SkillGroupArn?: Arn;
2195 /**
2196 * Whether the skill is enabled under the user's account, or if it requires linking to be used.
2197 */
2198 EnablementType?: EnablementTypeFilter;
2199 /**
2200 * Whether the skill is publicly available or is a private skill.
2201 */
2202 SkillType?: SkillTypeFilter;
2203 /**
2204 * 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.
2205 */
2206 NextToken?: NextToken;
2207 /**
2208 * 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.
2209 */
2210 MaxResults?: SkillListMaxResults;
2211 }
2212 export interface ListSkillsResponse {
2213 /**
2214 * The list of enabled skills requested. Required.
2215 */
2216 SkillSummaries?: SkillSummaryList;
2217 /**
2218 * The token returned to indicate that there is more data available.
2219 */
2220 NextToken?: NextToken;
2221 }
2222 export interface ListSkillsStoreCategoriesRequest {
2223 /**
2224 * The tokens used for pagination.
2225 */
2226 NextToken?: NextToken;
2227 /**
2228 * The maximum number of categories returned, per paginated calls.
2229 */
2230 MaxResults?: MaxResults;
2231 }
2232 export interface ListSkillsStoreCategoriesResponse {
2233 /**
2234 * The list of categories.
2235 */
2236 CategoryList?: CategoryList;
2237 /**
2238 * The tokens used for pagination.
2239 */
2240 NextToken?: NextToken;
2241 }
2242 export interface ListSkillsStoreSkillsByCategoryRequest {
2243 /**
2244 * The category ID for which the skills are being retrieved from the skill store.
2245 */
2246 CategoryId: CategoryId;
2247 /**
2248 * The tokens used for pagination.
2249 */
2250 NextToken?: NextToken;
2251 /**
2252 * The maximum number of skills returned per paginated calls.
2253 */
2254 MaxResults?: SkillListMaxResults;
2255 }
2256 export interface ListSkillsStoreSkillsByCategoryResponse {
2257 /**
2258 * The skill store skills.
2259 */
2260 SkillsStoreSkills?: SkillsStoreSkillList;
2261 /**
2262 * The tokens used for pagination.
2263 */
2264 NextToken?: NextToken;
2265 }
2266 export interface ListSmartHomeAppliancesRequest {
2267 /**
2268 * The room that the appliances are associated with.
2269 */
2270 RoomArn: Arn;
2271 /**
2272 * The maximum number of appliances to be returned, per paginated calls.
2273 */
2274 MaxResults?: MaxResults;
2275 /**
2276 * The tokens used for pagination.
2277 */
2278 NextToken?: NextToken;
2279 }
2280 export interface ListSmartHomeAppliancesResponse {
2281 /**
2282 * The smart home appliances.
2283 */
2284 SmartHomeAppliances?: SmartHomeApplianceList;
2285 /**
2286 * The tokens used for pagination.
2287 */
2288 NextToken?: NextToken;
2289 }
2290 export interface ListTagsRequest {
2291 /**
2292 * The ARN of the specified resource for which to list tags.
2293 */
2294 Arn: Arn;
2295 /**
2296 * 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.
2297 */
2298 NextToken?: NextToken;
2299 /**
2300 * 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.
2301 */
2302 MaxResults?: MaxResults;
2303 }
2304 export interface ListTagsResponse {
2305 /**
2306 * The tags requested for the specified resource.
2307 */
2308 Tags?: TagList;
2309 /**
2310 * The token returned to indicate that there is more data available.
2311 */
2312 NextToken?: NextToken;
2313 }
2314 export type Locale = "en-US"|string;
2315 export type MacAddress = string;
2316 export type MaxResults = number;
2317 export type MaxVolumeLimit = number;
2318 export interface MeetingSetting {
2319 /**
2320 * The values that indicate whether the pin is always required.
2321 */
2322 RequirePin: RequirePin;
2323 }
2324 export type NetworkEapMethod = "EAP_TLS"|string;
2325 export interface NetworkProfile {
2326 /**
2327 * The ARN of the network profile associated with a device.
2328 */
2329 NetworkProfileArn?: Arn;
2330 /**
2331 * The name of the network profile associated with a device.
2332 */
2333 NetworkProfileName?: NetworkProfileName;
2334 /**
2335 * Detailed information about a device's network profile.
2336 */
2337 Description?: NetworkProfileDescription;
2338 /**
2339 * The SSID of the Wi-Fi network.
2340 */
2341 Ssid?: NetworkSsid;
2342 /**
2343 * The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
2344 */
2345 SecurityType?: NetworkSecurityType;
2346 /**
2347 * The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
2348 */
2349 EapMethod?: NetworkEapMethod;
2350 /**
2351 * The current password of the Wi-Fi network.
2352 */
2353 CurrentPassword?: CurrentWiFiPassword;
2354 /**
2355 * 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.
2356 */
2357 NextPassword?: NextWiFiPassword;
2358 /**
2359 * The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
2360 */
2361 CertificateAuthorityArn?: Arn;
2362 /**
2363 * The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.
2364 */
2365 TrustAnchors?: TrustAnchorList;
2366 }
2367 export interface NetworkProfileData {
2368 /**
2369 * The ARN of the network profile associated with a device.
2370 */
2371 NetworkProfileArn?: Arn;
2372 /**
2373 * The name of the network profile associated with a device.
2374 */
2375 NetworkProfileName?: NetworkProfileName;
2376 /**
2377 * Detailed information about a device's network profile.
2378 */
2379 Description?: NetworkProfileDescription;
2380 /**
2381 * The SSID of the Wi-Fi network.
2382 */
2383 Ssid?: NetworkSsid;
2384 /**
2385 * The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
2386 */
2387 SecurityType?: NetworkSecurityType;
2388 /**
2389 * The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
2390 */
2391 EapMethod?: NetworkEapMethod;
2392 /**
2393 * The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
2394 */
2395 CertificateAuthorityArn?: Arn;
2396 }
2397 export type NetworkProfileDataList = NetworkProfileData[];
2398 export type NetworkProfileDescription = string;
2399 export type NetworkProfileName = string;
2400 export type NetworkSecurityType = "OPEN"|"WEP"|"WPA_PSK"|"WPA2_PSK"|"WPA2_ENTERPRISE"|string;
2401 export type NetworkSsid = string;
2402 export type NewInThisVersionBulletPoints = BulletPoint[];
2403 export type NextToken = string;
2404 export type NextWiFiPassword = string;
2405 export type OneClickIdDelay = string;
2406 export type OneClickPinDelay = string;
2407 export type OrganizationName = string;
2408 export type OutboundPhoneNumber = string;
2409 export interface PSTNDialIn {
2410 /**
2411 * The zip code.
2412 */
2413 CountryCode: CountryCode;
2414 /**
2415 * The phone number to call to join the conference.
2416 */
2417 PhoneNumber: OutboundPhoneNumber;
2418 /**
2419 * 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.
2420 */
2421 OneClickIdDelay: OneClickIdDelay;
2422 /**
2423 * 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.
2424 */
2425 OneClickPinDelay: OneClickPinDelay;
2426 }
2427 export interface PhoneNumber {
2428 /**
2429 * The raw value of the phone number.
2430 */
2431 Number: RawPhoneNumber;
2432 /**
2433 * The type of the phone number.
2434 */
2435 Type: PhoneNumberType;
2436 }
2437 export type PhoneNumberList = PhoneNumber[];
2438 export type PhoneNumberType = "MOBILE"|"WORK"|"HOME"|string;
2439 export type PrivacyPolicy = string;
2440 export type ProductDescription = string;
2441 export type ProductId = string;
2442 export interface Profile {
2443 /**
2444 * The ARN of a room profile.
2445 */
2446 ProfileArn?: Arn;
2447 /**
2448 * The name of a room profile.
2449 */
2450 ProfileName?: ProfileName;
2451 /**
2452 * Retrieves if the profile is default or not.
2453 */
2454 IsDefault?: Boolean;
2455 /**
2456 * The address of a room profile.
2457 */
2458 Address?: Address;
2459 /**
2460 * The time zone of a room profile.
2461 */
2462 Timezone?: Timezone;
2463 /**
2464 * The distance unit of a room profile.
2465 */
2466 DistanceUnit?: DistanceUnit;
2467 /**
2468 * The temperature unit of a room profile.
2469 */
2470 TemperatureUnit?: TemperatureUnit;
2471 /**
2472 * The wake word of a room profile.
2473 */
2474 WakeWord?: WakeWord;
2475 /**
2476 * The locale of a room profile.
2477 */
2478 Locale?: DeviceLocale;
2479 /**
2480 * The setup mode of a room profile.
2481 */
2482 SetupModeDisabled?: Boolean;
2483 /**
2484 * The max volume limit of a room profile.
2485 */
2486 MaxVolumeLimit?: MaxVolumeLimit;
2487 /**
2488 * The PSTN setting of a room profile.
2489 */
2490 PSTNEnabled?: Boolean;
2491 /**
2492 * The ARN of the address book.
2493 */
2494 AddressBookArn?: Arn;
2495 }
2496 export interface ProfileData {
2497 /**
2498 * The ARN of a room profile.
2499 */
2500 ProfileArn?: Arn;
2501 /**
2502 * The name of a room profile.
2503 */
2504 ProfileName?: ProfileName;
2505 /**
2506 * Retrieves if the profile data is default or not.
2507 */
2508 IsDefault?: Boolean;
2509 /**
2510 * The address of a room profile.
2511 */
2512 Address?: Address;
2513 /**
2514 * The timezone of a room profile.
2515 */
2516 Timezone?: Timezone;
2517 /**
2518 * The distance unit of a room profile.
2519 */
2520 DistanceUnit?: DistanceUnit;
2521 /**
2522 * The temperature unit of a room profile.
2523 */
2524 TemperatureUnit?: TemperatureUnit;
2525 /**
2526 * The wake word of a room profile.
2527 */
2528 WakeWord?: WakeWord;
2529 /**
2530 * The locale of a room profile.
2531 */
2532 Locale?: DeviceLocale;
2533 }
2534 export type ProfileDataList = ProfileData[];
2535 export type ProfileName = string;
2536 export type ProviderCalendarId = string;
2537 export interface PutConferencePreferenceRequest {
2538 /**
2539 * The conference preference of a specific conference provider.
2540 */
2541 ConferencePreference: ConferencePreference;
2542 }
2543 export interface PutConferencePreferenceResponse {
2544 }
2545 export interface PutInvitationConfigurationRequest {
2546 /**
2547 * The name of the organization sending the enrollment invite to a user.
2548 */
2549 OrganizationName: OrganizationName;
2550 /**
2551 * The email ID of the organization or individual contact that the enrolled user can use.
2552 */
2553 ContactEmail?: Email;
2554 /**
2555 * The list of private skill IDs that you want to recommend to the user to enable in the invitation.
2556 */
2557 PrivateSkillIds?: ShortSkillIdList;
2558 }
2559 export interface PutInvitationConfigurationResponse {
2560 }
2561 export interface PutRoomSkillParameterRequest {
2562 /**
2563 * The ARN of the room associated with the room skill parameter. Required.
2564 */
2565 RoomArn?: Arn;
2566 /**
2567 * The ARN of the skill associated with the room skill parameter. Required.
2568 */
2569 SkillId: SkillId;
2570 /**
2571 * The updated room skill parameter. Required.
2572 */
2573 RoomSkillParameter: RoomSkillParameter;
2574 }
2575 export interface PutRoomSkillParameterResponse {
2576 }
2577 export interface PutSkillAuthorizationRequest {
2578 /**
2579 * The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.
2580 */
2581 AuthorizationResult: AuthorizationResult;
2582 /**
2583 * The unique identifier of a skill.
2584 */
2585 SkillId: SkillId;
2586 /**
2587 * The room that the skill is authorized for.
2588 */
2589 RoomArn?: Arn;
2590 }
2591 export interface PutSkillAuthorizationResponse {
2592 }
2593 export type RawPhoneNumber = string;
2594 export interface RegisterAVSDeviceRequest {
2595 /**
2596 * The client ID of the OEM used for code-based linking authorization on an AVS device.
2597 */
2598 ClientId: ClientId;
2599 /**
2600 * 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.
2601 */
2602 UserCode: UserCode;
2603 /**
2604 * The product ID used to identify your AVS device during authorization.
2605 */
2606 ProductId: ProductId;
2607 /**
2608 * The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
2609 */
2610 DeviceSerialNumber: DeviceSerialNumberForAVS;
2611 /**
2612 * The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
2613 */
2614 AmazonId: AmazonId;
2615 }
2616 export interface RegisterAVSDeviceResponse {
2617 /**
2618 * The ARN of the device.
2619 */
2620 DeviceArn?: Arn;
2621 }
2622 export interface RejectSkillRequest {
2623 /**
2624 * The unique identifier of the skill.
2625 */
2626 SkillId: SkillId;
2627 }
2628 export interface RejectSkillResponse {
2629 }
2630 export type ReleaseDate = string;
2631 export type RequirePin = "YES"|"NO"|"OPTIONAL"|string;
2632 export interface ResolveRoomRequest {
2633 /**
2634 * The ARN of the user. Required.
2635 */
2636 UserId: UserId;
2637 /**
2638 * The ARN of the skill that was requested. Required.
2639 */
2640 SkillId: SkillId;
2641 }
2642 export interface ResolveRoomResponse {
2643 /**
2644 * The ARN of the room from which the skill request was invoked.
2645 */
2646 RoomArn?: Arn;
2647 /**
2648 * The name of the room from which the skill request was invoked.
2649 */
2650 RoomName?: RoomName;
2651 /**
2652 * Response to get the room profile request. Required.
2653 */
2654 RoomSkillParameters?: RoomSkillParameters;
2655 }
2656 export type ReviewKey = string;
2657 export type ReviewValue = string;
2658 export type Reviews = {[key: string]: ReviewValue};
2659 export interface RevokeInvitationRequest {
2660 /**
2661 * The ARN of the user for whom to revoke an enrollment invitation. Required.
2662 */
2663 UserArn?: Arn;
2664 /**
2665 * The ARN of the enrollment invitation to revoke. Required.
2666 */
2667 EnrollmentId?: EnrollmentId;
2668 }
2669 export interface RevokeInvitationResponse {
2670 }
2671 export interface Room {
2672 /**
2673 * The ARN of a room.
2674 */
2675 RoomArn?: Arn;
2676 /**
2677 * The name of a room.
2678 */
2679 RoomName?: RoomName;
2680 /**
2681 * The description of a room.
2682 */
2683 Description?: RoomDescription;
2684 /**
2685 * The provider calendar ARN of a room.
2686 */
2687 ProviderCalendarId?: ProviderCalendarId;
2688 /**
2689 * The profile ARN of a room.
2690 */
2691 ProfileArn?: Arn;
2692 }
2693 export interface RoomData {
2694 /**
2695 * The ARN of a room.
2696 */
2697 RoomArn?: Arn;
2698 /**
2699 * The name of a room.
2700 */
2701 RoomName?: RoomName;
2702 /**
2703 * The description of a room.
2704 */
2705 Description?: RoomDescription;
2706 /**
2707 * The provider calendar ARN of a room.
2708 */
2709 ProviderCalendarId?: ProviderCalendarId;
2710 /**
2711 * The profile ARN of a room.
2712 */
2713 ProfileArn?: Arn;
2714 /**
2715 * The profile name of a room.
2716 */
2717 ProfileName?: ProfileName;
2718 }
2719 export type RoomDataList = RoomData[];
2720 export type RoomDescription = string;
2721 export type RoomName = string;
2722 export interface RoomSkillParameter {
2723 /**
2724 * The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
2725 */
2726 ParameterKey: RoomSkillParameterKey;
2727 /**
2728 * The parameter value of a room skill parameter.
2729 */
2730 ParameterValue: RoomSkillParameterValue;
2731 }
2732 export type RoomSkillParameterKey = string;
2733 export type RoomSkillParameterValue = string;
2734 export type RoomSkillParameters = RoomSkillParameter[];
2735 export type S3KeyPrefix = string;
2736 export type SampleUtterances = Utterance[];
2737 export interface SearchAddressBooksRequest {
2738 /**
2739 * The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
2740 */
2741 Filters?: FilterList;
2742 /**
2743 * The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
2744 */
2745 SortCriteria?: SortList;
2746 /**
2747 * 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.
2748 */
2749 NextToken?: NextToken;
2750 /**
2751 * 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.
2752 */
2753 MaxResults?: MaxResults;
2754 }
2755 export interface SearchAddressBooksResponse {
2756 /**
2757 * The address books that meet the specified set of filter criteria, in sort order.
2758 */
2759 AddressBooks?: AddressBookDataList;
2760 /**
2761 * The token returned to indicate that there is more data available.
2762 */
2763 NextToken?: NextToken;
2764 /**
2765 * The total number of address books returned.
2766 */
2767 TotalCount?: TotalCount;
2768 }
2769 export interface SearchContactsRequest {
2770 /**
2771 * The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
2772 */
2773 Filters?: FilterList;
2774 /**
2775 * The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
2776 */
2777 SortCriteria?: SortList;
2778 /**
2779 * 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.
2780 */
2781 NextToken?: NextToken;
2782 /**
2783 * 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.
2784 */
2785 MaxResults?: MaxResults;
2786 }
2787 export interface SearchContactsResponse {
2788 /**
2789 * The contacts that meet the specified set of filter criteria, in sort order.
2790 */
2791 Contacts?: ContactDataList;
2792 /**
2793 * The token returned to indicate that there is more data available.
2794 */
2795 NextToken?: NextToken;
2796 /**
2797 * The total number of contacts returned.
2798 */
2799 TotalCount?: TotalCount;
2800 }
2801 export interface SearchDevicesRequest {
2802 /**
2803 * 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.
2804 */
2805 NextToken?: NextToken;
2806 /**
2807 * 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.
2808 */
2809 MaxResults?: MaxResults;
2810 /**
2811 * 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.
2812 */
2813 Filters?: FilterList;
2814 /**
2815 * 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.
2816 */
2817 SortCriteria?: SortList;
2818 }
2819 export interface SearchDevicesResponse {
2820 /**
2821 * The devices that meet the specified set of filter criteria, in sort order.
2822 */
2823 Devices?: DeviceDataList;
2824 /**
2825 * The token returned to indicate that there is more data available.
2826 */
2827 NextToken?: NextToken;
2828 /**
2829 * The total number of devices returned.
2830 */
2831 TotalCount?: TotalCount;
2832 }
2833 export interface SearchNetworkProfilesRequest {
2834 /**
2835 * 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.
2836 */
2837 NextToken?: NextToken;
2838 /**
2839 * 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.
2840 */
2841 MaxResults?: MaxResults;
2842 /**
2843 * The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.
2844 */
2845 Filters?: FilterList;
2846 /**
2847 * The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.
2848 */
2849 SortCriteria?: SortList;
2850 }
2851 export interface SearchNetworkProfilesResponse {
2852 /**
2853 * The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.
2854 */
2855 NetworkProfiles?: NetworkProfileDataList;
2856 /**
2857 * 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.
2858 */
2859 NextToken?: NextToken;
2860 /**
2861 * The total number of network profiles returned.
2862 */
2863 TotalCount?: TotalCount;
2864 }
2865 export interface SearchProfilesRequest {
2866 /**
2867 * 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.
2868 */
2869 NextToken?: NextToken;
2870 /**
2871 * 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.
2872 */
2873 MaxResults?: MaxResults;
2874 /**
2875 * The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
2876 */
2877 Filters?: FilterList;
2878 /**
2879 * The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
2880 */
2881 SortCriteria?: SortList;
2882 }
2883 export interface SearchProfilesResponse {
2884 /**
2885 * The profiles that meet the specified set of filter criteria, in sort order.
2886 */
2887 Profiles?: ProfileDataList;
2888 /**
2889 * The token returned to indicate that there is more data available.
2890 */
2891 NextToken?: NextToken;
2892 /**
2893 * The total number of room profiles returned.
2894 */
2895 TotalCount?: TotalCount;
2896 }
2897 export interface SearchRoomsRequest {
2898 /**
2899 * 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.
2900 */
2901 NextToken?: NextToken;
2902 /**
2903 * 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.
2904 */
2905 MaxResults?: MaxResults;
2906 /**
2907 * The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
2908 */
2909 Filters?: FilterList;
2910 /**
2911 * The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
2912 */
2913 SortCriteria?: SortList;
2914 }
2915 export interface SearchRoomsResponse {
2916 /**
2917 * The rooms that meet the specified set of filter criteria, in sort order.
2918 */
2919 Rooms?: RoomDataList;
2920 /**
2921 * The token returned to indicate that there is more data available.
2922 */
2923 NextToken?: NextToken;
2924 /**
2925 * The total number of rooms returned.
2926 */
2927 TotalCount?: TotalCount;
2928 }
2929 export interface SearchSkillGroupsRequest {
2930 /**
2931 * 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.
2932 */
2933 NextToken?: NextToken;
2934 /**
2935 * 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.
2936 */
2937 MaxResults?: MaxResults;
2938 /**
2939 * The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
2940 */
2941 Filters?: FilterList;
2942 /**
2943 * The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
2944 */
2945 SortCriteria?: SortList;
2946 }
2947 export interface SearchSkillGroupsResponse {
2948 /**
2949 * The skill groups that meet the filter criteria, in sort order.
2950 */
2951 SkillGroups?: SkillGroupDataList;
2952 /**
2953 * The token returned to indicate that there is more data available.
2954 */
2955 NextToken?: NextToken;
2956 /**
2957 * The total number of skill groups returned.
2958 */
2959 TotalCount?: TotalCount;
2960 }
2961 export interface SearchUsersRequest {
2962 /**
2963 * 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.
2964 */
2965 NextToken?: NextToken;
2966 /**
2967 * 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.
2968 */
2969 MaxResults?: MaxResults;
2970 /**
2971 * The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
2972 */
2973 Filters?: FilterList;
2974 /**
2975 * The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
2976 */
2977 SortCriteria?: SortList;
2978 }
2979 export interface SearchUsersResponse {
2980 /**
2981 * The users that meet the specified set of filter criteria, in sort order.
2982 */
2983 Users?: UserDataList;
2984 /**
2985 * The token returned to indicate that there is more data available.
2986 */
2987 NextToken?: NextToken;
2988 /**
2989 * The total number of users returned.
2990 */
2991 TotalCount?: TotalCount;
2992 }
2993 export interface SendAnnouncementRequest {
2994 /**
2995 * 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.
2996 */
2997 RoomFilters: FilterList;
2998 /**
2999 * The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
3000 */
3001 Content: Content;
3002 /**
3003 * The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.
3004 */
3005 TimeToLiveInSeconds?: TimeToLiveInSeconds;
3006 /**
3007 * The unique, user-specified identifier for the request that ensures idempotency.
3008 */
3009 ClientRequestToken: ClientRequestToken;
3010 }
3011 export interface SendAnnouncementResponse {
3012 /**
3013 * The identifier of the announcement.
3014 */
3015 AnnouncementArn?: Arn;
3016 }
3017 export interface SendInvitationRequest {
3018 /**
3019 * The ARN of the user to whom to send an invitation. Required.
3020 */
3021 UserArn?: Arn;
3022 }
3023 export interface SendInvitationResponse {
3024 }
3025 export type ShortDescription = string;
3026 export type ShortSkillIdList = SkillId[];
3027 export interface SipAddress {
3028 /**
3029 * The URI for the SIP address.
3030 */
3031 Uri: SipUri;
3032 /**
3033 * The type of the SIP address.
3034 */
3035 Type: SipType;
3036 }
3037 export type SipAddressList = SipAddress[];
3038 export type SipType = "WORK"|string;
3039 export type SipUri = string;
3040 export interface SkillDetails {
3041 /**
3042 * The description of the product.
3043 */
3044 ProductDescription?: ProductDescription;
3045 /**
3046 * The phrase used to trigger the skill.
3047 */
3048 InvocationPhrase?: InvocationPhrase;
3049 /**
3050 * The date when the skill was released.
3051 */
3052 ReleaseDate?: ReleaseDate;
3053 /**
3054 * The URL of the end user license agreement.
3055 */
3056 EndUserLicenseAgreement?: EndUserLicenseAgreement;
3057 /**
3058 * The generic keywords associated with the skill that can be used to find a skill.
3059 */
3060 GenericKeywords?: GenericKeywords;
3061 /**
3062 * The details about what the skill supports organized as bullet points.
3063 */
3064 BulletPoints?: BulletPoints;
3065 /**
3066 * The updates added in bullet points.
3067 */
3068 NewInThisVersionBulletPoints?: NewInThisVersionBulletPoints;
3069 /**
3070 * The types of skills.
3071 */
3072 SkillTypes?: SkillTypes;
3073 /**
3074 * The list of reviews for the skill, including Key and Value pair.
3075 */
3076 Reviews?: Reviews;
3077 /**
3078 * The details about the developer that published the skill.
3079 */
3080 DeveloperInfo?: DeveloperInfo;
3081 }
3082 export interface SkillGroup {
3083 /**
3084 * The ARN of a skill group.
3085 */
3086 SkillGroupArn?: Arn;
3087 /**
3088 * The name of a skill group.
3089 */
3090 SkillGroupName?: SkillGroupName;
3091 /**
3092 * The description of a skill group.
3093 */
3094 Description?: SkillGroupDescription;
3095 }
3096 export interface SkillGroupData {
3097 /**
3098 * The skill group ARN of a skill group.
3099 */
3100 SkillGroupArn?: Arn;
3101 /**
3102 * The skill group name of a skill group.
3103 */
3104 SkillGroupName?: SkillGroupName;
3105 /**
3106 * The description of a skill group.
3107 */
3108 Description?: SkillGroupDescription;
3109 }
3110 export type SkillGroupDataList = SkillGroupData[];
3111 export type SkillGroupDescription = string;
3112 export type SkillGroupName = string;
3113 export type SkillId = string;
3114 export type SkillListMaxResults = number;
3115 export type SkillName = string;
3116 export type SkillStoreType = string;
3117 export interface SkillSummary {
3118 /**
3119 * The ARN of the skill summary.
3120 */
3121 SkillId?: SkillId;
3122 /**
3123 * The name of the skill.
3124 */
3125 SkillName?: SkillName;
3126 /**
3127 * Linking support for a skill.
3128 */
3129 SupportsLinking?: boolean;
3130 /**
3131 * Whether the skill is enabled under the user's account, or if it requires linking to be used.
3132 */
3133 EnablementType?: EnablementType;
3134 /**
3135 * Whether the skill is publicly available or is a private skill.
3136 */
3137 SkillType?: SkillType;
3138 }
3139 export type SkillSummaryList = SkillSummary[];
3140 export type SkillType = "PUBLIC"|"PRIVATE"|string;
3141 export type SkillTypeFilter = "PUBLIC"|"PRIVATE"|"ALL"|string;
3142 export type SkillTypes = SkillStoreType[];
3143 export interface SkillsStoreSkill {
3144 /**
3145 * The ARN of the skill.
3146 */
3147 SkillId?: SkillId;
3148 /**
3149 * The name of the skill.
3150 */
3151 SkillName?: SkillName;
3152 /**
3153 * Short description about the skill.
3154 */
3155 ShortDescription?: ShortDescription;
3156 /**
3157 * The URL where the skill icon resides.
3158 */
3159 IconUrl?: IconUrl;
3160 /**
3161 * Sample utterances that interact with the skill.
3162 */
3163 SampleUtterances?: SampleUtterances;
3164 /**
3165 * Information about the skill.
3166 */
3167 SkillDetails?: SkillDetails;
3168 /**
3169 * Linking support for a skill.
3170 */
3171 SupportsLinking?: boolean;
3172 }
3173 export type SkillsStoreSkillList = SkillsStoreSkill[];
3174 export interface SmartHomeAppliance {
3175 /**
3176 * The friendly name of the smart home appliance.
3177 */
3178 FriendlyName?: ApplianceFriendlyName;
3179 /**
3180 * The description of the smart home appliance.
3181 */
3182 Description?: ApplianceDescription;
3183 /**
3184 * The name of the manufacturer of the smart home appliance.
3185 */
3186 ManufacturerName?: ApplianceManufacturerName;
3187 }
3188 export type SmartHomeApplianceList = SmartHomeAppliance[];
3189 export type SoftwareVersion = string;
3190 export interface Sort {
3191 /**
3192 * The sort key of a sort object.
3193 */
3194 Key: SortKey;
3195 /**
3196 * The sort value of a sort object.
3197 */
3198 Value: SortValue;
3199 }
3200 export type SortKey = string;
3201 export type SortList = Sort[];
3202 export type SortValue = "ASC"|"DESC"|string;
3203 export interface Ssml {
3204 /**
3205 * The locale of the SSML message. Currently, en-US is supported.
3206 */
3207 Locale: Locale;
3208 /**
3209 * The value of the SSML message in the correct SSML format. The audio tag is not supported.
3210 */
3211 Value: SsmlValue;
3212 }
3213 export type SsmlList = Ssml[];
3214 export type SsmlValue = string;
3215 export interface StartDeviceSyncRequest {
3216 /**
3217 * The ARN of the room with which the device to sync is associated. Required.
3218 */
3219 RoomArn?: Arn;
3220 /**
3221 * The ARN of the device to sync. Required.
3222 */
3223 DeviceArn?: Arn;
3224 /**
3225 * Request structure to start the device sync. Required.
3226 */
3227 Features: Features;
3228 }
3229 export interface StartDeviceSyncResponse {
3230 }
3231 export interface StartSmartHomeApplianceDiscoveryRequest {
3232 /**
3233 * The room where smart home appliance discovery was initiated.
3234 */
3235 RoomArn: Arn;
3236 }
3237 export interface StartSmartHomeApplianceDiscoveryResponse {
3238 }
3239 export interface Tag {
3240 /**
3241 * The key of a tag. Tag keys are case-sensitive.
3242 */
3243 Key: TagKey;
3244 /**
3245 * The value of a tag. Tag values are case-sensitive and can be null.
3246 */
3247 Value: TagValue;
3248 }
3249 export type TagKey = string;
3250 export type TagKeyList = TagKey[];
3251 export type TagList = Tag[];
3252 export interface TagResourceRequest {
3253 /**
3254 * The ARN of the resource to which to add metadata tags. Required.
3255 */
3256 Arn: Arn;
3257 /**
3258 * The tags to be added to the specified resource. Do not provide system tags. Required.
3259 */
3260 Tags: TagList;
3261 }
3262 export interface TagResourceResponse {
3263 }
3264 export type TagValue = string;
3265 export type TemperatureUnit = "FAHRENHEIT"|"CELSIUS"|string;
3266 export interface Text {
3267 /**
3268 * The locale of the text message. Currently, en-US is supported.
3269 */
3270 Locale: Locale;
3271 /**
3272 * The value of the text message.
3273 */
3274 Value: TextValue;
3275 }
3276 export type TextList = Text[];
3277 export type TextValue = string;
3278 export type TimeToLiveInSeconds = number;
3279 export type Timezone = string;
3280 export type TotalCount = number;
3281 export type TrustAnchor = string;
3282 export type TrustAnchorList = TrustAnchor[];
3283 export interface UntagResourceRequest {
3284 /**
3285 * The ARN of the resource from which to remove metadata tags. Required.
3286 */
3287 Arn: Arn;
3288 /**
3289 * The tags to be removed from the specified resource. Do not provide system tags. Required.
3290 */
3291 TagKeys: TagKeyList;
3292 }
3293 export interface UntagResourceResponse {
3294 }
3295 export interface UpdateAddressBookRequest {
3296 /**
3297 * The ARN of the room to update.
3298 */
3299 AddressBookArn: Arn;
3300 /**
3301 * The updated name of the room.
3302 */
3303 Name?: AddressBookName;
3304 /**
3305 * The updated description of the room.
3306 */
3307 Description?: AddressBookDescription;
3308 }
3309 export interface UpdateAddressBookResponse {
3310 }
3311 export interface UpdateBusinessReportScheduleRequest {
3312 /**
3313 * The ARN of the business report schedule.
3314 */
3315 ScheduleArn: Arn;
3316 /**
3317 * The S3 location of the output reports.
3318 */
3319 S3BucketName?: CustomerS3BucketName;
3320 /**
3321 * The S3 key where the report is delivered.
3322 */
3323 S3KeyPrefix?: S3KeyPrefix;
3324 /**
3325 * The format of the generated report (individual CSV files or zipped files of individual files).
3326 */
3327 Format?: BusinessReportFormat;
3328 /**
3329 * The name identifier of the schedule.
3330 */
3331 ScheduleName?: BusinessReportScheduleName;
3332 /**
3333 * The recurrence of the reports.
3334 */
3335 Recurrence?: BusinessReportRecurrence;
3336 }
3337 export interface UpdateBusinessReportScheduleResponse {
3338 }
3339 export interface UpdateConferenceProviderRequest {
3340 /**
3341 * The ARN of the conference provider.
3342 */
3343 ConferenceProviderArn: Arn;
3344 /**
3345 * The type of the conference provider.
3346 */
3347 ConferenceProviderType: ConferenceProviderType;
3348 /**
3349 * The IP endpoint and protocol for calling.
3350 */
3351 IPDialIn?: IPDialIn;
3352 /**
3353 * The information for PSTN conferencing.
3354 */
3355 PSTNDialIn?: PSTNDialIn;
3356 /**
3357 * The meeting settings for the conference provider.
3358 */
3359 MeetingSetting: MeetingSetting;
3360 }
3361 export interface UpdateConferenceProviderResponse {
3362 }
3363 export interface UpdateContactRequest {
3364 /**
3365 * The ARN of the contact to update.
3366 */
3367 ContactArn: Arn;
3368 /**
3369 * The updated display name of the contact.
3370 */
3371 DisplayName?: ContactName;
3372 /**
3373 * The updated first name of the contact.
3374 */
3375 FirstName?: ContactName;
3376 /**
3377 * The updated last name of the contact.
3378 */
3379 LastName?: ContactName;
3380 /**
3381 * 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.
3382 */
3383 PhoneNumber?: RawPhoneNumber;
3384 /**
3385 * The list of phone numbers for the contact.
3386 */
3387 PhoneNumbers?: PhoneNumberList;
3388 /**
3389 * The list of SIP addresses for the contact.
3390 */
3391 SipAddresses?: SipAddressList;
3392 }
3393 export interface UpdateContactResponse {
3394 }
3395 export interface UpdateDeviceRequest {
3396 /**
3397 * The ARN of the device to update. Required.
3398 */
3399 DeviceArn?: Arn;
3400 /**
3401 * The updated device name. Required.
3402 */
3403 DeviceName?: DeviceName;
3404 }
3405 export interface UpdateDeviceResponse {
3406 }
3407 export interface UpdateGatewayGroupRequest {
3408 /**
3409 * The ARN of the gateway group to update.
3410 */
3411 GatewayGroupArn: Arn;
3412 /**
3413 * The updated name of the gateway group.
3414 */
3415 Name?: GatewayGroupName;
3416 /**
3417 * The updated description of the gateway group.
3418 */
3419 Description?: GatewayGroupDescription;
3420 }
3421 export interface UpdateGatewayGroupResponse {
3422 }
3423 export interface UpdateGatewayRequest {
3424 /**
3425 * The ARN of the gateway to update.
3426 */
3427 GatewayArn: Arn;
3428 /**
3429 * The updated name of the gateway.
3430 */
3431 Name?: GatewayName;
3432 /**
3433 * The updated description of the gateway.
3434 */
3435 Description?: GatewayDescription;
3436 /**
3437 * The updated software version of the gateway. The gateway automatically updates its software version during normal operation.
3438 */
3439 SoftwareVersion?: GatewayVersion;
3440 }
3441 export interface UpdateGatewayResponse {
3442 }
3443 export interface UpdateNetworkProfileRequest {
3444 /**
3445 * The ARN of the network profile associated with a device.
3446 */
3447 NetworkProfileArn: Arn;
3448 /**
3449 * The name of the network profile associated with a device.
3450 */
3451 NetworkProfileName?: NetworkProfileName;
3452 /**
3453 * Detailed information about a device's network profile.
3454 */
3455 Description?: NetworkProfileDescription;
3456 /**
3457 * The current password of the Wi-Fi network.
3458 */
3459 CurrentPassword?: CurrentWiFiPassword;
3460 /**
3461 * 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.
3462 */
3463 NextPassword?: NextWiFiPassword;
3464 /**
3465 * The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
3466 */
3467 CertificateAuthorityArn?: Arn;
3468 /**
3469 * 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.
3470 */
3471 TrustAnchors?: TrustAnchorList;
3472 }
3473 export interface UpdateNetworkProfileResponse {
3474 }
3475 export interface UpdateProfileRequest {
3476 /**
3477 * The ARN of the room profile to update. Required.
3478 */
3479 ProfileArn?: Arn;
3480 /**
3481 * The updated name for the room profile.
3482 */
3483 ProfileName?: ProfileName;
3484 /**
3485 * Sets the profile as default if selected. If this is missing, no update is done to the default status.
3486 */
3487 IsDefault?: Boolean;
3488 /**
3489 * The updated timezone for the room profile.
3490 */
3491 Timezone?: Timezone;
3492 /**
3493 * The updated address for the room profile.
3494 */
3495 Address?: Address;
3496 /**
3497 * The updated distance unit for the room profile.
3498 */
3499 DistanceUnit?: DistanceUnit;
3500 /**
3501 * The updated temperature unit for the room profile.
3502 */
3503 TemperatureUnit?: TemperatureUnit;
3504 /**
3505 * The updated wake word for the room profile.
3506 */
3507 WakeWord?: WakeWord;
3508 /**
3509 * The updated locale for the room profile.
3510 */
3511 Locale?: DeviceLocale;
3512 /**
3513 * Whether the setup mode of the profile is enabled.
3514 */
3515 SetupModeDisabled?: Boolean;
3516 /**
3517 * The updated maximum volume limit for the room profile.
3518 */
3519 MaxVolumeLimit?: MaxVolumeLimit;
3520 /**
3521 * Whether the PSTN setting of the room profile is enabled.
3522 */
3523 PSTNEnabled?: Boolean;
3524 }
3525 export interface UpdateProfileResponse {
3526 }
3527 export interface UpdateRoomRequest {
3528 /**
3529 * The ARN of the room to update.
3530 */
3531 RoomArn?: Arn;
3532 /**
3533 * The updated name for the room.
3534 */
3535 RoomName?: RoomName;
3536 /**
3537 * The updated description for the room.
3538 */
3539 Description?: RoomDescription;
3540 /**
3541 * The updated provider calendar ARN for the room.
3542 */
3543 ProviderCalendarId?: ProviderCalendarId;
3544 /**
3545 * The updated profile ARN for the room.
3546 */
3547 ProfileArn?: Arn;
3548 }
3549 export interface UpdateRoomResponse {
3550 }
3551 export interface UpdateSkillGroupRequest {
3552 /**
3553 * The ARN of the skill group to update.
3554 */
3555 SkillGroupArn?: Arn;
3556 /**
3557 * The updated name for the skill group.
3558 */
3559 SkillGroupName?: SkillGroupName;
3560 /**
3561 * The updated description for the skill group.
3562 */
3563 Description?: SkillGroupDescription;
3564 }
3565 export interface UpdateSkillGroupResponse {
3566 }
3567 export type Url = string;
3568 export type UserCode = string;
3569 export interface UserData {
3570 /**
3571 * The ARN of a user.
3572 */
3573 UserArn?: Arn;
3574 /**
3575 * The first name of a user.
3576 */
3577 FirstName?: user_FirstName;
3578 /**
3579 * The last name of a user.
3580 */
3581 LastName?: user_LastName;
3582 /**
3583 * The email of a user.
3584 */
3585 Email?: Email;
3586 /**
3587 * The enrollment status of a user.
3588 */
3589 EnrollmentStatus?: EnrollmentStatus;
3590 /**
3591 * The enrollment ARN of a user.
3592 */
3593 EnrollmentId?: EnrollmentId;
3594 }
3595 export type UserDataList = UserData[];
3596 export type UserId = string;
3597 export type Utterance = string;
3598 export type Value = string;
3599 export type WakeWord = "ALEXA"|"AMAZON"|"ECHO"|"COMPUTER"|string;
3600 export type user_FirstName = string;
3601 export type user_LastName = string;
3602 export type user_UserId = string;
3603 /**
3604 * 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.
3605 */
3606 export type apiVersion = "2017-11-09"|"latest"|string;
3607 export interface ClientApiVersions {
3608 /**
3609 * 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.
3610 */
3611 apiVersion?: apiVersion;
3612 }
3613 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
3614 /**
3615 * Contains interfaces for use with the AlexaForBusiness client.
3616 */
3617 export import Types = AlexaForBusiness;
3618}
3619export = AlexaForBusiness;