UpdateMediaInsightsPipelineConfiguration
Updates the media insights pipeline's configuration settings.
Request Syntax
PUT /media-insights-pipeline-configurations/identifier
HTTP/1.1
Content-type: application/json
{
"Elements": [
{
"AmazonTranscribeCallAnalyticsProcessorConfiguration": {
"CallAnalyticsStreamCategories": [ "string
" ],
"ContentIdentificationType": "string
",
"ContentRedactionType": "string
",
"EnablePartialResultsStabilization": boolean
,
"FilterPartialResults": boolean
,
"LanguageCode": "string
",
"LanguageModelName": "string
",
"PartialResultsStability": "string
",
"PiiEntityTypes": "string
",
"PostCallAnalyticsSettings": {
"ContentRedactionOutput": "string
",
"DataAccessRoleArn": "string
",
"OutputEncryptionKMSKeyId": "string
",
"OutputLocation": "string
"
},
"VocabularyFilterMethod": "string
",
"VocabularyFilterName": "string
",
"VocabularyName": "string
"
},
"AmazonTranscribeProcessorConfiguration": {
"ContentIdentificationType": "string
",
"ContentRedactionType": "string
",
"EnablePartialResultsStabilization": boolean
,
"FilterPartialResults": boolean
,
"IdentifyLanguage": boolean
,
"IdentifyMultipleLanguages": boolean
,
"LanguageCode": "string
",
"LanguageModelName": "string
",
"LanguageOptions": "string
",
"PartialResultsStability": "string
",
"PiiEntityTypes": "string
",
"PreferredLanguage": "string
",
"ShowSpeakerLabel": boolean
,
"VocabularyFilterMethod": "string
",
"VocabularyFilterName": "string
",
"VocabularyFilterNames": "string
",
"VocabularyName": "string
",
"VocabularyNames": "string
"
},
"KinesisDataStreamSinkConfiguration": {
"InsightsTarget": "string
"
},
"LambdaFunctionSinkConfiguration": {
"InsightsTarget": "string
"
},
"S3RecordingSinkConfiguration": {
"Destination": "string
",
"RecordingFileFormat": "string
"
},
"SnsTopicSinkConfiguration": {
"InsightsTarget": "string
"
},
"SqsQueueSinkConfiguration": {
"InsightsTarget": "string
"
},
"Type": "string
",
"VoiceAnalyticsProcessorConfiguration": {
"SpeakerSearchStatus": "string
",
"VoiceToneAnalysisStatus": "string
"
},
"VoiceEnhancementSinkConfiguration": {
"Disabled": boolean
}
}
],
"RealTimeAlertConfiguration": {
"Disabled": boolean
,
"Rules": [
{
"IssueDetectionConfiguration": {
"RuleName": "string
"
},
"KeywordMatchConfiguration": {
"Keywords": [ "string
" ],
"Negate": boolean
,
"RuleName": "string
"
},
"SentimentConfiguration": {
"RuleName": "string
",
"SentimentType": "string
",
"TimePeriod": number
},
"Type": "string
"
}
]
},
"ResourceAccessRoleArn": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- identifier
-
The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration.
Length Constraints: Maximum length of 1024.
Pattern:
.*\S.*
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Elements
-
The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream..
Type: Array of MediaInsightsPipelineConfigurationElement objects
Required: Yes
- RealTimeAlertConfiguration
-
The configuration settings for real-time alerts for the media insights pipeline.
Type: RealTimeAlertConfiguration object
Required: No
- ResourceAccessRoleArn
-
The ARN of the role used by the service to access AWS resources.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^arn[\/\:\-\_\.a-zA-Z0-9]+$
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"MediaInsightsPipelineConfiguration": {
"CreatedTimestamp": "string",
"Elements": [
{
"AmazonTranscribeCallAnalyticsProcessorConfiguration": {
"CallAnalyticsStreamCategories": [ "string" ],
"ContentIdentificationType": "string",
"ContentRedactionType": "string",
"EnablePartialResultsStabilization": boolean,
"FilterPartialResults": boolean,
"LanguageCode": "string",
"LanguageModelName": "string",
"PartialResultsStability": "string",
"PiiEntityTypes": "string",
"PostCallAnalyticsSettings": {
"ContentRedactionOutput": "string",
"DataAccessRoleArn": "string",
"OutputEncryptionKMSKeyId": "string",
"OutputLocation": "string"
},
"VocabularyFilterMethod": "string",
"VocabularyFilterName": "string",
"VocabularyName": "string"
},
"AmazonTranscribeProcessorConfiguration": {
"ContentIdentificationType": "string",
"ContentRedactionType": "string",
"EnablePartialResultsStabilization": boolean,
"FilterPartialResults": boolean,
"IdentifyLanguage": boolean,
"IdentifyMultipleLanguages": boolean,
"LanguageCode": "string",
"LanguageModelName": "string",
"LanguageOptions": "string",
"PartialResultsStability": "string",
"PiiEntityTypes": "string",
"PreferredLanguage": "string",
"ShowSpeakerLabel": boolean,
"VocabularyFilterMethod": "string",
"VocabularyFilterName": "string",
"VocabularyFilterNames": "string",
"VocabularyName": "string",
"VocabularyNames": "string"
},
"KinesisDataStreamSinkConfiguration": {
"InsightsTarget": "string"
},
"LambdaFunctionSinkConfiguration": {
"InsightsTarget": "string"
},
"S3RecordingSinkConfiguration": {
"Destination": "string",
"RecordingFileFormat": "string"
},
"SnsTopicSinkConfiguration": {
"InsightsTarget": "string"
},
"SqsQueueSinkConfiguration": {
"InsightsTarget": "string"
},
"Type": "string",
"VoiceAnalyticsProcessorConfiguration": {
"SpeakerSearchStatus": "string",
"VoiceToneAnalysisStatus": "string"
},
"VoiceEnhancementSinkConfiguration": {
"Disabled": boolean
}
}
],
"MediaInsightsPipelineConfigurationArn": "string",
"MediaInsightsPipelineConfigurationId": "string",
"MediaInsightsPipelineConfigurationName": "string",
"RealTimeAlertConfiguration": {
"Disabled": boolean,
"Rules": [
{
"IssueDetectionConfiguration": {
"RuleName": "string"
},
"KeywordMatchConfiguration": {
"Keywords": [ "string" ],
"Negate": boolean,
"RuleName": "string"
},
"SentimentConfiguration": {
"RuleName": "string",
"SentimentType": "string",
"TimePeriod": number
},
"Type": "string"
}
]
},
"ResourceAccessRoleArn": "string",
"UpdatedTimestamp": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MediaInsightsPipelineConfiguration
-
The updated configuration settings.
Type: MediaInsightsPipelineConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
- ConflictException
-
The request could not be processed because of conflict in the current state of the resource.
HTTP Status Code: 409
- ForbiddenException
-
The client is permanently forbidden from making the request.
HTTP Status Code: 403
- NotFoundException
-
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404
- ServiceFailureException
-
The service encountered an unexpected error.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
HTTP Status Code: 503
- ThrottledClientException
-
The client exceeded its request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: