aws-sdk-transcribeservice 1.126.0 → 1.127.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-transcribeservice/client.rb +133 -51
- data/lib/aws-sdk-transcribeservice/client_api.rb +11 -0
- data/lib/aws-sdk-transcribeservice/types.rb +165 -51
- data/lib/aws-sdk-transcribeservice.rb +1 -1
- data/sig/client.rbs +6 -1
- data/sig/types.rbs +12 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 212c1b14f98e639d20fd3be11e7abec5df4d626870d72d9d4184ab247e6d9736
|
4
|
+
data.tar.gz: 5cde5e4ea03afbab9da47e721d8a6e9b42f10480536155d541cafbee88292d48
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 22cbbb198f9342e430e2fd44262eb8bc10e76463f7991d2df28977b2bd3194ad77f5a5f162a4bbe744c5b7392fb3cb5b5750bfe6b2554692470963b32d9e9b2e
|
7
|
+
data.tar.gz: e46687fbb7f1217524b5871f4234d44d7bf09d80d8bdfab20282f08a87841209a8aed4094f7a2964aa6d6975307b449efd339975438766f0065e9acb9bda04ec
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.127.0 (2025-08-12)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS HealthScribe now supports specifying preferred patient pronouns through the MedicalScribeContext parameter for use in the generated clinical notes.
|
8
|
+
|
4
9
|
1.126.0 (2025-08-08)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.127.0
|
@@ -1700,6 +1700,7 @@ module Aws::TranscribeService
|
|
1700
1700
|
# resp.medical_scribe_job.channel_definitions #=> Array
|
1701
1701
|
# resp.medical_scribe_job.channel_definitions[0].channel_id #=> Integer
|
1702
1702
|
# resp.medical_scribe_job.channel_definitions[0].participant_role #=> String, one of "PATIENT", "CLINICIAN"
|
1703
|
+
# resp.medical_scribe_job.medical_scribe_context_provided #=> Boolean
|
1703
1704
|
# resp.medical_scribe_job.tags #=> Array
|
1704
1705
|
# resp.medical_scribe_job.tags[0].key #=> String
|
1705
1706
|
# resp.medical_scribe_job.tags[0].value #=> String
|
@@ -2789,24 +2790,42 @@ module Aws::TranscribeService
|
|
2789
2790
|
# access your transcript.
|
2790
2791
|
#
|
2791
2792
|
# @option params [String] :output_encryption_kms_key_id
|
2792
|
-
# The
|
2793
|
-
# encrypt your Call Analytics output.
|
2793
|
+
# The KMS key you want to use to encrypt your Call Analytics output.
|
2794
2794
|
#
|
2795
|
-
#
|
2796
|
-
#
|
2797
|
-
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
2798
|
-
# For more information, see [ KMS key ARNs][1].
|
2795
|
+
# If using a key located in the **current** Amazon Web Services account,
|
2796
|
+
# you can specify your KMS key in one of four ways:
|
2799
2797
|
#
|
2800
|
-
#
|
2801
|
-
#
|
2798
|
+
# 1. Use the KMS key ID itself. For example,
|
2799
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
2800
|
+
#
|
2801
|
+
# 2. Use an alias for the KMS key ID. For example,
|
2802
|
+
# `alias/ExampleAlias`.
|
2803
|
+
#
|
2804
|
+
# 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
2805
|
+
# example,
|
2806
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
2807
|
+
#
|
2808
|
+
# 4. Use the ARN for the KMS key alias. For example,
|
2809
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
2802
2810
|
#
|
2803
|
-
#
|
2804
|
-
#
|
2805
|
-
#
|
2811
|
+
# If using a key located in a **different** Amazon Web Services account
|
2812
|
+
# than the current Amazon Web Services account, you can specify your KMS
|
2813
|
+
# key in one of two ways:
|
2806
2814
|
#
|
2815
|
+
# 1. Use the ARN for the KMS key ID. For example,
|
2816
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
2807
2817
|
#
|
2818
|
+
# 2. Use the ARN for the KMS key alias. For example,
|
2819
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
2808
2820
|
#
|
2809
|
-
#
|
2821
|
+
# If you do not specify an encryption key, your output is encrypted with
|
2822
|
+
# the default Amazon S3 key (SSE-S3).
|
2823
|
+
#
|
2824
|
+
# If you specify a KMS key to encrypt your output, you must also specify
|
2825
|
+
# an output location using the `OutputLocation` parameter.
|
2826
|
+
#
|
2827
|
+
# Note that the role making the request must have permission to use the
|
2828
|
+
# specified KMS key.
|
2810
2829
|
#
|
2811
2830
|
# @option params [String] :data_access_role_arn
|
2812
2831
|
# The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
@@ -2983,7 +3002,7 @@ module Aws::TranscribeService
|
|
2983
3002
|
# * `OutputBucketName`: The Amazon S3 bucket where you want your output
|
2984
3003
|
# files stored.
|
2985
3004
|
#
|
2986
|
-
# * `Settings`: A `MedicalScribeSettings`
|
3005
|
+
# * `Settings`: A `MedicalScribeSettings` object that must set exactly
|
2987
3006
|
# one of `ShowSpeakerLabels` or `ChannelIdentification` to true. If
|
2988
3007
|
# `ShowSpeakerLabels` is true, `MaxSpeakerLabels` must also be set.
|
2989
3008
|
#
|
@@ -3031,24 +3050,39 @@ module Aws::TranscribeService
|
|
3031
3050
|
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
|
3032
3051
|
#
|
3033
3052
|
# @option params [String] :output_encryption_kms_key_id
|
3034
|
-
# The
|
3035
|
-
# encrypt your Medical Scribe output.
|
3053
|
+
# The KMS key you want to use to encrypt your Medical Scribe output.
|
3036
3054
|
#
|
3037
|
-
#
|
3038
|
-
#
|
3039
|
-
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3040
|
-
# For more information, see [ KMS key ARNs][1].
|
3055
|
+
# If using a key located in the **current** Amazon Web Services account,
|
3056
|
+
# you can specify your KMS key in one of four ways:
|
3041
3057
|
#
|
3042
|
-
#
|
3043
|
-
#
|
3058
|
+
# 1. Use the KMS key ID itself. For example,
|
3059
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3060
|
+
#
|
3061
|
+
# 2. Use an alias for the KMS key ID. For example,
|
3062
|
+
# `alias/ExampleAlias`.
|
3063
|
+
#
|
3064
|
+
# 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
3065
|
+
# example,
|
3066
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3067
|
+
#
|
3068
|
+
# 4. Use the ARN for the KMS key alias. For example,
|
3069
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
3070
|
+
#
|
3071
|
+
# If using a key located in a **different** Amazon Web Services account
|
3072
|
+
# than the current Amazon Web Services account, you can specify your KMS
|
3073
|
+
# key in one of two ways:
|
3044
3074
|
#
|
3045
|
-
#
|
3046
|
-
#
|
3047
|
-
# permission to use the specified KMS key.
|
3075
|
+
# 1. Use the ARN for the KMS key ID. For example,
|
3076
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3048
3077
|
#
|
3078
|
+
# 2. Use the ARN for the KMS key alias. For example,
|
3079
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
3049
3080
|
#
|
3081
|
+
# If you do not specify an encryption key, your output is encrypted with
|
3082
|
+
# the default Amazon S3 key (SSE-S3).
|
3050
3083
|
#
|
3051
|
-
#
|
3084
|
+
# Note that the role specified in the `DataAccessRoleArn` request
|
3085
|
+
# parameter must have permission to use the specified KMS key.
|
3052
3086
|
#
|
3053
3087
|
# @option params [Hash<String,String>] :kms_encryption_context
|
3054
3088
|
# A map of plain text, non-secret key:value pairs, known as encryption
|
@@ -3102,7 +3136,7 @@ module Aws::TranscribeService
|
|
3102
3136
|
#
|
3103
3137
|
# @option params [Array<Types::Tag>] :tags
|
3104
3138
|
# Adds one or more custom tags, each in the form of a key:value pair, to
|
3105
|
-
# the
|
3139
|
+
# the Medical Scribe job.
|
3106
3140
|
#
|
3107
3141
|
# To learn more about using tags with Amazon Transcribe, refer to
|
3108
3142
|
# [Tagging resources][1].
|
@@ -3111,6 +3145,11 @@ module Aws::TranscribeService
|
|
3111
3145
|
#
|
3112
3146
|
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
|
3113
3147
|
#
|
3148
|
+
# @option params [Types::MedicalScribeContext] :medical_scribe_context
|
3149
|
+
# The `MedicalScribeContext` object that contains contextual information
|
3150
|
+
# which is used during clinical note generation to add relevant context
|
3151
|
+
# to the note.
|
3152
|
+
#
|
3114
3153
|
# @return [Types::StartMedicalScribeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3115
3154
|
#
|
3116
3155
|
# * {Types::StartMedicalScribeJobResponse#medical_scribe_job #medical_scribe_job} => Types::MedicalScribeJob
|
@@ -3152,6 +3191,11 @@ module Aws::TranscribeService
|
|
3152
3191
|
# value: "TagValue", # required
|
3153
3192
|
# },
|
3154
3193
|
# ],
|
3194
|
+
# medical_scribe_context: {
|
3195
|
+
# patient_context: {
|
3196
|
+
# pronouns: "HE_HIM", # accepts HE_HIM, SHE_HER, THEY_THEM
|
3197
|
+
# },
|
3198
|
+
# },
|
3155
3199
|
# })
|
3156
3200
|
#
|
3157
3201
|
# @example Response structure
|
@@ -3178,6 +3222,7 @@ module Aws::TranscribeService
|
|
3178
3222
|
# resp.medical_scribe_job.channel_definitions #=> Array
|
3179
3223
|
# resp.medical_scribe_job.channel_definitions[0].channel_id #=> Integer
|
3180
3224
|
# resp.medical_scribe_job.channel_definitions[0].participant_role #=> String, one of "PATIENT", "CLINICIAN"
|
3225
|
+
# resp.medical_scribe_job.medical_scribe_context_provided #=> Boolean
|
3181
3226
|
# resp.medical_scribe_job.tags #=> Array
|
3182
3227
|
# resp.medical_scribe_job.tags[0].key #=> String
|
3183
3228
|
# resp.medical_scribe_job.tags[0].value #=> String
|
@@ -3337,24 +3382,43 @@ module Aws::TranscribeService
|
|
3337
3382
|
# doesn't exist, one is created for you.
|
3338
3383
|
#
|
3339
3384
|
# @option params [String] :output_encryption_kms_key_id
|
3340
|
-
# The
|
3341
|
-
#
|
3385
|
+
# The KMS key you want to use to encrypt your medical transcription
|
3386
|
+
# output.
|
3342
3387
|
#
|
3343
|
-
#
|
3344
|
-
#
|
3345
|
-
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3346
|
-
# For more information, see [ KMS key ARNs][1].
|
3388
|
+
# If using a key located in the **current** Amazon Web Services account,
|
3389
|
+
# you can specify your KMS key in one of four ways:
|
3347
3390
|
#
|
3348
|
-
#
|
3349
|
-
#
|
3391
|
+
# 1. Use the KMS key ID itself. For example,
|
3392
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3393
|
+
#
|
3394
|
+
# 2. Use an alias for the KMS key ID. For example,
|
3395
|
+
# `alias/ExampleAlias`.
|
3396
|
+
#
|
3397
|
+
# 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
3398
|
+
# example,
|
3399
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3350
3400
|
#
|
3351
|
-
#
|
3352
|
-
#
|
3353
|
-
# permission to use the specified KMS key.
|
3401
|
+
# 4. Use the ARN for the KMS key alias. For example,
|
3402
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
3354
3403
|
#
|
3404
|
+
# If using a key located in a **different** Amazon Web Services account
|
3405
|
+
# than the current Amazon Web Services account, you can specify your KMS
|
3406
|
+
# key in one of two ways:
|
3407
|
+
#
|
3408
|
+
# 1. Use the ARN for the KMS key ID. For example,
|
3409
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3410
|
+
#
|
3411
|
+
# 2. Use the ARN for the KMS key alias. For example,
|
3412
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
3413
|
+
#
|
3414
|
+
# If you do not specify an encryption key, your output is encrypted with
|
3415
|
+
# the default Amazon S3 key (SSE-S3).
|
3355
3416
|
#
|
3417
|
+
# If you specify a KMS key to encrypt your output, you must also specify
|
3418
|
+
# an output location using the `OutputLocation` parameter.
|
3356
3419
|
#
|
3357
|
-
#
|
3420
|
+
# Note that the role making the request must have permission to use the
|
3421
|
+
# specified KMS key.
|
3358
3422
|
#
|
3359
3423
|
# @option params [Hash<String,String>] :kms_encryption_context
|
3360
3424
|
# A map of plain text, non-secret key:value pairs, known as encryption
|
@@ -3637,24 +3701,42 @@ module Aws::TranscribeService
|
|
3637
3701
|
# doesn't exist, one is created for you.
|
3638
3702
|
#
|
3639
3703
|
# @option params [String] :output_encryption_kms_key_id
|
3640
|
-
# The
|
3641
|
-
# encrypt your transcription output.
|
3704
|
+
# The KMS key you want to use to encrypt your transcription output.
|
3642
3705
|
#
|
3643
|
-
#
|
3644
|
-
#
|
3645
|
-
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3646
|
-
# For more information, see [ KMS key ARNs][1].
|
3706
|
+
# If using a key located in the **current** Amazon Web Services account,
|
3707
|
+
# you can specify your KMS key in one of four ways:
|
3647
3708
|
#
|
3648
|
-
#
|
3649
|
-
#
|
3709
|
+
# 1. Use the KMS key ID itself. For example,
|
3710
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3711
|
+
#
|
3712
|
+
# 2. Use an alias for the KMS key ID. For example,
|
3713
|
+
# `alias/ExampleAlias`.
|
3714
|
+
#
|
3715
|
+
# 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
3716
|
+
# example,
|
3717
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3718
|
+
#
|
3719
|
+
# 4. Use the ARN for the KMS key alias. For example,
|
3720
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
3650
3721
|
#
|
3651
|
-
#
|
3652
|
-
#
|
3653
|
-
#
|
3722
|
+
# If using a key located in a **different** Amazon Web Services account
|
3723
|
+
# than the current Amazon Web Services account, you can specify your KMS
|
3724
|
+
# key in one of two ways:
|
3654
3725
|
#
|
3726
|
+
# 1. Use the ARN for the KMS key ID. For example,
|
3727
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
3728
|
+
#
|
3729
|
+
# 2. Use the ARN for the KMS key alias. For example,
|
3730
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
3731
|
+
#
|
3732
|
+
# If you do not specify an encryption key, your output is encrypted with
|
3733
|
+
# the default Amazon S3 key (SSE-S3).
|
3655
3734
|
#
|
3735
|
+
# If you specify a KMS key to encrypt your output, you must also specify
|
3736
|
+
# an output location using the `OutputLocation` parameter.
|
3656
3737
|
#
|
3657
|
-
#
|
3738
|
+
# Note that the role making the request must have permission to use the
|
3739
|
+
# specified KMS key.
|
3658
3740
|
#
|
3659
3741
|
# @option params [Hash<String,String>] :kms_encryption_context
|
3660
3742
|
# A map of plain text, non-secret key:value pairs, known as encryption
|
@@ -4502,7 +4584,7 @@ module Aws::TranscribeService
|
|
4502
4584
|
tracer: tracer
|
4503
4585
|
)
|
4504
4586
|
context[:gem_name] = 'aws-sdk-transcribeservice'
|
4505
|
-
context[:gem_version] = '1.
|
4587
|
+
context[:gem_version] = '1.127.0'
|
4506
4588
|
Seahorse::Client::Request.new(handlers, context)
|
4507
4589
|
end
|
4508
4590
|
|
@@ -129,6 +129,7 @@ module Aws::TranscribeService
|
|
129
129
|
MedicalScribeChannelDefinition = Shapes::StructureShape.new(name: 'MedicalScribeChannelDefinition')
|
130
130
|
MedicalScribeChannelDefinitions = Shapes::ListShape.new(name: 'MedicalScribeChannelDefinitions')
|
131
131
|
MedicalScribeChannelId = Shapes::IntegerShape.new(name: 'MedicalScribeChannelId')
|
132
|
+
MedicalScribeContext = Shapes::StructureShape.new(name: 'MedicalScribeContext')
|
132
133
|
MedicalScribeJob = Shapes::StructureShape.new(name: 'MedicalScribeJob')
|
133
134
|
MedicalScribeJobStatus = Shapes::StringShape.new(name: 'MedicalScribeJobStatus')
|
134
135
|
MedicalScribeJobSummaries = Shapes::ListShape.new(name: 'MedicalScribeJobSummaries')
|
@@ -137,6 +138,7 @@ module Aws::TranscribeService
|
|
137
138
|
MedicalScribeNoteTemplate = Shapes::StringShape.new(name: 'MedicalScribeNoteTemplate')
|
138
139
|
MedicalScribeOutput = Shapes::StructureShape.new(name: 'MedicalScribeOutput')
|
139
140
|
MedicalScribeParticipantRole = Shapes::StringShape.new(name: 'MedicalScribeParticipantRole')
|
141
|
+
MedicalScribePatientContext = Shapes::StructureShape.new(name: 'MedicalScribePatientContext')
|
140
142
|
MedicalScribeSettings = Shapes::StructureShape.new(name: 'MedicalScribeSettings')
|
141
143
|
MedicalTranscript = Shapes::StructureShape.new(name: 'MedicalTranscript')
|
142
144
|
MedicalTranscriptionJob = Shapes::StructureShape.new(name: 'MedicalTranscriptionJob')
|
@@ -160,6 +162,7 @@ module Aws::TranscribeService
|
|
160
162
|
Phrases = Shapes::ListShape.new(name: 'Phrases')
|
161
163
|
PiiEntityType = Shapes::StringShape.new(name: 'PiiEntityType')
|
162
164
|
PiiEntityTypes = Shapes::ListShape.new(name: 'PiiEntityTypes')
|
165
|
+
Pronouns = Shapes::StringShape.new(name: 'Pronouns')
|
163
166
|
RedactionOutput = Shapes::StringShape.new(name: 'RedactionOutput')
|
164
167
|
RedactionType = Shapes::StringShape.new(name: 'RedactionType')
|
165
168
|
RelativeTimeRange = Shapes::StructureShape.new(name: 'RelativeTimeRange')
|
@@ -642,6 +645,9 @@ module Aws::TranscribeService
|
|
642
645
|
|
643
646
|
MedicalScribeChannelDefinitions.member = Shapes::ShapeRef.new(shape: MedicalScribeChannelDefinition)
|
644
647
|
|
648
|
+
MedicalScribeContext.add_member(:patient_context, Shapes::ShapeRef.new(shape: MedicalScribePatientContext, location_name: "PatientContext"))
|
649
|
+
MedicalScribeContext.struct_class = Types::MedicalScribeContext
|
650
|
+
|
645
651
|
MedicalScribeJob.add_member(:medical_scribe_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, location_name: "MedicalScribeJobName"))
|
646
652
|
MedicalScribeJob.add_member(:medical_scribe_job_status, Shapes::ShapeRef.new(shape: MedicalScribeJobStatus, location_name: "MedicalScribeJobStatus"))
|
647
653
|
MedicalScribeJob.add_member(:language_code, Shapes::ShapeRef.new(shape: MedicalScribeLanguageCode, location_name: "LanguageCode"))
|
@@ -654,6 +660,7 @@ module Aws::TranscribeService
|
|
654
660
|
MedicalScribeJob.add_member(:settings, Shapes::ShapeRef.new(shape: MedicalScribeSettings, location_name: "Settings"))
|
655
661
|
MedicalScribeJob.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: DataAccessRoleArn, location_name: "DataAccessRoleArn"))
|
656
662
|
MedicalScribeJob.add_member(:channel_definitions, Shapes::ShapeRef.new(shape: MedicalScribeChannelDefinitions, location_name: "ChannelDefinitions"))
|
663
|
+
MedicalScribeJob.add_member(:medical_scribe_context_provided, Shapes::ShapeRef.new(shape: Boolean, location_name: "MedicalScribeContextProvided"))
|
657
664
|
MedicalScribeJob.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
658
665
|
MedicalScribeJob.struct_class = Types::MedicalScribeJob
|
659
666
|
|
@@ -672,6 +679,9 @@ module Aws::TranscribeService
|
|
672
679
|
MedicalScribeOutput.add_member(:clinical_document_uri, Shapes::ShapeRef.new(shape: Uri, required: true, location_name: "ClinicalDocumentUri"))
|
673
680
|
MedicalScribeOutput.struct_class = Types::MedicalScribeOutput
|
674
681
|
|
682
|
+
MedicalScribePatientContext.add_member(:pronouns, Shapes::ShapeRef.new(shape: Pronouns, location_name: "Pronouns"))
|
683
|
+
MedicalScribePatientContext.struct_class = Types::MedicalScribePatientContext
|
684
|
+
|
675
685
|
MedicalScribeSettings.add_member(:show_speaker_labels, Shapes::ShapeRef.new(shape: Boolean, location_name: "ShowSpeakerLabels"))
|
676
686
|
MedicalScribeSettings.add_member(:max_speaker_labels, Shapes::ShapeRef.new(shape: MaxSpeakers, location_name: "MaxSpeakerLabels"))
|
677
687
|
MedicalScribeSettings.add_member(:channel_identification, Shapes::ShapeRef.new(shape: Boolean, location_name: "ChannelIdentification"))
|
@@ -804,6 +814,7 @@ module Aws::TranscribeService
|
|
804
814
|
StartMedicalScribeJobRequest.add_member(:settings, Shapes::ShapeRef.new(shape: MedicalScribeSettings, required: true, location_name: "Settings"))
|
805
815
|
StartMedicalScribeJobRequest.add_member(:channel_definitions, Shapes::ShapeRef.new(shape: MedicalScribeChannelDefinitions, location_name: "ChannelDefinitions"))
|
806
816
|
StartMedicalScribeJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
817
|
+
StartMedicalScribeJobRequest.add_member(:medical_scribe_context, Shapes::ShapeRef.new(shape: MedicalScribeContext, location_name: "MedicalScribeContext"))
|
807
818
|
StartMedicalScribeJobRequest.struct_class = Types::StartMedicalScribeJobRequest
|
808
819
|
|
809
820
|
StartMedicalScribeJobResponse.add_member(:medical_scribe_job, Shapes::ShapeRef.new(shape: MedicalScribeJob, location_name: "MedicalScribeJob"))
|
@@ -2824,6 +2824,21 @@ module Aws::TranscribeService
|
|
2824
2824
|
include Aws::Structure
|
2825
2825
|
end
|
2826
2826
|
|
2827
|
+
# The `MedicalScribeContext` object that contains contextual information
|
2828
|
+
# used to generate customized clinical notes.
|
2829
|
+
#
|
2830
|
+
# @!attribute [rw] patient_context
|
2831
|
+
# Contains patient-specific information.
|
2832
|
+
# @return [Types::MedicalScribePatientContext]
|
2833
|
+
#
|
2834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalScribeContext AWS API Documentation
|
2835
|
+
#
|
2836
|
+
class MedicalScribeContext < Struct.new(
|
2837
|
+
:patient_context)
|
2838
|
+
SENSITIVE = []
|
2839
|
+
include Aws::Structure
|
2840
|
+
end
|
2841
|
+
|
2827
2842
|
# Provides detailed information about a Medical Scribe job.
|
2828
2843
|
#
|
2829
2844
|
# To view the status of the specified Medical Scribe job, check the
|
@@ -2951,9 +2966,14 @@ module Aws::TranscribeService
|
|
2951
2966
|
# speaking).
|
2952
2967
|
# @return [Array<Types::MedicalScribeChannelDefinition>]
|
2953
2968
|
#
|
2969
|
+
# @!attribute [rw] medical_scribe_context_provided
|
2970
|
+
# Indicates whether the `MedicalScribeContext` object was provided
|
2971
|
+
# when the Medical Scribe job was started.
|
2972
|
+
# @return [Boolean]
|
2973
|
+
#
|
2954
2974
|
# @!attribute [rw] tags
|
2955
2975
|
# Adds one or more custom tags, each in the form of a key:value pair,
|
2956
|
-
# to the
|
2976
|
+
# to the Medical Scribe job.
|
2957
2977
|
#
|
2958
2978
|
# To learn more about using tags with Amazon Transcribe, refer to
|
2959
2979
|
# [Tagging resources][1].
|
@@ -2978,6 +2998,7 @@ module Aws::TranscribeService
|
|
2978
2998
|
:settings,
|
2979
2999
|
:data_access_role_arn,
|
2980
3000
|
:channel_definitions,
|
3001
|
+
:medical_scribe_context_provided,
|
2981
3002
|
:tags)
|
2982
3003
|
SENSITIVE = []
|
2983
3004
|
include Aws::Structure
|
@@ -3076,6 +3097,22 @@ module Aws::TranscribeService
|
|
3076
3097
|
include Aws::Structure
|
3077
3098
|
end
|
3078
3099
|
|
3100
|
+
# Contains patient-specific information used to customize the clinical
|
3101
|
+
# note generation.
|
3102
|
+
#
|
3103
|
+
# @!attribute [rw] pronouns
|
3104
|
+
# The patient's preferred pronouns that the user wants to provide as
|
3105
|
+
# a context for clinical note generation.
|
3106
|
+
# @return [String]
|
3107
|
+
#
|
3108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalScribePatientContext AWS API Documentation
|
3109
|
+
#
|
3110
|
+
class MedicalScribePatientContext < Struct.new(
|
3111
|
+
:pronouns)
|
3112
|
+
SENSITIVE = [:pronouns]
|
3113
|
+
include Aws::Structure
|
3114
|
+
end
|
3115
|
+
|
3079
3116
|
# Makes it possible to control how your Medical Scribe job is processed
|
3080
3117
|
# using a `MedicalScribeSettings` object. Specify
|
3081
3118
|
# `ChannelIdentification` if `ChannelDefinitions` are set. Enabled
|
@@ -4022,24 +4059,42 @@ module Aws::TranscribeService
|
|
4022
4059
|
# @return [String]
|
4023
4060
|
#
|
4024
4061
|
# @!attribute [rw] output_encryption_kms_key_id
|
4025
|
-
# The
|
4026
|
-
# encrypt your Call Analytics output.
|
4062
|
+
# The KMS key you want to use to encrypt your Call Analytics output.
|
4027
4063
|
#
|
4028
|
-
#
|
4029
|
-
#
|
4030
|
-
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4031
|
-
# For more information, see [ KMS key ARNs][1].
|
4064
|
+
# If using a key located in the **current** Amazon Web Services
|
4065
|
+
# account, you can specify your KMS key in one of four ways:
|
4032
4066
|
#
|
4033
|
-
#
|
4034
|
-
#
|
4067
|
+
# 1. Use the KMS key ID itself. For example,
|
4068
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4069
|
+
#
|
4070
|
+
# 2. Use an alias for the KMS key ID. For example,
|
4071
|
+
# `alias/ExampleAlias`.
|
4072
|
+
#
|
4073
|
+
# 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
4074
|
+
# example,
|
4075
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4076
|
+
#
|
4077
|
+
# 4. Use the ARN for the KMS key alias. For example,
|
4078
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
4035
4079
|
#
|
4036
|
-
#
|
4037
|
-
#
|
4038
|
-
#
|
4080
|
+
# If using a key located in a **different** Amazon Web Services
|
4081
|
+
# account than the current Amazon Web Services account, you can
|
4082
|
+
# specify your KMS key in one of two ways:
|
4039
4083
|
#
|
4084
|
+
# 1. Use the ARN for the KMS key ID. For example,
|
4085
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4040
4086
|
#
|
4087
|
+
# 2. Use the ARN for the KMS key alias. For example,
|
4088
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
4041
4089
|
#
|
4042
|
-
#
|
4090
|
+
# If you do not specify an encryption key, your output is encrypted
|
4091
|
+
# with the default Amazon S3 key (SSE-S3).
|
4092
|
+
#
|
4093
|
+
# If you specify a KMS key to encrypt your output, you must also
|
4094
|
+
# specify an output location using the `OutputLocation` parameter.
|
4095
|
+
#
|
4096
|
+
# Note that the role making the request must have permission to use
|
4097
|
+
# the specified KMS key.
|
4043
4098
|
# @return [String]
|
4044
4099
|
#
|
4045
4100
|
# @!attribute [rw] data_access_role_arn
|
@@ -4154,24 +4209,39 @@ module Aws::TranscribeService
|
|
4154
4209
|
# @return [String]
|
4155
4210
|
#
|
4156
4211
|
# @!attribute [rw] output_encryption_kms_key_id
|
4157
|
-
# The
|
4158
|
-
# encrypt your Medical Scribe output.
|
4212
|
+
# The KMS key you want to use to encrypt your Medical Scribe output.
|
4159
4213
|
#
|
4160
|
-
#
|
4161
|
-
#
|
4162
|
-
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4163
|
-
# For more information, see [ KMS key ARNs][1].
|
4214
|
+
# If using a key located in the **current** Amazon Web Services
|
4215
|
+
# account, you can specify your KMS key in one of four ways:
|
4164
4216
|
#
|
4165
|
-
#
|
4166
|
-
#
|
4217
|
+
# 1. Use the KMS key ID itself. For example,
|
4218
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4219
|
+
#
|
4220
|
+
# 2. Use an alias for the KMS key ID. For example,
|
4221
|
+
# `alias/ExampleAlias`.
|
4167
4222
|
#
|
4168
|
-
#
|
4169
|
-
#
|
4170
|
-
#
|
4223
|
+
# 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
4224
|
+
# example,
|
4225
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4171
4226
|
#
|
4227
|
+
# 4. Use the ARN for the KMS key alias. For example,
|
4228
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
4172
4229
|
#
|
4230
|
+
# If using a key located in a **different** Amazon Web Services
|
4231
|
+
# account than the current Amazon Web Services account, you can
|
4232
|
+
# specify your KMS key in one of two ways:
|
4173
4233
|
#
|
4174
|
-
#
|
4234
|
+
# 1. Use the ARN for the KMS key ID. For example,
|
4235
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4236
|
+
#
|
4237
|
+
# 2. Use the ARN for the KMS key alias. For example,
|
4238
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
4239
|
+
#
|
4240
|
+
# If you do not specify an encryption key, your output is encrypted
|
4241
|
+
# with the default Amazon S3 key (SSE-S3).
|
4242
|
+
#
|
4243
|
+
# Note that the role specified in the `DataAccessRoleArn` request
|
4244
|
+
# parameter must have permission to use the specified KMS key.
|
4175
4245
|
# @return [String]
|
4176
4246
|
#
|
4177
4247
|
# @!attribute [rw] kms_encryption_context
|
@@ -4232,7 +4302,7 @@ module Aws::TranscribeService
|
|
4232
4302
|
#
|
4233
4303
|
# @!attribute [rw] tags
|
4234
4304
|
# Adds one or more custom tags, each in the form of a key:value pair,
|
4235
|
-
# to the
|
4305
|
+
# to the Medical Scribe job.
|
4236
4306
|
#
|
4237
4307
|
# To learn more about using tags with Amazon Transcribe, refer to
|
4238
4308
|
# [Tagging resources][1].
|
@@ -4242,6 +4312,12 @@ module Aws::TranscribeService
|
|
4242
4312
|
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
|
4243
4313
|
# @return [Array<Types::Tag>]
|
4244
4314
|
#
|
4315
|
+
# @!attribute [rw] medical_scribe_context
|
4316
|
+
# The `MedicalScribeContext` object that contains contextual
|
4317
|
+
# information which is used during clinical note generation to add
|
4318
|
+
# relevant context to the note.
|
4319
|
+
# @return [Types::MedicalScribeContext]
|
4320
|
+
#
|
4245
4321
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalScribeJobRequest AWS API Documentation
|
4246
4322
|
#
|
4247
4323
|
class StartMedicalScribeJobRequest < Struct.new(
|
@@ -4253,7 +4329,8 @@ module Aws::TranscribeService
|
|
4253
4329
|
:data_access_role_arn,
|
4254
4330
|
:settings,
|
4255
4331
|
:channel_definitions,
|
4256
|
-
:tags
|
4332
|
+
:tags,
|
4333
|
+
:medical_scribe_context)
|
4257
4334
|
SENSITIVE = []
|
4258
4335
|
include Aws::Structure
|
4259
4336
|
end
|
@@ -4381,24 +4458,43 @@ module Aws::TranscribeService
|
|
4381
4458
|
# @return [String]
|
4382
4459
|
#
|
4383
4460
|
# @!attribute [rw] output_encryption_kms_key_id
|
4384
|
-
# The
|
4385
|
-
#
|
4461
|
+
# The KMS key you want to use to encrypt your medical transcription
|
4462
|
+
# output.
|
4386
4463
|
#
|
4387
|
-
#
|
4388
|
-
#
|
4389
|
-
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4390
|
-
# For more information, see [ KMS key ARNs][1].
|
4464
|
+
# If using a key located in the **current** Amazon Web Services
|
4465
|
+
# account, you can specify your KMS key in one of four ways:
|
4391
4466
|
#
|
4392
|
-
#
|
4393
|
-
#
|
4467
|
+
# 1. Use the KMS key ID itself. For example,
|
4468
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4469
|
+
#
|
4470
|
+
# 2. Use an alias for the KMS key ID. For example,
|
4471
|
+
# `alias/ExampleAlias`.
|
4472
|
+
#
|
4473
|
+
# 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
4474
|
+
# example,
|
4475
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4476
|
+
#
|
4477
|
+
# 4. Use the ARN for the KMS key alias. For example,
|
4478
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
4394
4479
|
#
|
4395
|
-
#
|
4396
|
-
#
|
4397
|
-
#
|
4480
|
+
# If using a key located in a **different** Amazon Web Services
|
4481
|
+
# account than the current Amazon Web Services account, you can
|
4482
|
+
# specify your KMS key in one of two ways:
|
4398
4483
|
#
|
4484
|
+
# 1. Use the ARN for the KMS key ID. For example,
|
4485
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4399
4486
|
#
|
4487
|
+
# 2. Use the ARN for the KMS key alias. For example,
|
4488
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
4400
4489
|
#
|
4401
|
-
#
|
4490
|
+
# If you do not specify an encryption key, your output is encrypted
|
4491
|
+
# with the default Amazon S3 key (SSE-S3).
|
4492
|
+
#
|
4493
|
+
# If you specify a KMS key to encrypt your output, you must also
|
4494
|
+
# specify an output location using the `OutputLocation` parameter.
|
4495
|
+
#
|
4496
|
+
# Note that the role making the request must have permission to use
|
4497
|
+
# the specified KMS key.
|
4402
4498
|
# @return [String]
|
4403
4499
|
#
|
4404
4500
|
# @!attribute [rw] kms_encryption_context
|
@@ -4622,24 +4718,42 @@ module Aws::TranscribeService
|
|
4622
4718
|
# @return [String]
|
4623
4719
|
#
|
4624
4720
|
# @!attribute [rw] output_encryption_kms_key_id
|
4625
|
-
# The
|
4626
|
-
# encrypt your transcription output.
|
4721
|
+
# The KMS key you want to use to encrypt your transcription output.
|
4627
4722
|
#
|
4628
|
-
#
|
4629
|
-
#
|
4630
|
-
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4631
|
-
# For more information, see [ KMS key ARNs][1].
|
4723
|
+
# If using a key located in the **current** Amazon Web Services
|
4724
|
+
# account, you can specify your KMS key in one of four ways:
|
4632
4725
|
#
|
4633
|
-
#
|
4634
|
-
#
|
4726
|
+
# 1. Use the KMS key ID itself. For example,
|
4727
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4728
|
+
#
|
4729
|
+
# 2. Use an alias for the KMS key ID. For example,
|
4730
|
+
# `alias/ExampleAlias`.
|
4635
4731
|
#
|
4636
|
-
#
|
4637
|
-
#
|
4638
|
-
#
|
4732
|
+
# 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
4733
|
+
# example,
|
4734
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4639
4735
|
#
|
4736
|
+
# 4. Use the ARN for the KMS key alias. For example,
|
4737
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
4738
|
+
#
|
4739
|
+
# If using a key located in a **different** Amazon Web Services
|
4740
|
+
# account than the current Amazon Web Services account, you can
|
4741
|
+
# specify your KMS key in one of two ways:
|
4742
|
+
#
|
4743
|
+
# 1. Use the ARN for the KMS key ID. For example,
|
4744
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
4745
|
+
#
|
4746
|
+
# 2. Use the ARN for the KMS key alias. For example,
|
4747
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
4748
|
+
#
|
4749
|
+
# If you do not specify an encryption key, your output is encrypted
|
4750
|
+
# with the default Amazon S3 key (SSE-S3).
|
4640
4751
|
#
|
4752
|
+
# If you specify a KMS key to encrypt your output, you must also
|
4753
|
+
# specify an output location using the `OutputLocation` parameter.
|
4641
4754
|
#
|
4642
|
-
#
|
4755
|
+
# Note that the role making the request must have permission to use
|
4756
|
+
# the specified KMS key.
|
4643
4757
|
# @return [String]
|
4644
4758
|
#
|
4645
4759
|
# @!attribute [rw] kms_encryption_context
|
data/sig/client.rbs
CHANGED
@@ -652,7 +652,12 @@ module Aws
|
|
652
652
|
key: ::String,
|
653
653
|
value: ::String
|
654
654
|
},
|
655
|
-
]
|
655
|
+
],
|
656
|
+
?medical_scribe_context: {
|
657
|
+
patient_context: {
|
658
|
+
pronouns: ("HE_HIM" | "SHE_HER" | "THEY_THEM")?
|
659
|
+
}?
|
660
|
+
}
|
656
661
|
) -> _StartMedicalScribeJobResponseSuccess
|
657
662
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartMedicalScribeJobResponseSuccess
|
658
663
|
|
data/sig/types.rbs
CHANGED
@@ -559,6 +559,11 @@ module Aws::TranscribeService
|
|
559
559
|
SENSITIVE: []
|
560
560
|
end
|
561
561
|
|
562
|
+
class MedicalScribeContext
|
563
|
+
attr_accessor patient_context: Types::MedicalScribePatientContext
|
564
|
+
SENSITIVE: []
|
565
|
+
end
|
566
|
+
|
562
567
|
class MedicalScribeJob
|
563
568
|
attr_accessor medical_scribe_job_name: ::String
|
564
569
|
attr_accessor medical_scribe_job_status: ("QUEUED" | "IN_PROGRESS" | "FAILED" | "COMPLETED")
|
@@ -572,6 +577,7 @@ module Aws::TranscribeService
|
|
572
577
|
attr_accessor settings: Types::MedicalScribeSettings
|
573
578
|
attr_accessor data_access_role_arn: ::String
|
574
579
|
attr_accessor channel_definitions: ::Array[Types::MedicalScribeChannelDefinition]
|
580
|
+
attr_accessor medical_scribe_context_provided: bool
|
575
581
|
attr_accessor tags: ::Array[Types::Tag]
|
576
582
|
SENSITIVE: []
|
577
583
|
end
|
@@ -593,6 +599,11 @@ module Aws::TranscribeService
|
|
593
599
|
SENSITIVE: []
|
594
600
|
end
|
595
601
|
|
602
|
+
class MedicalScribePatientContext
|
603
|
+
attr_accessor pronouns: ("HE_HIM" | "SHE_HER" | "THEY_THEM")
|
604
|
+
SENSITIVE: [:pronouns]
|
605
|
+
end
|
606
|
+
|
596
607
|
class MedicalScribeSettings
|
597
608
|
attr_accessor show_speaker_labels: bool
|
598
609
|
attr_accessor max_speaker_labels: ::Integer
|
@@ -748,6 +759,7 @@ module Aws::TranscribeService
|
|
748
759
|
attr_accessor settings: Types::MedicalScribeSettings
|
749
760
|
attr_accessor channel_definitions: ::Array[Types::MedicalScribeChannelDefinition]
|
750
761
|
attr_accessor tags: ::Array[Types::Tag]
|
762
|
+
attr_accessor medical_scribe_context: Types::MedicalScribeContext
|
751
763
|
SENSITIVE: []
|
752
764
|
end
|
753
765
|
|