:doc:`ivsrealtime <../../ivs-realtime>` / Client / update_ingest_configuration

***************************
update_ingest_configuration
***************************



.. py:method:: ivsrealtime.Client.update_ingest_configuration(**kwargs)

  

  Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateIngestConfiguration>`_  


  **Request Syntax**
  ::

    response = client.update_ingest_configuration(
        arn='string',
        stageArn='string'
    )
    
  :type arn: string
  :param arn: **[REQUIRED]** 

    ARN of the IngestConfiguration, for which the related stage ARN needs to be updated.

    

  
  :type stageArn: string
  :param stageArn: 

    Stage ARN that needs to be updated.

    

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

    
    ::

      {
          'ingestConfiguration': {
              'name': 'string',
              'arn': 'string',
              'ingestProtocol': 'RTMP'|'RTMPS',
              'streamKey': 'string',
              'stageArn': 'string',
              'participantId': 'string',
              'state': 'ACTIVE'|'INACTIVE',
              'userId': 'string',
              'attributes': {
                  'string': 'string'
              },
              'tags': {
                  'string': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ingestConfiguration** *(dict) --* 

        The updated IngestConfiguration.

        
        

        - **name** *(string) --* 

          Ingest name

          
        

        - **arn** *(string) --* 

          Ingest configuration ARN.

          
        

        - **ingestProtocol** *(string) --* 

          Type of ingest protocol that the user employs for broadcasting.

          
        

        - **streamKey** *(string) --* 

          Ingest-key value for the RTMP(S) protocol.

          
        

        - **stageArn** *(string) --* 

          ARN of the stage with which the IngestConfiguration is associated.

          
        

        - **participantId** *(string) --* 

          ID of the participant within the stage.

          
        

        - **state** *(string) --* 

          State of the ingest configuration. It is ``ACTIVE`` if a publisher currently is publishing to the stage associated with the ingest configuration.

          
        

        - **userId** *(string) --* 

          Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. *This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.*

          
        

        - **attributes** *(dict) --* 

          Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. *This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.*

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **tags** *(dict) --* 

          Tags attached to the resource. Array of maps, each of the form ``string:string (key:value)``. See `Best practices and strategies <https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html>`__ in *Tagging AWS Resources and Tag Editor* for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
  
  **Exceptions**
  
  *   :py:class:`ivsrealtime.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ivsrealtime.Client.exceptions.ValidationException`

  
  *   :py:class:`ivsrealtime.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`ivsrealtime.Client.exceptions.ConflictException`

  
  *   :py:class:`ivsrealtime.Client.exceptions.PendingVerification`

  