@aws-sdk/client-transcribe 3.863.0 → 3.866.0

package/dist-cjs/index.js

@@ -67,15 +67,18 @@ __export(index_exports, {
   ListVocabularyFiltersCommand: () => ListVocabularyFiltersCommand,
   MediaFormat: () => MediaFormat,
   MedicalContentIdentificationType: () => MedicalContentIdentificationType,
+  MedicalScribeContextFilterSensitiveLog: () => MedicalScribeContextFilterSensitiveLog,
   MedicalScribeJobStatus: () => MedicalScribeJobStatus,
   MedicalScribeLanguageCode: () => MedicalScribeLanguageCode,
   MedicalScribeNoteTemplate: () => MedicalScribeNoteTemplate,
   MedicalScribeParticipantRole: () => MedicalScribeParticipantRole,
+  MedicalScribePatientContextFilterSensitiveLog: () => MedicalScribePatientContextFilterSensitiveLog,
   ModelStatus: () => ModelStatus,
   NotFoundException: () => NotFoundException,
   OutputLocationType: () => OutputLocationType,
   ParticipantRole: () => ParticipantRole,
   PiiEntityType: () => PiiEntityType,
+  Pronouns: () => Pronouns,
   RedactionOutput: () => RedactionOutput,
   RedactionType: () => RedactionType,
   Rule: () => Rule,
@@ -83,6 +86,7 @@ __export(index_exports, {
   Specialty: () => Specialty,
   StartCallAnalyticsJobCommand: () => StartCallAnalyticsJobCommand,
   StartMedicalScribeJobCommand: () => StartMedicalScribeJobCommand,
+  StartMedicalScribeJobRequestFilterSensitiveLog: () => StartMedicalScribeJobRequestFilterSensitiveLog,
   StartMedicalTranscriptionJobCommand: () => StartMedicalTranscriptionJobCommand,
   StartTranscriptionJobCommand: () => StartTranscriptionJobCommand,
   SubtitleFormat: () => SubtitleFormat,
@@ -268,6 +272,9 @@ var import_core2 = require("@aws-sdk/core");
 
 
 
+// src/models/models_0.ts
+
+
 // src/models/TranscribeServiceException.ts
 
 var TranscribeServiceException = class _TranscribeServiceException extends import_smithy_client.ServiceException {
@@ -639,6 +646,25 @@ var OutputLocationType = {
   CUSTOMER_BUCKET: "CUSTOMER_BUCKET",
   SERVICE_BUCKET: "SERVICE_BUCKET"
 };
+var Pronouns = {
+  HE_HIM: "HE_HIM",
+  SHE_HER: "SHE_HER",
+  THEY_THEM: "THEY_THEM"
+};
+var MedicalScribePatientContextFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.Pronouns && { Pronouns: import_smithy_client.SENSITIVE_STRING }
+}), "MedicalScribePatientContextFilterSensitiveLog");
+var MedicalScribeContextFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.PatientContext && { PatientContext: MedicalScribePatientContextFilterSensitiveLog(obj.PatientContext) }
+}), "MedicalScribeContextFilterSensitiveLog");
+var StartMedicalScribeJobRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.MedicalScribeContext && {
+    MedicalScribeContext: MedicalScribeContextFilterSensitiveLog(obj.MedicalScribeContext)
+  }
+}), "StartMedicalScribeJobRequestFilterSensitiveLog");
 
 // src/protocols/Aws_json1_1.ts
 var se_CreateCallAnalyticsCategoryCommand = /* @__PURE__ */ __name(async (input, context) => {
@@ -1750,6 +1776,7 @@ var de_MedicalScribeJob = /* @__PURE__ */ __name((output, context) => {
     FailureReason: import_smithy_client.expectString,
     LanguageCode: import_smithy_client.expectString,
     Media: import_smithy_client._json,
+    MedicalScribeContextProvided: import_smithy_client.expectBoolean,
     MedicalScribeJobName: import_smithy_client.expectString,
     MedicalScribeJobStatus: import_smithy_client.expectString,
     MedicalScribeOutput: import_smithy_client._json,
@@ -2499,7 +2526,7 @@ var StartMedicalScribeJobCommand = class extends import_smithy_client.Command.cl
     (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
     (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
   ];
-}).s("Transcribe", "StartMedicalScribeJob", {}).n("TranscribeClient", "StartMedicalScribeJobCommand").f(void 0, void 0).ser(se_StartMedicalScribeJobCommand).de(de_StartMedicalScribeJobCommand).build() {
+}).s("Transcribe", "StartMedicalScribeJob", {}).n("TranscribeClient", "StartMedicalScribeJobCommand").f(StartMedicalScribeJobRequestFilterSensitiveLog, void 0).ser(se_StartMedicalScribeJobCommand).de(de_StartMedicalScribeJobCommand).build() {
   static {
     __name(this, "StartMedicalScribeJobCommand");
   }
@@ -2806,6 +2833,10 @@ var paginateListVocabularyFilters = (0, import_core.createPaginator)(TranscribeC
   Type,
   SubtitleFormat,
   ToxicityCategory,
-  OutputLocationType
+  OutputLocationType,
+  Pronouns,
+  MedicalScribePatientContextFilterSensitiveLog,
+  MedicalScribeContextFilterSensitiveLog,
+  StartMedicalScribeJobRequestFilterSensitiveLog
 });
 

package/dist-es/commands/StartMedicalScribeJobCommand.js

@@ -2,6 +2,7 @@ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { commonParams } from "../endpoint/EndpointParameters";
+import { StartMedicalScribeJobRequestFilterSensitiveLog, } from "../models/models_0";
 import { de_StartMedicalScribeJobCommand, se_StartMedicalScribeJobCommand } from "../protocols/Aws_json1_1";
 export { $Command };
 export class StartMedicalScribeJobCommand extends $Command
@@ -15,7 +16,7 @@ export class StartMedicalScribeJobCommand extends $Command
 })
     .s("Transcribe", "StartMedicalScribeJob", {})
     .n("TranscribeClient", "StartMedicalScribeJobCommand")
