-CallAnalyticsJobName <
String>
A unique name, chosen by you, for your Call Analytics 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.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Allows you to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId
to 0
(to indicate the first channel) and ParticipantRole
to AGENT
(to indicate that it's the agent speaking).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ChannelDefinitions |
-ContentRedaction_PiiEntityType <
String[]>
Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL
.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Settings_ContentRedaction_PiiEntityTypes |
Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.When you choose redacted
Amazon Transcribe creates only a redacted transcript.When you choose redacted_and_unredacted
Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Settings_ContentRedaction_RedactionOutput |
Specify the category of information you want to redact; PII
(personally identifiable information) is the only valid value. You can use PiiEntityTypes
to choose which types of PII you want to redact.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Settings_ContentRedaction_RedactionType |
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, 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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The Amazon S3 location of the media file you want to transcribe. For example:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-Media_RedactedMediaFileUri <
String>
The Amazon S3 location of the media file you want to redact. For example:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.
RedactedMediaFileUri
is only supported for Call Analytics (StartCallAnalyticsJob
) transcription requests. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-OutputEncryptionKMSKeyId <
String>
The KMS key you want to use to encrypt your Call Analytics output.If using a key located in the
current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab
. - Use an alias for the KMS key ID. For example,
alias/ExampleAlias
. - 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
. - 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:
- Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab
. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias
.
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).If you specify a KMS key to encrypt your output, you must also specify an output location using the
OutputLocation
parameter.Note that the user making the request must have permission to use the specified KMS key.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:
- s3://DOC-EXAMPLE-BUCKET
- s3://DOC-EXAMPLE-BUCKET/my-output-folder/
- s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the
CallAnalyticsJobName
parameter.You can specify a KMS key to encrypt your output using the
OutputEncryptionKMSKeyId
parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.If you don't specify
OutputLocation
, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the CallAnalyticsJobName parameter. The -PassThru parameter is deprecated, use -Select '^CallAnalyticsJobName' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is 'CallAnalyticsJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.StartCallAnalyticsJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.StartCallAnalyticsJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
If using automatic language identification (IdentifyLanguage
) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings
with the relevant sub-parameters (VocabularyName
, LanguageModelName
, and VocabularyFilterName
).You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.To include language options using IdentifyLanguage
without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions
instead of LanguageIdSettings
. Including language options can improve the accuracy of automatic language identification.If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the
parameter with the LanguageModelName
sub-parameter.If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the
parameter with the VocabularyName
or VocabularyFilterName
(or both) sub-parameter.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Settings_LanguageIdSettings |
-Settings_LanguageModelName <
String>
The name of the custom language model you want to use when processing your Call Analytics job. Note that language model names are case sensitive.The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.Including language options can improve the accuracy of language identification.For a list of languages supported with Call Analytics, refer to the
Supported languages table.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Settings_LanguageOptions |
Specify how you want your vocabulary filter applied to your transcript.To replace words with ***
, choose mask
.To delete words, choose remove
.To flag words without changing them, choose tag
.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-Settings_VocabularyFilterName <
String>
The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Vocabulary filter names are case sensitive.Note that if you include VocabularyFilterName
in your request, you must also include VocabularyFilterMethod
.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-Settings_VocabularyName <
String>
The name of the custom vocabulary you want to include in your Call Analytics transcription request. Vocabulary names are case sensitive.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |