aws-sdk-transcribestreamingservice 1.85.0 → 1.87.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2af23c742fde5c34f954ebfb0036d4664e5d14ba53e8c2d58ae5eddea8659205
-  data.tar.gz: 8b42d5d54f53c1201be1ec81c3717a2bdcbe576141e1a47ee619211d7d6f0d0c
+  metadata.gz: b53ce981f52482ea0c5120239ca0a0e6fa776132db5161f9f22a7883d6b91744
+  data.tar.gz: bb5ac8004ed5aa286bed41b4e566d06321c641017d70c216ca8346facd58e6dd
 SHA512:
-  metadata.gz: 562139c951f7e38180869ad075716283dfaba2152b98863c506684860ae8e1e1b6b568baec4365f086206a905e81384271d5e1e8c3c2b0616e818603f4ac784e
-  data.tar.gz: 90dd56045031cd678927eec80a5bd94bd7618ad2e2bb3615f63a4c7ea7806ca50510fb1466b0de36c596ae63c6d3e4d54069acca6502aacf9d45aecee0427211
+  metadata.gz: 1799f32001b29aac990bf66fb780177386ccb1c534f29dbdc34923b92b454301b14a87a73ffa8dbd8faacda85dc7d3a5171ea70bd8dd54335fdbef91b866c326
+  data.tar.gz: 6eb08c1e8151855920e4e3e3a6157d9f120674b327987b425f166a25e7ca1a230d3be952f0b0f0e3f1b135fe22c46b7be419e4a65634e4cdb4a2234f1dc70945

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.87.0 (2025-08-12)
+------------------
+
+* Feature - AWS HealthScribe now supports specifying preferred patient pronouns through the MedicalScribeContext parameter for use in the generated clinical notes.
+
+1.86.0 (2025-08-04)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.85.0 (2025-07-31)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.85.0
+1.87.0

data/lib/aws-sdk-transcribestreamingservice/async_client.rb

@@ -88,8 +88,8 @@ module Aws::TranscribeStreamingService
     #     class name or an instance of a plugin class.
     #
     #   @option options [required, Aws::CredentialProvider] :credentials
-    #     Your AWS credentials used for authentication. This can be an instance of any one of the
-    #     following classes:
+    #     Your AWS credentials used for authentication. This can be any class that includes and implements
+    #     `Aws::CredentialProvider`, or instance of any one of the following classes:
     #
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
@@ -117,8 +117,7 @@ module Aws::TranscribeStreamingService
     #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
     #       from the Cognito Identity service.
     #
-    #     When `:credentials` are not configured directly, the following
-    #     locations will be searched for credentials:
+    #     When `:credentials` are not configured directly, the following locations will be searched for credentials:
     #
     #     * `Aws.config[:credentials]`
     #
@@ -132,12 +131,10 @@ module Aws::TranscribeStreamingService
     #
     #     * `~/.aws/config`
     #
-    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
-    #       are very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
-    #       enable retries and extended timeouts. Instance profile credential
-    #       fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
-    #       to `true`.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
+    #       Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts. Instance profile credential fetching can be disabled by
+    #       setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -337,8 +334,8 @@ module Aws::TranscribeStreamingService
     #     `Aws::Telemetry::OTelProvider` for telemetry provider.
     #
     #   @option options [Aws::TokenProvider] :token_provider
-    #     Your Bearer token used for authentication. This can be an instance of any one of the
-    #     following classes:
+    #     Your Bearer token used for authentication. This can be any class that includes and implements
+    #     `Aws::TokenProvider`, or instance of any one of the following classes:
     #
     #     * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
     #       tokens.
@@ -859,12 +856,12 @@ module Aws::TranscribeStreamingService
     #
     # When you start a stream, you first specify the stream configuration in
     # a `MedicalScribeConfigurationEvent`. This event includes channel
-    # definitions, encryption settings, and post-stream analytics settings,
-    # such as the output configuration for aggregated transcript and
-    # clinical note generation. These are additional streaming session
-    # configurations beyond those provided in your initial start request
-    # headers. Whether you are starting a new session or resuming an
-    # existing session, your first event must be a
+    # definitions, encryption settings, medical scribe context, and
+    # post-stream analytics settings, such as the output configuration for
+    # aggregated transcript and clinical note generation. These are
+    # additional streaming session configurations beyond those provided in
+    # your initial start request headers. Whether you are starting a new
+    # session or resuming an existing session, your first event must be a
     # `MedicalScribeConfigurationEvent`.
     #
     # After you send a `MedicalScribeConfigurationEvent`, you start
@@ -2093,7 +2090,7 @@ module Aws::TranscribeStreamingService
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-transcribestreamingservice'
-      context[:gem_version] = '1.85.0'
+      context[:gem_version] = '1.87.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-transcribestreamingservice/client.rb

@@ -97,8 +97,8 @@ module Aws::TranscribeStreamingService
     #     class name or an instance of a plugin class.
     #
     #   @option options [required, Aws::CredentialProvider] :credentials
-    #     Your AWS credentials used for authentication. This can be an instance of any one of the
-    #     following classes:
+    #     Your AWS credentials used for authentication. This can be any class that includes and implements
+    #     `Aws::CredentialProvider`, or instance of any one of the following classes:
     #
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
@@ -126,8 +126,7 @@ module Aws::TranscribeStreamingService
     #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
     #       from the Cognito Identity service.
     #
-    #     When `:credentials` are not configured directly, the following
-    #     locations will be searched for credentials:
+    #     When `:credentials` are not configured directly, the following locations will be searched for credentials:
     #
     #     * `Aws.config[:credentials]`
     #
@@ -141,12 +140,10 @@ module Aws::TranscribeStreamingService
     #
     #     * `~/.aws/config`
     #
-    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
-    #       are very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
-    #       enable retries and extended timeouts. Instance profile credential
-    #       fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
-    #       to `true`.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
+    #       Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts. Instance profile credential fetching can be disabled by
+    #       setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -388,8 +385,8 @@ module Aws::TranscribeStreamingService
     #     `Aws::Telemetry::OTelProvider` for telemetry provider.
     #
     #   @option options [Aws::TokenProvider] :token_provider
-    #     Your Bearer token used for authentication. This can be an instance of any one of the
-    #     following classes:
+    #     Your Bearer token used for authentication. This can be any class that includes and implements
+    #     `Aws::TokenProvider`, or instance of any one of the following classes:
     #
     #     * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
     #       tokens.
@@ -535,6 +532,7 @@ module Aws::TranscribeStreamingService
     #   resp.medical_scribe_stream_details.post_stream_analytics_result.clinical_note_generation_result.transcript_output_location #=> String
     #   resp.medical_scribe_stream_details.post_stream_analytics_result.clinical_note_generation_result.status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETED"
     #   resp.medical_scribe_stream_details.post_stream_analytics_result.clinical_note_generation_result.failure_reason #=> String
+    #   resp.medical_scribe_stream_details.medical_scribe_context_provided #=> Boolean
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/GetMedicalScribeStream AWS API Documentation
     #
@@ -563,7 +561,7 @@ module Aws::TranscribeStreamingService
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-transcribestreamingservice'
-      context[:gem_version] = '1.85.0'
+      context[:gem_version] = '1.87.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-transcribestreamingservice/client_api.rb

@@ -81,6 +81,7 @@ module Aws::TranscribeStreamingService
     MedicalScribeChannelDefinitions = Shapes::ListShape.new(name: 'MedicalScribeChannelDefinitions')
     MedicalScribeChannelId = Shapes::IntegerShape.new(name: 'MedicalScribeChannelId')
     MedicalScribeConfigurationEvent = Shapes::StructureShape.new(name: 'MedicalScribeConfigurationEvent')
