Skip to content

Commit

Permalink
feat(client-connect): Release Notes: 1) Analytics API enhancements: A…
Browse files Browse the repository at this point in the history
…dded new ListAnalyticsDataLakeDataSets API. 2) Onboarding API Idempotency: Adds ClientToken to instance creation and management APIs to support idempotency.
  • Loading branch information
awstools committed Feb 14, 2025
1 parent d356927 commit 6fb2941
Show file tree
Hide file tree
Showing 41 changed files with 946 additions and 217 deletions.
8 changes: 8 additions & 0 deletions clients/client-connect/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1305,6 +1305,14 @@ ListAnalyticsDataAssociations

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/ListAnalyticsDataAssociationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ListAnalyticsDataAssociationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ListAnalyticsDataAssociationsCommandOutput/)

</details>
<details>
<summary>
ListAnalyticsDataLakeDataSets
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/ListAnalyticsDataLakeDataSetsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ListAnalyticsDataLakeDataSetsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ListAnalyticsDataLakeDataSetsCommandOutput/)

</details>
<details>
<summary>
Expand Down
23 changes: 23 additions & 0 deletions clients/client-connect/src/Connect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,11 @@ import {
ListAnalyticsDataAssociationsCommandInput,
ListAnalyticsDataAssociationsCommandOutput,
} from "./commands/ListAnalyticsDataAssociationsCommand";
import {
ListAnalyticsDataLakeDataSetsCommand,
ListAnalyticsDataLakeDataSetsCommandInput,
ListAnalyticsDataLakeDataSetsCommandOutput,
} from "./commands/ListAnalyticsDataLakeDataSetsCommand";
import {
ListApprovedOriginsCommand,
ListApprovedOriginsCommandInput,
Expand Down Expand Up @@ -1465,6 +1470,7 @@ const commands = {
ImportPhoneNumberCommand,
ListAgentStatusesCommand,
ListAnalyticsDataAssociationsCommand,
ListAnalyticsDataLakeDataSetsCommand,
ListApprovedOriginsCommand,
ListAssociatedContactsCommand,
ListAuthenticationProfilesCommand,
Expand Down Expand Up @@ -3753,6 +3759,23 @@ export interface Connect {
cb: (err: any, data?: ListAnalyticsDataAssociationsCommandOutput) => void
): void;

/**
* @see {@link ListAnalyticsDataLakeDataSetsCommand}
*/
listAnalyticsDataLakeDataSets(
args: ListAnalyticsDataLakeDataSetsCommandInput,
options?: __HttpHandlerOptions
): Promise<ListAnalyticsDataLakeDataSetsCommandOutput>;
listAnalyticsDataLakeDataSets(
args: ListAnalyticsDataLakeDataSetsCommandInput,
cb: (err: any, data?: ListAnalyticsDataLakeDataSetsCommandOutput) => void
): void;
listAnalyticsDataLakeDataSets(
args: ListAnalyticsDataLakeDataSetsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListAnalyticsDataLakeDataSetsCommandOutput) => void
): void;

/**
* @see {@link ListApprovedOriginsCommand}
*/
Expand Down
6 changes: 6 additions & 0 deletions clients/client-connect/src/ConnectClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,10 @@ import {
ListAnalyticsDataAssociationsCommandInput,
ListAnalyticsDataAssociationsCommandOutput,
} from "./commands/ListAnalyticsDataAssociationsCommand";
import {
ListAnalyticsDataLakeDataSetsCommandInput,
ListAnalyticsDataLakeDataSetsCommandOutput,
} from "./commands/ListAnalyticsDataLakeDataSetsCommand";
import {
ListApprovedOriginsCommandInput,
ListApprovedOriginsCommandOutput,
Expand Down Expand Up @@ -1003,6 +1007,7 @@ export type ServiceInputTypes =
| ImportPhoneNumberCommandInput
| ListAgentStatusesCommandInput
| ListAnalyticsDataAssociationsCommandInput
| ListAnalyticsDataLakeDataSetsCommandInput
| ListApprovedOriginsCommandInput
| ListAssociatedContactsCommandInput
| ListAuthenticationProfilesCommandInput
Expand Down Expand Up @@ -1289,6 +1294,7 @@ export type ServiceOutputTypes =
| ImportPhoneNumberCommandOutput
| ListAgentStatusesCommandOutput
| ListAnalyticsDataAssociationsCommandOutput
| ListAnalyticsDataLakeDataSetsCommandOutput
| ListApprovedOriginsCommandOutput
| ListAssociatedContactsCommandOutput
| ListAuthenticationProfilesCommandOutput
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export interface AssociateApprovedOriginCommandOutput extends __MetadataBearer {
* const input = { // AssociateApprovedOriginRequest
* InstanceId: "STRING_VALUE", // required
* Origin: "STRING_VALUE", // required
* ClientToken: "STRING_VALUE",
* };
* const command = new AssociateApprovedOriginCommand(input);
* const response = await client.send(command);
Expand Down
1 change: 1 addition & 0 deletions clients/client-connect/src/commands/AssociateBotCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export interface AssociateBotCommandOutput extends __MetadataBearer {}
* LexV2Bot: { // LexV2Bot
* AliasArn: "STRING_VALUE",
* },
* ClientToken: "STRING_VALUE",
* };
* const command = new AssociateBotCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ export interface AssociateInstanceStorageConfigCommandOutput
* FirehoseArn: "STRING_VALUE", // required
* },
* },
* ClientToken: "STRING_VALUE",
* };
* const command = new AssociateInstanceStorageConfigCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export interface AssociateLambdaFunctionCommandOutput extends __MetadataBearer {
* const input = { // AssociateLambdaFunctionRequest
* InstanceId: "STRING_VALUE", // required
* FunctionArn: "STRING_VALUE", // required
* ClientToken: "STRING_VALUE",
* };
* const command = new AssociateLambdaFunctionCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export interface AssociateLexBotCommandOutput extends __MetadataBearer {}
* Name: "STRING_VALUE", // required
* LexRegion: "STRING_VALUE", // required
* },
* ClientToken: "STRING_VALUE",
* };
* const command = new AssociateLexBotCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export interface AssociateSecurityKeyCommandOutput extends AssociateSecurityKeyR
* const input = { // AssociateSecurityKeyRequest
* InstanceId: "STRING_VALUE", // required
* Key: "STRING_VALUE", // required
* ClientToken: "STRING_VALUE",
* };
* const command = new AssociateSecurityKeyCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ export interface BatchAssociateAnalyticsDataSetCommandOutput
* // TargetAccountId: "STRING_VALUE",
* // ResourceShareId: "STRING_VALUE",
* // ResourceShareArn: "STRING_VALUE",
* // ResourceShareStatus: "STRING_VALUE",
* // },
* // ],
* // Errors: [ // ErrorResults
Expand Down
4 changes: 2 additions & 2 deletions clients/client-connect/src/commands/CreateContactCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met

