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>
-Settings_LanguageIdSetting <Hashtable>
-Settings_LanguageModelName <String>
-Settings_LanguageOption <String[]>
-Media_MediaFileUri <String>
-OutputEncryptionKMSKeyId <String>
-OutputLocation <String>
-Media_RedactedMediaFileUri <String>
-ContentRedaction_RedactionOutput <RedactionOutput>
-ContentRedaction_RedactionType <RedactionType>
-Settings_VocabularyFilterMethod <VocabularyFilterMethod>
-Settings_VocabularyFilterName <String>
-Settings_VocabularyName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.

Parameters

-CallAnalyticsJobName <String>
The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ChannelDefinition <ChannelDefinition[]>
When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChannelDefinitions
-ContentRedaction_RedactionOutput <RedactionOutput>
The output transcript file stored in either the default S3 bucket or in a bucket you specify.When you choose redacted Amazon Transcribe outputs only the redacted transcript.When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_ContentRedaction_RedactionOutput
-ContentRedaction_RedactionType <RedactionType>
Request parameter that defines the entities to be redacted. The only accepted value is PII.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_ContentRedaction_RedactionType
-DataAccessRoleArn <String>
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.
Required?True
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 S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:For example:For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Media_RedactedMediaFileUri <String>
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputEncryptionKMSKeyId <String>
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.You use either of the following to identify an Amazon Web Services KMS key in the current account:
  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
  • Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"
  • ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputLocation <String>
The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:
  • s3://DOC-EXAMPLE-BUCKET1 If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.
  • s3://DOC-EXAMPLE-BUCKET1/folder/f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.jsonIf you specify a folder, you must provide a trailing slash.
  • s3://DOC-EXAMPLE-BUCKET1/folder/filename.json If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.
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>
The language identification settings associated with your call analytics job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_LanguageIdSettings
-Settings_LanguageModelName <String>
The structure used to describe a custom language model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_LanguageOption <String[]>
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_LanguageOptions
-Settings_VocabularyFilterMethod <VocabularyFilterMethod>
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_VocabularyFilterName <String>
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_VocabularyName <String>
The name of a vocabulary to use when processing the call analytics job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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 also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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