+    MedicalScribeContext = Shapes::StructureShape.new(name: 'MedicalScribeContext')
     MedicalScribeEncryptionSettings = Shapes::StructureShape.new(name: 'MedicalScribeEncryptionSettings')
     MedicalScribeInputStream = Shapes::StructureShape.new(name: 'MedicalScribeInputStream')
     MedicalScribeLanguageCode = Shapes::StringShape.new(name: 'MedicalScribeLanguageCode')
@@ -88,6 +89,7 @@ module Aws::TranscribeStreamingService
     MedicalScribeMediaSampleRateHertz = Shapes::IntegerShape.new(name: 'MedicalScribeMediaSampleRateHertz')
     MedicalScribeNoteTemplate = Shapes::StringShape.new(name: 'MedicalScribeNoteTemplate')
     MedicalScribeParticipantRole = Shapes::StringShape.new(name: 'MedicalScribeParticipantRole')
+    MedicalScribePatientContext = Shapes::StructureShape.new(name: 'MedicalScribePatientContext')
     MedicalScribePostStreamAnalyticsResult = Shapes::StructureShape.new(name: 'MedicalScribePostStreamAnalyticsResult')
     MedicalScribePostStreamAnalyticsSettings = Shapes::StructureShape.new(name: 'MedicalScribePostStreamAnalyticsSettings')
     MedicalScribeResultStream = Shapes::StructureShape.new(name: 'MedicalScribeResultStream')
@@ -113,6 +115,7 @@ module Aws::TranscribeStreamingService
     PiiEntityTypes = Shapes::StringShape.new(name: 'PiiEntityTypes')
     PointsOfInterest = Shapes::StructureShape.new(name: 'PointsOfInterest')
     PostCallAnalyticsSettings = Shapes::StructureShape.new(name: 'PostCallAnalyticsSettings')
+    Pronouns = Shapes::StringShape.new(name: 'Pronouns')
     RequestId = Shapes::StringShape.new(name: 'RequestId')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     Result = Shapes::StructureShape.new(name: 'Result')
@@ -327,8 +330,12 @@ module Aws::TranscribeStreamingService
     MedicalScribeConfigurationEvent.add_member(:channel_definitions, Shapes::ShapeRef.new(shape: MedicalScribeChannelDefinitions, location_name: "ChannelDefinitions"))
     MedicalScribeConfigurationEvent.add_member(:encryption_settings, Shapes::ShapeRef.new(shape: MedicalScribeEncryptionSettings, location_name: "EncryptionSettings"))
     MedicalScribeConfigurationEvent.add_member(:post_stream_analytics_settings, Shapes::ShapeRef.new(shape: MedicalScribePostStreamAnalyticsSettings, required: true, location_name: "PostStreamAnalyticsSettings"))
+    MedicalScribeConfigurationEvent.add_member(:medical_scribe_context, Shapes::ShapeRef.new(shape: MedicalScribeContext, location_name: "MedicalScribeContext"))
     MedicalScribeConfigurationEvent.struct_class = Types::MedicalScribeConfigurationEvent
 
+    MedicalScribeContext.add_member(:patient_context, Shapes::ShapeRef.new(shape: MedicalScribePatientContext, location_name: "PatientContext"))
+    MedicalScribeContext.struct_class = Types::MedicalScribeContext
+
     MedicalScribeEncryptionSettings.add_member(:kms_encryption_context, Shapes::ShapeRef.new(shape: KMSEncryptionContextMap, location_name: "KmsEncryptionContext"))
     MedicalScribeEncryptionSettings.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KMSKeyId, required: true, location_name: "KmsKeyId"))
     MedicalScribeEncryptionSettings.struct_class = Types::MedicalScribeEncryptionSettings
