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

*****************
list_compositions
*****************



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

  

  Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

  

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


  **Request Syntax**
  ::

    response = client.list_compositions(
        filterByStageArn='string',
        filterByEncoderConfigurationArn='string',
        nextToken='string',
        maxResults=123
    )
    
  :type filterByStageArn: string
  :param filterByStageArn: 

    Filters the Composition list to match the specified Stage ARN.

    

  
  :type filterByEncoderConfigurationArn: string
  :param filterByEncoderConfigurationArn: 

    Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

    

  
  :type nextToken: string
  :param nextToken: 

    The first Composition to retrieve. This is used for pagination; see the ``nextToken`` response field.

    

  
  :type maxResults: integer
  :param maxResults: 

    Maximum number of results to return. Default: 100.

    

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

    
    ::

      {
          'compositions': [
              {
                  'arn': 'string',
                  'stageArn': 'string',
                  'destinations': [
                      {
                          'id': 'string',
                          'state': 'STARTING'|'ACTIVE'|'STOPPING'|'RECONNECTING'|'FAILED'|'STOPPED',
                          'startTime': datetime(2015, 1, 1),
                          'endTime': datetime(2015, 1, 1)
                      },
                  ],
                  'state': 'STARTING'|'ACTIVE'|'STOPPING'|'FAILED'|'STOPPED',
                  'tags': {
                      'string': 'string'
                  },
                  'startTime': datetime(2015, 1, 1),
                  'endTime': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **compositions** *(list) --* 

        List of the matching Compositions (summary information only).

        
        

        - *(dict) --* 

          Summary information about a Composition.

          
          

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

            ARN of the Composition resource.

            
          

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

            ARN of the attached stage.

            
          

          - **destinations** *(list) --* 

            Array of Destination objects.

            
            

            - *(dict) --* 

              Summary information about a Destination.

              
              

              - **id** *(string) --* 

                Unique identifier for this destination, assigned by IVS.

                
              

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

                State of the Composition Destination.

                
              

              - **startTime** *(datetime) --* 

                UTC time of the destination start. This is an ISO 8601 timestamp; *note that this is returned as a string*.

                
              

              - **endTime** *(datetime) --* 

                UTC time of the destination end. This is an ISO 8601 timestamp; *note that this is returned as a string*.

                
          
        
          

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

            State of the Composition resource.

            
          

          - **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) --* 
        
      
          

          - **startTime** *(datetime) --* 

            UTC time of the Composition start. This is an ISO 8601 timestamp; *note that this is returned as a string*.

            
          

          - **endTime** *(datetime) --* 

            UTC time of the Composition end. This is an ISO 8601 timestamp; *note that this is returned as a string*.

            
      
    
      

      - **nextToken** *(string) --* 

        If there are more compositions than ``maxResults``, use ``nextToken`` in the request to get the next set.

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

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

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

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

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

  