Package software.amazon.awssdk.services.transcribe.model

Interface MedicalScribeJob.Builder

    • Method Detail

      • medicalScribeJobName

        MedicalScribeJob.Builder medicalScribeJobName​(String medicalScribeJobName)

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

        Parameters:
        medicalScribeJobName - The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • medicalScribeJobStatus

        MedicalScribeJob.Builder medicalScribeJobStatus​(String medicalScribeJobStatus)

        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.

        Parameters:
        medicalScribeJobStatus - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MedicalScribeJobStatus, MedicalScribeJobStatus

      • medicalScribeJobStatus

        MedicalScribeJob.Builder medicalScribeJobStatus​(MedicalScribeJobStatus medicalScribeJobStatus)

        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.

        Parameters:
        medicalScribeJobStatus - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MedicalScribeJobStatus, MedicalScribeJobStatus

      • languageCode

        MedicalScribeJob.Builder languageCode​(String languageCode)

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

        Parameters:
        languageCode - The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MedicalScribeLanguageCode, MedicalScribeLanguageCode

      • languageCode

        MedicalScribeJob.Builder languageCode​(MedicalScribeLanguageCode languageCode)

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

        Parameters:
        languageCode - The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MedicalScribeLanguageCode, MedicalScribeLanguageCode

      • media

        MedicalScribeJob.Builder media​(Media media)
        Sets the value of the Media property for this object.
        Parameters:
        media - The new value for the Media property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • medicalScribeOutput

        MedicalScribeJob.Builder medicalScribeOutput​(MedicalScribeOutput medicalScribeOutput)

        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.

        Parameters:
        medicalScribeOutput - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        MedicalScribeJob.Builder startTime​(Instant startTime)

        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.

        Parameters:
        startTime - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTime

        MedicalScribeJob.Builder creationTime​(Instant creationTime)

        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.

        Parameters:
        creationTime - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • completionTime

        MedicalScribeJob.Builder completionTime​(Instant completionTime)

        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.

        Parameters:
        completionTime - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureReason

        MedicalScribeJob.Builder failureReason​(String failureReason)

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

        Parameters:
        failureReason - If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • settings

        MedicalScribeJob.Builder settings​(MedicalScribeSettings settings)

        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.

        Parameters:
        settings - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • settings

        default MedicalScribeJob.Builder settings​(Consumer<MedicalScribeSettings.Builder> settings)

        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.

        This is a convenience method that creates an instance of the MedicalScribeSettings.Builder avoiding the need to create one manually via MedicalScribeSettings.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(MedicalScribeSettings).

        Parameters:
        settings - a consumer that will call methods on MedicalScribeSettings.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        settings(MedicalScribeSettings)

      • dataAccessRoleArn

        MedicalScribeJob.Builder dataAccessRoleArn​(String dataAccessRoleArn)

        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.

        Parameters:
        dataAccessRoleArn - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • channelDefinitions

        MedicalScribeJob.Builder channelDefinitions​(Collection<MedicalScribeChannelDefinition> channelDefinitions)

        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).

        Parameters:
        channelDefinitions - 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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • channelDefinitions

        MedicalScribeJob.Builder channelDefinitions​(MedicalScribeChannelDefinition... channelDefinitions)

        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).

        Parameters:
        channelDefinitions - 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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • channelDefinitions

        MedicalScribeJob.Builder channelDefinitions​(Consumer<MedicalScribeChannelDefinition.Builder>... channelDefinitions)

        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).

        This is a convenience method that creates an instance of the MedicalScribeChannelDefinition.Builder avoiding the need to create one manually via MedicalScribeChannelDefinition.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #channelDefinitions(List).

        Parameters:
        channelDefinitions - a consumer that will call methods on MedicalScribeChannelDefinition.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #channelDefinitions(java.util.Collection)

      • tags

        MedicalScribeJob.Builder tags​(Collection<Tag> tags)

        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.

        Parameters:
        tags - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        MedicalScribeJob.Builder tags​(Tag... tags)

        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.

        Parameters:
        tags - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        MedicalScribeJob.Builder tags​(Consumer<Tag.Builder>... tags)

        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.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)