Method: Aws::ChimeSDKMediaPipelines::Client#create_media_stream_pipeline

Defined in:

lib/aws-sdk-chimesdkmediapipelines/client.rb

#create_media_stream_pipeline(params = {}) ⇒ Types::CreateMediaStreamPipelineResponse

Creates a streaming media pipeline.

Examples:

Request syntax with placeholder values

resp = client.create_media_stream_pipeline({
  sources: [ # required
    {
      source_type: "ChimeSdkMeeting", # required, accepts ChimeSdkMeeting
      source_arn: "Arn", # required
    },
  ],
  sinks: [ # required
    {
      sink_arn: "Arn", # required
      sink_type: "KinesisVideoStreamPool", # required, accepts KinesisVideoStreamPool
      reserved_stream_capacity: 1, # required
      media_stream_type: "MixedAudio", # required, accepts MixedAudio, IndividualAudio
    },
  ],
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure

resp.media_stream_pipeline.media_pipeline_id #=> String
resp.media_stream_pipeline.media_pipeline_arn #=> String
resp.media_stream_pipeline.created_timestamp #=> Time
resp.media_stream_pipeline.updated_timestamp #=> Time
resp.media_stream_pipeline.status #=> String, one of "Initializing", "InProgress", "Failed", "Stopping", "Stopped", "Paused", "NotStarted"
resp.media_stream_pipeline.sources #=> Array
resp.media_stream_pipeline.sources[0].source_type #=> String, one of "ChimeSdkMeeting"
resp.media_stream_pipeline.sources[0].source_arn #=> String
resp.media_stream_pipeline.sinks #=> Array
resp.media_stream_pipeline.sinks[0].sink_arn #=> String
resp.media_stream_pipeline.sinks[0].sink_type #=> String, one of "KinesisVideoStreamPool"
resp.media_stream_pipeline.sinks[0].reserved_stream_capacity #=> Integer
resp.media_stream_pipeline.sinks[0].media_stream_type #=> String, one of "MixedAudio", "IndividualAudio"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :sources (required, Array<Types::MediaStreamSource>) —

  The data sources for the media pipeline.

• :sinks (required, Array<Types::MediaStreamSink>) —

  The data sink for the media pipeline.

• :client_request_token (String) —

  The token assigned to the client making the request.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :tags (Array<Types::Tag>) —

  The tags assigned to the media pipeline.

Returns:

• (Types::CreateMediaStreamPipelineResponse) —

  Returns a response object which responds to the following methods:

  • #media_stream_pipeline => Types::MediaStreamPipeline

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1396

def create_media_stream_pipeline(params = {}, options = {})
  req = build_request(:create_media_stream_pipeline, params)
  req.send_request(options)
end