/**
* <important>
* <p>Only the EMAIL channel is supported. The supported initiation
* methods are: OUTBOUND, AGENT_REPLY, and FLOW.</p>
* <p>Only the EMAIL channel is supported. The supported initiation methods are: OUTBOUND,
* AGENT_REPLY, and FLOW.</p>
* </important>
* <p>Creates a new EMAIL contact. </p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export interface DeleteInstanceCommandOutput extends __MetadataBearer {}
* const client = new ConnectClient(config);
* const input = { // DeleteInstanceRequest
* InstanceId: "STRING_VALUE", // required
* ClientToken: "STRING_VALUE",
* };
* const command = new DeleteInstanceCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export interface DescribeAuthenticationProfileCommandOutput

/**
* <p>This API is in preview release for Amazon Connect and is subject to change. To
* request access to this API, contact Amazon Web Services Support.</p>
* request access to this API, contact Amazon Web ServicesSupport.</p>
* <p>Describes the target authentication profile.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
14 changes: 11 additions & 3 deletions clients/client-connect/src/commands/DescribeContactCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,17 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
* <p>Describes the specified contact. </p>
* <important>
* <p>Contact information remains available in Amazon Connect for 24 months from the
* InitiationTimestamp, and then it is deleted. Only contact information that is available in
* Amazon Connect is returned by this API</p>
* <ul>
* <li>
* <p>
* <code>CustomerEndpoint</code> and <code>SystemEndpoint</code> are only populated for EMAIL contacts. </p>
* </li>
* <li>
* <p>Contact information remains available in Amazon Connect for 24 months from the
* <code>InitiationTimestamp</code>, and then it is deleted. Only contact information that is available in
* Amazon Connect is returned by this API.</p>
* </li>
* </ul>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export interface DisassociateApprovedOriginCommandOutput extends __MetadataBeare
* const input = { // DisassociateApprovedOriginRequest
* InstanceId: "STRING_VALUE", // required
* Origin: "STRING_VALUE", // required
* ClientToken: "STRING_VALUE",
* };
* const command = new DisassociateApprovedOriginCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export interface DisassociateBotCommandOutput extends __MetadataBearer {}
* LexV2Bot: { // LexV2Bot
* AliasArn: "STRING_VALUE",
* },
* ClientToken: "STRING_VALUE",
* };
* const command = new DisassociateBotCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export interface DisassociateInstanceStorageConfigCommandOutput extends __Metada
* InstanceId: "STRING_VALUE", // required
* AssociationId: "STRING_VALUE", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS" || "SCREEN_RECORDINGS" || "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS" || "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS" || "EMAIL_MESSAGES", // required
* ClientToken: "STRING_VALUE",
* };
* const command = new DisassociateInstanceStorageConfigCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export interface DisassociateLambdaFunctionCommandOutput extends __MetadataBeare
* const input = { // DisassociateLambdaFunctionRequest
* InstanceId: "STRING_VALUE", // required
* FunctionArn: "STRING_VALUE", // required
* ClientToken: "STRING_VALUE",
* };
* const command = new DisassociateLambdaFunctionCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export interface DisassociateLexBotCommandOutput extends __MetadataBearer {}
* InstanceId: "STRING_VALUE", // required
* BotName: "STRING_VALUE", // required
* LexRegion: "STRING_VALUE", // required
* ClientToken: "STRING_VALUE",
* };
* const command = new DisassociateLexBotCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export interface DisassociateSecurityKeyCommandOutput extends __MetadataBearer {
* const input = { // DisassociateSecurityKeyRequest
* InstanceId: "STRING_VALUE", // required
* AssociationId: "STRING_VALUE", // required
* ClientToken: "STRING_VALUE",
* };
* const command = new DisassociateSecurityKeyCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export interface ImportPhoneNumberCommandOutput extends ImportPhoneNumberRespons
* <p>For example, if you already have 99 claimed or imported numbers and a service level quota of
* 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you
* will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers
* until you open an Amazon Web Services Support ticket. </p>
* until you open an Amazon Web ServicesSupport ticket. </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ export interface ListAnalyticsDataAssociationsCommandOutput
* // TargetAccountId: "STRING_VALUE",
* // ResourceShareId: "STRING_VALUE",
* // ResourceShareArn: "STRING_VALUE",
* // ResourceShareStatus: "STRING_VALUE",
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
// smithy-typescript generated code
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
import { getSerdePlugin } from "@smithy/middleware-serde";
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
import { commonParams } from "../endpoint/EndpointParameters";
import { ListAnalyticsDataLakeDataSetsRequest, ListAnalyticsDataLakeDataSetsResponse } from "../models/models_1";
import {
de_ListAnalyticsDataLakeDataSetsCommand,
se_ListAnalyticsDataLakeDataSetsCommand,
} from "../protocols/Aws_restJson1";

/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link ListAnalyticsDataLakeDataSetsCommand}.
*/
export interface ListAnalyticsDataLakeDataSetsCommandInput extends ListAnalyticsDataLakeDataSetsRequest {}
/**
* @public
*
* The output of {@link ListAnalyticsDataLakeDataSetsCommand}.
*/
export interface ListAnalyticsDataLakeDataSetsCommandOutput
extends ListAnalyticsDataLakeDataSetsResponse,
__MetadataBearer {}