@@ -338,6 +345,9 @@ module Aws::TranscribeStreamingService
     MedicalScribeInputStream.add_member(:configuration_event, Shapes::ShapeRef.new(shape: MedicalScribeConfigurationEvent, event: true, location_name: "ConfigurationEvent"))
     MedicalScribeInputStream.struct_class = Types::MedicalScribeInputStream
 
+    MedicalScribePatientContext.add_member(:pronouns, Shapes::ShapeRef.new(shape: Pronouns, location_name: "Pronouns"))
+    MedicalScribePatientContext.struct_class = Types::MedicalScribePatientContext
+
     MedicalScribePostStreamAnalyticsResult.add_member(:clinical_note_generation_result, Shapes::ShapeRef.new(shape: ClinicalNoteGenerationResult, location_name: "ClinicalNoteGenerationResult"))
     MedicalScribePostStreamAnalyticsResult.struct_class = Types::MedicalScribePostStreamAnalyticsResult
 
@@ -370,6 +380,7 @@ module Aws::TranscribeStreamingService
     MedicalScribeStreamDetails.add_member(:stream_status, Shapes::ShapeRef.new(shape: MedicalScribeStreamStatus, location_name: "StreamStatus"))
     MedicalScribeStreamDetails.add_member(:post_stream_analytics_settings, Shapes::ShapeRef.new(shape: MedicalScribePostStreamAnalyticsSettings, location_name: "PostStreamAnalyticsSettings"))
     MedicalScribeStreamDetails.add_member(:post_stream_analytics_result, Shapes::ShapeRef.new(shape: MedicalScribePostStreamAnalyticsResult, location_name: "PostStreamAnalyticsResult"))
+    MedicalScribeStreamDetails.add_member(:medical_scribe_context_provided, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "MedicalScribeContextProvided"))
     MedicalScribeStreamDetails.struct_class = Types::MedicalScribeStreamDetails
 
     MedicalScribeTranscriptEvent.add_member(:transcript_segment, Shapes::ShapeRef.new(shape: MedicalScribeTranscriptSegment, location_name: "TranscriptSegment"))

data/lib/aws-sdk-transcribestreamingservice/event_streams.rb

@@ -173,6 +173,10 @@ module Aws::TranscribeStreamingService
       # @option params [Types::MedicalScribePostStreamAnalyticsSettings] :post_stream_analytics_settings
       #   Specify settings for post-stream analytics.
       #
+      # @option params [Types::MedicalScribeContext] :medical_scribe_context
+      #   The `MedicalScribeContext` object that contains contextual information
+      #   used to generate customized clinical notes.
+      #
       def signal_configuration_event_event(params = {})
         @event_emitter.emit(:configuration_event, params)
       end

data/lib/aws-sdk-transcribestreamingservice/types.rb

@@ -947,6 +947,11 @@ module Aws::TranscribeStreamingService
     #   Specify settings for post-stream analytics.
     #   @return [Types::MedicalScribePostStreamAnalyticsSettings]
     #
+    # @!attribute [rw] medical_scribe_context
+    #   The `MedicalScribeContext` object that contains contextual
+    #   information used to generate customized clinical notes.
+    #   @return [Types::MedicalScribeContext]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeConfigurationEvent AWS API Documentation
     #
     class MedicalScribeConfigurationEvent < Struct.new(
@@ -957,11 +962,29 @@ module Aws::TranscribeStreamingService
       :channel_definitions,
       :encryption_settings,
       :post_stream_analytics_settings,
+      :medical_scribe_context,
       :event_type)
       SENSITIVE = []
       include Aws::Structure
     end
 
+    # The `MedicalScribeContext` object that contains contextual information
+    # which is used during clinical note generation to add relevant context
+    # to the note.
+    #
+    # @!attribute [rw] patient_context
+    #   Contains patient-specific information used to customize the clinical
+    #   note generation.
+    #   @return [Types::MedicalScribePatientContext]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeContext AWS API Documentation
+    #
+    class MedicalScribeContext < Struct.new(
+      :patient_context)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains encryption related settings to be used for data encryption
     # with Key Management Service, including KmsEncryptionContext and
     # KmsKeyId. The KmsKeyId is required, while KmsEncryptionContext is
