Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateMediaInsightsPipelineConfiguration

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

Request Syntax


POST /media-insights-pipeline-configurations HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "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
         }
      }
   ],
   "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",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

The unique identifier for the media insights pipeline configuration request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No

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

MediaInsightsPipelineConfigurationName

The name of the media insights pipeline configuration.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: ^[0-9a-zA-Z._-]+

Required: Yes

RealTimeAlertConfiguration

The configuration settings for the real-time alerts in a media insights pipeline configuration.

Type: RealTimeAlertConfiguration object

Required: No

ResourceAccessRoleArn

The ARN of the role used by the service to access AWS resources, including Transcribe and Transcribe Call Analytics, on the caller’s behalf.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^arn[\/\:\-\_\.a-zA-Z0-9]+$

Required: Yes

Tags

The tags assigned to the media insights pipeline configuration.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 201
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 201 response.

The following data is returned in JSON format by the service.

MediaInsightsPipelineConfiguration

The configuration settings for the media insights pipeline.

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.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

RequestId: The request id associated with the call responsible for the exception.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 401