Skip to content

Commit

Permalink
chore: move deprecation after description in comments (#5911)
Browse files Browse the repository at this point in the history
  • Loading branch information
trivikr committed Mar 15, 2024
1 parent 85ac6b4 commit 6bb7caa
Show file tree
Hide file tree
Showing 431 changed files with 963 additions and 530 deletions.
3 changes: 2 additions & 1 deletion clients/client-alexa-for-business/src/AlexaForBusiness.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1911,8 +1911,9 @@ export interface AlexaForBusiness {

/**
* <p>Alexa for Business has been retired and is no longer supported.</p>
* @public
*
* @deprecated Alexa For Business is no longer supported
* @public
*/
export class AlexaForBusiness extends AlexaForBusinessClient implements AlexaForBusiness {}
createAggregatedClient(commands, AlexaForBusiness);
Original file line number Diff line number Diff line change
Expand Up @@ -643,8 +643,9 @@ export interface AlexaForBusinessClientResolvedConfig extends AlexaForBusinessCl

/**
* <p>Alexa for Business has been retired and is no longer supported.</p>
* @public
*
* @deprecated Alexa For Business is no longer supported
* @public
*/
export class AlexaForBusinessClient extends __Client<
__HttpHandlerOptions,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ export interface ApproveSkillCommandOutput extends ApproveSkillResponse, __Metad
/**
* <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>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -63,7 +65,6 @@ export interface ApproveSkillCommandOutput extends ApproveSkillResponse, __Metad
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class ApproveSkillCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface AssociateContactWithAddressBookCommandOutput

/**
* <p>Associates a contact with a given address book.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -62,7 +64,6 @@ export interface AssociateContactWithAddressBookCommandOutput
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class AssociateContactWithAddressBookCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ export interface AssociateDeviceWithNetworkProfileCommandOutput

/**
* <p>Associates a device with the specified network profile.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -71,7 +73,6 @@ export interface AssociateDeviceWithNetworkProfileCommandOutput
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class AssociateDeviceWithNetworkProfileCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ export interface AssociateDeviceWithRoomCommandOutput extends AssociateDeviceWit
* <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>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -65,7 +67,6 @@ export interface AssociateDeviceWithRoomCommandOutput extends AssociateDeviceWit
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class AssociateDeviceWithRoomCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ export interface AssociateSkillGroupWithRoomCommandOutput
/**
* <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>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -60,7 +62,6 @@ export interface AssociateSkillGroupWithRoomCommandOutput
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class AssociateSkillGroupWithRoomCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export interface AssociateSkillWithSkillGroupCommandOutput

/**
* <p>Associates a skill with a skill group.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -68,7 +70,6 @@ export interface AssociateSkillWithSkillGroupCommandOutput
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class AssociateSkillWithSkillGroupCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface AssociateSkillWithUsersCommandOutput extends AssociateSkillWith

/**
* <p>Makes a private skill available for enrolled users to enable on their devices.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -59,7 +61,6 @@ export interface AssociateSkillWithUsersCommandOutput extends AssociateSkillWith
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class AssociateSkillWithUsersCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface CreateAddressBookCommandOutput extends CreateAddressBookRespons

/**
* <p>Creates an address book with the specified details.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -69,7 +71,6 @@ export interface CreateAddressBookCommandOutput extends CreateAddressBookRespons
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateAddressBookCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface CreateBusinessReportScheduleCommandOutput
/**
* <p>Creates a recurring schedule for usage reports to deliver to the specified S3
* location with a specified daily or weekly interval.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -80,7 +82,6 @@ export interface CreateBusinessReportScheduleCommandOutput
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateBusinessReportScheduleCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface CreateConferenceProviderCommandOutput extends CreateConferenceP

/**
* <p>Adds a new conference provider under the user's AWS account.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -79,7 +81,6 @@ export interface CreateConferenceProviderCommandOutput extends CreateConferenceP
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateConferenceProviderCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met

/**
* <p>Creates a contact with the specified details.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -87,7 +89,6 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateContactCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface CreateGatewayGroupCommandOutput extends CreateGatewayGroupRespo

/**
* <p>Creates a gateway group with the specified details.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -69,7 +71,6 @@ export interface CreateGatewayGroupCommandOutput extends CreateGatewayGroupRespo
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateGatewayGroupCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ export interface CreateNetworkProfileCommandOutput extends CreateNetworkProfileR

/**
* <p>Creates a network profile with the specified details.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -91,7 +93,6 @@ export interface CreateNetworkProfileCommandOutput extends CreateNetworkProfileR
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateNetworkProfileCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met

/**
* <p>Creates a new room profile with the specified details.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -102,7 +104,6 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateProfileCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface CreateRoomCommandOutput extends CreateRoomResponse, __MetadataB

/**
* <p>Creates a room with the specified details.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -71,7 +73,6 @@ export interface CreateRoomCommandOutput extends CreateRoomResponse, __MetadataB
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateRoomCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface CreateSkillGroupCommandOutput extends CreateSkillGroupResponse,

/**
* <p>Creates a skill group with a specified name and description.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -72,7 +74,6 @@ export interface CreateSkillGroupCommandOutput extends CreateSkillGroupResponse,
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateSkillGroupCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB

/**
* <p>Creates a user.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -74,7 +76,6 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class CreateUserCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface DeleteAddressBookCommandOutput extends DeleteAddressBookRespons

/**
* <p>Deletes an address book by the address book ARN.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -59,7 +61,6 @@ export interface DeleteAddressBookCommandOutput extends DeleteAddressBookRespons
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class DeleteAddressBookCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export interface DeleteBusinessReportScheduleCommandOutput
/**
* <p>Deletes the recurring report delivery schedule with the specified schedule
* ARN.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -65,7 +67,6 @@ export interface DeleteBusinessReportScheduleCommandOutput
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class DeleteBusinessReportScheduleCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface DeleteConferenceProviderCommandOutput extends DeleteConferenceP

/**
* <p>Deletes a conference provider.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -56,7 +58,6 @@ export interface DeleteConferenceProviderCommandOutput extends DeleteConferenceP
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class DeleteConferenceProviderCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface DeleteContactCommandOutput extends DeleteContactResponse, __Met

/**
* <p>Deletes a contact by the contact ARN.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -59,7 +61,6 @@ export interface DeleteContactCommandOutput extends DeleteContactResponse, __Met
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class DeleteContactCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ export interface DeleteDeviceCommandOutput extends DeleteDeviceResponse, __Metad

/**
* <p>Removes a device from Alexa For Business.</p>
*
* @deprecated Alexa For Business is no longer supported
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -62,7 +64,6 @@ export interface DeleteDeviceCommandOutput extends DeleteDeviceResponse, __Metad
* <p>Base exception class for all service exceptions from AlexaForBusiness service.</p>
*
* @public
* @deprecated Alexa For Business is no longer supported
*/
export class DeleteDeviceCommand extends $Command
.classBuilder<
Expand Down
Loading

0 comments on commit 6bb7caa

Please sign in to comment.