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

Interface StartMedicalScribeJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartMedicalScribeJobRequest.Builder,StartMedicalScribeJobRequest>, SdkBuilder<StartMedicalScribeJobRequest.Builder,StartMedicalScribeJobRequest>, SdkPojo, SdkRequest.Builder, TranscribeRequest.Builder
Enclosing class:
StartMedicalScribeJobRequest
public static interface StartMedicalScribeJobRequest.Builder extends TranscribeRequest.Builder, SdkPojo, CopyableBuilder<StartMedicalScribeJobRequest.Builder,StartMedicalScribeJobRequest>

  • Method Details

    • medicalScribeJobName

      StartMedicalScribeJobRequest.Builder medicalScribeJobName(String medicalScribeJobName)

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

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

      Parameters:
      medicalScribeJobName - A unique name, chosen by you, for your Medical Scribe job.

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

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

    • media

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

    • media

      default StartMedicalScribeJobRequest.Builder media(Consumer<Media.Builder> media)
      Sets the value of the Media property for this object. This is a convenience method that creates an instance of the Media.Builder avoiding the need to create one manually via Media.builder().

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

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

    • outputBucketName

      StartMedicalScribeJobRequest.Builder outputBucketName(String outputBucketName)

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

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

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

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

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

    • outputEncryptionKMSKeyId

      StartMedicalScribeJobRequest.Builder outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)

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

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

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

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

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

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

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

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

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

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

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

      Parameters:
      outputEncryptionKMSKeyId - The KMS key you want to use to encrypt your Medical Scribe output.

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

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

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

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

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

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

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

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

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

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

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

    • kmsEncryptionContext

      StartMedicalScribeJobRequest.Builder kmsEncryptionContext(Map<String,String> kmsEncryptionContext)

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

      Parameters:
      kmsEncryptionContext - A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataAccessRoleArn

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

    • settings

      StartMedicalScribeJobRequest.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 StartMedicalScribeJobRequest.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:

    • channelDefinitions

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

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

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

      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:

    • tags

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

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

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

      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:

    • overrideConfiguration

      StartMedicalScribeJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartMedicalScribeJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.