@@ -1030,6 +1053,21 @@ module Aws::TranscribeStreamingService
       include Aws::Structure
     end
 
+    # Contains patient-specific information.
+    #
+    # @!attribute [rw] pronouns
+    #   The patient's preferred pronouns that the user wants to provide as
+    #   a context for clinical note generation .
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribePatientContext AWS API Documentation
+    #
+    class MedicalScribePatientContext < Struct.new(
+      :pronouns)
+      SENSITIVE = [:pronouns]
+      include Aws::Structure
+    end
+
     # Contains details for the result of post-stream analytics.
     #
     # @!attribute [rw] clinical_note_generation_result
@@ -1181,6 +1219,11 @@ module Aws::TranscribeStreamingService
     #   session.
     #   @return [Types::MedicalScribePostStreamAnalyticsResult]
     #
+    # @!attribute [rw] medical_scribe_context_provided
+    #   Indicates whether the `MedicalScribeContext` object was provided
+    #   when the stream was started.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeStreamDetails AWS API Documentation
     #
     class MedicalScribeStreamDetails < Struct.new(
@@ -1198,7 +1241,8 @@ module Aws::TranscribeStreamingService
       :encryption_settings,
       :stream_status,
       :post_stream_analytics_settings,
-      :post_stream_analytics_result)
+      :post_stream_analytics_result,
+      :medical_scribe_context_provided)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-transcribestreamingservice.rb

@@ -56,7 +56,7 @@ module Aws::TranscribeStreamingService
   autoload :AsyncClient, 'aws-sdk-transcribestreamingservice/async_client'
   autoload :EventStreams, 'aws-sdk-transcribestreamingservice/event_streams'
 
-  GEM_VERSION = '1.85.0'
+  GEM_VERSION = '1.87.0'
 
 end
 

data/sig/types.rbs

@@ -205,16 +205,27 @@ module Aws::TranscribeStreamingService
       attr_accessor channel_definitions: ::Array[Types::MedicalScribeChannelDefinition]
       attr_accessor encryption_settings: Types::MedicalScribeEncryptionSettings
       attr_accessor post_stream_analytics_settings: Types::MedicalScribePostStreamAnalyticsSettings
+      attr_accessor medical_scribe_context: Types::MedicalScribeContext
       attr_accessor event_type: untyped
       SENSITIVE: []
     end
 
+    class MedicalScribeContext
+      attr_accessor patient_context: Types::MedicalScribePatientContext
+      SENSITIVE: []
+    end
+
     class MedicalScribeEncryptionSettings
       attr_accessor kms_encryption_context: ::Hash[::String, ::String]
       attr_accessor kms_key_id: ::String
       SENSITIVE: []
     end
 
+    class MedicalScribePatientContext
+      attr_accessor pronouns: ("HE_HIM" | "SHE_HER" | "THEY_THEM")
+      SENSITIVE: [:pronouns]
+    end
+
     class MedicalScribePostStreamAnalyticsResult
       attr_accessor clinical_note_generation_result: Types::ClinicalNoteGenerationResult
       SENSITIVE: []
@@ -247,6 +258,7 @@ module Aws::TranscribeStreamingService
       attr_accessor stream_status: ("IN_PROGRESS" | "PAUSED" | "FAILED" | "COMPLETED")
       attr_accessor post_stream_analytics_settings: Types::MedicalScribePostStreamAnalyticsSettings
       attr_accessor post_stream_analytics_result: Types::MedicalScribePostStreamAnalyticsResult
+      attr_accessor medical_scribe_context_provided: bool
       SENSITIVE: []
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-transcribestreamingservice
 version: !ruby/object:Gem::Version
-  version: 1.85.0
+  version: 1.87.0
 platform: ruby
 authors:
 - Amazon Web Services