-    .f(void 0, void 0)
+    .f(StartMedicalScribeJobRequestFilterSensitiveLog, void 0)
     .ser(se_StartMedicalScribeJobCommand)
     .de(de_StartMedicalScribeJobCommand)
     .build() {

package/dist-es/models/models_0.js

@@ -1,3 +1,4 @@
+import { SENSITIVE_STRING } from "@smithy/smithy-client";
 import { TranscribeServiceException as __BaseException } from "./TranscribeServiceException";
 export class BadRequestException extends __BaseException {
     name = "BadRequestException";
@@ -328,3 +329,22 @@ export const OutputLocationType = {
     CUSTOMER_BUCKET: "CUSTOMER_BUCKET",
     SERVICE_BUCKET: "SERVICE_BUCKET",
 };
+export const Pronouns = {
+    HE_HIM: "HE_HIM",
+    SHE_HER: "SHE_HER",
+    THEY_THEM: "THEY_THEM",
+};
+export const MedicalScribePatientContextFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.Pronouns && { Pronouns: SENSITIVE_STRING }),
+});
+export const MedicalScribeContextFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.PatientContext && { PatientContext: MedicalScribePatientContextFilterSensitiveLog(obj.PatientContext) }),
+});
+export const StartMedicalScribeJobRequestFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.MedicalScribeContext && {
+        MedicalScribeContext: MedicalScribeContextFilterSensitiveLog(obj.MedicalScribeContext),
+    }),
+});

package/dist-es/protocols/Aws_json1_1.js

