AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Transcribe Service StartCallAnalyticsJob API operation.

Syntax

Start-TRSCallAnalyticsJob
-CallAnalyticsJobName <String>
-ChannelDefinition <ChannelDefinition[]>
-DataAccessRoleArn <String>
-Summarization_GenerateAbstractiveSummary <Boolean>
-Settings_LanguageIdSetting <Hashtable>
-Settings_LanguageModelName <String>
-Settings_LanguageOption <String[]>
-Media_MediaFileUri <String>
-OutputEncryptionKMSKeyId <String>
-OutputLocation <String>
-ContentRedaction_PiiEntityType <String[]>
-Media_RedactedMediaFileUri <String>
-ContentRedaction_RedactionOutput <RedactionOutput>
-ContentRedaction_RedactionType <RedactionType>
-Tag <Tag[]>
-Settings_VocabularyFilterMethod <VocabularyFilterMethod>
-Settings_VocabularyFilterName <String>
-Settings_VocabularyName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonTranscribeServiceConfig>

Description

Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request. In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics. If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. Job queuing is available for Call Analytics jobs. If you pass a DataAccessRoleArn in your request and you exceed your Concurrent Job Limit, your job will automatically be added to a queue to be processed once your concurrent job count is below the limit. You must include the following parameters in your StartCallAnalyticsJob request:
  • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
  • CallAnalyticsJobName: A custom name that you create for your transcription job that's unique within your Amazon Web Services account.
  • Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media file.
With Call Analytics, you can redact the audio contained in your media file by including RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the RedactedMediaFileUri field of your response.

Parameters

-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)
-ChannelDefinition <ChannelDefinition[]>
Makes it possible 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)
AliasesChannelDefinitions
-ClientConfig <AmazonTranscribeServiceConfig>
Amazon.PowerShell.Cmdlets.TRS.AmazonTranscribeServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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. If you do not include PiiEntityTypes in your request, all PII is redacted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_ContentRedaction_PiiEntityTypes
-ContentRedaction_RedactionOutput <RedactionOutput>
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)
AliasesSettings_ContentRedaction_RedactionOutput
-ContentRedaction_RedactionType <RedactionType>
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. If you do not include PiiEntityTypes in your request, all PII is redacted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_ContentRedaction_RedactionType
-DataAccessRoleArn <String>
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 that 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)
-Force <SwitchParameter>
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)
-Media_MediaFileUri <String>
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 produces a redacted audio file in addition to a redacted transcript. It 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:
  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).If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.Note that the role making the request must have permission to use the specified KMS key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputLocation <String>
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:
  1. s3://DOC-EXAMPLE-BUCKET
  2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/
  3. 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 do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.If you do not 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)
-PassThru <SwitchParameter>
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)
-Select <String>
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)
-Settings_LanguageIdSetting <Hashtable>
If using automatic language identification 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).LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_LanguageIdSettings
-Settings_LanguageModelName <String>
The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom 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)
-Settings_LanguageOption <String[]>
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.To transcribe speech in Modern Standard Arabic (ar-SA) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file must be encoded at a sample rate of 16,000 Hz or higher.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_LanguageOptions
-Settings_VocabularyFilterMethod <VocabularyFilterMethod>
Specify how you want your custom 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. Custom 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. Custom vocabulary names are case sensitive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Summarization_GenerateAbstractiveSummary <Boolean>
Enables Generative call summarization in your Call Analytics requestGenerative call summarization provides a summary of the transcript including important components discussed in the conversation.For more information, see Enabling generative call summarization.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_Summarization_GenerateAbstractiveSummary
-Tag <Tag[]>
Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics job at the time you start this new job.To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.TranscribeService.Model.CallAnalyticsJob or Amazon.TranscribeService.Model.StartCallAnalyticsJobResponse
This cmdlet returns an Amazon.TranscribeService.Model.CallAnalyticsJob object. The service call response (type Amazon.TranscribeService.Model.StartCallAnalyticsJobResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z