@aws-sdk/client-connect-contact-lens 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist-types/ConnectContactLens.d.ts +2 -0
  2. package/dist-types/ConnectContactLensClient.d.ts +24 -4
  3. package/dist-types/commands/ListRealtimeContactAnalysisSegmentsCommand.d.ts +16 -0
  4. package/dist-types/models/ConnectContactLensServiceException.d.ts +2 -0
  5. package/dist-types/models/models_0.d.ts +21 -0
  6. package/dist-types/pagination/Interfaces.d.ts +3 -0
  7. package/dist-types/pagination/ListRealtimeContactAnalysisSegmentsPaginator.d.ts +3 -0
  8. package/package.json +29 -29
package/dist-types/ConnectContactLens.d.ts CHANGED
@@ -2,6 +2,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
2
2
  import { ListRealtimeContactAnalysisSegmentsCommandInput, ListRealtimeContactAnalysisSegmentsCommandOutput } from "./commands/ListRealtimeContactAnalysisSegmentsCommand";
3
3
  import { ConnectContactLensClient } from "./ConnectContactLensClient";
4
4
  /**
5
+ * @public
5
6
  * <p>Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents,
6
7
  * by using speech transcription, natural language processing, and intelligent search
7
8
  * capabilities. It performs sentiment analysis, detects issues, and enables you to automatically
@@ -12,6 +13,7 @@ import { ConnectContactLensClient } from "./ConnectContactLensClient";
12
13
  */
13
14
  export declare class ConnectContactLens extends ConnectContactLensClient {
14
15
  /**
16
+ * @public
15
17
  * <p>Provides a list of analysis segments for a real-time analysis session.</p>
16
18
  */
17
19
  listRealtimeContactAnalysisSegments(args: ListRealtimeContactAnalysisSegmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListRealtimeContactAnalysisSegmentsCommandOutput>;
package/dist-types/ConnectContactLensClient.d.ts CHANGED
@@ -9,15 +9,24 @@ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration
9
9
  import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
10
10
  import { ListRealtimeContactAnalysisSegmentsCommandInput, ListRealtimeContactAnalysisSegmentsCommandOutput } from "./commands/ListRealtimeContactAnalysisSegmentsCommand";
11
11
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
12
+ /**
13
+ * @public
14
+ */
12
15
  export type ServiceInputTypes = ListRealtimeContactAnalysisSegmentsCommandInput;
16
+ /**
17
+ * @public
18
+ */
13
19
  export type ServiceOutputTypes = ListRealtimeContactAnalysisSegmentsCommandOutput;
20
+ /**
21
+ * @public
22
+ */
14
23
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
15
24
  /**
16
25
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
17
26
  */
18
27
  requestHandler?: __HttpHandler;
19
28
  /**
20
- * A constructor for a class implementing the {@link __Checksum} interface
29
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
21
30
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
22
31
  * @internal
23
32
  */
@@ -107,23 +116,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
107
116
  */
108
117
  logger?: __Logger;
109
118
  /**
110
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
119
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
111
120
  */
112
121
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
113
122
  }
123
+ /**
124
+ * @public
125
+ */
114
126
  type ConnectContactLensClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
115
127
  /**
116
- * The configuration interface of ConnectContactLensClient class constructor that set the region, credentials and other options.
128
+ * @public
129
+ *
130
+ * The configuration interface of ConnectContactLensClient class constructor that set the region, credentials and other options.
117
131
  */
118
132
  export interface ConnectContactLensClientConfig extends ConnectContactLensClientConfigType {
119
133
  }
134
+ /**
135
+ * @public
136
+ */
120
137
  type ConnectContactLensClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
121
138
  /**
122
- * The resolved configuration interface of ConnectContactLensClient class. This is resolved and normalized from the {@link ConnectContactLensClientConfig | constructor configuration interface}.
139
+ * @public
140
+ *
141
+ * The resolved configuration interface of ConnectContactLensClient class. This is resolved and normalized from the {@link ConnectContactLensClientConfig | constructor configuration interface}.
123
142
  */
124
143
  export interface ConnectContactLensClientResolvedConfig extends ConnectContactLensClientResolvedConfigType {
125
144
  }
126
145
  /**
146
+ * @public
127
147
  * <p>Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents,
128
148
  * by using speech transcription, natural language processing, and intelligent search
129
149
  * capabilities. It performs sentiment analysis, detects issues, and enables you to automatically
package/dist-types/commands/ListRealtimeContactAnalysisSegmentsCommand.d.ts CHANGED
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectContactLensClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectContactLensClient";
5
5
  import { ListRealtimeContactAnalysisSegmentsRequest, ListRealtimeContactAnalysisSegmentsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListRealtimeContactAnalysisSegmentsCommand}.
8
10
  */
9
11
  export interface ListRealtimeContactAnalysisSegmentsCommandInput extends ListRealtimeContactAnalysisSegmentsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListRealtimeContactAnalysisSegmentsCommand}.