/**
* <p>Lists the data lake datasets available to associate with for a given Amazon Connect
* instance.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { ConnectClient, ListAnalyticsDataLakeDataSetsCommand } from "@aws-sdk/client-connect"; // ES Modules import
* // const { ConnectClient, ListAnalyticsDataLakeDataSetsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
* const client = new ConnectClient(config);
* const input = { // ListAnalyticsDataLakeDataSetsRequest
* InstanceId: "STRING_VALUE", // required
* NextToken: "STRING_VALUE",
* MaxResults: Number("int"),
* };
* const command = new ListAnalyticsDataLakeDataSetsCommand(input);
* const response = await client.send(command);
* // { // ListAnalyticsDataLakeDataSetsResponse
* // Results: [ // AnalyticsDataSetsResults
* // { // AnalyticsDataSetsResult
* // DataSetId: "STRING_VALUE",
* // DataSetName: "STRING_VALUE",
* // },
* // ],
* // NextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param ListAnalyticsDataLakeDataSetsCommandInput - {@link ListAnalyticsDataLakeDataSetsCommandInput}
* @returns {@link ListAnalyticsDataLakeDataSetsCommandOutput}
* @see {@link ListAnalyticsDataLakeDataSetsCommandInput} for command's `input` shape.
* @see {@link ListAnalyticsDataLakeDataSetsCommandOutput} for command's `response` shape.
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
*
* @throws {@link InternalServiceException} (server fault)
* <p>Request processing failed because of an error or failure with the service.</p>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>One or more of the specified parameters are not valid.</p>
*
* @throws {@link InvalidRequestException} (client fault)
* <p>The request is not valid.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The specified resource was not found.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The throttling limit has been exceeded.</p>
*
* @throws {@link ConnectServiceException}
* <p>Base exception class for all service exceptions from Connect service.</p>
*
* @public
*/
export class ListAnalyticsDataLakeDataSetsCommand extends $Command
.classBuilder<
ListAnalyticsDataLakeDataSetsCommandInput,
ListAnalyticsDataLakeDataSetsCommandOutput,
ConnectClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes
>()
.ep(commonParams)
.m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) {
return [
getSerdePlugin(config, this.serialize, this.deserialize),
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
];
})
.s("AmazonConnectService", "ListAnalyticsDataLakeDataSets", {})
.n("ConnectClient", "ListAnalyticsDataLakeDataSetsCommand")
.f(void 0, void 0)
.ser(se_ListAnalyticsDataLakeDataSetsCommand)
.de(de_ListAnalyticsDataLakeDataSetsCommand)
.build() {
/** @internal type navigation helper, not in runtime. */
protected declare static __types: {
api: {
input: ListAnalyticsDataLakeDataSetsRequest;
output: ListAnalyticsDataLakeDataSetsResponse;
};
sdk: {
input: ListAnalyticsDataLakeDataSetsCommandInput;
output: ListAnalyticsDataLakeDataSetsCommandOutput;
};
};
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface ListAuthenticationProfilesCommandOutput extends ListAuthenticat

/**
* <p>This API is in preview release for Amazon Connect and is subject to change. To
* request access to this API, contact Amazon Web Services Support.</p>
* request access to this API, contact Amazon Web ServicesSupport.</p>
* <p>Provides summary information about the authentication profiles in a specified Amazon Connect instance.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
3 changes: 2 additions & 1 deletion clients/client-connect/src/commands/ListQueuesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
import { commonParams } from "../endpoint/EndpointParameters";
import { ListQueuesRequest, ListQueuesResponse } from "../models/models_1";
import { ListQueuesRequest } from "../models/models_1";
import { ListQueuesResponse } from "../models/models_2";
import { de_ListQueuesCommand, se_ListQueuesCommand } from "../protocols/Aws_restJson1";

/**
Expand Down
Loading

0 comments on commit 6fb2941

Please sign in to comment.