@aws-sdk/client-transcribe 3.458.0 → 3.459.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -0
- package/dist-cjs/Transcribe.js +8 -0
- package/dist-cjs/commands/DeleteMedicalScribeJobCommand.js +51 -0
- package/dist-cjs/commands/GetMedicalScribeJobCommand.js +51 -0
- package/dist-cjs/commands/ListMedicalScribeJobsCommand.js +51 -0
- package/dist-cjs/commands/StartMedicalScribeJobCommand.js +51 -0
- package/dist-cjs/commands/index.js +4 -0
- package/dist-cjs/models/models_0.js +14 -1
- package/dist-cjs/pagination/ListMedicalScribeJobsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +242 -2
- package/dist-es/Transcribe.js +8 -0
- package/dist-es/commands/DeleteMedicalScribeJobCommand.js +47 -0
- package/dist-es/commands/GetMedicalScribeJobCommand.js +47 -0
- package/dist-es/commands/ListMedicalScribeJobsCommand.js +47 -0
- package/dist-es/commands/StartMedicalScribeJobCommand.js +47 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +13 -0
- package/dist-es/pagination/ListMedicalScribeJobsPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +232 -0
- package/dist-types/Transcribe.d.ts +28 -0
- package/dist-types/TranscribeClient.d.ts +6 -2
- package/dist-types/commands/DeleteMedicalScribeJobCommand.d.ts +87 -0
- package/dist-types/commands/GetMedicalScribeJobCommand.d.ts +135 -0
- package/dist-types/commands/ListMedicalScribeJobsCommand.d.ts +104 -0
- package/dist-types/commands/StartMedicalScribeJobCommand.d.ts +203 -0
- package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts +1 -1
- package/dist-types/commands/StartTranscriptionJobCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +623 -77
- package/dist-types/pagination/ListMedicalScribeJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
- package/dist-types/ts3.4/Transcribe.d.ts +68 -0
- package/dist-types/ts3.4/TranscribeClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/DeleteMedicalScribeJobCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetMedicalScribeJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListMedicalScribeJobsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartMedicalScribeJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +93 -0
- package/dist-types/ts3.4/pagination/ListMedicalScribeJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
- package/package.json +1 -1
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetMedicalScribeJobRequest, GetMedicalScribeJobResponse } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, TranscribeClientResolvedConfig } from "../TranscribeClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetMedicalScribeJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetMedicalScribeJobCommandInput extends GetMedicalScribeJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetMedicalScribeJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetMedicalScribeJobCommandOutput extends GetMedicalScribeJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Provides information about the specified Medical Scribe job.</p>
|
|
27
|
+
* <p>To view the status of the specified medical transcription job, check the
|
|
28
|
+
* <code>MedicalScribeJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
29
|
+
* the job is finished. You can find the results at the location specified in
|
|
30
|
+
* <code>MedicalScribeOutput</code>.
|
|
31
|
+
* If the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why your Medical Scribe job
|
|
32
|
+
* failed.</p>
|
|
33
|
+
* <p>To get a list of your Medical Scribe jobs, use the operation.</p>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { TranscribeClient, GetMedicalScribeJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import
|
|
38
|
+
* // const { TranscribeClient, GetMedicalScribeJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import
|
|
39
|
+
* const client = new TranscribeClient(config);
|
|
40
|
+
* const input = { // GetMedicalScribeJobRequest
|
|
41
|
+
* MedicalScribeJobName: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetMedicalScribeJobCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetMedicalScribeJobResponse
|
|
46
|
+
* // MedicalScribeJob: { // MedicalScribeJob
|
|
47
|
+
* // MedicalScribeJobName: "STRING_VALUE",
|
|
48
|
+
* // MedicalScribeJobStatus: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED",
|
|
49
|
+
* // LanguageCode: "en-US",
|
|
50
|
+
* // Media: { // Media
|
|
51
|
+
* // MediaFileUri: "STRING_VALUE",
|
|
52
|
+
* // RedactedMediaFileUri: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // MedicalScribeOutput: { // MedicalScribeOutput
|
|
55
|
+
* // TranscriptFileUri: "STRING_VALUE", // required
|
|
56
|
+
* // ClinicalDocumentUri: "STRING_VALUE", // required
|
|
57
|
+
* // },
|
|
58
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
59
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
60
|
+
* // CompletionTime: new Date("TIMESTAMP"),
|
|
61
|
+
* // FailureReason: "STRING_VALUE",
|
|
62
|
+
* // Settings: { // MedicalScribeSettings
|
|
63
|
+
* // ShowSpeakerLabels: true || false,
|
|
64
|
+
* // MaxSpeakerLabels: Number("int"),
|
|
65
|
+
* // ChannelIdentification: true || false,
|
|
66
|
+
* // VocabularyName: "STRING_VALUE",
|
|
67
|
+
* // VocabularyFilterName: "STRING_VALUE",
|
|
68
|
+
* // VocabularyFilterMethod: "remove" || "mask" || "tag",
|
|
69
|
+
* // },
|
|
70
|
+
* // DataAccessRoleArn: "STRING_VALUE",
|
|
71
|
+
* // ChannelDefinitions: [ // MedicalScribeChannelDefinitions
|
|
72
|
+
* // { // MedicalScribeChannelDefinition
|
|
73
|
+
* // ChannelId: Number("int"), // required
|
|
74
|
+
* // ParticipantRole: "PATIENT" || "CLINICIAN", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // Tags: [ // TagList
|
|
78
|
+
* // { // Tag
|
|
79
|
+
* // Key: "STRING_VALUE", // required
|
|
80
|
+
* // Value: "STRING_VALUE", // required
|
|
81
|
+
* // },
|
|
82
|
+
* // ],
|
|
83
|
+
* // },
|
|
84
|
+
* // };
|
|
85
|
+
*
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @param GetMedicalScribeJobCommandInput - {@link GetMedicalScribeJobCommandInput}
|
|
89
|
+
* @returns {@link GetMedicalScribeJobCommandOutput}
|
|
90
|
+
* @see {@link GetMedicalScribeJobCommandInput} for command's `input` shape.
|
|
91
|
+
* @see {@link GetMedicalScribeJobCommandOutput} for command's `response` shape.
|
|
92
|
+
* @see {@link TranscribeClientResolvedConfig | config} for TranscribeClient's `config` shape.
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link BadRequestException} (client fault)
|
|
95
|
+
* <p>Your request didn't pass one or more validation tests. This can occur when the entity
|
|
96
|
+
* you're trying to delete doesn't exist or if it's in a non-terminal state (such as
|
|
97
|
+
* <code>IN PROGRESS</code>). See the exception message field for more
|
|
98
|
+
* information.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
101
|
+
* <p>There was an internal error. Check the error message, correct the issue, and try your
|
|
102
|
+
* request again.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
105
|
+
* <p>You've either sent too many requests or your input file is too long. Wait before
|
|
106
|
+
* retrying your request, or use a smaller file and try your request again.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link NotFoundException} (client fault)
|
|
109
|
+
* <p>We can't find the requested resource. Check that the specified name is correct and try
|
|
110
|
+
* your request again.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link TranscribeServiceException}
|
|
113
|
+
* <p>Base exception class for all service exceptions from Transcribe service.</p>
|
|
114
|
+
*
|
|
115
|
+
*/
|
|
116
|
+
export declare class GetMedicalScribeJobCommand extends $Command<GetMedicalScribeJobCommandInput, GetMedicalScribeJobCommandOutput, TranscribeClientResolvedConfig> {
|
|
117
|
+
readonly input: GetMedicalScribeJobCommandInput;
|
|
118
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
constructor(input: GetMedicalScribeJobCommandInput);
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranscribeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMedicalScribeJobCommandInput, GetMedicalScribeJobCommandOutput>;
|
|
127
|
+
/**
|
|
128
|
+
* @internal
|
|
129
|
+
*/
|
|
130
|
+
private serialize;
|
|
131
|
+
/**
|
|
132
|
+
* @internal
|
|
133
|
+
*/
|
|
134
|
+
private deserialize;
|
|
135
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ListMedicalScribeJobsRequest, ListMedicalScribeJobsResponse } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, TranscribeClientResolvedConfig } from "../TranscribeClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListMedicalScribeJobsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListMedicalScribeJobsCommandInput extends ListMedicalScribeJobsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListMedicalScribeJobsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListMedicalScribeJobsCommandOutput extends ListMedicalScribeJobsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Provides a list of Medical Scribe jobs that match the specified criteria. If no
|
|
27
|
+
* criteria are specified, all Medical Scribe jobs are returned.</p>
|
|
28
|
+
* <p>To get detailed information about a specific Medical Scribe job, use the operation.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { TranscribeClient, ListMedicalScribeJobsCommand } from "@aws-sdk/client-transcribe"; // ES Modules import
|
|
33
|
+
* // const { TranscribeClient, ListMedicalScribeJobsCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import
|
|
34
|
+
* const client = new TranscribeClient(config);
|
|
35
|
+
* const input = { // ListMedicalScribeJobsRequest
|
|
36
|
+
* Status: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED",
|
|
37
|
+
* JobNameContains: "STRING_VALUE",
|
|
38
|
+
* NextToken: "STRING_VALUE",
|
|
39
|
+
* MaxResults: Number("int"),
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListMedicalScribeJobsCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListMedicalScribeJobsResponse
|
|
44
|
+
* // Status: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED",
|
|
45
|
+
* // NextToken: "STRING_VALUE",
|
|
46
|
+
* // MedicalScribeJobSummaries: [ // MedicalScribeJobSummaries
|
|
47
|
+
* // { // MedicalScribeJobSummary
|
|
48
|
+
* // MedicalScribeJobName: "STRING_VALUE",
|
|
49
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
50
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
51
|
+
* // CompletionTime: new Date("TIMESTAMP"),
|
|
52
|
+
* // LanguageCode: "en-US",
|
|
53
|
+
* // MedicalScribeJobStatus: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED",
|
|
54
|
+
* // FailureReason: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param ListMedicalScribeJobsCommandInput - {@link ListMedicalScribeJobsCommandInput}
|
|
62
|
+
* @returns {@link ListMedicalScribeJobsCommandOutput}
|
|
63
|
+
* @see {@link ListMedicalScribeJobsCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link ListMedicalScribeJobsCommandOutput} for command's `response` shape.
|
|
65
|
+
* @see {@link TranscribeClientResolvedConfig | config} for TranscribeClient's `config` shape.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link BadRequestException} (client fault)
|
|
68
|
+
* <p>Your request didn't pass one or more validation tests. This can occur when the entity
|
|
69
|
+
* you're trying to delete doesn't exist or if it's in a non-terminal state (such as
|
|
70
|
+
* <code>IN PROGRESS</code>). See the exception message field for more
|
|
71
|
+
* information.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
74
|
+
* <p>There was an internal error. Check the error message, correct the issue, and try your
|
|
75
|
+
* request again.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
78
|
+
* <p>You've either sent too many requests or your input file is too long. Wait before
|
|
79
|
+
* retrying your request, or use a smaller file and try your request again.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link TranscribeServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from Transcribe service.</p>
|
|
83
|
+
*
|
|
84
|
+
*/
|
|
85
|
+
export declare class ListMedicalScribeJobsCommand extends $Command<ListMedicalScribeJobsCommandInput, ListMedicalScribeJobsCommandOutput, TranscribeClientResolvedConfig> {
|
|
86
|
+
readonly input: ListMedicalScribeJobsCommandInput;
|
|
87
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
88
|
+
/**
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
constructor(input: ListMedicalScribeJobsCommandInput);
|
|
92
|
+
/**
|
|
93
|
+
* @internal
|
|
94
|
+
*/
|
|
95
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranscribeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListMedicalScribeJobsCommandInput, ListMedicalScribeJobsCommandOutput>;
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
99
|
+
private serialize;
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
private deserialize;
|
|
104
|
+
}
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { StartMedicalScribeJobRequest, StartMedicalScribeJobResponse } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, TranscribeClientResolvedConfig } from "../TranscribeClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StartMedicalScribeJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartMedicalScribeJobCommandInput extends StartMedicalScribeJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StartMedicalScribeJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StartMedicalScribeJobCommandOutput extends StartMedicalScribeJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Transcribes patient-clinician conversations and generates clinical notes. </p>
|
|
27
|
+
* <p>Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles,
|
|
28
|
+
* classifies dialogues, extracts medical terms, and generates preliminary clinical notes.
|
|
29
|
+
* To learn more about these features, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe.html">Amazon Web Services HealthScribe</a>.</p>
|
|
30
|
+
* <p>To make a <code>StartMedicalScribeJob</code> request, you must first upload
|
|
31
|
+
* your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location
|
|
32
|
+
* of the file using the <code>Media</code> parameter.</p>
|
|
33
|
+
* <p>You must include the following parameters in your
|
|
34
|
+
* <code>StartMedicalTranscriptionJob</code> request:</p>
|
|
35
|
+
* <ul>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <code>DataAccessRoleArn</code>: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in <code>Media</code>,
|
|
39
|
+
* write permission on the Amazon S3 bucket specified in <code>OutputBucketName</code>, and full permissions on the KMS key specified in <code>OutputEncryptionKMSKeyId</code> (if set).
|
|
40
|
+
* The role should also allow <code>transcribe.amazonaws.com</code> to assume it.
|
|
41
|
+
* </p>
|
|
42
|
+
* </li>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>
|
|
45
|
+
* <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location
|
|
46
|
+
* of your media file.</p>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>
|
|
50
|
+
* <code>MedicalScribeJobName</code>: A custom name you create for your
|
|
51
|
+
* MedicalScribe job that is unique within your Amazon Web Services account.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>
|
|
55
|
+
* <code>OutputBucketName</code>: The Amazon S3 bucket where you want
|
|
56
|
+
* your output files stored.</p>
|
|
57
|
+
* </li>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>
|
|
60
|
+
* <code>Settings</code>: A <code>MedicalScribeSettings</code> obect
|
|
61
|
+
* that must set exactly one of <code>ShowSpeakerLabels</code> or <code>ChannelIdentification</code> to true.
|
|
62
|
+
* If <code>ShowSpeakerLabels</code> is true, <code>MaxSpeakerLabels</code> must also be set.
|
|
63
|
+
* </p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>
|
|
67
|
+
* <code>ChannelDefinitions</code>: A <code>MedicalScribeChannelDefinitions</code> array should be set if and only if the <code>ChannelIdentification</code>
|
|
68
|
+
* value of <code>Settings</code> is set to true.
|
|
69
|
+
* </p>
|
|
70
|
+
* </li>
|
|
71
|
+
* </ul>
|
|
72
|
+
* @example
|
|
73
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
74
|
+
* ```javascript
|
|
75
|
+
* import { TranscribeClient, StartMedicalScribeJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import
|
|
76
|
+
* // const { TranscribeClient, StartMedicalScribeJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import
|
|
77
|
+
* const client = new TranscribeClient(config);
|
|
78
|
+
* const input = { // StartMedicalScribeJobRequest
|
|
79
|
+
* MedicalScribeJobName: "STRING_VALUE", // required
|
|
80
|
+
* Media: { // Media
|
|
81
|
+
* MediaFileUri: "STRING_VALUE",
|
|
82
|
+
* RedactedMediaFileUri: "STRING_VALUE",
|
|
83
|
+
* },
|
|
84
|
+
* OutputBucketName: "STRING_VALUE", // required
|
|
85
|
+
* OutputEncryptionKMSKeyId: "STRING_VALUE",
|
|
86
|
+
* KMSEncryptionContext: { // KMSEncryptionContextMap
|
|
87
|
+
* "<keys>": "STRING_VALUE",
|
|
88
|
+
* },
|
|
89
|
+
* DataAccessRoleArn: "STRING_VALUE", // required
|
|
90
|
+
* Settings: { // MedicalScribeSettings
|
|
91
|
+
* ShowSpeakerLabels: true || false,
|
|
92
|
+
* MaxSpeakerLabels: Number("int"),
|
|
93
|
+
* ChannelIdentification: true || false,
|
|
94
|
+
* VocabularyName: "STRING_VALUE",
|
|
95
|
+
* VocabularyFilterName: "STRING_VALUE",
|
|
96
|
+
* VocabularyFilterMethod: "remove" || "mask" || "tag",
|
|
97
|
+
* },
|
|
98
|
+
* ChannelDefinitions: [ // MedicalScribeChannelDefinitions
|
|
99
|
+
* { // MedicalScribeChannelDefinition
|
|
100
|
+
* ChannelId: Number("int"), // required
|
|
101
|
+
* ParticipantRole: "PATIENT" || "CLINICIAN", // required
|
|
102
|
+
* },
|
|
103
|
+
* ],
|
|
104
|
+
* Tags: [ // TagList
|
|
105
|
+
* { // Tag
|
|
106
|
+
* Key: "STRING_VALUE", // required
|
|
107
|
+
* Value: "STRING_VALUE", // required
|
|
108
|
+
* },
|
|
109
|
+
* ],
|
|
110
|
+
* };
|
|
111
|
+
* const command = new StartMedicalScribeJobCommand(input);
|
|
112
|
+
* const response = await client.send(command);
|
|
113
|
+
* // { // StartMedicalScribeJobResponse
|
|
114
|
+
* // MedicalScribeJob: { // MedicalScribeJob
|
|
115
|
+
* // MedicalScribeJobName: "STRING_VALUE",
|
|
116
|
+
* // MedicalScribeJobStatus: "QUEUED" || "IN_PROGRESS" || "FAILED" || "COMPLETED",
|
|
117
|
+
* // LanguageCode: "en-US",
|
|
118
|
+
* // Media: { // Media
|
|
119
|
+
* // MediaFileUri: "STRING_VALUE",
|
|
120
|
+
* // RedactedMediaFileUri: "STRING_VALUE",
|
|
121
|
+
* // },
|
|
122
|
+
* // MedicalScribeOutput: { // MedicalScribeOutput
|
|
123
|
+
* // TranscriptFileUri: "STRING_VALUE", // required
|
|
124
|
+
* // ClinicalDocumentUri: "STRING_VALUE", // required
|
|
125
|
+
* // },
|
|
126
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
127
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
128
|
+
* // CompletionTime: new Date("TIMESTAMP"),
|
|
129
|
+
* // FailureReason: "STRING_VALUE",
|
|
130
|
+
* // Settings: { // MedicalScribeSettings
|
|
131
|
+
* // ShowSpeakerLabels: true || false,
|
|
132
|
+
* // MaxSpeakerLabels: Number("int"),
|
|
133
|
+
* // ChannelIdentification: true || false,
|
|
134
|
+
* // VocabularyName: "STRING_VALUE",
|
|
135
|
+
* // VocabularyFilterName: "STRING_VALUE",
|
|
136
|
+
* // VocabularyFilterMethod: "remove" || "mask" || "tag",
|
|
137
|
+
* // },
|
|
138
|
+
* // DataAccessRoleArn: "STRING_VALUE",
|
|
139
|
+
* // ChannelDefinitions: [ // MedicalScribeChannelDefinitions
|
|
140
|
+
* // { // MedicalScribeChannelDefinition
|
|
141
|
+
* // ChannelId: Number("int"), // required
|
|
142
|
+
* // ParticipantRole: "PATIENT" || "CLINICIAN", // required
|
|
143
|
+
* // },
|
|
144
|
+
* // ],
|
|
145
|
+
* // Tags: [ // TagList
|
|
146
|
+
* // { // Tag
|
|
147
|
+
* // Key: "STRING_VALUE", // required
|
|
148
|
+
* // Value: "STRING_VALUE", // required
|
|
149
|
+
* // },
|
|
150
|
+
* // ],
|
|
151
|
+
* // },
|
|
152
|
+
* // };
|
|
153
|
+
*
|
|
154
|
+
* ```
|
|
155
|
+
*
|
|
156
|
+
* @param StartMedicalScribeJobCommandInput - {@link StartMedicalScribeJobCommandInput}
|
|
157
|
+
* @returns {@link StartMedicalScribeJobCommandOutput}
|
|
158
|
+
* @see {@link StartMedicalScribeJobCommandInput} for command's `input` shape.
|
|
159
|
+
* @see {@link StartMedicalScribeJobCommandOutput} for command's `response` shape.
|
|
160
|
+
* @see {@link TranscribeClientResolvedConfig | config} for TranscribeClient's `config` shape.
|
|
161
|
+
*
|
|
162
|
+
* @throws {@link BadRequestException} (client fault)
|
|
163
|
+
* <p>Your request didn't pass one or more validation tests. This can occur when the entity
|
|
164
|
+
* you're trying to delete doesn't exist or if it's in a non-terminal state (such as
|
|
165
|
+
* <code>IN PROGRESS</code>). See the exception message field for more
|
|
166
|
+
* information.</p>
|
|
167
|
+
*
|
|
168
|
+
* @throws {@link ConflictException} (client fault)
|
|
169
|
+
* <p>A resource already exists with this name. Resource names must be unique within an
|
|
170
|
+
* Amazon Web Services account.</p>
|
|
171
|
+
*
|
|
172
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
173
|
+
* <p>There was an internal error. Check the error message, correct the issue, and try your
|
|
174
|
+
* request again.</p>
|
|
175
|
+
*
|
|
176
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
177
|
+
* <p>You've either sent too many requests or your input file is too long. Wait before
|
|
178
|
+
* retrying your request, or use a smaller file and try your request again.</p>
|
|
179
|
+
*
|
|
180
|
+
* @throws {@link TranscribeServiceException}
|
|
181
|
+
* <p>Base exception class for all service exceptions from Transcribe service.</p>
|
|
182
|
+
*
|
|
183
|
+
*/
|
|
184
|
+
export declare class StartMedicalScribeJobCommand extends $Command<StartMedicalScribeJobCommandInput, StartMedicalScribeJobCommandOutput, TranscribeClientResolvedConfig> {
|
|
185
|
+
readonly input: StartMedicalScribeJobCommandInput;
|
|
186
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
187
|
+
/**
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
constructor(input: StartMedicalScribeJobCommandInput);
|
|
191
|
+
/**
|
|
192
|
+
* @internal
|
|
193
|
+
*/
|
|
194
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranscribeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartMedicalScribeJobCommandInput, StartMedicalScribeJobCommandOutput>;
|
|
195
|
+
/**
|
|
196
|
+
* @internal
|
|
197
|
+
*/
|
|
198
|
+
private serialize;
|
|
199
|
+
/**
|
|
200
|
+
* @internal
|
|
201
|
+
*/
|
|
202
|
+
private deserialize;
|
|
203
|
+
}
|
|
@@ -31,7 +31,7 @@ export interface StartMedicalTranscriptionJobCommandOutput extends StartMedicalT
|
|
|
31
31
|
* features, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html">How Amazon Transcribe Medical
|
|
32
32
|
* works</a>.</p>
|
|
33
33
|
* <p>To make a <code>StartMedicalTranscriptionJob</code> request, you must first upload
|
|
34
|
-
* your media file into an Amazon S3 bucket; you can then specify the S3 location
|
|
34
|
+
* your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location
|
|
35
35
|
* of the file using the <code>Media</code> parameter.</p>
|
|
36
36
|
* <p>You must include the following parameters in your
|
|
37
37
|
* <code>StartMedicalTranscriptionJob</code> request:</p>
|
|
@@ -52,7 +52,7 @@ export interface StartTranscriptionJobCommandOutput extends StartTranscriptionJo
|
|
|
52
52
|
* <code>IdentifyMultipleLanguages</code>: If you know the language of your
|
|
53
53
|
* media file, specify it using the <code>LanguageCode</code> parameter; you can
|
|
54
54
|
* find all valid language codes in the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
55
|
-
* languages</a> table. If you
|
|
55
|
+
* languages</a> table. If you do not know the languages spoken in your
|
|
56
56
|
* media, use either <code>IdentifyLanguage</code> or
|
|
57
57
|
* <code>IdentifyMultipleLanguages</code> and let Amazon Transcribe identify
|
|
58
58
|
* the languages for you.</p>
|
|
@@ -6,6 +6,7 @@ export * from "./CreateVocabularyFilterCommand";
|
|
|
6
6
|
export * from "./DeleteCallAnalyticsCategoryCommand";
|
|
7
7
|
export * from "./DeleteCallAnalyticsJobCommand";
|
|
8
8
|
export * from "./DeleteLanguageModelCommand";
|
|
9
|
+
export * from "./DeleteMedicalScribeJobCommand";
|
|
9
10
|
export * from "./DeleteMedicalTranscriptionJobCommand";
|
|
10
11
|
export * from "./DeleteMedicalVocabularyCommand";
|
|
11
12
|
export * from "./DeleteTranscriptionJobCommand";
|
|
@@ -14,6 +15,7 @@ export * from "./DeleteVocabularyFilterCommand";
|
|
|
14
15
|
export * from "./DescribeLanguageModelCommand";
|
|
15
16
|
export * from "./GetCallAnalyticsCategoryCommand";
|
|
16
17
|
export * from "./GetCallAnalyticsJobCommand";
|
|
18
|
+
export * from "./GetMedicalScribeJobCommand";
|
|
17
19
|
export * from "./GetMedicalTranscriptionJobCommand";
|
|
18
20
|
export * from "./GetMedicalVocabularyCommand";
|
|
19
21
|
export * from "./GetTranscriptionJobCommand";
|
|
@@ -22,6 +24,7 @@ export * from "./GetVocabularyFilterCommand";
|
|
|
22
24
|
export * from "./ListCallAnalyticsCategoriesCommand";
|
|
23
25
|
export * from "./ListCallAnalyticsJobsCommand";
|
|
24
26
|
export * from "./ListLanguageModelsCommand";
|
|
27
|
+
export * from "./ListMedicalScribeJobsCommand";
|
|
25
28
|
export * from "./ListMedicalTranscriptionJobsCommand";
|
|
26
29
|
export * from "./ListMedicalVocabulariesCommand";
|
|
27
30
|
export * from "./ListTagsForResourceCommand";
|
|
@@ -29,6 +32,7 @@ export * from "./ListTranscriptionJobsCommand";
|
|
|
29
32
|
export * from "./ListVocabulariesCommand";
|
|
30
33
|
export * from "./ListVocabularyFiltersCommand";
|
|
31
34
|
export * from "./StartCallAnalyticsJobCommand";
|
|
35
|
+
export * from "./StartMedicalScribeJobCommand";
|
|
32
36
|
export * from "./StartMedicalTranscriptionJobCommand";
|
|
33
37
|
export * from "./StartTranscriptionJobCommand";
|
|
34
38
|
export * from "./TagResourceCommand";
|