@@ -1118,6 +1118,7 @@ const de_MedicalScribeJob = (output, context) => {
         FailureReason: __expectString,
         LanguageCode: __expectString,
         Media: _json,
+        MedicalScribeContextProvided: __expectBoolean,
         MedicalScribeJobName: __expectString,
         MedicalScribeJobStatus: __expectString,
         MedicalScribeOutput: _json,

package/dist-types/commands/GetMedicalScribeJobCommand.d.ts

@@ -81,6 +81,7 @@ declare const GetMedicalScribeJobCommand_base: {
  * //         ParticipantRole: "PATIENT" || "CLINICIAN", // required
  * //       },
  * //     ],
+ * //     MedicalScribeContextProvided: true || false,
  * //     Tags: [ // TagList
  * //       { // Tag
  * //         Key: "STRING_VALUE", // required

package/dist-types/commands/StartMedicalScribeJobCommand.d.ts

@@ -61,7 +61,7 @@ declare const StartMedicalScribeJobCommand_base: {
  *             </li>
  *             <li>
  *                <p>
- *                   <code>Settings</code>: A <code>MedicalScribeSettings</code> obect
+ *                   <code>Settings</code>: A <code>MedicalScribeSettings</code> object
  *                 that must set exactly one of <code>ShowSpeakerLabels</code> or <code>ChannelIdentification</code> to true.
  *                 If <code>ShowSpeakerLabels</code> is true, <code>MaxSpeakerLabels</code> must also be set.
  *                 </p>
@@ -114,6 +114,11 @@ declare const StartMedicalScribeJobCommand_base: {
  *       Value: "STRING_VALUE", // required
  *     },
  *   ],
+ *   MedicalScribeContext: { // MedicalScribeContext
+ *     PatientContext: { // MedicalScribePatientContext
+ *       Pronouns: "HE_HIM" || "SHE_HER" || "THEY_THEM",
+ *     },
+ *   },
  * };
  * const command = new StartMedicalScribeJobCommand(input);
  * const response = await client.send(command);
@@ -152,6 +157,7 @@ declare const StartMedicalScribeJobCommand_base: {
  * //         ParticipantRole: "PATIENT" || "CLINICIAN", // required
  * //       },
  * //     ],
+ * //     MedicalScribeContextProvided: true || false,
  * //     Tags: [ // TagList
  * //       { // Tag
  * //         Key: "STRING_VALUE", // required

package/dist-types/models/models_0.d.ts

@@ -2565,7 +2565,12 @@ export interface MedicalScribeJob {
      */
     ChannelDefinitions?: MedicalScribeChannelDefinition[] | undefined;
     /**
-     * <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.</p>
+     * <p>Indicates whether the <code>MedicalScribeContext</code> object was provided when the Medical Scribe job was started.</p>
+     * @public
+     */
+    MedicalScribeContextProvided?: boolean | undefined;
+    /**
+     * <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medical Scribe job.</p>
      *          <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
      *                 resources</a>.</p>
      * @public
@@ -4419,6 +4424,42 @@ export interface ListVocabularyFiltersResponse {
      */
     VocabularyFilters?: VocabularyFilterInfo[] | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const Pronouns: {
+    readonly HE_HIM: "HE_HIM";
+    readonly SHE_HER: "SHE_HER";
+    readonly THEY_THEM: "THEY_THEM";
+};
+/**
+ * @public
+ */
+export type Pronouns = (typeof Pronouns)[keyof typeof Pronouns];
+/**
+ * <p>Contains patient-specific information used to customize the clinical note generation.</p>
+ * @public
+ */
+export interface MedicalScribePatientContext {
+    /**
+     * <p>The patient's preferred pronouns that the user wants to provide as a context for clinical note generation.</p>
+     * @public
+     */
+    Pronouns?: Pronouns | undefined;
+}
+/**
+ * <p>The <code>MedicalScribeContext</code> object that contains contextual information used to generate
+ *             customized clinical notes.</p>
+ * @public
+ */
+export interface MedicalScribeContext {
+    /**
+     * <p>Contains patient-specific information.</p>
+     * @public
+     */
+    PatientContext?: MedicalScribePatientContext | undefined;
+}
 /**
  * @public
  */
@@ -4676,12 +4717,18 @@ export interface StartMedicalScribeJobRequest {
      */
     ChannelDefinitions?: MedicalScribeChannelDefinition[] | undefined;
     /**
-     * <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.</p>
+     * <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medical Scribe job.</p>
      *          <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
      *                 resources</a>.</p>
      * @public
      */
     Tags?: Tag[] | undefined;
+    /**
+     * <p>The <code>MedicalScribeContext</code> object that contains contextual information which is used during
+     *             clinical note generation to add relevant context to the note.</p>
+     * @public
+     */
+    MedicalScribeContext?: MedicalScribeContext | undefined;
 }
 /**
  * @public
@@ -5577,3 +5624,15 @@ export interface UpdateVocabularyFilterResponse {
      */
     LastModifiedTime?: Date | undefined;
 }
+/**
+ * @internal
+ */
+export declare const MedicalScribePatientContextFilterSensitiveLog: (obj: MedicalScribePatientContext) => any;
+/**
+ * @internal
+ */
+export declare const MedicalScribeContextFilterSensitiveLog: (obj: MedicalScribeContext) => any;
+/**
+ * @internal
+ */
+export declare const StartMedicalScribeJobRequestFilterSensitiveLog: (obj: StartMedicalScribeJobRequest) => any;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -629,6 +629,7 @@ export interface MedicalScribeJob {
   Settings?: MedicalScribeSettings | undefined;
   DataAccessRoleArn?: string | undefined;
   ChannelDefinitions?: MedicalScribeChannelDefinition[] | undefined;
+  MedicalScribeContextProvided?: boolean | undefined;
   Tags?: Tag[] | undefined;
 }
 export interface GetMedicalScribeJobResponse {
@@ -954,6 +955,18 @@ export interface ListVocabularyFiltersResponse {
   NextToken?: string | undefined;
   VocabularyFilters?: VocabularyFilterInfo[] | undefined;
 }
+export declare const Pronouns: {
+  readonly HE_HIM: "HE_HIM";
+  readonly SHE_HER: "SHE_HER";
+  readonly THEY_THEM: "THEY_THEM";
+};
+export type Pronouns = (typeof Pronouns)[keyof typeof Pronouns];
+export interface MedicalScribePatientContext {
+  Pronouns?: Pronouns | undefined;
+}
+export interface MedicalScribeContext {
+  PatientContext?: MedicalScribePatientContext | undefined;
+}
 export interface StartCallAnalyticsJobRequest {
   CallAnalyticsJobName: string | undefined;
   Media: Media | undefined;
@@ -977,6 +990,7 @@ export interface StartMedicalScribeJobRequest {
   Settings: MedicalScribeSettings | undefined;
   ChannelDefinitions?: MedicalScribeChannelDefinition[] | undefined;
   Tags?: Tag[] | undefined;
+  MedicalScribeContext?: MedicalScribeContext | undefined;
 }
 export interface StartMedicalScribeJobResponse {
   MedicalScribeJob?: MedicalScribeJob | undefined;
@@ -1084,3 +1098,12 @@ export interface UpdateVocabularyFilterResponse {
   LanguageCode?: LanguageCode | undefined;
   LastModifiedTime?: Date | undefined;
 }
+export declare const MedicalScribePatientContextFilterSensitiveLog: (
+  obj: MedicalScribePatientContext
+) => any;
+export declare const MedicalScribeContextFilterSensitiveLog: (
+  obj: MedicalScribeContext
+) => any;
+export declare const StartMedicalScribeJobRequestFilterSensitiveLog: (
+  obj: StartMedicalScribeJobRequest
+) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-transcribe",
   "description": "AWS SDK for JavaScript Transcribe Client for Node.js, Browser and React Native",
-  "version": "3.863.0",
+  "version": "3.866.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-transcribe",
@@ -20,17 +20,17 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/core": "3.863.0",
-    "@aws-sdk/credential-provider-node": "3.863.0",
+    "@aws-sdk/core": "3.864.0",
+    "@aws-sdk/credential-provider-node": "3.864.0",
     "@aws-sdk/middleware-host-header": "3.862.0",
     "@aws-sdk/middleware-logger": "3.862.0",
     "@aws-sdk/middleware-recursion-detection": "3.862.0",
-    "@aws-sdk/middleware-user-agent": "3.863.0",
+    "@aws-sdk/middleware-user-agent": "3.864.0",
     "@aws-sdk/region-config-resolver": "3.862.0",
     "@aws-sdk/types": "3.862.0",
     "@aws-sdk/util-endpoints": "3.862.0",
     "@aws-sdk/util-user-agent-browser": "3.862.0",
-    "@aws-sdk/util-user-agent-node": "3.863.0",
+    "@aws-sdk/util-user-agent-node": "3.864.0",
     "@smithy/config-resolver": "^4.1.5",
     "@smithy/core": "^3.8.0",
     "@smithy/fetch-http-handler": "^5.1.1",