Amazon Chime SDK · Schema
UpdateMediaInsightsPipelineConfigurationRequest
CommunicationsVideoMessagingSDKReal-Time
Properties
| Name | Type | Description |
|---|---|---|
| Identifier | string | The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration. |
| ResourceAccessRoleArn | string | The ARN of the role used by the service to access Amazon Web Services resources. |
| RealTimeAlertConfiguration | object | |
| Elements | array | The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/amazon-chime/json-schema/amazon-chime-update-media-insights-pipeline-configuration-request-schema.json",
"title": "UpdateMediaInsightsPipelineConfigurationRequest",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/amazon-chime-media-insights-pipeline-configurations-api-openapi.yml#/components/schemas/UpdateMediaInsightsPipelineConfigurationRequest",
"type": "object",
"properties": {
"Identifier": {
"type": "string",
"description": "The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration."
},
"ResourceAccessRoleArn": {
"type": "string",
"description": "The ARN of the role used by the service to access Amazon Web Services resources."
},
"RealTimeAlertConfiguration": {
"$ref": "#/$defs/RealTimeAlertConfiguration"
},
"Elements": {
"type": "array",
"items": {
"$ref": "#/$defs/MediaInsightsPipelineConfigurationElement"
},
"description": "The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.."
}
},
"required": [
"Identifier",
"ResourceAccessRoleArn",
"Elements"
],
"$defs": {
"AmazonTranscribeCallAnalyticsProcessorConfiguration": {
"type": "object",
"properties": {
"LanguageCode": {
"type": "string",
"enum": [
"en-US",
"en-GB",
"es-US",
"fr-CA",
"fr-FR",
"en-AU",
"it-IT",
"de-DE",
"pt-BR"
],
"description": "The language code in the configuration."
},
"VocabularyName": {
"type": "string",
"description": "Specifies the name of the custom vocabulary to use when processing a transcription. Note that vocabulary names are case sensitive. If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription. For more information, see Custom vocabularies in the Amazon Transcribe Developer Guide. Length Constraints: Minimum length of 1. Maximum length of 200."
},
"VocabularyFilterName": {
"type": "string",
"description": "Specifies the name of the custom vocabulary filter to use when processing a transcription. Note that vocabulary filter names are case sensitive. If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription. For more information, see Using vocabulary filtering with unwanted words in the Amazon Transcribe Developer Guide. Length Constraints: Minimum length of 1. Maximum length of 200."
},
"VocabularyFilterMethod": {
"type": "string",
"enum": [
"remove",
"mask",
"tag"
],
"description": "Specifies how to apply a vocabulary filter to a transcript. To replace words with ***, choose mask. To delete words, choose remove. To flag words without changing them, choose tag."
},
"LanguageModelName": {
"type": "string",
"description": "Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive. The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings. For more information, see Custom language models in the Amazon Transcribe Developer Guide."
},
"EnablePartialResultsStabilization": {
"type": "boolean",
"description": "Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide."
},
"PartialResultsStability": {
"type": "string",
"enum": [
"high",
"medium",
"low"
],
"description": "Specifies the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization). Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide."
},
"ContentIdentificationType": {
"type": "string",
"enum": [
"PII"
],
"description": "Labels all personally identifiable information (PII) identified in your transcript. Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment. You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you do, your request returns a BadRequestException. For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide."
},
"ContentRedactionType": {
"type": "string",
"enum": [
"PII"
],
"description": "Redacts all personally identifiable information (PII) identified in your transcript. Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment. You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you do, your request returns a BadRequestException. For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide."
},
"PiiEntityTypes": {
"type": "string",
"description": "Specifies the types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL. To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both. Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL. Length Constraints: Minimum length of 1. Maximum length of 300."
},
"FilterPartialResults": {
"type": "boolean",
"description": "If true, UtteranceEvents with IsPartial: true are filtered out of the insights target."
},
"PostCallAnalyticsSettings": {
"$ref": "#/$defs/PostCallAnalyticsSettings"
},
"CallAnalyticsStreamCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target."
}
},
"required": [
"LanguageCode"
]
},
"AmazonTranscribeProcessorConfiguration": {
"type": "object",
"properties": {
"LanguageCode": {
"type": "string",
"enum": [
"en-US",
"en-GB",
"es-US",
"fr-CA",
"fr-FR",
"en-AU",
"it-IT",
"de-DE",
"pt-BR"
],
"description": "The language code that represents the language spoken in your audio. If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification. For a list of languages that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide."
},
"VocabularyName": {
"type": "string",
"description": "The name of the custom vocabulary that you specified in your Call Analytics request. Length Constraints: Minimum length of 1. Maximum length of 200."
},
"VocabularyFilterName": {
"type": "string",
"description": "The name of the custom vocabulary filter that you specified in your Call Analytics request. Length Constraints: Minimum length of 1. Maximum length of 200."
},
"VocabularyFilterMethod": {
"type": "string",
"enum": [
"remove",
"mask",
"tag"
],
"description": "The vocabulary filtering method used in your Call Analytics transcription."
},
"ShowSpeakerLabel": {
"type": "boolean",
"description": "Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file. For more information, see Partitioning speakers (diarization) in the Amazon Transcribe Developer Guide."
},
"EnablePartialResultsStabilization": {
"type": "boolean",
"description": "Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide."
},
"PartialResultsStability": {
"type": "string",
"enum": [
"high",
"medium",
"low"
],
"description": "The level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization). Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide."
},
"ContentIdentificationType": {
"type": "string",
"enum": [
"PII"
],
"description": "Labels all personally identifiable information (PII) identified in your transcript. Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment. You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException. For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide."
},
"ContentRedactionType": {
"type": "string",
"enum": [
"PII"
],
"description": "Redacts all personally identifiable information (PII) identified in your transcript. Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment. You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException. For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide."
},
"PiiEntityTypes": {
"type": "string",
"description": "The types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL. To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both. Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL. If you leave this parameter empty, the default behavior is equivalent to ALL."
},
"LanguageModelName": {
"type": "string",
"description": "The name of the custom language model that you want to use when processing your transcription. 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 custom language model isn't applied. There are no errors or warnings associated with a language mismatch. For more information, see Custom language models in the Amazon Transcribe Developer Guide."
},
"FilterPartialResults": {
"type": "boolean",
"description": "If true, TranscriptEvents with IsPartial: true are filtered out of the insights target."
},
"IdentifyLanguage": {
"type": "boolean",
"description": "Turns language identification on or off."
},
"IdentifyMultipleLanguages": {
"type": "boolean",
"description": "Turns language identification on or off for multiple languages. Calls to this API must include a LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages parameter. If you include more than one of those parameters, your transcription job fails."
},
"LanguageOptions": {
"type": "string",
"description": "The language options for the transcription, such as automatic language detection."
},
"PreferredLanguage": {
"type": "string",
"enum": [
"en-US",
"en-GB",
"es-US",
"fr-CA",
"fr-FR",
"en-AU",
"it-IT",
"de-DE",
"pt-BR"
],
"description": "The preferred language for the transcription."
},
"VocabularyNames": {
"type": "string",
"description": "The names of the custom vocabulary or vocabularies used during transcription."
},
"VocabularyFilterNames": {
"type": "string",
"description": "The names of the custom vocabulary filter or filters using during transcription."
}
}
},
"IssueDetectionConfiguration": {
"type": "object",
"properties": {
"RuleName": {
"type": "string",
"description": "The name of the issue detection rule."
}
},
"required": [
"RuleName"
]
},
"KeywordMatchConfiguration": {
"type": "object",
"properties": {
"RuleName": {
"type": "string",
"description": "The name of the keyword match rule."
},
"Keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "The keywords or phrases that you want to match."
},
"Negate": {
"type": "boolean",
"description": "Matches keywords or phrases on their presence or absence. If set to TRUE, the rule matches when all the specified keywords or phrases are absent. Default: FALSE."
}
},
"required": [
"RuleName",
"Keywords"
]
},
"KinesisDataStreamSinkConfiguration": {
"type": "object",
"properties": {
"InsightsTarget": {
"type": "string",
"description": "The ARN of the sink."
}
}
},
"LambdaFunctionSinkConfiguration": {
"type": "object",
"properties": {
"InsightsTarget": {
"type": "string",
"description": "The ARN of the sink."
}
}
},
"MediaInsightsPipelineConfigurationElement": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"enum": [
"AmazonTranscribeCallAnalyticsProcessor",
"VoiceAnalyticsProcessor",
"AmazonTranscribeProcessor",
"KinesisDataStreamSink",
"LambdaFunctionSink",
"SqsQueueSink",
"SnsTopicSink",
"S3RecordingSink",
"VoiceEnhancementSink"
],
"description": "The element type."
},
"AmazonTranscribeCallAnalyticsProcessorConfiguration": {
"$ref": "#/$defs/AmazonTranscribeCallAnalyticsProcessorConfiguration"
},
"AmazonTranscribeProcessorConfiguration": {
"$ref": "#/$defs/AmazonTranscribeProcessorConfiguration"
},
"KinesisDataStreamSinkConfiguration": {
"$ref": "#/$defs/KinesisDataStreamSinkConfiguration"
},
"S3RecordingSinkConfiguration": {
"$ref": "#/$defs/S3RecordingSinkConfiguration"
},
"VoiceAnalyticsProcessorConfiguration": {
"$ref": "#/$defs/VoiceAnalyticsProcessorConfiguration"
},
"LambdaFunctionSinkConfiguration": {
"$ref": "#/$defs/LambdaFunctionSinkConfiguration"
},
"SqsQueueSinkConfiguration": {
"$ref": "#/$defs/SqsQueueSinkConfiguration"
},
"SnsTopicSinkConfiguration": {
"$ref": "#/$defs/SnsTopicSinkConfiguration"
},
"VoiceEnhancementSinkConfiguration": {
"$ref": "#/$defs/VoiceEnhancementSinkConfiguration"
}
},
"required": [
"Type"
]
},
"PostCallAnalyticsSettings": {
"type": "object",
"properties": {
"OutputLocation": {
"type": "string",
"description": "The URL of the Amazon S3 bucket that contains the post-call data."
},
"DataAccessRoleArn": {
"type": "string",
"description": "The ARN of the role used by Amazon Web Services Transcribe to upload your post call analysis. For more information, see Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide."
},
"ContentRedactionOutput": {
"type": "string",
"enum": [
"redacted",
"redacted_and_unredacted"
],
"description": "The content redaction output settings for a post-call analysis task."
},
"OutputEncryptionKMSKeyId": {
"type": "string",
"description": "The ID of the KMS (Key Management Service) key used to encrypt the output."
}
},
"required": [
"OutputLocation",
"DataAccessRoleArn"
]
},
"RealTimeAlertConfiguration": {
"type": "object",
"properties": {
"Disabled": {
"type": "boolean",
"description": "Turns off real-time alerts."
},
"Rules": {
"type": "array",
"items": {
"$ref": "#/$defs/RealTimeAlertRule"
},
"description": "The rules in the alert. Rules specify the words or phrases that you want to be notified about."
}
}
},
"RealTimeAlertRule": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"enum": [
"KeywordMatch",
"Sentiment",
"IssueDetection"
],
"description": "The type of alert rule."
},
"KeywordMatchConfiguration": {
"$ref": "#/$defs/KeywordMatchConfiguration"
},
"SentimentConfiguration": {
"$ref": "#/$defs/SentimentConfiguration"
},
"IssueDetectionConfiguration": {
"$ref": "#/$defs/IssueDetectionConfiguration"
}
},
"required": [
"Type"
]
},
"S3RecordingSinkConfiguration": {
"type": "object",
"properties": {
"Destination": {
"type": "string",
"description": "The default URI of the Amazon S3 bucket used as the recording sink."
},
"RecordingFileFormat": {
"type": "string",
"enum": [
"Wav",
"Opus"
],
"description": "The default file format for the media files sent to the Amazon S3 bucket."
}
}
},
"SentimentConfiguration": {
"type": "object",
"properties": {
"RuleName": {
"type": "string",
"description": "The name of the rule in the sentiment configuration."
},
"SentimentType": {
"type": "string",
"enum": [
"NEGATIVE"
],
"description": "The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL."
},
"TimePeriod": {
"type": "integer",
"description": "Specifies the analysis interval."
}
},
"required": [
"RuleName",
"SentimentType",
"TimePeriod"
]
},
"SnsTopicSinkConfiguration": {
"type": "object",
"properties": {
"InsightsTarget": {
"type": "string",
"description": "The ARN of the SNS sink."
}
}
},
"SqsQueueSinkConfiguration": {
"type": "object",
"properties": {
"InsightsTarget": {
"type": "string",
"description": "The ARN of the SQS sink."
}
}
},
"VoiceAnalyticsProcessorConfiguration": {
"type": "object",
"properties": {
"SpeakerSearchStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
],
"description": "The status of the speaker search task."
},
"VoiceToneAnalysisStatus": {
"type": "string",
"enum": [
"Enabled",
"Disabled"
],
"description": "The status of the voice tone analysis task."
}
}
},
"VoiceEnhancementSinkConfiguration": {
"type": "object",
"properties": {
"Disabled": {
"type": "boolean",
"description": "Disables the VoiceEnhancementSinkConfiguration element."
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-chime-update-media-insights-pipeline-configuration-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.