Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CreateMediaInsightsPipelineConfigurationCommand

A structure that contains the static configurations for a media insights pipeline.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ChimeSDKMediaPipelinesClient, CreateMediaInsightsPipelineConfigurationCommand } from "@aws-sdk/client-chime-sdk-media-pipelines"; // ES Modules import
// const { ChimeSDKMediaPipelinesClient, CreateMediaInsightsPipelineConfigurationCommand } = require("@aws-sdk/client-chime-sdk-media-pipelines"); // CommonJS import
const client = new ChimeSDKMediaPipelinesClient(config);
const input = { // CreateMediaInsightsPipelineConfigurationRequest
  MediaInsightsPipelineConfigurationName: "STRING_VALUE", // required
  ResourceAccessRoleArn: "STRING_VALUE", // required
  RealTimeAlertConfiguration: { // RealTimeAlertConfiguration
    Disabled: true || false,
    Rules: [ // RealTimeAlertRuleList
      { // RealTimeAlertRule
        Type: "KeywordMatch" || "Sentiment" || "IssueDetection", // required
        KeywordMatchConfiguration: { // KeywordMatchConfiguration
          RuleName: "STRING_VALUE", // required
          Keywords: [ // KeywordMatchWordList // required
            "STRING_VALUE",
          ],
          Negate: true || false,
        },
        SentimentConfiguration: { // SentimentConfiguration
          RuleName: "STRING_VALUE", // required
          SentimentType: "NEGATIVE", // required
          TimePeriod: Number("int"), // required
        },
        IssueDetectionConfiguration: { // IssueDetectionConfiguration
          RuleName: "STRING_VALUE", // required
        },
      },
    ],
  },
  Elements: [ // MediaInsightsPipelineConfigurationElements // required
    { // MediaInsightsPipelineConfigurationElement
      Type: "AmazonTranscribeCallAnalyticsProcessor" || "VoiceAnalyticsProcessor" || "AmazonTranscribeProcessor" || "KinesisDataStreamSink" || "LambdaFunctionSink" || "SqsQueueSink" || "SnsTopicSink" || "S3RecordingSink" || "VoiceEnhancementSink", // required
      AmazonTranscribeCallAnalyticsProcessorConfiguration: { // AmazonTranscribeCallAnalyticsProcessorConfiguration
        LanguageCode: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR", // required
        VocabularyName: "STRING_VALUE",
        VocabularyFilterName: "STRING_VALUE",
        VocabularyFilterMethod: "remove" || "mask" || "tag",
        LanguageModelName: "STRING_VALUE",
        EnablePartialResultsStabilization: true || false,
        PartialResultsStability: "high" || "medium" || "low",
        ContentIdentificationType: "PII",
        ContentRedactionType: "PII",
        PiiEntityTypes: "STRING_VALUE",
        FilterPartialResults: true || false,
        PostCallAnalyticsSettings: { // PostCallAnalyticsSettings
          OutputLocation: "STRING_VALUE", // required
          DataAccessRoleArn: "STRING_VALUE", // required
          ContentRedactionOutput: "redacted" || "redacted_and_unredacted",
          OutputEncryptionKMSKeyId: "STRING_VALUE",
        },
        CallAnalyticsStreamCategories: [ // CategoryNameList
          "STRING_VALUE",
        ],
      },
      AmazonTranscribeProcessorConfiguration: { // AmazonTranscribeProcessorConfiguration
        LanguageCode: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR",
        VocabularyName: "STRING_VALUE",
        VocabularyFilterName: "STRING_VALUE",
        VocabularyFilterMethod: "remove" || "mask" || "tag",
        ShowSpeakerLabel: true || false,
        EnablePartialResultsStabilization: true || false,
        PartialResultsStability: "high" || "medium" || "low",
        ContentIdentificationType: "PII",
        ContentRedactionType: "PII",
        PiiEntityTypes: "STRING_VALUE",
        LanguageModelName: "STRING_VALUE",
        FilterPartialResults: true || false,
        IdentifyLanguage: true || false,
        IdentifyMultipleLanguages: true || false,
        LanguageOptions: "STRING_VALUE",
        PreferredLanguage: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR",
        VocabularyNames: "STRING_VALUE",
        VocabularyFilterNames: "STRING_VALUE",
      },
      KinesisDataStreamSinkConfiguration: { // KinesisDataStreamSinkConfiguration
        InsightsTarget: "STRING_VALUE",
      },
      S3RecordingSinkConfiguration: { // S3RecordingSinkConfiguration
        Destination: "STRING_VALUE",
        RecordingFileFormat: "Wav" || "Opus",
      },
      VoiceAnalyticsProcessorConfiguration: { // VoiceAnalyticsProcessorConfiguration
        SpeakerSearchStatus: "Enabled" || "Disabled",
        VoiceToneAnalysisStatus: "Enabled" || "Disabled",
      },
      LambdaFunctionSinkConfiguration: { // LambdaFunctionSinkConfiguration
        InsightsTarget: "STRING_VALUE",
      },
      SqsQueueSinkConfiguration: { // SqsQueueSinkConfiguration
        InsightsTarget: "STRING_VALUE",
      },
      SnsTopicSinkConfiguration: { // SnsTopicSinkConfiguration
        InsightsTarget: "STRING_VALUE",
      },
      VoiceEnhancementSinkConfiguration: { // VoiceEnhancementSinkConfiguration
        Disabled: true || false,
      },
    },
  ],
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  ClientRequestToken: "STRING_VALUE",
};
const command = new CreateMediaInsightsPipelineConfigurationCommand(input);
const response = await client.send(command);
// { // CreateMediaInsightsPipelineConfigurationResponse
//   MediaInsightsPipelineConfiguration: { // MediaInsightsPipelineConfiguration
//     MediaInsightsPipelineConfigurationName: "STRING_VALUE",
//     MediaInsightsPipelineConfigurationArn: "STRING_VALUE",
//     ResourceAccessRoleArn: "STRING_VALUE",
//     RealTimeAlertConfiguration: { // RealTimeAlertConfiguration
//       Disabled: true || false,
//       Rules: [ // RealTimeAlertRuleList
//         { // RealTimeAlertRule
//           Type: "KeywordMatch" || "Sentiment" || "IssueDetection", // required
//           KeywordMatchConfiguration: { // KeywordMatchConfiguration
//             RuleName: "STRING_VALUE", // required
//             Keywords: [ // KeywordMatchWordList // required
//               "STRING_VALUE",
//             ],
//             Negate: true || false,
//           },
//           SentimentConfiguration: { // SentimentConfiguration
//             RuleName: "STRING_VALUE", // required
//             SentimentType: "NEGATIVE", // required
//             TimePeriod: Number("int"), // required
//           },
//           IssueDetectionConfiguration: { // IssueDetectionConfiguration
//             RuleName: "STRING_VALUE", // required
//           },
//         },
//       ],
//     },
//     Elements: [ // MediaInsightsPipelineConfigurationElements
//       { // MediaInsightsPipelineConfigurationElement
//         Type: "AmazonTranscribeCallAnalyticsProcessor" || "VoiceAnalyticsProcessor" || "AmazonTranscribeProcessor" || "KinesisDataStreamSink" || "LambdaFunctionSink" || "SqsQueueSink" || "SnsTopicSink" || "S3RecordingSink" || "VoiceEnhancementSink", // required
//         AmazonTranscribeCallAnalyticsProcessorConfiguration: { // AmazonTranscribeCallAnalyticsProcessorConfiguration
//           LanguageCode: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR", // required
//           VocabularyName: "STRING_VALUE",
//           VocabularyFilterName: "STRING_VALUE",
//           VocabularyFilterMethod: "remove" || "mask" || "tag",
//           LanguageModelName: "STRING_VALUE",
//           EnablePartialResultsStabilization: true || false,
//           PartialResultsStability: "high" || "medium" || "low",
//           ContentIdentificationType: "PII",
//           ContentRedactionType: "PII",
//           PiiEntityTypes: "STRING_VALUE",
//           FilterPartialResults: true || false,
//           PostCallAnalyticsSettings: { // PostCallAnalyticsSettings
//             OutputLocation: "STRING_VALUE", // required
//             DataAccessRoleArn: "STRING_VALUE", // required
//             ContentRedactionOutput: "redacted" || "redacted_and_unredacted",
//             OutputEncryptionKMSKeyId: "STRING_VALUE",
//           },
//           CallAnalyticsStreamCategories: [ // CategoryNameList
//             "STRING_VALUE",
//           ],
//         },
//         AmazonTranscribeProcessorConfiguration: { // AmazonTranscribeProcessorConfiguration
//           LanguageCode: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR",
//           VocabularyName: "STRING_VALUE",
//           VocabularyFilterName: "STRING_VALUE",
//           VocabularyFilterMethod: "remove" || "mask" || "tag",
//           ShowSpeakerLabel: true || false,
//           EnablePartialResultsStabilization: true || false,
//           PartialResultsStability: "high" || "medium" || "low",
//           ContentIdentificationType: "PII",
//           ContentRedactionType: "PII",
//           PiiEntityTypes: "STRING_VALUE",
//           LanguageModelName: "STRING_VALUE",
//           FilterPartialResults: true || false,
//           IdentifyLanguage: true || false,
//           IdentifyMultipleLanguages: true || false,
//           LanguageOptions: "STRING_VALUE",
//           PreferredLanguage: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR",
//           VocabularyNames: "STRING_VALUE",
//           VocabularyFilterNames: "STRING_VALUE",
//         },
//         KinesisDataStreamSinkConfiguration: { // KinesisDataStreamSinkConfiguration
//           InsightsTarget: "STRING_VALUE",
//         },
//         S3RecordingSinkConfiguration: { // S3RecordingSinkConfiguration
//           Destination: "STRING_VALUE",
//           RecordingFileFormat: "Wav" || "Opus",
//         },
//         VoiceAnalyticsProcessorConfiguration: { // VoiceAnalyticsProcessorConfiguration
//           SpeakerSearchStatus: "Enabled" || "Disabled",
//           VoiceToneAnalysisStatus: "Enabled" || "Disabled",
//         },
//         LambdaFunctionSinkConfiguration: { // LambdaFunctionSinkConfiguration
//           InsightsTarget: "STRING_VALUE",
//         },
//         SqsQueueSinkConfiguration: { // SqsQueueSinkConfiguration
//           InsightsTarget: "STRING_VALUE",
//         },
//         SnsTopicSinkConfiguration: { // SnsTopicSinkConfiguration
//           InsightsTarget: "STRING_VALUE",
//         },
//         VoiceEnhancementSinkConfiguration: { // VoiceEnhancementSinkConfiguration
//           Disabled: true || false,
//         },
//       },
//     ],
//     MediaInsightsPipelineConfigurationId: "STRING_VALUE",
//     CreatedTimestamp: new Date("TIMESTAMP"),
//     UpdatedTimestamp: new Date("TIMESTAMP"),
//   },
// };

