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

CreateMediaInsightsPipeline

Creates a media insights pipeline.

Request Syntax


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

{
   "ClientRequestToken": "string",
   "KinesisVideoStreamRecordingSourceRuntimeConfiguration": { 
      "FragmentSelector": { 
         "FragmentSelectorType": "string",
         "TimestampRange": { 
            "EndTimestamp": number,
            "StartTimestamp": number
         }
      },
      "Streams": [ 
         { 
            "StreamArn": "string"
         }
      ]
   },
   "KinesisVideoStreamSourceRuntimeConfiguration": { 
      "MediaEncoding": "string",
      "MediaSampleRate": number,
      "Streams": [ 
         { 
            "FragmentNumber": "string",
            "StreamArn": "string",
            "StreamChannelDefinition": { 
               "ChannelDefinitions": [ 
                  { 
                     "ChannelId": number,
                     "ParticipantRole": "string"
                  }
               ],
               "NumberOfChannels": number
            }
         }
      ]
   },
   "MediaInsightsPipelineConfigurationArn": "string",
   "MediaInsightsRuntimeMetadata": { 
      "string" : "string" 
   },
   "S3RecordingSinkRuntimeConfiguration": { 
      "Destination": "string",
      "RecordingFileFormat": "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 request.

Type: String

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

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

Required: No

KinesisVideoStreamRecordingSourceRuntimeConfiguration

The runtime configuration for the Kinesis video recording stream source.

Type: KinesisVideoStreamRecordingSourceRuntimeConfiguration object

Required: No

KinesisVideoStreamSourceRuntimeConfiguration

The runtime configuration for the Kinesis video stream source of the media insights pipeline.

Type: KinesisVideoStreamSourceRuntimeConfiguration object

Required: No

MediaInsightsPipelineConfigurationArn

The ARN of the pipeline's configuration.

Type: String

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

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

Required: Yes

MediaInsightsRuntimeMetadata

The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.

Type: String to string map

Key Length Constraints: Maximum length of 1024.

Key Pattern: .*\S.*

Value Length Constraints: Maximum length of 4096.

Value Pattern: .*

Required: No

S3RecordingSinkRuntimeConfiguration

The runtime configuration for the S3 recording sink. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.

Type: S3RecordingSinkRuntimeConfiguration object

Required: No

Tags

The tags assigned to the media insights pipeline.

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

{
   "MediaInsightsPipeline": { 
      "CreatedTimestamp": "string",
      "ElementStatuses": [ 
         { 
            "Status": "string",
            "Type": "string"
         }
      ],
      "KinesisVideoStreamRecordingSourceRuntimeConfiguration": { 
         "FragmentSelector": { 
            "FragmentSelectorType": "string",
            "TimestampRange": { 
               "EndTimestamp": number,
               "StartTimestamp": number
            }
         },
         "Streams": [ 
            { 
               "StreamArn": "string"
            }
         ]
      },
      "KinesisVideoStreamSourceRuntimeConfiguration": { 
         "MediaEncoding": "string",
         "MediaSampleRate": number,
         "Streams": [ 
            { 
               "FragmentNumber": "string",
               "StreamArn": "string",
               "StreamChannelDefinition": { 
                  "ChannelDefinitions": [ 
                     { 
                        "ChannelId": number,
                        "ParticipantRole": "string"
                     }
                  ],
                  "NumberOfChannels": number
               }
            }
         ]
      },
      "MediaInsightsPipelineConfigurationArn": "string",
      "MediaInsightsRuntimeMetadata": { 
         "string" : "string" 
      },
      "MediaPipelineArn": "string",
      "MediaPipelineId": "string",
      "S3RecordingSinkRuntimeConfiguration": { 
         "Destination": "string",
         "RecordingFileFormat": "string"
      },
      "Status": "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.

MediaInsightsPipeline

The media insights pipeline object.

Type: MediaInsightsPipeline 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

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

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

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