docs(client-alexa-for-business): Alexa for Business has been deprecat…

…ed and is no longer supported.
aws · Jun 1, 2023 · 26b35f3 · 26b35f3
1 parent 35366f2
commit 26b35f3
Show file tree

Hide file tree

Showing 101 changed files with 2,409 additions and 922 deletions.
diff --git a/clients/client-alexa-for-business/README.md b/clients/client-alexa-for-business/README.md
@@ -6,14 +6,7 @@
 
 AWS SDK for JavaScript AlexaForBusiness Client for Node.js, Browser and React Native.
 
-<p>Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools
-to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your
-own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations.
-You can also make these available as private skills for your organization. Alexa for Business makes it
-efficient to voice-enable your products and services, thus providing context-aware voice
-experiences for your customers. Device makers building with the Alexa Voice Service (AVS)
-can create fully integrated solutions, register their products with Alexa for Business, and manage them
-as shared devices in their organization. </p>
+<p>Alexa for Business has been retired and is no longer supported.</p>
 
 ## Installing
 

diff --git a/clients/client-alexa-for-business/src/AlexaForBusiness.ts b/clients/client-alexa-for-business/src/AlexaForBusiness.ts
@@ -1878,14 +1878,9 @@ export interface AlexaForBusiness {
 
 /**
  * @public
- * <p>Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools
- *          to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your
- *          own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations.
- *          You can also make these available as private skills for your organization. Alexa for Business makes it
- *          efficient to voice-enable your products and services, thus providing context-aware voice
- *          experiences for your customers. Device makers building with the Alexa Voice Service (AVS)
- *          can create fully integrated solutions, register their products with Alexa for Business, and manage them
- *          as shared devices in their organization. </p>
+ * @deprecated
+ *
+ * <p>Alexa for Business has been retired and is no longer supported.</p>
  */
 export class AlexaForBusiness extends AlexaForBusinessClient implements AlexaForBusiness {}
 createAggregatedClient(commands, AlexaForBusiness);
diff --git a/clients/client-alexa-for-business/src/AlexaForBusinessClient.ts b/clients/client-alexa-for-business/src/AlexaForBusinessClient.ts
@@ -631,14 +631,9 @@ export interface AlexaForBusinessClientResolvedConfig extends AlexaForBusinessCl
 
 /**
  * @public
- * <p>Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools
- *          to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your
- *          own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations.
- *          You can also make these available as private skills for your organization. Alexa for Business makes it
- *          efficient to voice-enable your products and services, thus providing context-aware voice
- *          experiences for your customers. Device makers building with the Alexa Voice Service (AVS)
- *          can create fully integrated solutions, register their products with Alexa for Business, and manage them
- *          as shared devices in their organization. </p>
+ * @deprecated
+ *
+ * <p>Alexa for Business has been retired and is no longer supported.</p>
  */
 export class AlexaForBusinessClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-alexa-for-business/src/commands/ApproveSkillCommand.ts b/clients/client-alexa-for-business/src/commands/ApproveSkillCommand.ts
@@ -36,6 +36,8 @@ export interface ApproveSkillCommandOutput extends ApproveSkillResponse, __Metad
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>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.</p>
  * @example

diff --git a/clients/client-alexa-for-business/src/commands/AssociateContactWithAddressBookCommand.ts b/clients/client-alexa-for-business/src/commands/AssociateContactWithAddressBookCommand.ts
@@ -41,6 +41,8 @@ export interface AssociateContactWithAddressBookCommandOutput
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Associates a contact with a given address book.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/AssociateDeviceWithNetworkProfileCommand.ts b/clients/client-alexa-for-business/src/commands/AssociateDeviceWithNetworkProfileCommand.ts
@@ -44,6 +44,8 @@ export interface AssociateDeviceWithNetworkProfileCommandOutput
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Associates a device with the specified network profile.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/AssociateDeviceWithRoomCommand.ts b/clients/client-alexa-for-business/src/commands/AssociateDeviceWithRoomCommand.ts
@@ -36,6 +36,8 @@ export interface AssociateDeviceWithRoomCommandOutput extends AssociateDeviceWit
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Associates a device with a given room. This applies all the settings from the room
  *          profile to the device, and all the skills in any skill groups added to that room. This
  *          operation requires the device to be online, or else a manual sync is required. </p>

diff --git a/clients/client-alexa-for-business/src/commands/AssociateSkillGroupWithRoomCommand.ts b/clients/client-alexa-for-business/src/commands/AssociateSkillGroupWithRoomCommand.ts
@@ -38,6 +38,8 @@ export interface AssociateSkillGroupWithRoomCommandOutput
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Associates a skill group with a given room. This enables all skills in the associated
  *          skill group on all devices in the room.</p>
  * @example

diff --git a/clients/client-alexa-for-business/src/commands/AssociateSkillWithSkillGroupCommand.ts b/clients/client-alexa-for-business/src/commands/AssociateSkillWithSkillGroupCommand.ts
@@ -41,6 +41,8 @@ export interface AssociateSkillWithSkillGroupCommandOutput
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Associates a skill with a skill group.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/AssociateSkillWithUsersCommand.ts b/clients/client-alexa-for-business/src/commands/AssociateSkillWithUsersCommand.ts
@@ -36,6 +36,8 @@ export interface AssociateSkillWithUsersCommandOutput extends AssociateSkillWith
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Makes a private skill available for enrolled users to enable on their devices.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/CreateAddressBookCommand.ts b/clients/client-alexa-for-business/src/commands/CreateAddressBookCommand.ts
@@ -36,6 +36,8 @@ export interface CreateAddressBookCommandOutput extends CreateAddressBookRespons
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Creates an address book with the specified details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/CreateBusinessReportScheduleCommand.ts b/clients/client-alexa-for-business/src/commands/CreateBusinessReportScheduleCommand.ts
@@ -41,6 +41,8 @@ export interface CreateBusinessReportScheduleCommandOutput
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Creates a recurring schedule for usage reports to deliver to the specified S3
  *          location with a specified daily or weekly interval.</p>
  * @example
@@ -53,9 +55,9 @@ export interface CreateBusinessReportScheduleCommandOutput
  *   ScheduleName: "STRING_VALUE",
  *   S3BucketName: "STRING_VALUE",
  *   S3KeyPrefix: "STRING_VALUE",
- *   Format: "STRING_VALUE", // required
+ *   Format: "CSV" || "CSV_ZIP", // required
  *   ContentRange: { // BusinessReportContentRange
- *     Interval: "STRING_VALUE", // required
+ *     Interval: "ONE_DAY" || "ONE_WEEK" || "THIRTY_DAYS", // required
  *   },
  *   Recurrence: { // BusinessReportRecurrence
  *     StartDate: "STRING_VALUE",

diff --git a/clients/client-alexa-for-business/src/commands/CreateConferenceProviderCommand.ts b/clients/client-alexa-for-business/src/commands/CreateConferenceProviderCommand.ts
@@ -36,6 +36,8 @@ export interface CreateConferenceProviderCommandOutput extends CreateConferenceP
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Adds a new conference provider under the user's AWS account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -45,10 +47,10 @@ export interface CreateConferenceProviderCommandOutput extends CreateConferenceP
  * const client = new AlexaForBusinessClient(config);
  * const input = { // CreateConferenceProviderRequest
  *   ConferenceProviderName: "STRING_VALUE", // required
- *   ConferenceProviderType: "STRING_VALUE", // required
+ *   ConferenceProviderType: "CHIME" || "BLUEJEANS" || "FUZE" || "GOOGLE_HANGOUTS" || "POLYCOM" || "RINGCENTRAL" || "SKYPE_FOR_BUSINESS" || "WEBEX" || "ZOOM" || "CUSTOM", // required
  *   IPDialIn: { // IPDialIn
  *     Endpoint: "STRING_VALUE", // required
- *     CommsProtocol: "STRING_VALUE", // required
+ *     CommsProtocol: "SIP" || "SIPS" || "H323", // required
  *   },
  *   PSTNDialIn: { // PSTNDialIn
  *     CountryCode: "STRING_VALUE", // required
@@ -57,7 +59,7 @@ export interface CreateConferenceProviderCommandOutput extends CreateConferenceP
  *     OneClickPinDelay: "STRING_VALUE", // required
  *   },
  *   MeetingSetting: { // MeetingSetting
- *     RequirePin: "STRING_VALUE", // required
+ *     RequirePin: "YES" || "NO" || "OPTIONAL", // required
  *   },
  *   ClientRequestToken: "STRING_VALUE",
  *   Tags: [ // TagList

diff --git a/clients/client-alexa-for-business/src/commands/CreateContactCommand.ts b/clients/client-alexa-for-business/src/commands/CreateContactCommand.ts
@@ -40,6 +40,8 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Creates a contact with the specified details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -55,13 +57,13 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met
  *   PhoneNumbers: [ // PhoneNumberList
  *     { // PhoneNumber
  *       Number: "STRING_VALUE", // required
- *       Type: "STRING_VALUE", // required
+ *       Type: "MOBILE" || "WORK" || "HOME", // required
  *     },
  *   ],
  *   SipAddresses: [ // SipAddressList
  *     { // SipAddress
  *       Uri: "STRING_VALUE", // required
- *       Type: "STRING_VALUE", // required
+ *       Type: "WORK", // required
  *     },
  *   ],
  *   ClientRequestToken: "STRING_VALUE",

diff --git a/clients/client-alexa-for-business/src/commands/CreateGatewayGroupCommand.ts b/clients/client-alexa-for-business/src/commands/CreateGatewayGroupCommand.ts
@@ -36,6 +36,8 @@ export interface CreateGatewayGroupCommandOutput extends CreateGatewayGroupRespo
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Creates a gateway group with the specified details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/CreateNetworkProfileCommand.ts b/clients/client-alexa-for-business/src/commands/CreateNetworkProfileCommand.ts
@@ -40,6 +40,8 @@ export interface CreateNetworkProfileCommandOutput extends CreateNetworkProfileR
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Creates a network profile with the specified details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -51,8 +53,8 @@ export interface CreateNetworkProfileCommandOutput extends CreateNetworkProfileR
  *   NetworkProfileName: "STRING_VALUE", // required
  *   Description: "STRING_VALUE",
  *   Ssid: "STRING_VALUE", // required
- *   SecurityType: "STRING_VALUE", // required
- *   EapMethod: "STRING_VALUE",
+ *   SecurityType: "OPEN" || "WEP" || "WPA_PSK" || "WPA2_PSK" || "WPA2_ENTERPRISE", // required
+ *   EapMethod: "EAP_TLS",
  *   CurrentPassword: "STRING_VALUE",
  *   NextPassword: "STRING_VALUE",
  *   CertificateAuthorityArn: "STRING_VALUE",

diff --git a/clients/client-alexa-for-business/src/commands/CreateProfileCommand.ts b/clients/client-alexa-for-business/src/commands/CreateProfileCommand.ts
@@ -36,6 +36,8 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Creates a new room profile with the specified details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -47,9 +49,9 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
  *   ProfileName: "STRING_VALUE", // required
  *   Timezone: "STRING_VALUE", // required
  *   Address: "STRING_VALUE", // required
- *   DistanceUnit: "STRING_VALUE", // required
- *   TemperatureUnit: "STRING_VALUE", // required
- *   WakeWord: "STRING_VALUE", // required
+ *   DistanceUnit: "METRIC" || "IMPERIAL", // required
+ *   TemperatureUnit: "FAHRENHEIT" || "CELSIUS", // required
+ *   WakeWord: "ALEXA" || "AMAZON" || "ECHO" || "COMPUTER", // required
  *   Locale: "STRING_VALUE",
  *   ClientRequestToken: "STRING_VALUE",
  *   SetupModeDisabled: true || false,
@@ -62,7 +64,7 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
  *       ReminderAtMinutes: [ // EndOfMeetingReminderMinutesList // required
  *         Number("int"),
  *       ],
- *       ReminderType: "STRING_VALUE", // required
+ *       ReminderType: "ANNOUNCEMENT_TIME_CHECK" || "ANNOUNCEMENT_VARIABLE_TIME_LEFT" || "CHIME" || "KNOCK", // required
  *       Enabled: true || false, // required
  *     },
  *     InstantBooking: { // CreateInstantBooking
@@ -73,6 +75,9 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
  *       ReleaseAfterMinutes: Number("int"), // required
  *       Enabled: true || false, // required
  *     },
+ *     ProactiveJoin: { // CreateProactiveJoin
+ *       EnabledByMotion: true || false, // required
+ *     },
  *   },
  *   Tags: [ // TagList
  *     { // Tag

diff --git a/clients/client-alexa-for-business/src/commands/CreateRoomCommand.ts b/clients/client-alexa-for-business/src/commands/CreateRoomCommand.ts
@@ -36,6 +36,8 @@ export interface CreateRoomCommandOutput extends CreateRoomResponse, __MetadataB
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Creates a room with the specified details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/CreateSkillGroupCommand.ts b/clients/client-alexa-for-business/src/commands/CreateSkillGroupCommand.ts
@@ -36,6 +36,8 @@ export interface CreateSkillGroupCommandOutput extends CreateSkillGroupResponse,
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Creates a skill group with a specified name and description.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/CreateUserCommand.ts b/clients/client-alexa-for-business/src/commands/CreateUserCommand.ts
@@ -36,6 +36,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Creates a user.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/DeleteAddressBookCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteAddressBookCommand.ts
@@ -36,6 +36,8 @@ export interface DeleteAddressBookCommandOutput extends DeleteAddressBookRespons
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Deletes an address book by the address book ARN.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/DeleteBusinessReportScheduleCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteBusinessReportScheduleCommand.ts
@@ -41,6 +41,8 @@ export interface DeleteBusinessReportScheduleCommandOutput
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Deletes the recurring report delivery schedule with the specified schedule
  *          ARN.</p>
  * @example

diff --git a/clients/client-alexa-for-business/src/commands/DeleteConferenceProviderCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteConferenceProviderCommand.ts
@@ -36,6 +36,8 @@ export interface DeleteConferenceProviderCommandOutput extends DeleteConferenceP
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Deletes a conference provider.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/DeleteContactCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteContactCommand.ts
@@ -36,6 +36,8 @@ export interface DeleteContactCommandOutput extends DeleteContactResponse, __Met
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Deletes a contact by the contact ARN.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/DeleteDeviceCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteDeviceCommand.ts
@@ -36,6 +36,8 @@ export interface DeleteDeviceCommandOutput extends DeleteDeviceResponse, __Metad
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Removes a device from Alexa For Business.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/DeleteDeviceUsageDataCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteDeviceUsageDataCommand.ts
@@ -36,6 +36,8 @@ export interface DeleteDeviceUsageDataCommandOutput extends DeleteDeviceUsageDat
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>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.</p>
@@ -47,7 +49,7 @@ export interface DeleteDeviceUsageDataCommandOutput extends DeleteDeviceUsageDat
  * const client = new AlexaForBusinessClient(config);
  * const input = { // DeleteDeviceUsageDataRequest
  *   DeviceArn: "STRING_VALUE", // required
- *   DeviceUsageType: "STRING_VALUE", // required
+ *   DeviceUsageType: "VOICE", // required
  * };
  * const command = new DeleteDeviceUsageDataCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-alexa-for-business/src/commands/DeleteGatewayGroupCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteGatewayGroupCommand.ts
@@ -36,6 +36,8 @@ export interface DeleteGatewayGroupCommandOutput extends DeleteGatewayGroupRespo
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Deletes a gateway group.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/DeleteNetworkProfileCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteNetworkProfileCommand.ts
@@ -36,6 +36,8 @@ export interface DeleteNetworkProfileCommandOutput extends DeleteNetworkProfileR
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Deletes a network profile by the network profile ARN.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/DeleteProfileCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteProfileCommand.ts
@@ -36,6 +36,8 @@ export interface DeleteProfileCommandOutput extends DeleteProfileResponse, __Met
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Deletes a room profile by the profile ARN.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-alexa-for-business/src/commands/DeleteRoomCommand.ts b/clients/client-alexa-for-business/src/commands/DeleteRoomCommand.ts
@@ -36,6 +36,8 @@ export interface DeleteRoomCommandOutput extends DeleteRoomResponse, __MetadataB
 
 /**
  * @public
+ * @deprecated
+ *
  * <p>Deletes a room by the room ARN.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.