13
17
  */
14
18
  export interface ListRealtimeContactAnalysisSegmentsCommandOutput extends ListRealtimeContactAnalysisSegmentsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides a list of analysis segments for a real-time analysis session.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListRealtimeContactAnalysisSegmentsCommandOutput extends ListRe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListRealtimeContactAnalysisSegmentsCommandInput - {@link ListRealtimeContactAnalysisSegmentsCommandInput}
34
+ * @returns {@link ListRealtimeContactAnalysisSegmentsCommandOutput}
28
35
  * @see {@link ListRealtimeContactAnalysisSegmentsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListRealtimeContactAnalysisSegmentsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectContactLensClientResolvedConfig | config} for ConnectContactLensClient's `config` shape.
@@ -49,11 +56,20 @@ export interface ListRealtimeContactAnalysisSegmentsCommandOutput extends ListRe
49
56
  export declare class ListRealtimeContactAnalysisSegmentsCommand extends $Command<ListRealtimeContactAnalysisSegmentsCommandInput, ListRealtimeContactAnalysisSegmentsCommandOutput, ConnectContactLensClientResolvedConfig> {
50
57
  readonly input: ListRealtimeContactAnalysisSegmentsCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: ListRealtimeContactAnalysisSegmentsCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectContactLensClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRealtimeContactAnalysisSegmentsCommandInput, ListRealtimeContactAnalysisSegmentsCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
package/dist-types/models/ConnectContactLensServiceException.d.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from ConnectContactLens service.
4
6
  */
5
7
  export declare class ConnectContactLensServiceException extends __ServiceException {
package/dist-types/models/models_0.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ConnectContactLensServiceException as __BaseException } from "./ConnectContactLensServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You do not have sufficient access to perform this action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -13,6 +14,7 @@ export declare class AccessDeniedException extends __BaseException {
13
14
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
15
  }
15
16
  /**
17
+ * @public
16
18
  * <p>Request processing failed due to an error or failure with the service.</p>
17
19
  */
