:doc:`ChimeSDKMediaPipelines <../../chime-sdk-media-pipelines>` / Client / create_media_stream_pipeline

****************************
create_media_stream_pipeline
****************************



.. py:method:: ChimeSDKMediaPipelines.Client.create_media_stream_pipeline(**kwargs)

  

  Creates a streaming media pipeline.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaStreamPipeline>`_  


  **Request Syntax**
  ::

    response = client.create_media_stream_pipeline(
        Sources=[
            {
                'SourceType': 'ChimeSdkMeeting',
                'SourceArn': 'string'
            },
        ],
        Sinks=[
            {
                'SinkArn': 'string',
                'SinkType': 'KinesisVideoStreamPool',
                'ReservedStreamCapacity': 123,
                'MediaStreamType': 'MixedAudio'|'IndividualAudio'
            },
        ],
        ClientRequestToken='string',
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    )
    
  :type Sources: list
  :param Sources: **[REQUIRED]** 

    The data sources for the media pipeline.

    

  
    - *(dict) --* 

      Structure that contains the settings for media stream sources.

      

    
      - **SourceType** *(string) --* **[REQUIRED]** 

        The type of media stream source.

        

      
      - **SourceArn** *(string) --* **[REQUIRED]** 

        The ARN of the meeting.

        

      
    

  :type Sinks: list
  :param Sinks: **[REQUIRED]** 

    The data sink for the media pipeline.

    

  
    - *(dict) --* 

      Structure that contains the settings for a media stream sink.

      

    
      - **SinkArn** *(string) --* **[REQUIRED]** 

        The ARN of the Kinesis Video Stream pool returned by the  CreateMediaPipelineKinesisVideoStreamPool API.

        

      
      - **SinkType** *(string) --* **[REQUIRED]** 

        The media stream sink's type.

        

      
      - **ReservedStreamCapacity** *(integer) --* **[REQUIRED]** 

        Specifies the number of streams that the sink can accept.

        

      
      - **MediaStreamType** *(string) --* **[REQUIRED]** 

        The media stream sink's media stream type.

        

      
    

  :type ClientRequestToken: string
  :param ClientRequestToken: 

    The token assigned to the client making the request.

    This field is autopopulated if not provided.

  
  :type Tags: list
  :param Tags: 

    The tags assigned to the media pipeline.

    

  
    - *(dict) --* 

      A key/value pair that grants users access to meeting resources.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

        The key half of a tag.

        

      
      - **Value** *(string) --* **[REQUIRED]** 

        The value half of a tag.

        

      
    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'MediaStreamPipeline': {
              'MediaPipelineId': 'string',
              'MediaPipelineArn': 'string',
              'CreatedTimestamp': datetime(2015, 1, 1),
              'UpdatedTimestamp': datetime(2015, 1, 1),
              'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped'|'Paused'|'NotStarted',
              'Sources': [
                  {
                      'SourceType': 'ChimeSdkMeeting',
                      'SourceArn': 'string'
                  },
              ],
              'Sinks': [
                  {
                      'SinkArn': 'string',
                      'SinkType': 'KinesisVideoStreamPool',
                      'ReservedStreamCapacity': 123,
                      'MediaStreamType': 'MixedAudio'|'IndividualAudio'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **MediaStreamPipeline** *(dict) --* 

        The requested media pipeline.

        
        

        - **MediaPipelineId** *(string) --* 

          The ID of the media stream pipeline

          
        

        - **MediaPipelineArn** *(string) --* 

          The ARN of the media stream pipeline.

          
        

        - **CreatedTimestamp** *(datetime) --* 

          The time at which the media stream pipeline was created.

          
        

        - **UpdatedTimestamp** *(datetime) --* 

          The time at which the media stream pipeline was updated.

          
        

        - **Status** *(string) --* 

          The status of the media stream pipeline.

          
        

        - **Sources** *(list) --* 

          The media stream pipeline's data sources.

          
          

          - *(dict) --* 

            Structure that contains the settings for media stream sources.

            
            

            - **SourceType** *(string) --* 

              The type of media stream source.

              
            

            - **SourceArn** *(string) --* 

              The ARN of the meeting.

              
        
      
        

        - **Sinks** *(list) --* 

          The media stream pipeline's data sinks.

          
          

          - *(dict) --* 

            Structure that contains the settings for a media stream sink.

            
            

            - **SinkArn** *(string) --* 

              The ARN of the Kinesis Video Stream pool returned by the  CreateMediaPipelineKinesisVideoStreamPool API.

              
            

            - **SinkType** *(string) --* 

              The media stream sink's type.

              
            

            - **ReservedStreamCapacity** *(integer) --* 

              Specifies the number of streams that the sink can accept.

              
            

            - **MediaStreamType** *(string) --* 

              The media stream sink's media stream type.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`ChimeSDKMediaPipelines.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ChimeSDKMediaPipelines.Client.exceptions.NotFoundException`

  
  *   :py:class:`ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`ChimeSDKMediaPipelines.Client.exceptions.ResourceLimitExceededException`

  
  *   :py:class:`ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException`

  