From 8797f6465be931f4c331b9a69ee2ab4ea79c5717 Mon Sep 17 00:00:00 2001 From: awstools Date: Mon, 27 Nov 2023 20:10:28 +0000 Subject: [PATCH] feat(client-transcribe): This release adds support for AWS HealthScribe APIs within Amazon Transcribe --- clients/client-transcribe/README.md | 32 + clients/client-transcribe/src/Transcribe.ts | 92 +++ .../client-transcribe/src/TranscribeClient.ts | 24 + .../commands/DeleteMedicalScribeJobCommand.ts | 153 ++++ .../commands/GetMedicalScribeJobCommand.ts | 201 +++++ .../commands/ListMedicalScribeJobsCommand.ts | 170 ++++ .../commands/StartMedicalScribeJobCommand.ts | 269 +++++++ .../StartMedicalTranscriptionJobCommand.ts | 2 +- .../commands/StartTranscriptionJobCommand.ts | 2 +- .../client-transcribe/src/commands/index.ts | 4 + .../client-transcribe/src/models/models_0.ts | 757 ++++++++++++++++-- .../ListMedicalScribeJobsPaginator.ts | 50 ++ .../client-transcribe/src/pagination/index.ts | 1 + .../src/protocols/Aws_json1_1.ts | 389 +++++++++ .../sdk-codegen/aws-models/transcribe.json | 727 +++++++++++++++-- 15 files changed, 2746 insertions(+), 127 deletions(-) create mode 100644 clients/client-transcribe/src/commands/DeleteMedicalScribeJobCommand.ts create mode 100644 clients/client-transcribe/src/commands/GetMedicalScribeJobCommand.ts create mode 100644 clients/client-transcribe/src/commands/ListMedicalScribeJobsCommand.ts create mode 100644 clients/client-transcribe/src/commands/StartMedicalScribeJobCommand.ts create mode 100644 clients/client-transcribe/src/pagination/ListMedicalScribeJobsPaginator.ts diff --git a/clients/client-transcribe/README.md b/clients/client-transcribe/README.md index 5f84c94da42e8..9800a4f6eaac0 100644 --- a/clients/client-transcribe/README.md +++ b/clients/client-transcribe/README.md @@ -287,6 +287,14 @@ DeleteLanguageModel [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/DeleteLanguageModelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/DeleteLanguageModelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/DeleteLanguageModelCommandOutput/) + +
+ +DeleteMedicalScribeJob + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/DeleteMedicalScribeJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/DeleteMedicalScribeJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/DeleteMedicalScribeJobCommandOutput/) +
@@ -351,6 +359,14 @@ GetCallAnalyticsJob [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/GetCallAnalyticsJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/GetCallAnalyticsJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/GetCallAnalyticsJobCommandOutput/) +
+
+ +GetMedicalScribeJob + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/GetMedicalScribeJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/GetMedicalScribeJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/GetMedicalScribeJobCommandOutput/) +
@@ -415,6 +431,14 @@ ListLanguageModels [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/ListLanguageModelsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/ListLanguageModelsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/ListLanguageModelsCommandOutput/) +
+
+ +ListMedicalScribeJobs + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/ListMedicalScribeJobsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/ListMedicalScribeJobsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/ListMedicalScribeJobsCommandOutput/) +
@@ -471,6 +495,14 @@ StartCallAnalyticsJob [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/StartCallAnalyticsJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/StartCallAnalyticsJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/StartCallAnalyticsJobCommandOutput/) +
+
+ +StartMedicalScribeJob + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/StartMedicalScribeJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/StartMedicalScribeJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Interface/StartMedicalScribeJobCommandOutput/) +
diff --git a/clients/client-transcribe/src/Transcribe.ts b/clients/client-transcribe/src/Transcribe.ts index cd6f1cec76cc1..88709a5213472 100644 --- a/clients/client-transcribe/src/Transcribe.ts +++ b/clients/client-transcribe/src/Transcribe.ts @@ -42,6 +42,11 @@ import { DeleteLanguageModelCommandInput, DeleteLanguageModelCommandOutput, } from "./commands/DeleteLanguageModelCommand"; +import { + DeleteMedicalScribeJobCommand, + DeleteMedicalScribeJobCommandInput, + DeleteMedicalScribeJobCommandOutput, +} from "./commands/DeleteMedicalScribeJobCommand"; import { DeleteMedicalTranscriptionJobCommand, DeleteMedicalTranscriptionJobCommandInput, @@ -82,6 +87,11 @@ import { GetCallAnalyticsJobCommandInput, GetCallAnalyticsJobCommandOutput, } from "./commands/GetCallAnalyticsJobCommand"; +import { + GetMedicalScribeJobCommand, + GetMedicalScribeJobCommandInput, + GetMedicalScribeJobCommandOutput, +} from "./commands/GetMedicalScribeJobCommand"; import { GetMedicalTranscriptionJobCommand, GetMedicalTranscriptionJobCommandInput, @@ -122,6 +132,11 @@ import { ListLanguageModelsCommandInput, ListLanguageModelsCommandOutput, } from "./commands/ListLanguageModelsCommand"; +import { + ListMedicalScribeJobsCommand, + ListMedicalScribeJobsCommandInput, + ListMedicalScribeJobsCommandOutput, +} from "./commands/ListMedicalScribeJobsCommand"; import { ListMedicalTranscriptionJobsCommand, ListMedicalTranscriptionJobsCommandInput, @@ -157,6 +172,11 @@ import { StartCallAnalyticsJobCommandInput, StartCallAnalyticsJobCommandOutput, } from "./commands/StartCallAnalyticsJobCommand"; +import { + StartMedicalScribeJobCommand, + StartMedicalScribeJobCommandInput, + StartMedicalScribeJobCommandOutput, +} from "./commands/StartMedicalScribeJobCommand"; import { StartMedicalTranscriptionJobCommand, StartMedicalTranscriptionJobCommandInput, @@ -204,6 +224,7 @@ const commands = { DeleteCallAnalyticsCategoryCommand, DeleteCallAnalyticsJobCommand, DeleteLanguageModelCommand, + DeleteMedicalScribeJobCommand, DeleteMedicalTranscriptionJobCommand, DeleteMedicalVocabularyCommand, DeleteTranscriptionJobCommand, @@ -212,6 +233,7 @@ const commands = { DescribeLanguageModelCommand, GetCallAnalyticsCategoryCommand, GetCallAnalyticsJobCommand, + GetMedicalScribeJobCommand, GetMedicalTranscriptionJobCommand, GetMedicalVocabularyCommand, GetTranscriptionJobCommand, @@ -220,6 +242,7 @@ const commands = { ListCallAnalyticsCategoriesCommand, ListCallAnalyticsJobsCommand, ListLanguageModelsCommand, + ListMedicalScribeJobsCommand, ListMedicalTranscriptionJobsCommand, ListMedicalVocabulariesCommand, ListTagsForResourceCommand, @@ -227,6 +250,7 @@ const commands = { ListVocabulariesCommand, ListVocabularyFiltersCommand, StartCallAnalyticsJobCommand, + StartMedicalScribeJobCommand, StartMedicalTranscriptionJobCommand, StartTranscriptionJobCommand, TagResourceCommand, @@ -374,6 +398,23 @@ export interface Transcribe { cb: (err: any, data?: DeleteLanguageModelCommandOutput) => void ): void; + /** + * @see {@link DeleteMedicalScribeJobCommand} + */ + deleteMedicalScribeJob( + args: DeleteMedicalScribeJobCommandInput, + options?: __HttpHandlerOptions + ): Promise; + deleteMedicalScribeJob( + args: DeleteMedicalScribeJobCommandInput, + cb: (err: any, data?: DeleteMedicalScribeJobCommandOutput) => void + ): void; + deleteMedicalScribeJob( + args: DeleteMedicalScribeJobCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteMedicalScribeJobCommandOutput) => void + ): void; + /** * @see {@link DeleteMedicalTranscriptionJobCommand} */ @@ -510,6 +551,23 @@ export interface Transcribe { cb: (err: any, data?: GetCallAnalyticsJobCommandOutput) => void ): void; + /** + * @see {@link GetMedicalScribeJobCommand} + */ + getMedicalScribeJob( + args: GetMedicalScribeJobCommandInput, + options?: __HttpHandlerOptions + ): Promise; + getMedicalScribeJob( + args: GetMedicalScribeJobCommandInput, + cb: (err: any, data?: GetMedicalScribeJobCommandOutput) => void + ): void; + getMedicalScribeJob( + args: GetMedicalScribeJobCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetMedicalScribeJobCommandOutput) => void + ): void; + /** * @see {@link GetMedicalTranscriptionJobCommand} */ @@ -640,6 +698,23 @@ export interface Transcribe { cb: (err: any, data?: ListLanguageModelsCommandOutput) => void ): void; + /** + * @see {@link ListMedicalScribeJobsCommand} + */ + listMedicalScribeJobs( + args: ListMedicalScribeJobsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listMedicalScribeJobs( + args: ListMedicalScribeJobsCommandInput, + cb: (err: any, data?: ListMedicalScribeJobsCommandOutput) => void + ): void; + listMedicalScribeJobs( + args: ListMedicalScribeJobsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListMedicalScribeJobsCommandOutput) => void + ): void; + /** * @see {@link ListMedicalTranscriptionJobsCommand} */ @@ -759,6 +834,23 @@ export interface Transcribe { cb: (err: any, data?: StartCallAnalyticsJobCommandOutput) => void ): void; + /** + * @see {@link StartMedicalScribeJobCommand} + */ + startMedicalScribeJob( + args: StartMedicalScribeJobCommandInput, + options?: __HttpHandlerOptions + ): Promise; + startMedicalScribeJob( + args: StartMedicalScribeJobCommandInput, + cb: (err: any, data?: StartMedicalScribeJobCommandOutput) => void + ): void; + startMedicalScribeJob( + args: StartMedicalScribeJobCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: StartMedicalScribeJobCommandOutput) => void + ): void; + /** * @see {@link StartMedicalTranscriptionJobCommand} */ diff --git a/clients/client-transcribe/src/TranscribeClient.ts b/clients/client-transcribe/src/TranscribeClient.ts index 5c728da193daf..2cb14043a5a91 100644 --- a/clients/client-transcribe/src/TranscribeClient.ts +++ b/clients/client-transcribe/src/TranscribeClient.ts @@ -79,6 +79,10 @@ import { DeleteLanguageModelCommandInput, DeleteLanguageModelCommandOutput, } from "./commands/DeleteLanguageModelCommand"; +import { + DeleteMedicalScribeJobCommandInput, + DeleteMedicalScribeJobCommandOutput, +} from "./commands/DeleteMedicalScribeJobCommand"; import { DeleteMedicalTranscriptionJobCommandInput, DeleteMedicalTranscriptionJobCommandOutput, @@ -108,6 +112,10 @@ import { GetCallAnalyticsJobCommandInput, GetCallAnalyticsJobCommandOutput, } from "./commands/GetCallAnalyticsJobCommand"; +import { + GetMedicalScribeJobCommandInput, + GetMedicalScribeJobCommandOutput, +} from "./commands/GetMedicalScribeJobCommand"; import { GetMedicalTranscriptionJobCommandInput, GetMedicalTranscriptionJobCommandOutput, @@ -134,6 +142,10 @@ import { ListCallAnalyticsJobsCommandOutput, } from "./commands/ListCallAnalyticsJobsCommand"; import { ListLanguageModelsCommandInput, ListLanguageModelsCommandOutput } from "./commands/ListLanguageModelsCommand"; +import { + ListMedicalScribeJobsCommandInput, + ListMedicalScribeJobsCommandOutput, +} from "./commands/ListMedicalScribeJobsCommand"; import { ListMedicalTranscriptionJobsCommandInput, ListMedicalTranscriptionJobsCommandOutput, @@ -159,6 +171,10 @@ import { StartCallAnalyticsJobCommandInput, StartCallAnalyticsJobCommandOutput, } from "./commands/StartCallAnalyticsJobCommand"; +import { + StartMedicalScribeJobCommandInput, + StartMedicalScribeJobCommandOutput, +} from "./commands/StartMedicalScribeJobCommand"; import { StartMedicalTranscriptionJobCommandInput, StartMedicalTranscriptionJobCommandOutput, @@ -205,6 +221,7 @@ export type ServiceInputTypes = | DeleteCallAnalyticsCategoryCommandInput | DeleteCallAnalyticsJobCommandInput | DeleteLanguageModelCommandInput + | DeleteMedicalScribeJobCommandInput | DeleteMedicalTranscriptionJobCommandInput | DeleteMedicalVocabularyCommandInput | DeleteTranscriptionJobCommandInput @@ -213,6 +230,7 @@ export type ServiceInputTypes = | DescribeLanguageModelCommandInput | GetCallAnalyticsCategoryCommandInput | GetCallAnalyticsJobCommandInput + | GetMedicalScribeJobCommandInput | GetMedicalTranscriptionJobCommandInput | GetMedicalVocabularyCommandInput | GetTranscriptionJobCommandInput @@ -221,6 +239,7 @@ export type ServiceInputTypes = | ListCallAnalyticsCategoriesCommandInput | ListCallAnalyticsJobsCommandInput | ListLanguageModelsCommandInput + | ListMedicalScribeJobsCommandInput | ListMedicalTranscriptionJobsCommandInput | ListMedicalVocabulariesCommandInput | ListTagsForResourceCommandInput @@ -228,6 +247,7 @@ export type ServiceInputTypes = | ListVocabulariesCommandInput | ListVocabularyFiltersCommandInput | StartCallAnalyticsJobCommandInput + | StartMedicalScribeJobCommandInput | StartMedicalTranscriptionJobCommandInput | StartTranscriptionJobCommandInput | TagResourceCommandInput @@ -249,6 +269,7 @@ export type ServiceOutputTypes = | DeleteCallAnalyticsCategoryCommandOutput | DeleteCallAnalyticsJobCommandOutput | DeleteLanguageModelCommandOutput + | DeleteMedicalScribeJobCommandOutput | DeleteMedicalTranscriptionJobCommandOutput | DeleteMedicalVocabularyCommandOutput | DeleteTranscriptionJobCommandOutput @@ -257,6 +278,7 @@ export type ServiceOutputTypes = | DescribeLanguageModelCommandOutput | GetCallAnalyticsCategoryCommandOutput | GetCallAnalyticsJobCommandOutput + | GetMedicalScribeJobCommandOutput | GetMedicalTranscriptionJobCommandOutput | GetMedicalVocabularyCommandOutput | GetTranscriptionJobCommandOutput @@ -265,6 +287,7 @@ export type ServiceOutputTypes = | ListCallAnalyticsCategoriesCommandOutput | ListCallAnalyticsJobsCommandOutput | ListLanguageModelsCommandOutput + | ListMedicalScribeJobsCommandOutput | ListMedicalTranscriptionJobsCommandOutput | ListMedicalVocabulariesCommandOutput | ListTagsForResourceCommandOutput @@ -272,6 +295,7 @@ export type ServiceOutputTypes = | ListVocabulariesCommandOutput | ListVocabularyFiltersCommandOutput | StartCallAnalyticsJobCommandOutput + | StartMedicalScribeJobCommandOutput | StartMedicalTranscriptionJobCommandOutput | StartTranscriptionJobCommandOutput | TagResourceCommandOutput diff --git a/clients/client-transcribe/src/commands/DeleteMedicalScribeJobCommand.ts b/clients/client-transcribe/src/commands/DeleteMedicalScribeJobCommand.ts new file mode 100644 index 0000000000000..709d5eb7b8210 --- /dev/null +++ b/clients/client-transcribe/src/commands/DeleteMedicalScribeJobCommand.ts @@ -0,0 +1,153 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { DeleteMedicalScribeJobRequest } from "../models/models_0"; +import { de_DeleteMedicalScribeJobCommand, se_DeleteMedicalScribeJobCommand } from "../protocols/Aws_json1_1"; +import { ServiceInputTypes, ServiceOutputTypes, TranscribeClientResolvedConfig } from "../TranscribeClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DeleteMedicalScribeJobCommand}. + */ +export interface DeleteMedicalScribeJobCommandInput extends DeleteMedicalScribeJobRequest {} +/** + * @public + * + * The output of {@link DeleteMedicalScribeJobCommand}. + */ +export interface DeleteMedicalScribeJobCommandOutput extends __MetadataBearer {} + +/** + * @public + *

Deletes a Medical Scribe job. To use this operation, specify the name of the + * job you want to delete using MedicalScribeJobName. Job names are + * case sensitive.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, DeleteMedicalScribeJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, DeleteMedicalScribeJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const input = { // DeleteMedicalScribeJobRequest + * MedicalScribeJobName: "STRING_VALUE", // required + * }; + * const command = new DeleteMedicalScribeJobCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteMedicalScribeJobCommandInput - {@link DeleteMedicalScribeJobCommandInput} + * @returns {@link DeleteMedicalScribeJobCommandOutput} + * @see {@link DeleteMedicalScribeJobCommandInput} for command's `input` shape. + * @see {@link DeleteMedicalScribeJobCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for TranscribeClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *

Your request didn't pass one or more validation tests. This can occur when the entity + * you're trying to delete doesn't exist or if it's in a non-terminal state (such as + * IN PROGRESS). See the exception message field for more + * information.

+ * + * @throws {@link InternalFailureException} (server fault) + *

There was an internal error. Check the error message, correct the issue, and try your + * request again.

+ * + * @throws {@link LimitExceededException} (client fault) + *

You've either sent too many requests or your input file is too long. Wait before + * retrying your request, or use a smaller file and try your request again.

+ * + * @throws {@link TranscribeServiceException} + *

Base exception class for all service exceptions from Transcribe service.

+ * + */ +export class DeleteMedicalScribeJobCommand extends $Command< + DeleteMedicalScribeJobCommandInput, + DeleteMedicalScribeJobCommandOutput, + TranscribeClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteMedicalScribeJobCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: TranscribeClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, DeleteMedicalScribeJobCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "TranscribeClient"; + const commandName = "DeleteMedicalScribeJobCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "Transcribe", + operation: "DeleteMedicalScribeJob", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: DeleteMedicalScribeJobCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_DeleteMedicalScribeJobCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_DeleteMedicalScribeJobCommand(output, context); + } +} diff --git a/clients/client-transcribe/src/commands/GetMedicalScribeJobCommand.ts b/clients/client-transcribe/src/commands/GetMedicalScribeJobCommand.ts new file mode 100644 index 0000000000000..9182327c46d2d --- /dev/null +++ b/clients/client-transcribe/src/commands/GetMedicalScribeJobCommand.ts @@ -0,0 +1,201 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { GetMedicalScribeJobRequest, GetMedicalScribeJobResponse } from "../models/models_0"; +import { de_GetMedicalScribeJobCommand, se_GetMedicalScribeJobCommand } from "../protocols/Aws_json1_1"; +import { ServiceInputTypes, ServiceOutputTypes, TranscribeClientResolvedConfig } from "../TranscribeClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link GetMedicalScribeJobCommand}. + */ +export interface GetMedicalScribeJobCommandInput extends GetMedicalScribeJobRequest {} +/** + * @public + * + * The output of {@link GetMedicalScribeJobCommand}. + */ +export interface GetMedicalScribeJobCommandOutput extends GetMedicalScribeJobResponse, __MetadataBearer {} + +/** + * @public + *

Provides information about the specified Medical Scribe job.

+ *

To view the status of the specified medical transcription job, check the + * MedicalScribeJobStatus field. If the status is COMPLETED, + * the job is finished. You can find the results at the location specified in + * MedicalScribeOutput. + * If the status is FAILED, FailureReason provides details on why your Medical Scribe job + * failed.

+ *

To get a list of your Medical Scribe jobs, use the operation.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, GetMedicalScribeJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, GetMedicalScribeJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const input = { // GetMedicalScribeJobRequest + * MedicalScribeJobName: "STRING_VALUE", // required + * }; + * const command = new GetMedicalScribeJobCommand(input); + * const response = await client.send(command); + * // { // GetMedicalScribeJobResponse + * // MedicalScribeJob: { // MedicalScribeJob + * // MedicalScribeJobName: "STRING_VALUE", + * // MedicalScribeJobStatus: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED", + * // LanguageCode: "en-US", + * // Media: { // Media + * // MediaFileUri: "STRING_VALUE", + * // RedactedMediaFileUri: "STRING_VALUE", + * // }, + * // MedicalScribeOutput: { // MedicalScribeOutput + * // TranscriptFileUri: "STRING_VALUE", // required + * // ClinicalDocumentUri: "STRING_VALUE", // required + * // }, + * // StartTime: new Date("TIMESTAMP"), + * // CreationTime: new Date("TIMESTAMP"), + * // CompletionTime: new Date("TIMESTAMP"), + * // FailureReason: "STRING_VALUE", + * // Settings: { // MedicalScribeSettings + * // ShowSpeakerLabels: true || false, + * // MaxSpeakerLabels: Number("int"), + * // ChannelIdentification: true || false, + * // VocabularyName: "STRING_VALUE", + * // VocabularyFilterName: "STRING_VALUE", + * // VocabularyFilterMethod: "remove" || "mask" || "tag", + * // }, + * // DataAccessRoleArn: "STRING_VALUE", + * // ChannelDefinitions: [ // MedicalScribeChannelDefinitions + * // { // MedicalScribeChannelDefinition + * // ChannelId: Number("int"), // required + * // ParticipantRole: "PATIENT" || "CLINICIAN", // required + * // }, + * // ], + * // Tags: [ // TagList + * // { // Tag + * // Key: "STRING_VALUE", // required + * // Value: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // }; + * + * ``` + * + * @param GetMedicalScribeJobCommandInput - {@link GetMedicalScribeJobCommandInput} + * @returns {@link GetMedicalScribeJobCommandOutput} + * @see {@link GetMedicalScribeJobCommandInput} for command's `input` shape. + * @see {@link GetMedicalScribeJobCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for TranscribeClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *

Your request didn't pass one or more validation tests. This can occur when the entity + * you're trying to delete doesn't exist or if it's in a non-terminal state (such as + * IN PROGRESS). See the exception message field for more + * information.

+ * + * @throws {@link InternalFailureException} (server fault) + *

There was an internal error. Check the error message, correct the issue, and try your + * request again.

+ * + * @throws {@link LimitExceededException} (client fault) + *

You've either sent too many requests or your input file is too long. Wait before + * retrying your request, or use a smaller file and try your request again.

+ * + * @throws {@link NotFoundException} (client fault) + *

We can't find the requested resource. Check that the specified name is correct and try + * your request again.

+ * + * @throws {@link TranscribeServiceException} + *

Base exception class for all service exceptions from Transcribe service.

+ * + */ +export class GetMedicalScribeJobCommand extends $Command< + GetMedicalScribeJobCommandInput, + GetMedicalScribeJobCommandOutput, + TranscribeClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetMedicalScribeJobCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: TranscribeClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, GetMedicalScribeJobCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "TranscribeClient"; + const commandName = "GetMedicalScribeJobCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "Transcribe", + operation: "GetMedicalScribeJob", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: GetMedicalScribeJobCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_GetMedicalScribeJobCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_GetMedicalScribeJobCommand(output, context); + } +} diff --git a/clients/client-transcribe/src/commands/ListMedicalScribeJobsCommand.ts b/clients/client-transcribe/src/commands/ListMedicalScribeJobsCommand.ts new file mode 100644 index 0000000000000..bb7a9d04fbba1 --- /dev/null +++ b/clients/client-transcribe/src/commands/ListMedicalScribeJobsCommand.ts @@ -0,0 +1,170 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { ListMedicalScribeJobsRequest, ListMedicalScribeJobsResponse } from "../models/models_0"; +import { de_ListMedicalScribeJobsCommand, se_ListMedicalScribeJobsCommand } from "../protocols/Aws_json1_1"; +import { ServiceInputTypes, ServiceOutputTypes, TranscribeClientResolvedConfig } from "../TranscribeClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListMedicalScribeJobsCommand}. + */ +export interface ListMedicalScribeJobsCommandInput extends ListMedicalScribeJobsRequest {} +/** + * @public + * + * The output of {@link ListMedicalScribeJobsCommand}. + */ +export interface ListMedicalScribeJobsCommandOutput extends ListMedicalScribeJobsResponse, __MetadataBearer {} + +/** + * @public + *

Provides a list of Medical Scribe jobs that match the specified criteria. If no + * criteria are specified, all Medical Scribe jobs are returned.

+ *

To get detailed information about a specific Medical Scribe job, use the operation.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, ListMedicalScribeJobsCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, ListMedicalScribeJobsCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const input = { // ListMedicalScribeJobsRequest + * Status: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED", + * JobNameContains: "STRING_VALUE", + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListMedicalScribeJobsCommand(input); + * const response = await client.send(command); + * // { // ListMedicalScribeJobsResponse + * // Status: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED", + * // NextToken: "STRING_VALUE", + * // MedicalScribeJobSummaries: [ // MedicalScribeJobSummaries + * // { // MedicalScribeJobSummary + * // MedicalScribeJobName: "STRING_VALUE", + * // CreationTime: new Date("TIMESTAMP"), + * // StartTime: new Date("TIMESTAMP"), + * // CompletionTime: new Date("TIMESTAMP"), + * // LanguageCode: "en-US", + * // MedicalScribeJobStatus: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED", + * // FailureReason: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListMedicalScribeJobsCommandInput - {@link ListMedicalScribeJobsCommandInput} + * @returns {@link ListMedicalScribeJobsCommandOutput} + * @see {@link ListMedicalScribeJobsCommandInput} for command's `input` shape. + * @see {@link ListMedicalScribeJobsCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for TranscribeClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *

Your request didn't pass one or more validation tests. This can occur when the entity + * you're trying to delete doesn't exist or if it's in a non-terminal state (such as + * IN PROGRESS). See the exception message field for more + * information.

+ * + * @throws {@link InternalFailureException} (server fault) + *

There was an internal error. Check the error message, correct the issue, and try your + * request again.

+ * + * @throws {@link LimitExceededException} (client fault) + *

You've either sent too many requests or your input file is too long. Wait before + * retrying your request, or use a smaller file and try your request again.

+ * + * @throws {@link TranscribeServiceException} + *

Base exception class for all service exceptions from Transcribe service.

+ * + */ +export class ListMedicalScribeJobsCommand extends $Command< + ListMedicalScribeJobsCommandInput, + ListMedicalScribeJobsCommandOutput, + TranscribeClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListMedicalScribeJobsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: TranscribeClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, ListMedicalScribeJobsCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "TranscribeClient"; + const commandName = "ListMedicalScribeJobsCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "Transcribe", + operation: "ListMedicalScribeJobs", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: ListMedicalScribeJobsCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_ListMedicalScribeJobsCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_ListMedicalScribeJobsCommand(output, context); + } +} diff --git a/clients/client-transcribe/src/commands/StartMedicalScribeJobCommand.ts b/clients/client-transcribe/src/commands/StartMedicalScribeJobCommand.ts new file mode 100644 index 0000000000000..0a38cd3e9d7a7 --- /dev/null +++ b/clients/client-transcribe/src/commands/StartMedicalScribeJobCommand.ts @@ -0,0 +1,269 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { StartMedicalScribeJobRequest, StartMedicalScribeJobResponse } from "../models/models_0"; +import { de_StartMedicalScribeJobCommand, se_StartMedicalScribeJobCommand } from "../protocols/Aws_json1_1"; +import { ServiceInputTypes, ServiceOutputTypes, TranscribeClientResolvedConfig } from "../TranscribeClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link StartMedicalScribeJobCommand}. + */ +export interface StartMedicalScribeJobCommandInput extends StartMedicalScribeJobRequest {} +/** + * @public + * + * The output of {@link StartMedicalScribeJobCommand}. + */ +export interface StartMedicalScribeJobCommandOutput extends StartMedicalScribeJobResponse, __MetadataBearer {} + +/** + * @public + *

Transcribes patient-clinician conversations and generates clinical notes.

+ *

Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, + * classifies dialogues, extracts medical terms, and generates preliminary clinical notes. + * To learn more about these features, refer to Amazon Web Services HealthScribe.

+ *

To make a StartMedicalScribeJob request, you must first upload + * your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location + * of the file using the Media parameter.

+ *

You must include the following parameters in your + * StartMedicalTranscriptionJob request:

+ *
    + *
  • + *

    + * DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media, + * write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). + * The role should also allow transcribe.amazonaws.com to assume it. + *

    + *
    • + *
  • + *

    + * Media (MediaFileUri): The Amazon S3 location + * of your media file.

    + *
    • + *
  • + *

    + * MedicalScribeJobName: A custom name you create for your + * MedicalScribe job that is unique within your Amazon Web Services account.

    + *
    • + *
  • + *

    + * OutputBucketName: The Amazon S3 bucket where you want + * your output files stored.

    + *
    • + *
  • + *

    + * Settings: A MedicalScribeSettings obect + * that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. + * If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set. + *

    + *
    • + *
  • + *

    + * ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification + * value of Settings is set to true. + *

    + *
    • + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, StartMedicalScribeJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, StartMedicalScribeJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const input = { // StartMedicalScribeJobRequest + * MedicalScribeJobName: "STRING_VALUE", // required + * Media: { // Media + * MediaFileUri: "STRING_VALUE", + * RedactedMediaFileUri: "STRING_VALUE", + * }, + * OutputBucketName: "STRING_VALUE", // required + * OutputEncryptionKMSKeyId: "STRING_VALUE", + * KMSEncryptionContext: { // KMSEncryptionContextMap + * "": "STRING_VALUE", + * }, + * DataAccessRoleArn: "STRING_VALUE", // required + * Settings: { // MedicalScribeSettings + * ShowSpeakerLabels: true || false, + * MaxSpeakerLabels: Number("int"), + * ChannelIdentification: true || false, + * VocabularyName: "STRING_VALUE", + * VocabularyFilterName: "STRING_VALUE", + * VocabularyFilterMethod: "remove" || "mask" || "tag", + * }, + * ChannelDefinitions: [ // MedicalScribeChannelDefinitions + * { // MedicalScribeChannelDefinition + * ChannelId: Number("int"), // required + * ParticipantRole: "PATIENT" || "CLINICIAN", // required + * }, + * ], + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new StartMedicalScribeJobCommand(input); + * const response = await client.send(command); + * // { // StartMedicalScribeJobResponse + * // MedicalScribeJob: { // MedicalScribeJob + * // MedicalScribeJobName: "STRING_VALUE", + * // MedicalScribeJobStatus: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED", + * // LanguageCode: "en-US", + * // Media: { // Media + * // MediaFileUri: "STRING_VALUE", + * // RedactedMediaFileUri: "STRING_VALUE", + * // }, + * // MedicalScribeOutput: { // MedicalScribeOutput + * // TranscriptFileUri: "STRING_VALUE", // required + * // ClinicalDocumentUri: "STRING_VALUE", // required + * // }, + * // StartTime: new Date("TIMESTAMP"), + * // CreationTime: new Date("TIMESTAMP"), + * // CompletionTime: new Date("TIMESTAMP"), + * // FailureReason: "STRING_VALUE", + * // Settings: { // MedicalScribeSettings + * // ShowSpeakerLabels: true || false, + * // MaxSpeakerLabels: Number("int"), + * // ChannelIdentification: true || false, + * // VocabularyName: "STRING_VALUE", + * // VocabularyFilterName: "STRING_VALUE", + * // VocabularyFilterMethod: "remove" || "mask" || "tag", + * // }, + * // DataAccessRoleArn: "STRING_VALUE", + * // ChannelDefinitions: [ // MedicalScribeChannelDefinitions + * // { // MedicalScribeChannelDefinition + * // ChannelId: Number("int"), // required + * // ParticipantRole: "PATIENT" || "CLINICIAN", // required + * // }, + * // ], + * // Tags: [ // TagList + * // { // Tag + * // Key: "STRING_VALUE", // required + * // Value: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // }; + * + * ``` + * + * @param StartMedicalScribeJobCommandInput - {@link StartMedicalScribeJobCommandInput} + * @returns {@link StartMedicalScribeJobCommandOutput} + * @see {@link StartMedicalScribeJobCommandInput} for command's `input` shape. + * @see {@link StartMedicalScribeJobCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for TranscribeClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *

Your request didn't pass one or more validation tests. This can occur when the entity + * you're trying to delete doesn't exist or if it's in a non-terminal state (such as + * IN PROGRESS). See the exception message field for more + * information.

+ * + * @throws {@link ConflictException} (client fault) + *

A resource already exists with this name. Resource names must be unique within an + * Amazon Web Services account.

+ * + * @throws {@link InternalFailureException} (server fault) + *

There was an internal error. Check the error message, correct the issue, and try your + * request again.

+ * + * @throws {@link LimitExceededException} (client fault) + *

You've either sent too many requests or your input file is too long. Wait before + * retrying your request, or use a smaller file and try your request again.

+ * + * @throws {@link TranscribeServiceException} + *

Base exception class for all service exceptions from Transcribe service.

+ * + */ +export class StartMedicalScribeJobCommand extends $Command< + StartMedicalScribeJobCommandInput, + StartMedicalScribeJobCommandOutput, + TranscribeClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartMedicalScribeJobCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: TranscribeClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, StartMedicalScribeJobCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "TranscribeClient"; + const commandName = "StartMedicalScribeJobCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "Transcribe", + operation: "StartMedicalScribeJob", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: StartMedicalScribeJobCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_StartMedicalScribeJobCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_StartMedicalScribeJobCommand(output, context); + } +} diff --git a/clients/client-transcribe/src/commands/StartMedicalTranscriptionJobCommand.ts b/clients/client-transcribe/src/commands/StartMedicalTranscriptionJobCommand.ts index 05e9f32a7af35..029766da21bd0 100644 --- a/clients/client-transcribe/src/commands/StartMedicalTranscriptionJobCommand.ts +++ b/clients/client-transcribe/src/commands/StartMedicalTranscriptionJobCommand.ts @@ -50,7 +50,7 @@ export interface StartMedicalTranscriptionJobCommandOutput * features, refer to How Amazon Transcribe Medical * works.

*

To make a StartMedicalTranscriptionJob request, you must first upload - * your media file into an Amazon S3 bucket; you can then specify the S3 location + * your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location * of the file using the Media parameter.

*

You must include the following parameters in your * StartMedicalTranscriptionJob request:

diff --git a/clients/client-transcribe/src/commands/StartTranscriptionJobCommand.ts b/clients/client-transcribe/src/commands/StartTranscriptionJobCommand.ts index fed1da511502d..f8943972a10ee 100644 --- a/clients/client-transcribe/src/commands/StartTranscriptionJobCommand.ts +++ b/clients/client-transcribe/src/commands/StartTranscriptionJobCommand.ts @@ -66,7 +66,7 @@ export interface StartTranscriptionJobCommandOutput extends StartTranscriptionJo * IdentifyMultipleLanguages: If you know the language of your * media file, specify it using the LanguageCode parameter; you can * find all valid language codes in the Supported - * languages table. If you don't know the languages spoken in your + * languages table. If you do not know the languages spoken in your * media, use either IdentifyLanguage or * IdentifyMultipleLanguages and let Amazon Transcribe identify * the languages for you.

diff --git a/clients/client-transcribe/src/commands/index.ts b/clients/client-transcribe/src/commands/index.ts index a8543b850a7bf..45573fa1eb8a5 100644 --- a/clients/client-transcribe/src/commands/index.ts +++ b/clients/client-transcribe/src/commands/index.ts @@ -7,6 +7,7 @@ export * from "./CreateVocabularyFilterCommand"; export * from "./DeleteCallAnalyticsCategoryCommand"; export * from "./DeleteCallAnalyticsJobCommand"; export * from "./DeleteLanguageModelCommand"; +export * from "./DeleteMedicalScribeJobCommand"; export * from "./DeleteMedicalTranscriptionJobCommand"; export * from "./DeleteMedicalVocabularyCommand"; export * from "./DeleteTranscriptionJobCommand"; @@ -15,6 +16,7 @@ export * from "./DeleteVocabularyFilterCommand"; export * from "./DescribeLanguageModelCommand"; export * from "./GetCallAnalyticsCategoryCommand"; export * from "./GetCallAnalyticsJobCommand"; +export * from "./GetMedicalScribeJobCommand"; export * from "./GetMedicalTranscriptionJobCommand"; export * from "./GetMedicalVocabularyCommand"; export * from "./GetTranscriptionJobCommand"; @@ -23,6 +25,7 @@ export * from "./GetVocabularyFilterCommand"; export * from "./ListCallAnalyticsCategoriesCommand"; export * from "./ListCallAnalyticsJobsCommand"; export * from "./ListLanguageModelsCommand"; +export * from "./ListMedicalScribeJobsCommand"; export * from "./ListMedicalTranscriptionJobsCommand"; export * from "./ListMedicalVocabulariesCommand"; export * from "./ListTagsForResourceCommand"; @@ -30,6 +33,7 @@ export * from "./ListTranscriptionJobsCommand"; export * from "./ListVocabulariesCommand"; export * from "./ListVocabularyFiltersCommand"; export * from "./StartCallAnalyticsJobCommand"; +export * from "./StartMedicalScribeJobCommand"; export * from "./StartMedicalTranscriptionJobCommand"; export * from "./StartTranscriptionJobCommand"; export * from "./TagResourceCommand"; diff --git a/clients/client-transcribe/src/models/models_0.ts b/clients/client-transcribe/src/models/models_0.ts index b97bcb915674a..8190252748f47 100644 --- a/clients/client-transcribe/src/models/models_0.ts +++ b/clients/client-transcribe/src/models/models_0.ts @@ -262,7 +262,8 @@ export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode]; * @public *

Describes the Amazon S3 location of the media file you want to use in your * request.

- *

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section + *

For information on supported media formats, refer to the MediaFormat + * parameter or the Media formats section * in the Amazon S3 Developer Guide.

*/ export interface Media { @@ -390,17 +391,19 @@ export type RedactionType = (typeof RedactionType)[keyof typeof RedactionType]; /** * @public - *

Makes it possible to redact or flag specified personally identifiable information - * (PII) in your transcript. If you use ContentRedaction, you must also - * include the sub-parameters: PiiEntityTypes, RedactionOutput, - * and RedactionType.

+ *

Makes it possible to redact or flag specified personally identifiable information (PII) in + * your transcript. If you use ContentRedaction, you must also include the + * sub-parameters: RedactionOutput and RedactionType. You can + * optionally include PiiEntityTypes to choose which types of PII you want to + * redact.

*/ export interface ContentRedaction { /** * @public *

Specify the category of information you want to redact; PII (personally - * identifiable information) is the only valid value. You can use - * PiiEntityTypes to choose which types of PII you want to redact.

+ * identifiable information) is the only valid value. You can use PiiEntityTypes to + * choose which types of PII you want to redact. If you do not include PiiEntityTypes in + * your request, all PII is redacted.

*/ RedactionType: RedactionType | undefined; @@ -420,7 +423,8 @@ export interface ContentRedaction { * @public *

Specify which types of personally identifiable information (PII) you want to redact in * your transcript. You can include as many types as you'd like, or you can select - * ALL.

+ * ALL. If you do not include PiiEntityTypes in your request, all PII is + * redacted.

*/ PiiEntityTypes?: PiiEntityType[]; } @@ -462,7 +466,7 @@ export interface LanguageIdSettings { *

The name of the custom vocabulary you want to use when processing your transcription * job. Custom vocabulary names are case sensitive.

*

The language of the specified custom vocabulary must match the language code that you - * specify in your transcription request. If the languages don't match, the custom + * specify in your transcription request. If the languages do not match, the custom * vocabulary isn't applied. There are no errors or warnings associated with a language * mismatch.

*/ @@ -473,7 +477,7 @@ export interface LanguageIdSettings { *

The name of the custom vocabulary filter you want to use when processing your * transcription job. Custom vocabulary filter names are case sensitive.

*

The language of the specified custom vocabulary filter must match the language code - * that you specify in your transcription request. If the languages don't match, the custom + * that you specify in your transcription request. If the languages do not match, the custom * vocabulary filter isn't applied. There are no errors or warnings associated with a * language mismatch.

*

Note that if you include VocabularyFilterName in your request, you must @@ -486,7 +490,7 @@ export interface LanguageIdSettings { *

The name of the custom language model you want to use when processing your * transcription job. Note that custom language model names are case sensitive.

*

The language of the specified custom language model must match the language code that - * you specify in your transcription request. If the languages don't match, the custom + * you specify in your transcription request. If the languages do not match, the custom * language model isn't applied. There are no errors or warnings associated with a language * mismatch.

*/ @@ -562,7 +566,7 @@ export interface CallAnalyticsJobSettings { *

The name of the custom language model you want to use when processing your Call * Analytics job. Note that custom language model names are case sensitive.

*

The language of the specified custom language model must match the language code that - * you specify in your transcription request. If the languages don't match, the custom + * you specify in your transcription request. If the languages do not match, the custom * language model isn't applied. There are no errors or warnings associated with a language * mismatch.

*/ @@ -570,10 +574,11 @@ export interface CallAnalyticsJobSettings { /** * @public - *

Makes it possible to redact or flag specified personally identifiable information - * (PII) in your transcript. If you use ContentRedaction, you must also - * include the sub-parameters: PiiEntityTypes, RedactionOutput, - * and RedactionType.

+ *

Makes it possible to redact or flag specified personally identifiable information (PII) in + * your transcript. If you use ContentRedaction, you must also include the + * sub-parameters: RedactionOutput and RedactionType. You can + * optionally include PiiEntityTypes to choose which types of PII you want to + * redact.

*/ ContentRedaction?: ContentRedaction; @@ -715,7 +720,7 @@ export interface CallAnalyticsJob { *

The language code used to create your Call Analytics job. For a list of supported * languages and their associated language codes, refer to the Supported languages * table.

- *

If you don't know the language spoken in your media file, you can omit this field and + *

If you do not know the language spoken in your media file, you can omit this field and * let Amazon Transcribe automatically identify the language of your media. To improve the * accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

*/ @@ -785,7 +790,7 @@ export interface CallAnalyticsJob { *

* Unsupported media format.

*

The media format specified in MediaFormat isn't valid. Refer to - * MediaFormat for a list of supported + * refer to the MediaFormat parameter for a list of supported * formats.

* *
  • @@ -814,14 +819,14 @@ export interface CallAnalyticsJob { *

    * Invalid file size: file size too large.

    *

    The size of your media file is larger than what Amazon Transcribe can - * process. For more information, refer to Guidelines and + * process. For more information, refer to Service * quotas.

    *
    • *
  • *

    * Invalid number of channels: number of channels too large.

    *

    Your audio contains more channels than Amazon Transcribe is able to process. - * For more information, refer to Guidelines and + * For more information, refer to Service * quotas.

    *
    • * @@ -1622,10 +1627,8 @@ export interface CreateLanguageModelRequest { * model must contain terms in only one language, and the language you select for your * custom language model must match the language of your training and tuning data.

    *

    For a list of supported languages and their associated language codes, refer to the - * Supported languages table. Note that - * US English - * (en-US) is the only language supported with Amazon Transcribe - * Medical.

    + * Supported languages table. Note that US English (en-US) is the + * only language supported with Amazon Transcribe Medical.

    *

    A custom language model can only be used to transcribe files in the same language as * the model. For example, if you create a custom language model using US English * (en-US), you can only apply this model to files that contain English @@ -2130,6 +2133,18 @@ export interface DeleteLanguageModelRequest { ModelName: string | undefined; } +/** + * @public + */ +export interface DeleteMedicalScribeJobRequest { + /** + * @public + *

    The name of the Medical Scribe job you want to delete. Job names are case + * sensitive.

    + */ + MedicalScribeJobName: string | undefined; +} + /** * @public */ @@ -2265,7 +2280,7 @@ export interface LanguageModel { * model must contain terms in only one language, and the language you select for your * custom language model must match the language of your training and tuning data.

    *

    For a list of supported languages and their associated language codes, refer to the - * Supported languages table. Note that U.S. English (en-US) is + * Supported languages table. Note that US English (en-US) is * the only language supported with Amazon Transcribe Medical.

    */ LanguageCode?: CLMLanguageCode; @@ -2380,6 +2395,322 @@ export interface GetCallAnalyticsJobResponse { CallAnalyticsJob?: CallAnalyticsJob; } +/** + * @public + */ +export interface GetMedicalScribeJobRequest { + /** + * @public + *

    The name of the Medical Scribe job you want information about. Job names are + * case sensitive.

    + */ + MedicalScribeJobName: string | undefined; +} + +/** + * @public + * @enum + */ +export const MedicalScribeParticipantRole = { + CLINICIAN: "CLINICIAN", + PATIENT: "PATIENT", +} as const; + +/** + * @public + */ +export type MedicalScribeParticipantRole = + (typeof MedicalScribeParticipantRole)[keyof typeof MedicalScribeParticipantRole]; + +/** + * @public + *

    Indicates which speaker is on which channel. The options are + * CLINICIAN and PATIENT + *

    + */ +export interface MedicalScribeChannelDefinition { + /** + * @public + *

    Specify the audio channel you want to define.

    + */ + ChannelId: number | undefined; + + /** + * @public + *

    Specify the participant that you want to flag. + * The options are CLINICIAN and PATIENT + *

    + */ + ParticipantRole: MedicalScribeParticipantRole | undefined; +} + +/** + * @public + * @enum + */ +export const MedicalScribeLanguageCode = { + EN_US: "en-US", +} as const; + +/** + * @public + */ +export type MedicalScribeLanguageCode = (typeof MedicalScribeLanguageCode)[keyof typeof MedicalScribeLanguageCode]; + +/** + * @public + * @enum + */ +export const MedicalScribeJobStatus = { + COMPLETED: "COMPLETED", + FAILED: "FAILED", + IN_PROGRESS: "IN_PROGRESS", + QUEUED: "QUEUED", +} as const; + +/** + * @public + */ +export type MedicalScribeJobStatus = (typeof MedicalScribeJobStatus)[keyof typeof MedicalScribeJobStatus]; + +/** + * @public + *

    The location of the output of your Medical Scribe job. + * ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document + * and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

    + */ +export interface MedicalScribeOutput { + /** + * @public + *

    Holds the Amazon S3 URI for the Transcript.

    + */ + TranscriptFileUri: string | undefined; + + /** + * @public + *

    Holds the Amazon S3 URI for the Clinical Document.

    + */ + ClinicalDocumentUri: string | undefined; +} + +/** + * @public + *

    Makes it possible to control how your Medical Scribe job is processed using a + * MedicalScribeSettings object. Specify ChannelIdentification if + * ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification + * and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels + * must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings + * to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. + * VocabularyFilterMethod must be specified if VocabularyFilterName is set. + *

    + */ +export interface MedicalScribeSettings { + /** + * @public + *

    Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker + * partitioning labels the speech from individual speakers in your media file.

    + *

    If you enable ShowSpeakerLabels in your request, you must also include + * MaxSpeakerLabels.

    + *

    For more information, see Partitioning speakers + * (diarization).

    + */ + ShowSpeakerLabels?: boolean; + + /** + * @public + *

    Specify the maximum number of speakers you want to partition in your media.

    + *

    Note that if your media contains more speakers than the specified number, multiple + * speakers are treated as a single speaker.

    + *

    If you specify the MaxSpeakerLabels field, you must set the + * ShowSpeakerLabels field to true.

    + */ + MaxSpeakerLabels?: number; + + /** + * @public + *

    Enables channel identification in multi-channel audio.

    + *

    Channel identification transcribes the audio on each channel independently, then + * appends the output for each channel into one transcript.

    + *

    For more information, see Transcribing multi-channel + * audio.

    + */ + ChannelIdentification?: boolean; + + /** + * @public + *

    The name of the custom vocabulary you want to include in your Medical Scribe + * request. Custom vocabulary names are case sensitive.

    + */ + VocabularyName?: string; + + /** + * @public + *

    The name of the custom vocabulary filter you want to include in your Medical Scribe + * request. Custom vocabulary filter names are case sensitive.

    + *

    Note that if you include VocabularyFilterName in your request, you must + * also include VocabularyFilterMethod.

    + */ + VocabularyFilterName?: string; + + /** + * @public + *

    Specify how you want your custom vocabulary filter applied to your transcript.

    + *

    To replace words with ***, choose mask.

    + *

    To delete words, choose remove.

    + *

    To flag words without changing them, choose tag.

    + */ + VocabularyFilterMethod?: VocabularyFilterMethod; +} + +/** + * @public + *

    Provides detailed information about a Medical Scribe job.

    + *

    To view the status of the specified Medical Scribe job, check the + * MedicalScribeJobStatus field. If the status is COMPLETED, + * the job is finished and you can find the results at the locations specified in + * MedicalScribeOutput. If the status is FAILED, + * FailureReason provides details on why your Medical Scribe job + * failed.

    + */ +export interface MedicalScribeJob { + /** + * @public + *

    The name of the Medical Scribe job. Job names are case sensitive and must be + * unique within an Amazon Web Services account.

    + */ + MedicalScribeJobName?: string; + + /** + * @public + *

    Provides the status of the specified Medical Scribe job.

    + *

    If the status is COMPLETED, the job is finished and you can find the + * results at the location specified in MedicalScribeOutput If + * the status is FAILED, FailureReason provides details on why + * your Medical Scribe job failed.

    + */ + MedicalScribeJobStatus?: MedicalScribeJobStatus; + + /** + * @public + *

    The language code used to create your Medical Scribe job. US English + * (en-US) is the only supported language for Medical Scribe jobs.

    + */ + LanguageCode?: MedicalScribeLanguageCode; + + /** + * @public + *

    Describes the Amazon S3 location of the media file you want to use in your + * request.

    + *

    For information on supported media formats, refer to the MediaFormat + * parameter or the Media formats section + * in the Amazon S3 Developer Guide.

    + */ + Media?: Media; + + /** + * @public + *

    The location of the output of your Medical Scribe job. + * ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document + * and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

    + */ + MedicalScribeOutput?: MedicalScribeOutput; + + /** + * @public + *

    The date and time your Medical Scribe job began processing.

    + *

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For + * example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job + * that started processing at 12:32 PM UTC-7 on May 4, 2022.

    + */ + StartTime?: Date; + + /** + * @public + *

    The date and time the specified Medical Scribe job request was made.

    + *

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For + * example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job + * that started processing at 12:32 PM UTC-7 on May 4, 2022.

    + */ + CreationTime?: Date; + + /** + * @public + *

    The date and time the specified Medical Scribe job finished processing.

    + *

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For + * example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job + * that finished processing at 12:32 PM UTC-7 on May 4, 2022.

    + */ + CompletionTime?: Date; + + /** + * @public + *

    If MedicalScribeJobStatus is FAILED, + * FailureReason contains information about why the transcription job + * failed. See also: Common Errors.

    + */ + FailureReason?: string; + + /** + * @public + *

    Makes it possible to control how your Medical Scribe job is processed using a + * MedicalScribeSettings object. Specify ChannelIdentification if + * ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification + * and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels + * must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings + * to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. + * VocabularyFilterMethod must be specified if VocabularyFilterName is set. + *

    + */ + Settings?: MedicalScribeSettings; + + /** + * @public + *

    The Amazon Resource Name (ARN) of an IAM role that has permissions to + * access the Amazon S3 bucket that contains your input files, + * write to the output bucket, and use your KMS key if supplied. + * If the role that you specify doesn’t have the appropriate permissions your request fails.

    + *

    IAM role ARNs have the format + * arn:partition:iam::account:role/role-name-with-path. For example: + * arn:aws:iam::111122223333:role/Admin.

    + *

    For more information, see IAM + * ARNs.

    + */ + DataAccessRoleArn?: string; + + /** + * @public + *

    Makes it possible to specify which speaker is on which channel. For example, if the clinician + * is the first participant to speak, you would set ChannelId of the first ChannelDefinition + * in the list to 0 (to indicate the first channel) and ParticipantRole to + * CLINICIAN (to indicate that it's the clinician speaking). + * Then you would set the ChannelId of the second ChannelDefinition in the list to + * 1 (to indicate the second channel) and ParticipantRole to + * PATIENT (to indicate that it's the patient speaking). + *

    + */ + ChannelDefinitions?: MedicalScribeChannelDefinition[]; + + /** + * @public + *

    Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

    + *

    To learn more about using tags with Amazon Transcribe, refer to Tagging + * resources.

    + */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface GetMedicalScribeJobResponse { + /** + * @public + *

    Provides detailed information about the specified Medical Scribe job, including + * job status and, if applicable, failure reason

    + */ + MedicalScribeJob?: MedicalScribeJob; +} + /** * @public */ @@ -2419,9 +2750,6 @@ export interface MedicalTranscriptionSetting { * partitioning labels the speech from individual speakers in your media file.

    *

    If you enable ShowSpeakerLabels in your request, you must also include * MaxSpeakerLabels.

    - *

    You can't include ShowSpeakerLabels and - * ChannelIdentification in the same request. Including both parameters - * returns a BadRequestException.

    *

    For more information, see Partitioning speakers * (diarization).

    */ @@ -2445,9 +2773,6 @@ export interface MedicalTranscriptionSetting { *

    If you have multi-channel audio and do not enable channel identification, your audio * is transcribed in a continuous manner and your transcript does not separate the speech * by channel.

    - *

    You can't include both ShowSpeakerLabels and - * ChannelIdentification in the same request. Including both parameters - * returns a BadRequestException.

    *

    For more information, see Transcribing multi-channel * audio.

    */ @@ -2484,7 +2809,7 @@ export interface MedicalTranscriptionSetting { *

    The name of the custom vocabulary you want to use when processing your medical * transcription job. Custom vocabulary names are case sensitive.

    *

    The language of the specified custom vocabulary must match the language code that you - * specify in your transcription request. If the languages don't match, the custom + * specify in your transcription request. If the languages do not match, the custom * vocabulary isn't applied. There are no errors or warnings associated with a language * mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

    */ @@ -2602,7 +2927,8 @@ export interface MedicalTranscriptionJob { * @public *

    Describes the Amazon S3 location of the media file you want to use in your * request.

    - *

    For information on supported media formats, refer to the MediaFormat parameter or the Media formats section + *

    For information on supported media formats, refer to the MediaFormat + * parameter or the Media formats section * in the Amazon S3 Developer Guide.

    */ Media?: Media; @@ -2652,7 +2978,7 @@ export interface MedicalTranscriptionJob { *

    * Unsupported media format.

    *

    The media format specified in MediaFormat isn't valid. Refer to - * MediaFormat for a list of supported + * refer to the MediaFormat parameter for a list of supported * formats.

    * *
  • @@ -2681,14 +3007,14 @@ export interface MedicalTranscriptionJob { *

    * Invalid file size: file size too large.

    *

    The size of your media file is larger than what Amazon Transcribe can - * process. For more information, refer to Guidelines and + * process. For more information, refer to Service * quotas.

    *
    • *
  • *

    * Invalid number of channels: number of channels too large.

    *

    Your audio contains more channels than Amazon Transcribe is able to process. - * For more information, refer to Guidelines and + * For more information, refer to Service * quotas.

    *
    • * @@ -2800,7 +3126,7 @@ export interface GetMedicalVocabularyResponse { /** * @public - *

    The S3 location where the specified custom medical vocabulary is stored; use this URI + *

    The Amazon S3 location where the specified custom medical vocabulary is stored; use this URI * to view or download the custom vocabulary.

    */ DownloadUri?: string; @@ -2895,7 +3221,7 @@ export interface ModelSettings { *

    The name of the custom language model you want to use when processing your * transcription job. Note that custom language model names are case sensitive.

    *

    The language of the specified custom language model must match the language code that - * you specify in your transcription request. If the languages don't match, the custom + * you specify in your transcription request. If the languages do not match, the custom * language model isn't applied. There are no errors or warnings associated with a language * mismatch.

    */ @@ -2904,7 +3230,8 @@ export interface ModelSettings { /** * @public - *

    Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker + *

    Allows additional optional settings in your + * request, including channel identification, alternative transcriptions, and speaker * partitioning. You can use that to apply custom vocabularies to your transcription * job.

    */ @@ -2922,9 +3249,6 @@ export interface Settings { * partitioning labels the speech from individual speakers in your media file.

    *

    If you enable ShowSpeakerLabels in your request, you must also include * MaxSpeakerLabels.

    - *

    You can't include both ShowSpeakerLabels and - * ChannelIdentification in the same request. Including both parameters - * returns a BadRequestException.

    *

    For more information, see Partitioning speakers * (diarization).

    */ @@ -2945,9 +3269,6 @@ export interface Settings { *

    Enables channel identification in multi-channel audio.

    *

    Channel identification transcribes the audio on each channel independently, then * appends the output for each channel into one transcript.

    - *

    You can't include both ShowSpeakerLabels and - * ChannelIdentification in the same request. Including both parameters - * returns a BadRequestException.

    *

    For more information, see Transcribing multi-channel * audio.

    */ @@ -3192,7 +3513,7 @@ export interface TranscriptionJob { *

    * Unsupported media format.

    *

    The media format specified in MediaFormat isn't valid. Refer to - * MediaFormat for a list of supported + * refer to the MediaFormat parameter for a list of supported * formats.

    * *
  • @@ -3221,14 +3542,14 @@ export interface TranscriptionJob { *

    * Invalid file size: file size too large.

    *

    The size of your media file is larger than what Amazon Transcribe can - * process. For more information, refer to Guidelines and + * process. For more information, refer to Service * quotas.

    *
    • *
  • *

    * Invalid number of channels: number of channels too large.

    *

    Your audio contains more channels than Amazon Transcribe is able to process. - * For more information, refer to Guidelines and + * For more information, refer to Service * quotas.

    *
    • * @@ -3394,7 +3715,7 @@ export interface GetVocabularyResponse { /** * @public - *

    The S3 location where the custom vocabulary is stored; use this URI to view or + *

    The Amazon S3 location where the custom vocabulary is stored; use this URI to view or * download the custom vocabulary.

    */ DownloadUri?: string; @@ -3463,7 +3784,7 @@ export interface ListCallAnalyticsCategoriesRequest { * @public *

    The maximum number of Call Analytics categories to return in each page of results. If * there are fewer results than the value that you specify, only the actual results are - * returned. If you don't specify a value, a default of 5 is used.

    + * returned. If you do not specify a value, a default of 5 is used.

    */ MaxResults?: number; } @@ -3497,7 +3818,7 @@ export interface ListCallAnalyticsJobsRequest { /** * @public *

    Returns only Call Analytics jobs with the specified status. Jobs are ordered by - * creation date, with the newest job first. If you don't include Status, all + * creation date, with the newest job first. If you do not include Status, all * Call Analytics jobs are returned.

    */ Status?: CallAnalyticsJobStatus; @@ -3523,7 +3844,7 @@ export interface ListCallAnalyticsJobsRequest { * @public *

    The maximum number of Call Analytics jobs to return in each page of results. If there * are fewer results than the value that you specify, only the actual results are returned. - * If you don't specify a value, a default of 5 is used.

    + * If you do not specify a value, a default of 5 is used.

    */ MaxResults?: number; } @@ -3563,7 +3884,7 @@ export interface ListLanguageModelsRequest { /** * @public *

    Returns only custom language models with the specified status. Language models are - * ordered by creation date, with the newest model first. If you don't include + * ordered by creation date, with the newest model first. If you do not include * StatusEquals, all custom language models are returned.

    */ StatusEquals?: ModelStatus; @@ -3589,7 +3910,7 @@ export interface ListLanguageModelsRequest { * @public *

    The maximum number of custom language models to return in each page of results. If * there are fewer results than the value that you specify, only the actual results are - * returned. If you don't specify a value, a default of 5 is used.

    + * returned. If you do not specify a value, a default of 5 is used.

    */ MaxResults?: number; } @@ -3616,6 +3937,137 @@ export interface ListLanguageModelsResponse { Models?: LanguageModel[]; } +/** + * @public + */ +export interface ListMedicalScribeJobsRequest { + /** + * @public + *

    Returns only Medical Scribe jobs with the specified status. Jobs are ordered by + * creation date, with the newest job first. If you do not include Status, all + * Medical Scribe jobs are returned.

    + */ + Status?: MedicalScribeJobStatus; + + /** + * @public + *

    Returns only the Medical Scribe jobs that contain the specified string. The + * search is not case sensitive.

    + */ + JobNameContains?: string; + + /** + * @public + *

    If your ListMedicalScribeJobs request returns more results than + * can be displayed, NextToken is displayed in the response with an associated + * string. To get the next page of results, copy this string and repeat your request, + * including NextToken with the value of the copied string. Repeat as needed + * to view all your results.

    + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of Medical Scribe jobs to return in each page of results. If + * there are fewer results than the value that you specify, only the actual results are + * returned. If you do not specify a value, a default of 5 is used.

    + */ + MaxResults?: number; +} + +/** + * @public + *

    Provides detailed information about a specific Medical Scribe job.

    + */ +export interface MedicalScribeJobSummary { + /** + * @public + *

    The name of the Medical Scribe job. Job names are case sensitive and must be + * unique within an Amazon Web Services account.

    + */ + MedicalScribeJobName?: string; + + /** + * @public + *

    The date and time the specified Medical Scribe job request was made.

    + *

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For + * example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job + * that started processing at 12:32 PM UTC-7 on May 4, 2022.

    + */ + CreationTime?: Date; + + /** + * @public + *

    The date and time your Medical Scribe job began processing.

    + *

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For + * example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job + * that started processing at 12:32 PM UTC-7 on May 4, 2022.

    + */ + StartTime?: Date; + + /** + * @public + *

    The date and time the specified Medical Scribe job finished processing.

    + *

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For + * example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job + * that finished processing at 12:32 PM UTC-7 on May 4, 2022.

    + */ + CompletionTime?: Date; + + /** + * @public + *

    The language code used to create your Medical Scribe job. US English + * (en-US) is the only supported language for Medical Scribe jobs.

    + */ + LanguageCode?: MedicalScribeLanguageCode; + + /** + * @public + *

    Provides the status of the specified Medical Scribe job.

    + *

    If the status is COMPLETED, the job is finished and you can find the + * results at the location specified in MedicalScribeOutput If + * the status is FAILED, FailureReason provides details on why + * your Medical Scribe job failed.

    + */ + MedicalScribeJobStatus?: MedicalScribeJobStatus; + + /** + * @public + *

    If MedicalScribeJobStatus is FAILED, + * FailureReason contains information about why the transcription job + * failed. See also: Common Errors.

    + */ + FailureReason?: string; +} + +/** + * @public + */ +export interface ListMedicalScribeJobsResponse { + /** + * @public + *

    Lists all Medical Scribe jobs that have the status specified in your request. + * Jobs are ordered by creation date, with the newest job first.

    + */ + Status?: MedicalScribeJobStatus; + + /** + * @public + *

    If NextToken is present in your response, it indicates that not all + * results are displayed. To view the next set of results, copy the string associated with + * the NextToken parameter in your results output, then run your request again + * including NextToken with the value of the copied string. Repeat as needed + * to view all your results.

    + */ + NextToken?: string; + + /** + * @public + *

    Provides a summary of information about each result.

    + */ + MedicalScribeJobSummaries?: MedicalScribeJobSummary[]; +} + /** * @public */ @@ -3623,7 +4075,7 @@ export interface ListMedicalTranscriptionJobsRequest { /** * @public *

    Returns only medical transcription jobs with the specified status. Jobs are ordered by - * creation date, with the newest job first. If you don't include Status, all + * creation date, with the newest job first. If you do not include Status, all * medical transcription jobs are returned.

    */ Status?: TranscriptionJobStatus; @@ -3649,7 +4101,7 @@ export interface ListMedicalTranscriptionJobsRequest { * @public *

    The maximum number of medical transcription jobs to return in each page of results. If * there are fewer results than the value that you specify, only the actual results are - * returned. If you don't specify a value, a default of 5 is used.

    + * returned. If you do not specify a value, a default of 5 is used.

    */ MaxResults?: number; } @@ -3812,14 +4264,14 @@ export interface ListMedicalVocabulariesRequest { * @public *

    The maximum number of custom medical vocabularies to return in each page of results. * If there are fewer results than the value that you specify, only the actual results are - * returned. If you don't specify a value, a default of 5 is used.

    + * returned. If you do not specify a value, a default of 5 is used.

    */ MaxResults?: number; /** * @public *

    Returns only custom medical vocabularies with the specified state. Custom vocabularies - * are ordered by creation date, with the newest vocabulary first. If you don't include + * are ordered by creation date, with the newest vocabulary first. If you do not include * StateEquals, all custom medical vocabularies are returned.

    */ StateEquals?: VocabularyState; @@ -3948,7 +4400,7 @@ export interface ListTranscriptionJobsRequest { /** * @public *

    Returns only transcription jobs with the specified status. Jobs are ordered by - * creation date, with the newest job first. If you don't include Status, all + * creation date, with the newest job first. If you do not include Status, all * transcription jobs are returned.

    */ Status?: TranscriptionJobStatus; @@ -3974,7 +4426,7 @@ export interface ListTranscriptionJobsRequest { * @public *

    The maximum number of transcription jobs to return in each page of results. If there * are fewer results than the value that you specify, only the actual results are returned. - * If you don't specify a value, a default of 5 is used.

    + * If you do not specify a value, a default of 5 is used.

    */ MaxResults?: number; } @@ -4160,14 +4612,14 @@ export interface ListVocabulariesRequest { * @public *

    The maximum number of custom vocabularies to return in each page of results. If there * are fewer results than the value that you specify, only the actual results are returned. - * If you don't specify a value, a default of 5 is used.

    + * If you do not specify a value, a default of 5 is used.

    */ MaxResults?: number; /** * @public *

    Returns only custom vocabularies with the specified state. Vocabularies are ordered by - * creation date, with the newest vocabulary first. If you don't include + * creation date, with the newest vocabulary first. If you do not include * StateEquals, all custom medical vocabularies are returned.

    */ StateEquals?: VocabularyState; @@ -4227,7 +4679,7 @@ export interface ListVocabularyFiltersRequest { * @public *

    The maximum number of custom vocabulary filters to return in each page of results. If * there are fewer results than the value that you specify, only the actual results are - * returned. If you don't specify a value, a default of 5 is used.

    + * returned. If you do not specify a value, a default of 5 is used.

    */ MaxResults?: number; @@ -4336,9 +4788,9 @@ export interface StartCallAnalyticsJobRequest { * value that matches the name you specified for your transcription job using the * CallAnalyticsJobName parameter.

    *

    You can specify a KMS key to encrypt your output using the - * OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for + * OutputEncryptionKMSKeyId parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for * server-side encryption.

    - *

    If you don't specify OutputLocation, your transcript is placed in a + *

    If you do not specify OutputLocation, your transcript is placed in a * service-managed Amazon S3 bucket and you are provided with a URI to access your * transcript.

    */ @@ -4383,7 +4835,7 @@ export interface StartCallAnalyticsJobRequest { * arn:aws:kms:region:account-ID:alias/ExampleAlias.

    * * - *

    If you don't specify an encryption key, your output is encrypted with the default + *

    If you do not specify an encryption key, your output is encrypted with the default * Amazon S3 key (SSE-S3).

    *

    If you specify a KMS key to encrypt your output, you must also specify * an output location using the OutputLocation parameter.

    @@ -4434,6 +4886,154 @@ export interface StartCallAnalyticsJobResponse { CallAnalyticsJob?: CallAnalyticsJob; } +/** + * @public + */ +export interface StartMedicalScribeJobRequest { + /** + * @public + *

    A unique name, chosen by you, for your Medical Scribe job.

    + *

    This name is case sensitive, cannot contain spaces, and must be unique within an + * Amazon Web Services account. If you try to create a new job with the same name as an + * existing job, you get a ConflictException error.

    + */ + MedicalScribeJobName: string | undefined; + + /** + * @public + *

    Describes the Amazon S3 location of the media file you want to use in your + * request.

    + *

    For information on supported media formats, refer to the MediaFormat + * parameter or the Media formats section + * in the Amazon S3 Developer Guide.

    + */ + Media: Media | undefined; + + /** + * @public + *

    The name of the Amazon S3 bucket where you want your Medical Scribe + * output stored. Do not include the S3:// prefix of the specified + * bucket.

    + *

    Note that the role specified in the DataAccessRoleArn request parameter + * must have permission to use the specified location. You + * can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

    + */ + OutputBucketName: string | undefined; + + /** + * @public + *

    The KMS key you want to use to encrypt your Medical Scribe + * output.

    + *

    If using a key located in the current + * Amazon Web Services account, you can specify your KMS key in one of four + * ways:

    + *
      + *
    1. + *

      Use the KMS key ID itself. For example, + * 1234abcd-12ab-34cd-56ef-1234567890ab.

      + *
      2. + *
    2. + *

      Use an alias for the KMS key ID. For example, + * alias/ExampleAlias.

      + *
      3. + *
    3. + *

      Use the Amazon Resource Name (ARN) for the KMS key ID. For + * example, + * arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      + *
      4. + *
    4. + *

      Use the ARN for the KMS key alias. For example, + * arn:aws:kms:region:account-ID:alias/ExampleAlias.

      + *
      5. + *
    + *

    If using a key located in a different + * Amazon Web Services account than the current Amazon Web Services account, you can specify + * your KMS key in one of two ways:

    + *
      + *
    1. + *

      Use the ARN for the KMS key ID. For example, + * arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      + *
      2. + *
    2. + *

      Use the ARN for the KMS key alias. For example, + * arn:aws:kms:region:account-ID:alias/ExampleAlias.

      + *
      3. + *
    + *

    If you do not specify an encryption key, your output is encrypted with the default + * Amazon S3 key (SSE-S3).

    + *

    Note that the role specified in the DataAccessRoleArn request parameter + * must have permission to use the specified KMS key.

    + */ + OutputEncryptionKMSKeyId?: string; + + /** + * @public + *

    A map of plain text, non-secret key:value pairs, known as encryption context pairs, + * that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

    + */ + KMSEncryptionContext?: Record; + + /** + * @public + *

    The Amazon Resource Name (ARN) of an IAM role that has permissions to + * access the Amazon S3 bucket that contains your input files, + * write to the output bucket, and use your KMS key if supplied. + * If the role that you specify doesn’t have the appropriate permissions your request fails.

    + *

    IAM role ARNs have the format + * arn:partition:iam::account:role/role-name-with-path. For example: + * arn:aws:iam::111122223333:role/Admin.

    + *

    For more information, see IAM + * ARNs.

    + */ + DataAccessRoleArn: string | undefined; + + /** + * @public + *

    Makes it possible to control how your Medical Scribe job is processed using a + * MedicalScribeSettings object. Specify ChannelIdentification if + * ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification + * and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels + * must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings + * to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. + * VocabularyFilterMethod must be specified if VocabularyFilterName is set. + *

    + */ + Settings: MedicalScribeSettings | undefined; + + /** + * @public + *

    Makes it possible to specify which speaker is on which channel. For example, if the clinician + * is the first participant to speak, you would set ChannelId of the first ChannelDefinition + * in the list to 0 (to indicate the first channel) and ParticipantRole to + * CLINICIAN (to indicate that it's the clinician speaking). + * Then you would set the ChannelId of the second ChannelDefinition in the list to + * 1 (to indicate the second channel) and ParticipantRole to + * PATIENT (to indicate that it's the patient speaking). + *

    + */ + ChannelDefinitions?: MedicalScribeChannelDefinition[]; + + /** + * @public + *

    Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

    + *

    To learn more about using tags with Amazon Transcribe, refer to Tagging + * resources.

    + */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface StartMedicalScribeJobResponse { + /** + * @public + *

    Provides detailed information about the current Medical Scribe job, including + * job status and, if applicable, failure reason.

    + */ + MedicalScribeJob?: MedicalScribeJob; +} + /** * @public */ @@ -4462,7 +5062,7 @@ export interface StartMedicalTranscriptionJobRequest { /** * @public *

    The sample rate, in hertz, of the audio track in your input media file.

    - *

    If you don't specify the media sample rate, Amazon Transcribe Medical determines it + *

    If you do not specify the media sample rate, Amazon Transcribe Medical determines it * for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the * value detected, your job fails. Therefore, in most cases, it's advised to omit * MediaSampleRateHertz and let Amazon Transcribe Medical determine the @@ -4480,7 +5080,8 @@ export interface StartMedicalTranscriptionJobRequest { * @public *

    Describes the Amazon S3 location of the media file you want to use in your * request.

    - *

    For information on supported media formats, refer to the MediaFormat parameter or the Media formats section + *

    For information on supported media formats, refer to the MediaFormat + * parameter or the Media formats section * in the Amazon S3 Developer Guide.

    */ Media: Media | undefined; @@ -4581,7 +5182,7 @@ export interface StartMedicalTranscriptionJobRequest { * arn:aws:kms:region:account-ID:alias/ExampleAlias.

    * * - *

    If you don't specify an encryption key, your output is encrypted with the default + *

    If you do not specify an encryption key, your output is encrypted with the default * Amazon S3 key (SSE-S3).

    *

    If you specify a KMS key to encrypt your output, you must also specify * an output location using the OutputLocation parameter.

    @@ -4718,7 +5319,7 @@ export interface StartTranscriptionJobRequest { /** * @public *

    The sample rate, in hertz, of the audio track in your input media file.

    - *

    If you don't specify the media sample rate, Amazon Transcribe determines it for you. + *

    If you do not specify the media sample rate, Amazon Transcribe determines it for you. * If you specify the sample rate, it must match the rate detected by Amazon Transcribe. * If there's a mismatch between the value that you specify and the value detected, your * job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

    @@ -4752,7 +5353,7 @@ export interface StartTranscriptionJobRequest { * OutputKey to test-files/.

    *

    Note that Amazon Transcribe must have permission to use the specified location. You * can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

    - *

    If you don't specify OutputBucketName, your transcript is placed in a + *

    If you do not specify OutputBucketName, your transcript is placed in a * service-managed Amazon S3 bucket and you are provided with a URI to access your * transcript.

    */ @@ -4836,7 +5437,7 @@ export interface StartTranscriptionJobRequest { * arn:aws:kms:region:account-ID:alias/ExampleAlias.

    * * - *

    If you don't specify an encryption key, your output is encrypted with the default + *

    If you do not specify an encryption key, your output is encrypted with the default * Amazon S3 key (SSE-S3).

    *

    If you specify a KMS key to encrypt your output, you must also specify * an output location using the OutputLocation parameter.

    @@ -4854,7 +5455,8 @@ export interface StartTranscriptionJobRequest { /** * @public - *

    Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker + *

    Specify additional optional settings in your + * request, including channel identification, alternative transcriptions, speaker * partitioning. You can use that to apply custom vocabularies and vocabulary filters.

    *

    If you want to include a custom vocabulary or a custom vocabulary filter (or both) * with your request but do not want to use automatic @@ -4891,10 +5493,11 @@ export interface StartTranscriptionJobRequest { /** * @public - *

    Makes it possible to redact or flag specified personally identifiable information - * (PII) in your transcript. If you use ContentRedaction, you must also - * include the sub-parameters: PiiEntityTypes, RedactionOutput, - * and RedactionType.

    + *

    Makes it possible to redact or flag specified personally identifiable information (PII) in + * your transcript. If you use ContentRedaction, you must also include the + * sub-parameters: RedactionOutput and RedactionType. You can + * optionally include PiiEntityTypes to choose which types of PII you want to redact. + * If you do not include PiiEntityTypes in your request, all PII is redacted.

    */ ContentRedaction?: ContentRedaction; diff --git a/clients/client-transcribe/src/pagination/ListMedicalScribeJobsPaginator.ts b/clients/client-transcribe/src/pagination/ListMedicalScribeJobsPaginator.ts new file mode 100644 index 0000000000000..039997048f596 --- /dev/null +++ b/clients/client-transcribe/src/pagination/ListMedicalScribeJobsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + ListMedicalScribeJobsCommand, + ListMedicalScribeJobsCommandInput, + ListMedicalScribeJobsCommandOutput, +} from "../commands/ListMedicalScribeJobsCommand"; +import { TranscribeClient } from "../TranscribeClient"; +import { TranscribePaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: TranscribeClient, + input: ListMedicalScribeJobsCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.send(new ListMedicalScribeJobsCommand(input), ...args); +}; +/** + * @public + */ +export async function* paginateListMedicalScribeJobs( + config: TranscribePaginationConfiguration, + input: ListMedicalScribeJobsCommandInput, + ...additionalArguments: any +): Paginator { + // ToDo: replace with actual type instead of typeof input.NextToken + let token: typeof input.NextToken | undefined = config.startingToken || undefined; + let hasNext = true; + let page: ListMedicalScribeJobsCommandOutput; + while (hasNext) { + input.NextToken = token; + input["MaxResults"] = config.pageSize; + if (config.client instanceof TranscribeClient) { + page = await makePagedClientRequest(config.client, input, ...additionalArguments); + } else { + throw new Error("Invalid client, expected Transcribe | TranscribeClient"); + } + yield page; + const prevToken = token; + token = page.NextToken; + hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken)); + } + // @ts-ignore + return undefined; +} diff --git a/clients/client-transcribe/src/pagination/index.ts b/clients/client-transcribe/src/pagination/index.ts index 9cfc9ab5ad8ce..025c0bd789f38 100644 --- a/clients/client-transcribe/src/pagination/index.ts +++ b/clients/client-transcribe/src/pagination/index.ts @@ -3,6 +3,7 @@ export * from "./Interfaces"; export * from "./ListCallAnalyticsCategoriesPaginator"; export * from "./ListCallAnalyticsJobsPaginator"; export * from "./ListLanguageModelsPaginator"; +export * from "./ListMedicalScribeJobsPaginator"; export * from "./ListMedicalTranscriptionJobsPaginator"; export * from "./ListMedicalVocabulariesPaginator"; export * from "./ListTranscriptionJobsPaginator"; diff --git a/clients/client-transcribe/src/protocols/Aws_json1_1.ts b/clients/client-transcribe/src/protocols/Aws_json1_1.ts index ec300a7c974eb..b235565a74172 100644 --- a/clients/client-transcribe/src/protocols/Aws_json1_1.ts +++ b/clients/client-transcribe/src/protocols/Aws_json1_1.ts @@ -50,6 +50,10 @@ import { DeleteLanguageModelCommandInput, DeleteLanguageModelCommandOutput, } from "../commands/DeleteLanguageModelCommand"; +import { + DeleteMedicalScribeJobCommandInput, + DeleteMedicalScribeJobCommandOutput, +} from "../commands/DeleteMedicalScribeJobCommand"; import { DeleteMedicalTranscriptionJobCommandInput, DeleteMedicalTranscriptionJobCommandOutput, @@ -79,6 +83,10 @@ import { GetCallAnalyticsJobCommandInput, GetCallAnalyticsJobCommandOutput, } from "../commands/GetCallAnalyticsJobCommand"; +import { + GetMedicalScribeJobCommandInput, + GetMedicalScribeJobCommandOutput, +} from "../commands/GetMedicalScribeJobCommand"; import { GetMedicalTranscriptionJobCommandInput, GetMedicalTranscriptionJobCommandOutput, @@ -105,6 +113,10 @@ import { ListCallAnalyticsJobsCommandOutput, } from "../commands/ListCallAnalyticsJobsCommand"; import { ListLanguageModelsCommandInput, ListLanguageModelsCommandOutput } from "../commands/ListLanguageModelsCommand"; +import { + ListMedicalScribeJobsCommandInput, + ListMedicalScribeJobsCommandOutput, +} from "../commands/ListMedicalScribeJobsCommand"; import { ListMedicalTranscriptionJobsCommandInput, ListMedicalTranscriptionJobsCommandOutput, @@ -130,6 +142,10 @@ import { StartCallAnalyticsJobCommandInput, StartCallAnalyticsJobCommandOutput, } from "../commands/StartCallAnalyticsJobCommand"; +import { + StartMedicalScribeJobCommandInput, + StartMedicalScribeJobCommandOutput, +} from "../commands/StartMedicalScribeJobCommand"; import { StartMedicalTranscriptionJobCommandInput, StartMedicalTranscriptionJobCommandOutput, @@ -175,6 +191,7 @@ import { DeleteCallAnalyticsCategoryRequest, DeleteCallAnalyticsJobRequest, DeleteLanguageModelRequest, + DeleteMedicalScribeJobRequest, DeleteMedicalTranscriptionJobRequest, DeleteMedicalVocabularyRequest, DeleteTranscriptionJobRequest, @@ -186,6 +203,8 @@ import { GetCallAnalyticsCategoryResponse, GetCallAnalyticsJobRequest, GetCallAnalyticsJobResponse, + GetMedicalScribeJobRequest, + GetMedicalScribeJobResponse, GetMedicalTranscriptionJobRequest, GetMedicalTranscriptionJobResponse, GetMedicalVocabularyRequest, @@ -211,6 +230,8 @@ import { ListCallAnalyticsJobsResponse, ListLanguageModelsRequest, ListLanguageModelsResponse, + ListMedicalScribeJobsRequest, + ListMedicalScribeJobsResponse, ListMedicalTranscriptionJobsRequest, ListMedicalTranscriptionJobsResponse, ListMedicalVocabulariesRequest, @@ -223,6 +244,10 @@ import { ListVocabularyFiltersRequest, ListVocabularyFiltersResponse, Media, + MedicalScribeChannelDefinition, + MedicalScribeJob, + MedicalScribeJobSummary, + MedicalScribeSettings, MedicalTranscriptionJob, MedicalTranscriptionJobSummary, MedicalTranscriptionSetting, @@ -237,6 +262,8 @@ import { Settings, StartCallAnalyticsJobRequest, StartCallAnalyticsJobResponse, + StartMedicalScribeJobRequest, + StartMedicalScribeJobResponse, StartMedicalTranscriptionJobRequest, StartMedicalTranscriptionJobResponse, StartTranscriptionJobRequest, @@ -369,6 +396,19 @@ export const se_DeleteLanguageModelCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1DeleteMedicalScribeJobCommand + */ +export const se_DeleteMedicalScribeJobCommand = async ( + input: DeleteMedicalScribeJobCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("DeleteMedicalScribeJob"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1DeleteMedicalTranscriptionJobCommand */ @@ -473,6 +513,19 @@ export const se_GetCallAnalyticsJobCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1GetMedicalScribeJobCommand + */ +export const se_GetMedicalScribeJobCommand = async ( + input: GetMedicalScribeJobCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("GetMedicalScribeJob"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1GetMedicalTranscriptionJobCommand */ @@ -577,6 +630,19 @@ export const se_ListLanguageModelsCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1ListMedicalScribeJobsCommand + */ +export const se_ListMedicalScribeJobsCommand = async ( + input: ListMedicalScribeJobsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ListMedicalScribeJobs"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1ListMedicalTranscriptionJobsCommand */ @@ -668,6 +734,19 @@ export const se_StartCallAnalyticsJobCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1StartMedicalScribeJobCommand + */ +export const se_StartMedicalScribeJobCommand = async ( + input: StartMedicalScribeJobCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("StartMedicalScribeJob"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1StartMedicalTranscriptionJobCommand */ @@ -1203,6 +1282,55 @@ const de_DeleteLanguageModelCommandError = async ( } }; +/** + * deserializeAws_json1_1DeleteMedicalScribeJobCommand + */ +export const de_DeleteMedicalScribeJobCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_DeleteMedicalScribeJobCommandError(output, context); + } + await collectBody(output.body, context); + const response: DeleteMedicalScribeJobCommandOutput = { + $metadata: deserializeMetadata(output), + }; + return response; +}; + +/** + * deserializeAws_json1_1DeleteMedicalScribeJobCommandError + */ +const de_DeleteMedicalScribeJobCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "BadRequestException": + case "com.amazonaws.transcribe#BadRequestException": + throw await de_BadRequestExceptionRes(parsedOutput, context); + case "InternalFailureException": + case "com.amazonaws.transcribe#InternalFailureException": + throw await de_InternalFailureExceptionRes(parsedOutput, context); + case "LimitExceededException": + case "com.amazonaws.transcribe#LimitExceededException": + throw await de_LimitExceededExceptionRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1DeleteMedicalTranscriptionJobCommand */ @@ -1622,6 +1750,61 @@ const de_GetCallAnalyticsJobCommandError = async ( } }; +/** + * deserializeAws_json1_1GetMedicalScribeJobCommand + */ +export const de_GetMedicalScribeJobCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_GetMedicalScribeJobCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_GetMedicalScribeJobResponse(data, context); + const response: GetMedicalScribeJobCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1GetMedicalScribeJobCommandError + */ +const de_GetMedicalScribeJobCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "BadRequestException": + case "com.amazonaws.transcribe#BadRequestException": + throw await de_BadRequestExceptionRes(parsedOutput, context); + case "InternalFailureException": + case "com.amazonaws.transcribe#InternalFailureException": + throw await de_InternalFailureExceptionRes(parsedOutput, context); + case "LimitExceededException": + case "com.amazonaws.transcribe#LimitExceededException": + throw await de_LimitExceededExceptionRes(parsedOutput, context); + case "NotFoundException": + case "com.amazonaws.transcribe#NotFoundException": + throw await de_NotFoundExceptionRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1GetMedicalTranscriptionJobCommand */ @@ -2053,6 +2236,58 @@ const de_ListLanguageModelsCommandError = async ( } }; +/** + * deserializeAws_json1_1ListMedicalScribeJobsCommand + */ +export const de_ListMedicalScribeJobsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_ListMedicalScribeJobsCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_ListMedicalScribeJobsResponse(data, context); + const response: ListMedicalScribeJobsCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1ListMedicalScribeJobsCommandError + */ +const de_ListMedicalScribeJobsCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "BadRequestException": + case "com.amazonaws.transcribe#BadRequestException": + throw await de_BadRequestExceptionRes(parsedOutput, context); + case "InternalFailureException": + case "com.amazonaws.transcribe#InternalFailureException": + throw await de_InternalFailureExceptionRes(parsedOutput, context); + case "LimitExceededException": + case "com.amazonaws.transcribe#LimitExceededException": + throw await de_LimitExceededExceptionRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1ListMedicalTranscriptionJobsCommand */ @@ -2423,6 +2658,61 @@ const de_StartCallAnalyticsJobCommandError = async ( } }; +/** + * deserializeAws_json1_1StartMedicalScribeJobCommand + */ +export const de_StartMedicalScribeJobCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_StartMedicalScribeJobCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_StartMedicalScribeJobResponse(data, context); + const response: StartMedicalScribeJobCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1StartMedicalScribeJobCommandError + */ +const de_StartMedicalScribeJobCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "BadRequestException": + case "com.amazonaws.transcribe#BadRequestException": + throw await de_BadRequestExceptionRes(parsedOutput, context); + case "ConflictException": + case "com.amazonaws.transcribe#ConflictException": + throw await de_ConflictExceptionRes(parsedOutput, context); + case "InternalFailureException": + case "com.amazonaws.transcribe#InternalFailureException": + throw await de_InternalFailureExceptionRes(parsedOutput, context); + case "LimitExceededException": + case "com.amazonaws.transcribe#LimitExceededException": + throw await de_LimitExceededExceptionRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1StartMedicalTranscriptionJobCommand */ @@ -2975,6 +3265,8 @@ const de_NotFoundExceptionRes = async (parsedOutput: any, context: __SerdeContex // se_DeleteLanguageModelRequest omitted. +// se_DeleteMedicalScribeJobRequest omitted. + // se_DeleteMedicalTranscriptionJobRequest omitted. // se_DeleteMedicalVocabularyRequest omitted. @@ -2991,6 +3283,8 @@ const de_NotFoundExceptionRes = async (parsedOutput: any, context: __SerdeContex // se_GetCallAnalyticsJobRequest omitted. +// se_GetMedicalScribeJobRequest omitted. + // se_GetMedicalTranscriptionJobRequest omitted. // se_GetMedicalVocabularyRequest omitted. @@ -3021,6 +3315,8 @@ const de_NotFoundExceptionRes = async (parsedOutput: any, context: __SerdeContex // se_ListLanguageModelsRequest omitted. +// se_ListMedicalScribeJobsRequest omitted. + // se_ListMedicalTranscriptionJobsRequest omitted. // se_ListMedicalVocabulariesRequest omitted. @@ -3035,6 +3331,12 @@ const de_NotFoundExceptionRes = async (parsedOutput: any, context: __SerdeContex // se_Media omitted. +// se_MedicalScribeChannelDefinition omitted. + +// se_MedicalScribeChannelDefinitions omitted. + +// se_MedicalScribeSettings omitted. + // se_MedicalTranscriptionSetting omitted. // se_ModelSettings omitted. @@ -3059,6 +3361,8 @@ const de_NotFoundExceptionRes = async (parsedOutput: any, context: __SerdeContex // se_StartCallAnalyticsJobRequest omitted. +// se_StartMedicalScribeJobRequest omitted. + // se_StartMedicalTranscriptionJobRequest omitted. // se_StartTranscriptionJobRequest omitted. @@ -3273,6 +3577,15 @@ const de_GetCallAnalyticsJobResponse = (output: any, context: __SerdeContext): G }) as any; }; +/** + * deserializeAws_json1_1GetMedicalScribeJobResponse + */ +const de_GetMedicalScribeJobResponse = (output: any, context: __SerdeContext): GetMedicalScribeJobResponse => { + return take(output, { + MedicalScribeJob: (_: any) => de_MedicalScribeJob(_, context), + }) as any; +}; + /** * deserializeAws_json1_1GetMedicalTranscriptionJobResponse */ @@ -3423,6 +3736,17 @@ const de_ListLanguageModelsResponse = (output: any, context: __SerdeContext): Li }) as any; }; +/** + * deserializeAws_json1_1ListMedicalScribeJobsResponse + */ +const de_ListMedicalScribeJobsResponse = (output: any, context: __SerdeContext): ListMedicalScribeJobsResponse => { + return take(output, { + MedicalScribeJobSummaries: (_: any) => de_MedicalScribeJobSummaries(_, context), + NextToken: __expectString, + Status: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1ListMedicalTranscriptionJobsResponse */ @@ -3484,6 +3808,62 @@ const de_ListVocabularyFiltersResponse = (output: any, context: __SerdeContext): // de_Media omitted. +// de_MedicalScribeChannelDefinition omitted. + +// de_MedicalScribeChannelDefinitions omitted. + +/** + * deserializeAws_json1_1MedicalScribeJob + */ +const de_MedicalScribeJob = (output: any, context: __SerdeContext): MedicalScribeJob => { + return take(output, { + ChannelDefinitions: _json, + CompletionTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + CreationTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + DataAccessRoleArn: __expectString, + FailureReason: __expectString, + LanguageCode: __expectString, + Media: _json, + MedicalScribeJobName: __expectString, + MedicalScribeJobStatus: __expectString, + MedicalScribeOutput: _json, + Settings: _json, + StartTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + Tags: _json, + }) as any; +}; + +/** + * deserializeAws_json1_1MedicalScribeJobSummaries + */ +const de_MedicalScribeJobSummaries = (output: any, context: __SerdeContext): MedicalScribeJobSummary[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_MedicalScribeJobSummary(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_json1_1MedicalScribeJobSummary + */ +const de_MedicalScribeJobSummary = (output: any, context: __SerdeContext): MedicalScribeJobSummary => { + return take(output, { + CompletionTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + CreationTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + FailureReason: __expectString, + LanguageCode: __expectString, + MedicalScribeJobName: __expectString, + MedicalScribeJobStatus: __expectString, + StartTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + }) as any; +}; + +// de_MedicalScribeOutput omitted. + +// de_MedicalScribeSettings omitted. + // de_MedicalTranscript omitted. /** @@ -3587,6 +3967,15 @@ const de_StartCallAnalyticsJobResponse = (output: any, context: __SerdeContext): }) as any; }; +/** + * deserializeAws_json1_1StartMedicalScribeJobResponse + */ +const de_StartMedicalScribeJobResponse = (output: any, context: __SerdeContext): StartMedicalScribeJobResponse => { + return take(output, { + MedicalScribeJob: (_: any) => de_MedicalScribeJob(_, context), + }) as any; +}; + /** * deserializeAws_json1_1StartMedicalTranscriptionJobResponse */ diff --git a/codegen/sdk-codegen/aws-models/transcribe.json b/codegen/sdk-codegen/aws-models/transcribe.json index 7e2dbfbcfb733..7f7bdbdb142c5 100644 --- a/codegen/sdk-codegen/aws-models/transcribe.json +++ b/codegen/sdk-codegen/aws-models/transcribe.json @@ -159,7 +159,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    The language code used to create your Call Analytics job. For a list of supported\n languages and their associated language codes, refer to the Supported languages\n table.

    \n

    If you don't know the language spoken in your media file, you can omit this field and\n let Amazon Transcribe automatically identify the language of your media. To improve the\n accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

    " + "smithy.api#documentation": "

    The language code used to create your Call Analytics job. For a list of supported\n languages and their associated language codes, refer to the Supported languages\n table.

    \n

    If you do not know the language spoken in your media file, you can omit this field and\n let Amazon Transcribe automatically identify the language of your media. To improve the\n accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

    " } }, "MediaSampleRateHertz": { @@ -204,7 +204,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

    If CallAnalyticsJobStatus is FAILED,\n FailureReason contains information about why the Call Analytics job\n request failed.

    \n

    The FailureReason field contains one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format.

      \n

      The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format.

      \n

      The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file.

      \n

      The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample\n rate.

      \n

      The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large.

      \n

      The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large.

      \n

      Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.

      \n
      • \n
    " + "smithy.api#documentation": "

    If CallAnalyticsJobStatus is FAILED,\n FailureReason contains information about why the Call Analytics job\n request failed.

    \n

    The FailureReason field contains one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format.

      \n

      The media format specified in MediaFormat isn't valid. Refer to\n refer to the MediaFormat parameter for a list of supported\n formats.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format.

      \n

      The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file.

      \n

      The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample\n rate.

      \n

      The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large.

      \n

      The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Service \n quotas.

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large.

      \n

      Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Service \n quotas.

      \n
      • \n
    " } }, "DataAccessRoleArn": { @@ -270,7 +270,7 @@ "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

    The name of the custom language model you want to use when processing your Call\n Analytics job. Note that custom language model names are case sensitive.

    \n

    The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

    " + "smithy.api#documentation": "

    The name of the custom language model you want to use when processing your Call\n Analytics job. Note that custom language model names are case sensitive.

    \n

    The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages do not match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

    " } }, "ContentRedaction": { @@ -500,7 +500,7 @@ "RedactionType": { "target": "com.amazonaws.transcribe#RedactionType", "traits": { - "smithy.api#documentation": "

    Specify the category of information you want to redact; PII (personally\n identifiable information) is the only valid value. You can use\n PiiEntityTypes to choose which types of PII you want to redact.

    ", + "smithy.api#documentation": "

    Specify the category of information you want to redact; PII (personally\n identifiable information) is the only valid value. You can use PiiEntityTypes to \n choose which types of PII you want to redact. If you do not include PiiEntityTypes in \n your request, all PII is redacted.

    ", "smithy.api#required": {} } }, @@ -514,12 +514,12 @@ "PiiEntityTypes": { "target": "com.amazonaws.transcribe#PiiEntityTypes", "traits": { - "smithy.api#documentation": "

    Specify which types of personally identifiable information (PII) you want to redact in\n your transcript. You can include as many types as you'd like, or you can select\n ALL.

    " + "smithy.api#documentation": "

    Specify which types of personally identifiable information (PII) you want to redact in\n your transcript. You can include as many types as you'd like, or you can select\n ALL. If you do not include PiiEntityTypes in your request, all PII is \n redacted.

    " } } }, "traits": { - "smithy.api#documentation": "

    Makes it possible to redact or flag specified personally identifiable information\n (PII) in your transcript. If you use ContentRedaction, you must also\n include the sub-parameters: PiiEntityTypes, RedactionOutput,\n and RedactionType.

    " + "smithy.api#documentation": "

    Makes it possible to redact or flag specified personally identifiable information (PII) in \n your transcript. If you use ContentRedaction, you must also include the \n sub-parameters: RedactionOutput and RedactionType. You can \n optionally include PiiEntityTypes to choose which types of PII you want to \n redact.

    " } }, "com.amazonaws.transcribe#CreateCallAnalyticsCategory": { @@ -633,7 +633,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

    The language code that represents the language of your model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

    \n

    For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that\n US English\n (en-US) is the only language supported with Amazon Transcribe\n Medical.

    \n

    A custom language model can only be used to transcribe files in the same language as\n the model. For example, if you create a custom language model using US English\n (en-US), you can only apply this model to files that contain English\n audio.

    ", + "smithy.api#documentation": "

    The language code that represents the language of your model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

    \n

    For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that US English (en-US) is the \n only language supported with Amazon Transcribe Medical.

    \n

    A custom language model can only be used to transcribe files in the same language as\n the model. For example, if you create a custom language model using US English\n (en-US), you can only apply this model to files that contain English\n audio.

    ", "smithy.api#required": {} } }, @@ -1195,6 +1195,50 @@ "smithy.api#input": {} } }, + "com.amazonaws.transcribe#DeleteMedicalScribeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#DeleteMedicalScribeJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a Medical Scribe job. To use this operation, specify the name of the\n job you want to delete using MedicalScribeJobName. Job names are\n case sensitive.

    ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/medicalscribejobs/{MedicalScribeJobName}", + "code": 204 + } + } + }, + "com.amazonaws.transcribe#DeleteMedicalScribeJobRequest": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    The name of the Medical Scribe job you want to delete. Job names are case\n sensitive.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.transcribe#DeleteMedicalTranscriptionJob": { "type": "operation", "input": { @@ -1613,6 +1657,67 @@ "smithy.api#output": {} } }, + "com.amazonaws.transcribe#GetMedicalScribeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#GetMedicalScribeJobRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#GetMedicalScribeJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Provides information about the specified Medical Scribe job.

    \n

    To view the status of the specified medical transcription job, check the\n MedicalScribeJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n MedicalScribeOutput. \n If the status is FAILED, FailureReason provides details on why your Medical Scribe job\n failed.

    \n

    To get a list of your Medical Scribe jobs, use the operation.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/medicalscribejobs/{MedicalScribeJobName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#GetMedicalScribeJobRequest": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    The name of the Medical Scribe job you want information about. Job names are\n case sensitive.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transcribe#GetMedicalScribeJobResponse": { + "type": "structure", + "members": { + "MedicalScribeJob": { + "target": "com.amazonaws.transcribe#MedicalScribeJob", + "traits": { + "smithy.api#documentation": "

    Provides detailed information about the specified Medical Scribe job, including \n job status and, if applicable, failure reason

    " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.transcribe#GetMedicalTranscriptionJob": { "type": "operation", "input": { @@ -1757,7 +1862,7 @@ "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

    The S3 location where the specified custom medical vocabulary is stored; use this URI\n to view or download the custom vocabulary.

    " + "smithy.api#documentation": "

    The Amazon S3 location where the specified custom medical vocabulary is stored; use this URI\n to view or download the custom vocabulary.

    " } } }, @@ -1988,7 +2093,7 @@ "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

    The S3 location where the custom vocabulary is stored; use this URI to view or\n download the custom vocabulary.

    " + "smithy.api#documentation": "

    The Amazon S3 location where the custom vocabulary is stored; use this URI to view or\n download the custom vocabulary.

    " } } }, @@ -2795,19 +2900,19 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The name of the custom vocabulary you want to use when processing your transcription\n job. Custom vocabulary names are case sensitive.

    \n

    The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch.

    " + "smithy.api#documentation": "

    The name of the custom vocabulary you want to use when processing your transcription\n job. Custom vocabulary names are case sensitive.

    \n

    The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages do not match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch.

    " } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

    The name of the custom vocabulary filter you want to use when processing your\n transcription job. Custom vocabulary filter names are case sensitive.

    \n

    The language of the specified custom vocabulary filter must match the language code\n that you specify in your transcription request. If the languages don't match, the custom\n vocabulary filter isn't applied. There are no errors or warnings associated with a\n language mismatch.

    \n

    Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

    " + "smithy.api#documentation": "

    The name of the custom vocabulary filter you want to use when processing your\n transcription job. Custom vocabulary filter names are case sensitive.

    \n

    The language of the specified custom vocabulary filter must match the language code\n that you specify in your transcription request. If the languages do not match, the custom\n vocabulary filter isn't applied. There are no errors or warnings associated with a\n language mismatch.

    \n

    Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

    " } }, "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

    The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

    \n

    The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

    " + "smithy.api#documentation": "

    The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

    \n

    The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages do not match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

    " } } }, @@ -2854,7 +2959,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

    The language code used to create your custom language model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

    \n

    For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that U.S. English (en-US) is\n the only language supported with Amazon Transcribe Medical.

    " + "smithy.api#documentation": "

    The language code used to create your custom language model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

    \n

    For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that US English (en-US) is\n the only language supported with Amazon Transcribe Medical.

    " } }, "BaseModelName": { @@ -2962,7 +3067,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of Call Analytics categories to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

    ", + "smithy.api#documentation": "

    The maximum number of Call Analytics categories to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

    ", "smithy.api#httpQuery": "MaxResults" } } @@ -3030,7 +3135,7 @@ "Status": { "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", "traits": { - "smithy.api#documentation": "

    Returns only Call Analytics jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you don't include Status, all\n Call Analytics jobs are returned.

    ", + "smithy.api#documentation": "

    Returns only Call Analytics jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you do not include Status, all\n Call Analytics jobs are returned.

    ", "smithy.api#httpQuery": "Status" } }, @@ -3051,7 +3156,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of Call Analytics jobs to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you don't specify a value, a default of 5 is used.

    ", + "smithy.api#documentation": "

    The maximum number of Call Analytics jobs to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you do not specify a value, a default of 5 is used.

    ", "smithy.api#httpQuery": "MaxResults" } } @@ -3125,7 +3230,7 @@ "StatusEquals": { "target": "com.amazonaws.transcribe#ModelStatus", "traits": { - "smithy.api#documentation": "

    Returns only custom language models with the specified status. Language models are\n ordered by creation date, with the newest model first. If you don't include\n StatusEquals, all custom language models are returned.

    ", + "smithy.api#documentation": "

    Returns only custom language models with the specified status. Language models are\n ordered by creation date, with the newest model first. If you do not include\n StatusEquals, all custom language models are returned.

    ", "smithy.api#httpQuery": " StatusEquals" } }, @@ -3146,7 +3251,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of custom language models to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

    ", + "smithy.api#documentation": "

    The maximum number of custom language models to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

    ", "smithy.api#httpQuery": "MaxResults" } } @@ -3175,6 +3280,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.transcribe#ListMedicalScribeJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#ListMedicalScribeJobsRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#ListMedicalScribeJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Provides a list of Medical Scribe jobs that match the specified criteria. If no\n criteria are specified, all Medical Scribe jobs are returned.

    \n

    To get detailed information about a specific Medical Scribe job, use the operation.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/medicalscribejobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.transcribe#ListMedicalScribeJobsRequest": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.transcribe#MedicalScribeJobStatus", + "traits": { + "smithy.api#documentation": "

    Returns only Medical Scribe jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you do not include Status, all\n Medical Scribe jobs are returned.

    ", + "smithy.api#httpQuery": "Status" + } + }, + "JobNameContains": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    Returns only the Medical Scribe jobs that contain the specified string. The\n search is not case sensitive.

    ", + "smithy.api#httpQuery": "JobNameContains" + } + }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

    If your ListMedicalScribeJobs request returns more results than\n can be displayed, NextToken is displayed in the response with an associated\n string. To get the next page of results, copy this string and repeat your request,\n including NextToken with the value of the copied string. Repeat as needed\n to view all your results.

    ", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.transcribe#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of Medical Scribe jobs to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

    ", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transcribe#ListMedicalScribeJobsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.transcribe#MedicalScribeJobStatus", + "traits": { + "smithy.api#documentation": "

    Lists all Medical Scribe jobs that have the status specified in your request.\n Jobs are ordered by creation date, with the newest job first.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

    If NextToken is present in your response, it indicates that not all\n results are displayed. To view the next set of results, copy the string associated with\n the NextToken parameter in your results output, then run your request again\n including NextToken with the value of the copied string. Repeat as needed\n to view all your results.

    " + } + }, + "MedicalScribeJobSummaries": { + "target": "com.amazonaws.transcribe#MedicalScribeJobSummaries", + "traits": { + "smithy.api#documentation": "

    Provides a summary of information about each result.

    " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.transcribe#ListMedicalTranscriptionJobs": { "type": "operation", "input": { @@ -3214,7 +3414,7 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

    Returns only medical transcription jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you don't include Status, all\n medical transcription jobs are returned.

    ", + "smithy.api#documentation": "

    Returns only medical transcription jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you do not include Status, all\n medical transcription jobs are returned.

    ", "smithy.api#httpQuery": "Status" } }, @@ -3235,7 +3435,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of medical transcription jobs to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

    ", + "smithy.api#documentation": "

    The maximum number of medical transcription jobs to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

    ", "smithy.api#httpQuery": "MaxResults" } } @@ -3316,14 +3516,14 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of custom medical vocabularies to return in each page of results.\n If there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

    ", + "smithy.api#documentation": "

    The maximum number of custom medical vocabularies to return in each page of results.\n If there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

    ", "smithy.api#httpQuery": "MaxResults" } }, "StateEquals": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

    Returns only custom medical vocabularies with the specified state. Custom vocabularies\n are ordered by creation date, with the newest vocabulary first. If you don't include\n StateEquals, all custom medical vocabularies are returned.

    ", + "smithy.api#documentation": "

    Returns only custom medical vocabularies with the specified state. Custom vocabularies\n are ordered by creation date, with the newest vocabulary first. If you do not include\n StateEquals, all custom medical vocabularies are returned.

    ", "smithy.api#httpQuery": "StateEquals" } }, @@ -3471,7 +3671,7 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

    Returns only transcription jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you don't include Status, all\n transcription jobs are returned.

    ", + "smithy.api#documentation": "

    Returns only transcription jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you do not include Status, all\n transcription jobs are returned.

    ", "smithy.api#httpQuery": "Status" } }, @@ -3492,7 +3692,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of transcription jobs to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you don't specify a value, a default of 5 is used.

    ", + "smithy.api#documentation": "

    The maximum number of transcription jobs to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you do not specify a value, a default of 5 is used.

    ", "smithy.api#httpQuery": "MaxResults" } } @@ -3573,14 +3773,14 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of custom vocabularies to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you don't specify a value, a default of 5 is used.

    ", + "smithy.api#documentation": "

    The maximum number of custom vocabularies to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you do not specify a value, a default of 5 is used.

    ", "smithy.api#httpQuery": "MaxResults" } }, "StateEquals": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

    Returns only custom vocabularies with the specified state. Vocabularies are ordered by\n creation date, with the newest vocabulary first. If you don't include\n StateEquals, all custom medical vocabularies are returned.

    ", + "smithy.api#documentation": "

    Returns only custom vocabularies with the specified state. Vocabularies are ordered by\n creation date, with the newest vocabulary first. If you do not include\n StateEquals, all custom medical vocabularies are returned.

    ", "smithy.api#httpQuery": "StateEquals" } }, @@ -3668,7 +3868,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of custom vocabulary filters to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

    ", + "smithy.api#documentation": "

    The maximum number of custom vocabulary filters to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

    ", "smithy.api#httpQuery": "MaxResults" } }, @@ -3748,7 +3948,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Describes the Amazon S3 location of the media file you want to use in your\n request.

    \n

    For information on supported media formats, refer to the MediaFormat parameter or the Media formats section \n in the Amazon S3 Developer Guide.

    " + "smithy.api#documentation": "

    Describes the Amazon S3 location of the media file you want to use in your\n request.

    \n

    For information on supported media formats, refer to the MediaFormat \n parameter or the Media formats section \n in the Amazon S3 Developer Guide.

    " } }, "com.amazonaws.transcribe#MediaFormat": { @@ -3833,6 +4033,313 @@ } } }, + "com.amazonaws.transcribe#MedicalScribeChannelDefinition": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.transcribe#MedicalScribeChannelId", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    Specify the audio channel you want to define.

    ", + "smithy.api#required": {} + } + }, + "ParticipantRole": { + "target": "com.amazonaws.transcribe#MedicalScribeParticipantRole", + "traits": { + "smithy.api#documentation": "

    Specify the participant that you want to flag. \n The options are CLINICIAN and PATIENT\n

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Indicates which speaker is on which channel. The options are \n CLINICIAN and PATIENT\n

    " + } + }, + "com.amazonaws.transcribe#MedicalScribeChannelDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#MedicalScribeChannelDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.transcribe#MedicalScribeChannelId": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.transcribe#MedicalScribeJob": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    The name of the Medical Scribe job. Job names are case sensitive and must be\n unique within an Amazon Web Services account.

    " + } + }, + "MedicalScribeJobStatus": { + "target": "com.amazonaws.transcribe#MedicalScribeJobStatus", + "traits": { + "smithy.api#documentation": "

    Provides the status of the specified Medical Scribe job.

    \n

    If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in MedicalScribeOutput If\n the status is FAILED, FailureReason provides details on why\n your Medical Scribe job failed.

    " + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribe#MedicalScribeLanguageCode", + "traits": { + "smithy.api#documentation": "

    The language code used to create your Medical Scribe job. US English\n (en-US) is the only supported language for Medical Scribe jobs.

    " + } + }, + "Media": { + "target": "com.amazonaws.transcribe#Media" + }, + "MedicalScribeOutput": { + "target": "com.amazonaws.transcribe#MedicalScribeOutput", + "traits": { + "smithy.api#documentation": "

    The location of the output of your Medical Scribe job. \n ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document \n and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

    " + } + }, + "StartTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    The date and time your Medical Scribe job began processing.

    \n

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    The date and time the specified Medical Scribe job request was made.

    \n

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

    " + } + }, + "CompletionTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    The date and time the specified Medical Scribe job finished processing.

    \n

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job\n that finished processing at 12:32 PM UTC-7 on May 4, 2022.

    " + } + }, + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", + "traits": { + "smithy.api#documentation": "

    If MedicalScribeJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n failed. See also: Common Errors.

    " + } + }, + "Settings": { + "target": "com.amazonaws.transcribe#MedicalScribeSettings", + "traits": { + "smithy.api#documentation": "

    Makes it possible to control how your Medical Scribe job is processed using a\n MedicalScribeSettings object. Specify ChannelIdentification if \n ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification \n and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels\n must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings\n to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. \n VocabularyFilterMethod must be specified if VocabularyFilterName is set.\n

    " + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.transcribe#DataAccessRoleArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files, \n write to the output bucket, and use your KMS key if supplied. \n If the role that you specify doesn’t have the appropriate permissions your request fails.

    \n

    IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

    \n

    For more information, see IAM\n ARNs.

    " + } + }, + "ChannelDefinitions": { + "target": "com.amazonaws.transcribe#MedicalScribeChannelDefinitions", + "traits": { + "smithy.api#documentation": "

    Makes it possible to specify which speaker is on which channel. For example, if the clinician\n is the first participant to speak, you would set ChannelId of the first ChannelDefinition \n in the list to 0 (to indicate the first channel) and ParticipantRole to\n CLINICIAN (to indicate that it's the clinician speaking).\n Then you would set the ChannelId of the second ChannelDefinition in the list to\n 1 (to indicate the second channel) and ParticipantRole to\n PATIENT (to indicate that it's the patient speaking).\n

    " + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

    Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

    \n

    To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides detailed information about a Medical Scribe job.

    \n

    To view the status of the specified Medical Scribe job, check the\n MedicalScribeJobStatus field. If the status is COMPLETED,\n the job is finished and you can find the results at the locations specified in\n MedicalScribeOutput. If the status is FAILED,\n FailureReason provides details on why your Medical Scribe job\n failed.

    " + } + }, + "com.amazonaws.transcribe#MedicalScribeJobStatus": { + "type": "enum", + "members": { + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, + "com.amazonaws.transcribe#MedicalScribeJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#MedicalScribeJobSummary" + } + }, + "com.amazonaws.transcribe#MedicalScribeJobSummary": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    The name of the Medical Scribe job. Job names are case sensitive and must be\n unique within an Amazon Web Services account.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    The date and time the specified Medical Scribe job request was made.

    \n

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

    " + } + }, + "StartTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    The date and time your Medical Scribe job began processing.

    \n

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

    " + } + }, + "CompletionTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    The date and time the specified Medical Scribe job finished processing.

    \n

    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job\n that finished processing at 12:32 PM UTC-7 on May 4, 2022.

    " + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribe#MedicalScribeLanguageCode", + "traits": { + "smithy.api#documentation": "

    The language code used to create your Medical Scribe job. US English\n (en-US) is the only supported language for Medical Scribe jobs.

    " + } + }, + "MedicalScribeJobStatus": { + "target": "com.amazonaws.transcribe#MedicalScribeJobStatus", + "traits": { + "smithy.api#documentation": "

    Provides the status of the specified Medical Scribe job.

    \n

    If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in MedicalScribeOutput If\n the status is FAILED, FailureReason provides details on why\n your Medical Scribe job failed.

    " + } + }, + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", + "traits": { + "smithy.api#documentation": "

    If MedicalScribeJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n failed. See also: Common Errors.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides detailed information about a specific Medical Scribe job.

    " + } + }, + "com.amazonaws.transcribe#MedicalScribeLanguageCode": { + "type": "enum", + "members": { + "EN_US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-US" + } + } + } + }, + "com.amazonaws.transcribe#MedicalScribeOutput": { + "type": "structure", + "members": { + "TranscriptFileUri": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

    Holds the Amazon S3 URI for the Transcript.

    ", + "smithy.api#required": {} + } + }, + "ClinicalDocumentUri": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

    Holds the Amazon S3 URI for the Clinical Document.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    The location of the output of your Medical Scribe job. \n ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document \n and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

    " + } + }, + "com.amazonaws.transcribe#MedicalScribeParticipantRole": { + "type": "enum", + "members": { + "PATIENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATIENT" + } + }, + "CLINICIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLINICIAN" + } + } + } + }, + "com.amazonaws.transcribe#MedicalScribeSettings": { + "type": "structure", + "members": { + "ShowSpeakerLabels": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

    Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker\n partitioning labels the speech from individual speakers in your media file.

    \n

    If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

    \n

    For more information, see Partitioning speakers\n (diarization).

    " + } + }, + "MaxSpeakerLabels": { + "target": "com.amazonaws.transcribe#MaxSpeakers", + "traits": { + "smithy.api#documentation": "

    Specify the maximum number of speakers you want to partition in your media.

    \n

    Note that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.

    \n

    If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

    " + } + }, + "ChannelIdentification": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

    Enables channel identification in multi-channel audio.

    \n

    Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

    \n

    For more information, see Transcribing multi-channel\n audio.

    " + } + }, + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", + "traits": { + "smithy.api#documentation": "

    The name of the custom vocabulary you want to include in your Medical Scribe\n request. Custom vocabulary names are case sensitive.

    " + } + }, + "VocabularyFilterName": { + "target": "com.amazonaws.transcribe#VocabularyFilterName", + "traits": { + "smithy.api#documentation": "

    The name of the custom vocabulary filter you want to include in your Medical Scribe\n request. Custom vocabulary filter names are case sensitive.

    \n

    Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

    " + } + }, + "VocabularyFilterMethod": { + "target": "com.amazonaws.transcribe#VocabularyFilterMethod", + "traits": { + "smithy.api#documentation": "

    Specify how you want your custom vocabulary filter applied to your transcript.

    \n

    To replace words with ***, choose mask.

    \n

    To delete words, choose remove.

    \n

    To flag words without changing them, choose tag.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Makes it possible to control how your Medical Scribe job is processed using a\n MedicalScribeSettings object. Specify ChannelIdentification if \n ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification \n and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels\n must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings\n to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. \n VocabularyFilterMethod must be specified if VocabularyFilterName is set.\n

    " + } + }, "com.amazonaws.transcribe#MedicalTranscript": { "type": "structure", "members": { @@ -3910,7 +4417,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

    If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

    \n

    The FailureReason field contains one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format.

      \n

      The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format.

      \n

      The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file.

      \n

      The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 16,000 and 48,000 hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample\n rate.

      \n

      The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large.

      \n

      The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large.

      \n

      Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.

      \n
      • \n
    " + "smithy.api#documentation": "

    If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

    \n

    The FailureReason field contains one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format.

      \n

      The media format specified in MediaFormat isn't valid. Refer to\n refer to the MediaFormat parameter for a list of supported\n formats.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format.

      \n

      The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file.

      \n

      The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 16,000 and 48,000 hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample\n rate.

      \n

      The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large.

      \n

      The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Service \n quotas.

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large.

      \n

      Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Service \n quotas.

      \n
      • \n
    " } }, "Settings": { @@ -4034,7 +4541,7 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

    Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

    \n

    If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

    \n

    You can't include ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

    \n

    For more information, see Partitioning speakers\n (diarization).

    " + "smithy.api#documentation": "

    Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

    \n

    If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

    \n

    For more information, see Partitioning speakers\n (diarization).

    " } }, "MaxSpeakerLabels": { @@ -4046,7 +4553,7 @@ "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

    Enables channel identification in multi-channel audio.

    \n

    Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

    \n

    If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.

    \n

    You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

    \n

    For more information, see Transcribing multi-channel\n audio.

    " + "smithy.api#documentation": "

    Enables channel identification in multi-channel audio.

    \n

    Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

    \n

    If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.

    \n

    For more information, see Transcribing multi-channel\n audio.

    " } }, "ShowAlternatives": { @@ -4064,7 +4571,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The name of the custom vocabulary you want to use when processing your medical\n transcription job. Custom vocabulary names are case sensitive.

    \n

    The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

    " + "smithy.api#documentation": "

    The name of the custom vocabulary you want to use when processing your medical\n transcription job. Custom vocabulary names are case sensitive.

    \n

    The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages do not match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

    " } } }, @@ -4088,7 +4595,7 @@ "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

    The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

    \n

    The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

    " + "smithy.api#documentation": "

    The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

    \n

    The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages do not match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

    " } } }, @@ -4554,7 +5061,7 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

    Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

    \n

    If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

    \n

    You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

    \n

    For more information, see Partitioning speakers\n (diarization).

    " + "smithy.api#documentation": "

    Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

    \n

    If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

    \n

    For more information, see Partitioning speakers\n (diarization).

    " } }, "MaxSpeakerLabels": { @@ -4566,7 +5073,7 @@ "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

    Enables channel identification in multi-channel audio.

    \n

    Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

    \n

    You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

    \n

    For more information, see Transcribing multi-channel\n audio.

    " + "smithy.api#documentation": "

    Enables channel identification in multi-channel audio.

    \n

    Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

    \n

    For more information, see Transcribing multi-channel\n audio.

    " } }, "ShowAlternatives": { @@ -4595,7 +5102,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker\n partitioning. You can use that to apply custom vocabularies to your transcription\n job.

    " + "smithy.api#documentation": "

    Allows additional optional settings in your \n request, including channel identification, alternative transcriptions, and speaker\n partitioning. You can use that to apply custom vocabularies to your transcription\n job.

    " } }, "com.amazonaws.transcribe#Specialty": { @@ -4661,13 +5168,13 @@ "OutputLocation": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

    The Amazon S3 location where you want your Call Analytics transcription output\n stored. You can use any of the following formats to specify the output location:

    \n
      \n
    1. \n

      s3://DOC-EXAMPLE-BUCKET

      \n
      2. \n
    2. \n

      s3://DOC-EXAMPLE-BUCKET/my-output-folder/

      \n
      3. \n
    3. \n

      s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

      \n
      4. \n
    \n

    Unless you specify a file name (option 3), the name of your output file has a default\n value that matches the name you specified for your transcription job using the\n CallAnalyticsJobName parameter.

    \n

    You can specify a KMS key to encrypt your output using the\n OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for\n server-side encryption.

    \n

    If you don't specify OutputLocation, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

    " + "smithy.api#documentation": "

    The Amazon S3 location where you want your Call Analytics transcription output\n stored. You can use any of the following formats to specify the output location:

    \n
      \n
    1. \n

      s3://DOC-EXAMPLE-BUCKET

      \n
      2. \n
    2. \n

      s3://DOC-EXAMPLE-BUCKET/my-output-folder/

      \n
      3. \n
    3. \n

      s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

      \n
      4. \n
    \n

    Unless you specify a file name (option 3), the name of your output file has a default\n value that matches the name you specified for your transcription job using the\n CallAnalyticsJobName parameter.

    \n

    You can specify a KMS key to encrypt your output using the\n OutputEncryptionKMSKeyId parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for\n server-side encryption.

    \n

    If you do not specify OutputLocation, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

    " } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

    The KMS key you want to use to encrypt your Call Analytics\n output.

    \n

    If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

    \n
      \n
    1. \n

      Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

      \n
      3. \n
    3. \n

      Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      4. \n
    4. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      5. \n
    \n

    If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

    \n
      \n
    1. \n

      Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      3. \n
    \n

    If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

    \n

    Note that the role making the request must\n have permission to use the specified KMS key.

    " + "smithy.api#documentation": "

    The KMS key you want to use to encrypt your Call Analytics\n output.

    \n

    If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

    \n
      \n
    1. \n

      Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

      \n
      3. \n
    3. \n

      Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      4. \n
    4. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      5. \n
    \n

    If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

    \n
      \n
    1. \n

      Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      3. \n
    \n

    If you do not specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

    \n

    Note that the role making the request must\n have permission to use the specified KMS key.

    " } }, "DataAccessRoleArn": { @@ -4707,6 +5214,118 @@ "smithy.api#output": {} } }, + "com.amazonaws.transcribe#StartMedicalScribeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#StartMedicalScribeJobRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#StartMedicalScribeJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#ConflictException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Transcribes patient-clinician conversations and generates clinical notes.

    \n

    Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, \n classifies dialogues, extracts medical terms, and generates preliminary clinical notes.\n To learn more about these features, refer to Amazon Web Services HealthScribe.

    \n

    To make a StartMedicalScribeJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location\n of the file using the Media parameter.

    \n

    You must include the following parameters in your\n StartMedicalTranscriptionJob request:

    \n
      \n
    • \n

      \n DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media,\n write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set).\n The role should also allow transcribe.amazonaws.com to assume it.\n

      \n
      • \n
    • \n

      \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

      \n
      • \n
    • \n

      \n MedicalScribeJobName: A custom name you create for your\n MedicalScribe job that is unique within your Amazon Web Services account.

      \n
      • \n
    • \n

      \n OutputBucketName: The Amazon S3 bucket where you want\n your output files stored.

      \n
      • \n
    • \n

      \n Settings: A MedicalScribeSettings obect \n that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true.\n If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set.\n

      \n
      • \n
    • \n

      \n ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification\n value of Settings is set to true. \n

      \n
      • \n
    ", + "smithy.api#http": { + "method": "PUT", + "uri": "/medicalscribejobs/{MedicalScribeJobName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#StartMedicalScribeJobRequest": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    A unique name, chosen by you, for your Medical Scribe job.

    \n

    This name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new job with the same name as an\n existing job, you get a ConflictException error.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Media": { + "target": "com.amazonaws.transcribe#Media", + "traits": { + "smithy.api#required": {} + } + }, + "OutputBucketName": { + "target": "com.amazonaws.transcribe#OutputBucketName", + "traits": { + "smithy.api#documentation": "

    The name of the Amazon S3 bucket where you want your Medical Scribe\n output stored. Do not include the S3:// prefix of the specified\n bucket.

    \n

    Note that the role specified in the DataAccessRoleArn request parameter \n must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

    ", + "smithy.api#required": {} + } + }, + "OutputEncryptionKMSKeyId": { + "target": "com.amazonaws.transcribe#KMSKeyId", + "traits": { + "smithy.api#documentation": "

    The KMS key you want to use to encrypt your Medical Scribe\n output.

    \n

    If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

    \n
      \n
    1. \n

      Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

      \n
      3. \n
    3. \n

      Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      4. \n
    4. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      5. \n
    \n

    If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

    \n
      \n
    1. \n

      Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      3. \n
    \n

    If you do not specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

    \n

    Note that the role specified in the DataAccessRoleArn request parameter \n must have permission to use the specified KMS key.

    " + } + }, + "KMSEncryptionContext": { + "target": "com.amazonaws.transcribe#KMSEncryptionContextMap", + "traits": { + "smithy.api#documentation": "

    A map of plain text, non-secret key:value pairs, known as encryption context pairs,\n that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

    " + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.transcribe#DataAccessRoleArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files, \n write to the output bucket, and use your KMS key if supplied. \n If the role that you specify doesn’t have the appropriate permissions your request fails.

    \n

    IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

    \n

    For more information, see IAM\n ARNs.

    ", + "smithy.api#required": {} + } + }, + "Settings": { + "target": "com.amazonaws.transcribe#MedicalScribeSettings", + "traits": { + "smithy.api#documentation": "

    Makes it possible to control how your Medical Scribe job is processed using a\n MedicalScribeSettings object. Specify ChannelIdentification if \n ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification \n and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels\n must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings\n to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. \n VocabularyFilterMethod must be specified if VocabularyFilterName is set.\n

    ", + "smithy.api#required": {} + } + }, + "ChannelDefinitions": { + "target": "com.amazonaws.transcribe#MedicalScribeChannelDefinitions", + "traits": { + "smithy.api#documentation": "

    Makes it possible to specify which speaker is on which channel. For example, if the clinician\n is the first participant to speak, you would set ChannelId of the first ChannelDefinition \n in the list to 0 (to indicate the first channel) and ParticipantRole to\n CLINICIAN (to indicate that it's the clinician speaking).\n Then you would set the ChannelId of the second ChannelDefinition in the list to\n 1 (to indicate the second channel) and ParticipantRole to\n PATIENT (to indicate that it's the patient speaking).\n

    " + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

    Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

    \n

    To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transcribe#StartMedicalScribeJobResponse": { + "type": "structure", + "members": { + "MedicalScribeJob": { + "target": "com.amazonaws.transcribe#MedicalScribeJob", + "traits": { + "smithy.api#documentation": "

    Provides detailed information about the current Medical Scribe job, including\n job status and, if applicable, failure reason.

    " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.transcribe#StartMedicalTranscriptionJob": { "type": "operation", "input": { @@ -4730,7 +5349,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Transcribes the audio from a medical dictation or conversation and applies any\n additional Request Parameters you choose to include in your request.

    \n

    In addition to many standard transcription features, Amazon Transcribe Medical\n provides you with a robust medical vocabulary and, optionally, content identification,\n which adds flags to personal health information (PHI). To learn more about these\n features, refer to How Amazon Transcribe Medical\n works.

    \n

    To make a StartMedicalTranscriptionJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the S3 location\n of the file using the Media parameter.

    \n

    You must include the following parameters in your\n StartMedicalTranscriptionJob request:

    \n
      \n
    • \n

      \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

      \n
      • \n
    • \n

      \n MedicalTranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.

      \n
      • \n
    • \n

      \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

      \n
      • \n
    • \n

      \n LanguageCode: This must be en-US.

      \n
      • \n
    • \n

      \n OutputBucketName: The Amazon S3 bucket where you want\n your transcript stored. If you want your output stored in a sub-folder of this\n bucket, you must also include OutputKey.

      \n
      • \n
    • \n

      \n Specialty: This must be PRIMARYCARE.

      \n
      • \n
    • \n

      \n Type: Choose whether your audio is a conversation or a\n dictation.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Transcribes the audio from a medical dictation or conversation and applies any\n additional Request Parameters you choose to include in your request.

    \n

    In addition to many standard transcription features, Amazon Transcribe Medical\n provides you with a robust medical vocabulary and, optionally, content identification,\n which adds flags to personal health information (PHI). To learn more about these\n features, refer to How Amazon Transcribe Medical\n works.

    \n

    To make a StartMedicalTranscriptionJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location\n of the file using the Media parameter.

    \n

    You must include the following parameters in your\n StartMedicalTranscriptionJob request:

    \n
      \n
    • \n

      \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

      \n
      • \n
    • \n

      \n MedicalTranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.

      \n
      • \n
    • \n

      \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

      \n
      • \n
    • \n

      \n LanguageCode: This must be en-US.

      \n
      • \n
    • \n

      \n OutputBucketName: The Amazon S3 bucket where you want\n your transcript stored. If you want your output stored in a sub-folder of this\n bucket, you must also include OutputKey.

      \n
      • \n
    • \n

      \n Specialty: This must be PRIMARYCARE.

      \n
      • \n
    • \n

      \n Type: Choose whether your audio is a conversation or a\n dictation.

      \n
      • \n
    ", "smithy.api#http": { "method": "PUT", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -4759,7 +5378,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MedicalMediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

    The sample rate, in hertz, of the audio track in your input media file.

    \n

    If you don't specify the media sample rate, Amazon Transcribe Medical determines it\n for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the\n value detected, your job fails. Therefore, in most cases, it's advised to omit\n MediaSampleRateHertz and let Amazon Transcribe Medical determine the\n sample rate.

    " + "smithy.api#documentation": "

    The sample rate, in hertz, of the audio track in your input media file.

    \n

    If you do not specify the media sample rate, Amazon Transcribe Medical determines it\n for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the\n value detected, your job fails. Therefore, in most cases, it's advised to omit\n MediaSampleRateHertz and let Amazon Transcribe Medical determine the\n sample rate.

    " } }, "MediaFormat": { @@ -4790,7 +5409,7 @@ "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

    The KMS key you want to use to encrypt your medical transcription\n output.

    \n

    If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

    \n
      \n
    1. \n

      Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

      \n
      3. \n
    3. \n

      Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      4. \n
    4. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      5. \n
    \n

    If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

    \n
      \n
    1. \n

      Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      3. \n
    \n

    If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

    \n

    Note that the role making the request must\n have permission to use the specified KMS key.

    " + "smithy.api#documentation": "

    The KMS key you want to use to encrypt your medical transcription\n output.

    \n

    If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

    \n
      \n
    1. \n

      Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

      \n
      3. \n
    3. \n

      Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      4. \n
    4. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      5. \n
    \n

    If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

    \n
      \n
    1. \n

      Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      3. \n
    \n

    If you do not specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

    \n

    Note that the role making the request must\n have permission to use the specified KMS key.

    " } }, "KMSEncryptionContext": { @@ -4873,7 +5492,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Transcribes the audio from a media file and applies any additional Request Parameters\n you choose to include in your request.

    \n

    To make a StartTranscriptionJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.

    \n

    You must include the following parameters in your StartTranscriptionJob\n request:

    \n
      \n
    • \n

      \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

      \n
      • \n
    • \n

      \n TranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.

      \n
      • \n
    • \n

      \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

      \n
      • \n
    • \n

      One of LanguageCode, IdentifyLanguage, or\n IdentifyMultipleLanguages: If you know the language of your\n media file, specify it using the LanguageCode parameter; you can\n find all valid language codes in the Supported\n languages table. If you don't know the languages spoken in your\n media, use either IdentifyLanguage or\n IdentifyMultipleLanguages and let Amazon Transcribe identify\n the languages for you.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Transcribes the audio from a media file and applies any additional Request Parameters\n you choose to include in your request.

    \n

    To make a StartTranscriptionJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.

    \n

    You must include the following parameters in your StartTranscriptionJob\n request:

    \n
      \n
    • \n

      \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

      \n
      • \n
    • \n

      \n TranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.

      \n
      • \n
    • \n

      \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

      \n
      • \n
    • \n

      One of LanguageCode, IdentifyLanguage, or\n IdentifyMultipleLanguages: If you know the language of your\n media file, specify it using the LanguageCode parameter; you can\n find all valid language codes in the Supported\n languages table. If you do not know the languages spoken in your\n media, use either IdentifyLanguage or\n IdentifyMultipleLanguages and let Amazon Transcribe identify\n the languages for you.

      \n
      • \n
    ", "smithy.api#http": { "method": "PUT", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -4901,7 +5520,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

    The sample rate, in hertz, of the audio track in your input media file.

    \n

    If you don't specify the media sample rate, Amazon Transcribe determines it for you.\n If you specify the sample rate, it must match the rate detected by Amazon Transcribe.\n If there's a mismatch between the value that you specify and the value detected, your\n job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

    " + "smithy.api#documentation": "

    The sample rate, in hertz, of the audio track in your input media file.

    \n

    If you do not specify the media sample rate, Amazon Transcribe determines it for you.\n If you specify the sample rate, it must match the rate detected by Amazon Transcribe.\n If there's a mismatch between the value that you specify and the value detected, your\n job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

    " } }, "MediaFormat": { @@ -4920,7 +5539,7 @@ "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

    The name of the Amazon S3 bucket where you want your transcription output\n stored. Do not include the S3:// prefix of the specified bucket.

    \n

    If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.

    \n

    For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

    \n

    Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

    \n

    If you don't specify OutputBucketName, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

    " + "smithy.api#documentation": "

    The name of the Amazon S3 bucket where you want your transcription output\n stored. Do not include the S3:// prefix of the specified bucket.

    \n

    If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.

    \n

    For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

    \n

    Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

    \n

    If you do not specify OutputBucketName, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

    " } }, "OutputKey": { @@ -4932,7 +5551,7 @@ "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

    The KMS key you want to use to encrypt your transcription\n output.

    \n

    If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

    \n
      \n
    1. \n

      Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

      \n
      3. \n
    3. \n

      Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      4. \n
    4. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      5. \n
    \n

    If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

    \n
      \n
    1. \n

      Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      3. \n
    \n

    If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

    \n

    Note that the role making the request must\n have permission to use the specified KMS key.

    " + "smithy.api#documentation": "

    The KMS key you want to use to encrypt your transcription\n output.

    \n

    If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

    \n
      \n
    1. \n

      Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

      \n
      3. \n
    3. \n

      Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      4. \n
    4. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      5. \n
    \n

    If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

    \n
      \n
    1. \n

      Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      \n
      2. \n
    2. \n

      Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

      \n
      3. \n
    \n

    If you do not specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

    \n

    Note that the role making the request must\n have permission to use the specified KMS key.

    " } }, "KMSEncryptionContext": { @@ -4944,7 +5563,7 @@ "Settings": { "target": "com.amazonaws.transcribe#Settings", "traits": { - "smithy.api#documentation": "

    Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker\n partitioning. You can use that to apply custom vocabularies and vocabulary filters.

    \n

    If you want to include a custom vocabulary or a custom vocabulary filter (or both)\n with your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.

    \n

    If you're using automatic language identification with your request and want to\n include a custom language model, a custom vocabulary, or a custom vocabulary filter, use\n instead the parameter with the\n LanguageModelName, VocabularyName or\n VocabularyFilterName sub-parameters.

    " + "smithy.api#documentation": "

    Specify additional optional settings in your \n request, including channel identification, alternative transcriptions, speaker\n partitioning. You can use that to apply custom vocabularies and vocabulary filters.

    \n

    If you want to include a custom vocabulary or a custom vocabulary filter (or both)\n with your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.

    \n

    If you're using automatic language identification with your request and want to\n include a custom language model, a custom vocabulary, or a custom vocabulary filter, use\n instead the parameter with the\n LanguageModelName, VocabularyName or\n VocabularyFilterName sub-parameters.

    " } }, "ModelSettings": { @@ -4962,7 +5581,7 @@ "ContentRedaction": { "target": "com.amazonaws.transcribe#ContentRedaction", "traits": { - "smithy.api#documentation": "

    Makes it possible to redact or flag specified personally identifiable information\n (PII) in your transcript. If you use ContentRedaction, you must also\n include the sub-parameters: PiiEntityTypes, RedactionOutput,\n and RedactionType.

    " + "smithy.api#documentation": "

    Makes it possible to redact or flag specified personally identifiable information (PII) in \n your transcript. If you use ContentRedaction, you must also include the \n sub-parameters: RedactionOutput and RedactionType. You can \n optionally include PiiEntityTypes to choose which types of PII you want to redact.\n If you do not include PiiEntityTypes in your request, all PII is redacted.

    " } }, "IdentifyLanguage": { @@ -5354,6 +5973,9 @@ { "target": "com.amazonaws.transcribe#DeleteLanguageModel" }, + { + "target": "com.amazonaws.transcribe#DeleteMedicalScribeJob" + }, { "target": "com.amazonaws.transcribe#DeleteMedicalTranscriptionJob" }, @@ -5378,6 +6000,9 @@ { "target": "com.amazonaws.transcribe#GetCallAnalyticsJob" }, + { + "target": "com.amazonaws.transcribe#GetMedicalScribeJob" + }, { "target": "com.amazonaws.transcribe#GetMedicalTranscriptionJob" }, @@ -5402,6 +6027,9 @@ { "target": "com.amazonaws.transcribe#ListLanguageModels" }, + { + "target": "com.amazonaws.transcribe#ListMedicalScribeJobs" + }, { "target": "com.amazonaws.transcribe#ListMedicalTranscriptionJobs" }, @@ -5423,6 +6051,9 @@ { "target": "com.amazonaws.transcribe#StartCallAnalyticsJob" }, + { + "target": "com.amazonaws.transcribe#StartMedicalScribeJob" + }, { "target": "com.amazonaws.transcribe#StartMedicalTranscriptionJob" }, @@ -6658,7 +7289,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

    If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

    \n

    The FailureReason field contains one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format.

      \n

      The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format.

      \n

      The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file.

      \n

      The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample\n rate.

      \n

      The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large.

      \n

      The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large.

      \n

      Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.

      \n
      • \n
    " + "smithy.api#documentation": "

    If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

    \n

    The FailureReason field contains one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format.

      \n

      The media format specified in MediaFormat isn't valid. Refer to\n refer to the MediaFormat parameter for a list of supported\n formats.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format.

      \n

      The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file.

      \n

      The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample\n rate.

      \n

      The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large.

      \n

      The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Service \n quotas.

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large.

      \n

      Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Service \n quotas.

      \n
      • \n
    " } }, "Settings": {