CreateMediaInsightsPipelineConfigurationCommand Input

See CreateMediaInsightsPipelineConfigurationCommandInput for more details

Parameter	Type	Description
`Elements` Required	`MediaInsightsPipelineConfigurationElement[] \| undefined`	The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.
`MediaInsightsPipelineConfigurationName` Required	`string \| undefined`	The name of the media insights pipeline configuration.
`ResourceAccessRoleArn` Required	`string \| undefined`	The ARN of the role used by the service to access Amazon Web Services resources, including `Transcribe` and `Transcribe Call Analytics`, on the caller’s behalf.
`ClientRequestToken`	`string \| undefined`	The unique identifier for the media insights pipeline configuration request.
`RealTimeAlertConfiguration`	`RealTimeAlertConfiguration \| undefined`	The configuration settings for the real-time alerts in a media insights pipeline configuration.
`Tags`	`Tag[] \| undefined`	The tags assigned to the media insights pipeline configuration.

CreateMediaInsightsPipelineConfigurationCommand Output

See CreateMediaInsightsPipelineConfigurationCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`MediaInsightsPipelineConfiguration`	`MediaInsightsPipelineConfiguration \| undefined`	The configuration settings for the media insights pipeline.

Throws

Name	Fault	Details
BadRequestException	client	The input parameters don't match the service's restrictions.
ForbiddenException	client	The client is permanently forbidden from making the request.
NotFoundException	client	One or more of the resources in the request does not exist in the system.
ResourceLimitExceededException	client	The request exceeds the resource limit.
ServiceFailureException	server	The service encountered an unexpected error.
ServiceUnavailableException	server	The service is currently unavailable.
ThrottledClientException	client	The client exceeded its request rate limit.
UnauthorizedClientException	client	The client is not currently authorized to make the request.
ChimeSDKMediaPipelinesServiceException		Base exception class for all service exceptions from ChimeSDKMediaPipelines service.

Getting Started

References

CreateMediaInsightsPipelineConfigurationCommand

Example Syntax

CreateMediaInsightsPipelineConfigurationCommand Input

CreateMediaInsightsPipelineConfigurationCommand Output

Throws

Table of Contents

Search