18
20
  export declare class InternalServiceException extends __BaseException {
@@ -25,6 +27,7 @@ export declare class InternalServiceException extends __BaseException {
25
27
  constructor(opts: __ExceptionOptionType<InternalServiceException, __BaseException>);
26
28
  }
27
29
  /**
30
+ * @public
28
31
  * <p>The request is not valid.</p>
29
32
  */
30
33
  export declare class InvalidRequestException extends __BaseException {
@@ -36,6 +39,9 @@ export declare class InvalidRequestException extends __BaseException {
36
39
  */
37
40
  constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
38
41
  }
42
+ /**
43
+ * @public
44
+ */
39
45
  export interface ListRealtimeContactAnalysisSegmentsRequest {
40
46
  /**
41
47
  * <p>The identifier of the Amazon Connect instance.</p>
@@ -56,6 +62,7 @@ export interface ListRealtimeContactAnalysisSegmentsRequest {
56
62
  NextToken?: string;
57
63
  }
58
64
  /**
65
+ * @public
59
66
  * <p>The section of the contact audio where that category rule was detected.</p>
60
67
  */
61
68
  export interface PointOfInterest {
@@ -69,6 +76,7 @@ export interface PointOfInterest {
69
76
  EndOffsetMillis: number | undefined;
70
77
  }
71
78
  /**
79
+ * @public
72
80
  * <p>Provides information about the category rule that was matched.</p>
73
81
  */
74
82
  export interface CategoryDetails {
@@ -78,6 +86,7 @@ export interface CategoryDetails {
78
86
  PointsOfInterest: PointOfInterest[] | undefined;
79
87
  }
80
88
  /**
89
+ * @public
81
90
  * <p>Provides the category rules that are used to automatically categorize contacts based on
82
91
  * uttered keywords and phrases.</p>
83
92
  */
@@ -92,6 +101,7 @@ export interface Categories {
92
101
  MatchedDetails: Record<string, CategoryDetails> | undefined;
93
102
  }
94
103
  /**
104
+ * @public
95
105
  * <p>For characters that were detected as issues, where they occur in the transcript.</p>
96
106
  */
97
107
  export interface CharacterOffsets {
@@ -105,6 +115,7 @@ export interface CharacterOffsets {
105
115
  EndOffsetChar: number | undefined;
106
116
  }
107
117
  /**
118
+ * @public
108
119
  * <p>Potential issues that are detected based on an artificial intelligence analysis of each
109
120
  * turn in the conversation.</p>
110
121
  */
@@ -114,12 +125,16 @@ export interface IssueDetected {
114
125
  */
115
126
  CharacterOffsets: CharacterOffsets | undefined;
116
127
  }
128
+ /**
129
+ * @public
130
+ */
117
131
  export declare enum SentimentValue {
118
132
  NEGATIVE = "NEGATIVE",
119
133
  NEUTRAL = "NEUTRAL",
120
134
  POSITIVE = "POSITIVE"
121
135
  }
122
136
  /**
137
+ * @public
123
138
  * <p>A list of messages in the session.</p>
124
139
  */
125
140
  export interface Transcript {
@@ -157,6 +172,7 @@ export interface Transcript {
157
172
  IssuesDetected?: IssueDetected[];
158
173
  }
159
174
  /**
175
+ * @public
160
176
  * <p>An analyzed segment for a real-time analysis session.</p>
161
177
  */
162
178
  export interface RealtimeContactAnalysisSegment {
@@ -169,6 +185,9 @@ export interface RealtimeContactAnalysisSegment {
169
185
  */
170
186
  Categories?: Categories;
171
187
  }
188
+ /**
189
+ * @public
190
+ */
172
191
  export interface ListRealtimeContactAnalysisSegmentsResponse {
173
192
  /**
174
193
  * <p>An analyzed transcript or category.</p>
@@ -191,6 +210,7 @@ export interface ListRealtimeContactAnalysisSegmentsResponse {
191
210
  NextToken?: string;
192
211
  }
193
212
  /**
213
+ * @public
194
214
  * <p>The specified resource was not found.</p>
195
215
  */
196
216
  export declare class ResourceNotFoundException extends __BaseException {
@@ -203,6 +223,7 @@ export declare class ResourceNotFoundException extends __BaseException {
203
223
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
204
224
  }
205
225
  /**
226
+ * @public
206
227
  * <p>The throttling limit has been exceeded.</p>
207
228
  */
208
229
  export declare class ThrottlingException extends __BaseException {
package/dist-types/pagination/Interfaces.d.ts CHANGED
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { ConnectContactLensClient } from "../ConnectContactLensClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface ConnectContactLensPaginationConfiguration extends PaginationConfiguration {
4
7
  client: ConnectContactLensClient;
5
8
  }
package/dist-types/pagination/ListRealtimeContactAnalysisSegmentsPaginator.d.ts CHANGED
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListRealtimeContactAnalysisSegmentsCommandInput, ListRealtimeContactAnalysisSegmentsCommandOutput } from "../commands/ListRealtimeContactAnalysisSegmentsCommand";
3
3
  import { ConnectContactLensPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListRealtimeContactAnalysisSegments(config: ConnectContactLensPaginationConfiguration, input: ListRealtimeContactAnalysisSegmentsCommandInput, ...additionalArguments: any): Paginator<ListRealtimeContactAnalysisSegmentsCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-connect-contact-lens",
3
3
  "description": "AWS SDK for JavaScript Connect Contact Lens Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },