Skip to content

Commit

Permalink
feat(client-chime): The Amazon Chime SDK APIs in the Chime namespace …
Browse files Browse the repository at this point in the history 
…are no longer supported. Customers should use APIs in the dedicated Amazon Chime SDK namespaces: ChimeSDKIdentity, ChimeSDKMediaPipelines, ChimeSDKMeetings, ChimeSDKMessaging, and ChimeSDKVoice.
  • Loading branch information
awstools committed Jun 29, 2023
1 parent 8c61b34 commit a6ff65f
Show file tree
Hide file tree
Showing 140 changed files with 1,792 additions and 187 deletions.
11 changes: 10 additions & 1 deletion clients/client-chime/README.md
View file
Expand Up @@ -6,12 +6,21 @@

AWS SDK for JavaScript Chime Client for Node.js, Browser and React Native.

<important>
<p>
<b>Most of these APIs are no longer supported and will not be updated.</b> We recommend using the latest versions in the
<a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/welcome.html">Amazon Chime SDK API reference</a>, in the Amazon Chime SDK.</p>
<p>Using the latest versions requires migrating to dedicated namespaces. For more information, refer to
<a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
<i>Amazon Chime SDK Developer Guide</i>.</p>
</important>
<p>The Amazon Chime application programming interface (API) is designed so administrators can
perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice
Connectors. This guide provides detailed information about the Amazon Chime API,
including operations, types, inputs and outputs, and error codes.</p>
<p>You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the
AWS CLI. The page for each API action contains a <i>See Also</i> section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.</p>
AWS CLI. The page for each API action contains a <i>See Also</i> section that includes links to information about using the action with a language-specific
AWS SDK or the AWS CLI.</p>
<dl>
<dt>Using an AWS SDK</dt>
<dd>
Expand Down
15 changes: 13 additions & 2 deletions clients/client-chime/src/Chime.ts
View file
Expand Up @@ -4043,12 +4043,23 @@ export interface Chime {

/**
* @public
* <p>The Amazon Chime application programming interface (API) is designed so administrators can
* @deprecated
*
* <important>
* <p>
* <b>Most of these APIs are no longer supported and will not be updated.</b> We recommend using the latest versions in the
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/welcome.html">Amazon Chime SDK API reference</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest versions requires migrating to dedicated namespaces. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* <p>The Amazon Chime application programming interface (API) is designed so administrators can
* perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice
* Connectors. This guide provides detailed information about the Amazon Chime API,
* including operations, types, inputs and outputs, and error codes.</p>
* <p>You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the
* AWS CLI. The page for each API action contains a <i>See Also</i> section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.</p>
* AWS CLI. The page for each API action contains a <i>See Also</i> section that includes links to information about using the action with a language-specific
* AWS SDK or the AWS CLI.</p>
* <dl>
* <dt>Using an AWS SDK</dt>
* <dd>
Expand Down
15 changes: 13 additions & 2 deletions clients/client-chime/src/ChimeClient.ts
View file
Expand Up @@ -1151,12 +1151,23 @@ export interface ChimeClientResolvedConfig extends ChimeClientResolvedConfigType

/**
* @public
* <p>The Amazon Chime application programming interface (API) is designed so administrators can
* @deprecated
*
* <important>
* <p>
* <b>Most of these APIs are no longer supported and will not be updated.</b> We recommend using the latest versions in the
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/welcome.html">Amazon Chime SDK API reference</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest versions requires migrating to dedicated namespaces. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* <p>The Amazon Chime application programming interface (API) is designed so administrators can
* perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice
* Connectors. This guide provides detailed information about the Amazon Chime API,
* including operations, types, inputs and outputs, and error codes.</p>
* <p>You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the
* AWS CLI. The page for each API action contains a <i>See Also</i> section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.</p>
* AWS CLI. The page for each API action contains a <i>See Also</i> section that includes links to information about using the action with a language-specific
* AWS SDK or the AWS CLI.</p>
* <dl>
* <dt>Using an AWS SDK</dt>
* <dd>
Expand Down
9 changes: 9 additions & 0 deletions clients/client-chime/src/commands/AssociatePhoneNumbersWithVoiceConnectorCommand.ts
View file
Expand Up @@ -46,7 +46,16 @@ export interface AssociatePhoneNumbersWithVoiceConnectorCommandOutput

/**
* @public
* @deprecated
*
* <p>Associates phone numbers with the specified Amazon Chime Voice Connector.</p>
* <important>
* <p>
* <b>This API is is no longer supported and will not be updated.</b> We recommend using the latest version, <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnector.html">AssociatePhoneNumbersWithVoiceConnector</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest version requires migrating to a dedicated namespace. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
9 changes: 9 additions & 0 deletions clients/client-chime/src/commands/AssociatePhoneNumbersWithVoiceConnectorGroupCommand.ts
View file
Expand Up @@ -46,7 +46,16 @@ export interface AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput

/**
* @public
* @deprecated
*
* <p>Associates phone numbers with the specified Amazon Chime Voice Connector group.</p>
* <important>
* <p>
* <b>This API is is no longer supported and will not be updated.</b> We recommend using the latest version, <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup.html">AssociatePhoneNumbersWithVoiceConnectorGroup</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest version requires migrating to a dedicated namespace. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
13 changes: 11 additions & 2 deletions clients/client-chime/src/commands/BatchCreateAttendeeCommand.ts
View file
Expand Up @@ -41,8 +41,17 @@ export interface BatchCreateAttendeeCommandOutput extends BatchCreateAttendeeRes

/**
* @public
* <p>
* Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see
* @deprecated
*
* <p>Creates up to 100 new attendees for an active Amazon Chime SDK meeting.</p>
* <important>
* <p>
* <b>This API is is no longer supported and will not be updated.</b> We recommend using the latest version, <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_BatchCreateAttendee.html">BatchCreateAttendee</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest version requires migrating to a dedicated namespace. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* <p>For more information about the Amazon Chime SDK, see
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
* in the
* <i>Amazon Chime SDK Developer Guide</i>.
Expand Down
9 changes: 9 additions & 0 deletions clients/client-chime/src/commands/BatchCreateChannelMembershipCommand.ts
View file
Expand Up @@ -45,7 +45,16 @@ export interface BatchCreateChannelMembershipCommandOutput

/**
* @public
* @deprecated
*
* <p>Adds a specified number of users to a channel.</p>
* <important>
* <p>
* <b>This API is is no longer supported and will not be updated.</b> We recommend using the latest version, <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_BatchCreateChannelMembership.html">BatchCreateChannelMembership</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest version requires migrating to a dedicated namespace. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 2 additions & 1 deletion clients/client-chime/src/commands/BatchCreateRoomMembershipCommand.ts
View file
Expand Up @@ -36,7 +36,8 @@ export interface BatchCreateRoomMembershipCommandOutput extends BatchCreateRoomM

/**
* @public
* <p>Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.</p>
* <p>Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a
* chat room administrator or a general chat room member.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
7 changes: 3 additions & 4 deletions clients/client-chime/src/commands/BatchSuspendUserCommand.ts
View file
Expand Up @@ -44,12 +44,11 @@ export interface BatchSuspendUserCommandOutput extends BatchSuspendUserResponse,
* <code>Team</code> account users, invite them to the <code>Team</code> account again.
* You can use the <a>InviteUsers</a> action to do so.</p>
* <p>Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of
* Amazon Chime and can no longer sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <a>BatchUnsuspendUser</a> action.</p>
* Amazon Chime and can no longer sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the
* <a>BatchUnsuspendUser</a> action.</p>
* <p>
* To sign out users without suspending them, use the
* <a>LogoutUser</a>
* action.
* </p>
* <a>LogoutUser</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
6 changes: 2 additions & 4 deletions clients/client-chime/src/commands/BatchUnsuspendUserCommand.ts
View file
Expand Up @@ -43,11 +43,9 @@ export interface BatchUnsuspendUserCommandOutput extends BatchUnsuspendUserRespo
* Managing Your Amazon Chime Accounts
* </a> in the account types, in the <i>Amazon Chime Administration Guide</i>.
* </p>
* <p>
* Previously suspended users who are unsuspended using this action are returned to
* <p>Previously suspended users who are unsuspended using this action are returned to
* <code>Registered</code>
* status. Users who are not previously suspended are ignored.
* </p>
* status. Users who are not previously suspended are ignored.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 2 additions & 1 deletion clients/client-chime/src/commands/CreateAccountCommand.ts
View file
Expand Up @@ -38,7 +38,8 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met
* @public
* <p>Creates an Amazon Chime account under the administrator's AWS account. Only <code>Team</code>
* account types are currently supported for this action. For more information about different account types, see
* <a href="https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p>
* <a href="https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime
* Administration Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
12 changes: 10 additions & 2 deletions clients/client-chime/src/commands/CreateAppInstanceAdminCommand.ts
View file
Expand Up @@ -40,8 +40,16 @@ export interface CreateAppInstanceAdminCommandOutput extends CreateAppInstanceAd

/**
* @public
* <p>Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The promoted user can perform the following actions.
* </p>
* @deprecated
*
* <p>Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The promoted user can perform the following actions. </p>
* <important>
* <p>
* <b>This API is is no longer supported and will not be updated.</b> We recommend using the latest version, <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceAdmin.html">CreateAppInstanceAdmin</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest version requires migrating to a dedicated namespace. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* <ul>
* <li>
* <p>
Expand Down
9 changes: 9 additions & 0 deletions clients/client-chime/src/commands/CreateAppInstanceCommand.ts
View file
Expand Up @@ -40,8 +40,17 @@ export interface CreateAppInstanceCommandOutput extends CreateAppInstanceRespons

/**
* @public
* @deprecated
*
* <p>Creates an Amazon Chime SDK messaging <code>AppInstance</code> under an AWS account. Only SDK messaging customers use this API.
* <code>CreateAppInstance</code> supports idempotency behavior as described in the AWS API Standard.</p>
* <important>
* <p>
* <b>This API is is no longer supported and will not be updated.</b> We recommend using the latest version, <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstance.html">CreateAppInstance</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest version requires migrating to a dedicated namespace. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
9 changes: 9 additions & 0 deletions clients/client-chime/src/commands/CreateAppInstanceUserCommand.ts
View file
Expand Up @@ -40,8 +40,17 @@ export interface CreateAppInstanceUserCommandOutput extends CreateAppInstanceUse

/**
* @public
* @deprecated
*
* <p>Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and
* <code>Name</code> for that user.</p>
* <important>
* <p>
* <b>This API is is no longer supported and will not be updated.</b> We recommend using the latest version, <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceUser.html">CreateAppInstanceUser</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest version requires migrating to a dedicated namespace. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
9 changes: 9 additions & 0 deletions clients/client-chime/src/commands/CreateAttendeeCommand.ts
View file
Expand Up @@ -41,12 +41,21 @@ export interface CreateAttendeeCommandOutput extends CreateAttendeeResponse, __M

/**
* @public
* @deprecated
*
* <p>
* Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
* in the
* <i>Amazon Chime SDK Developer Guide</i>.
* </p>
* <important>
* <p>
* <b>This API is is no longer supported and will not be updated.</b> We recommend using the latest version, <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateAttendee.html">CreateAttendee</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest version requires migrating to a dedicated namespace. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
9 changes: 9 additions & 0 deletions clients/client-chime/src/commands/CreateChannelBanCommand.ts
View file
Expand Up @@ -40,6 +40,8 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,

/**
* @public
* @deprecated
*
* <p>Permanently bans a member from a channel. Moderators can't add banned members to a
* channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then
* <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or
Expand All @@ -51,6 +53,13 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
* the header.</p>
* </note>
* <important>
* <p>
* <b>This API is is no longer supported and will not be updated.</b> We recommend using the latest version, <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelBan.html">CreateChannelBan</a>, in the Amazon Chime SDK.</p>
* <p>Using the latest version requires migrating to a dedicated namespace. For more information, refer to
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html">Migrating from the Amazon Chime namespace</a> in the
* <i>Amazon Chime SDK Developer Guide</i>.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down

0 comments on commit a6ff65f

Please sign in to comment.