:doc:`KinesisVideo <../../kinesisvideo>` / Client / describe_stream

***************
describe_stream
***************



.. py:method:: KinesisVideo.Client.describe_stream(**kwargs)

  

  Returns the most current information about the specified stream. You must specify either the ``StreamName`` or the ``StreamARN``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeStream>`_  


  **Request Syntax**
  ::

    response = client.describe_stream(
        StreamName='string',
        StreamARN='string'
    )
    
  :type StreamName: string
  :param StreamName: 

    The name of the stream.

    

  
  :type StreamARN: string
  :param StreamARN: 

    The Amazon Resource Name (ARN) of the stream.

    

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

    
    ::

      {
          'StreamInfo': {
              'DeviceName': 'string',
              'StreamName': 'string',
              'StreamARN': 'string',
              'MediaType': 'string',
              'KmsKeyId': 'string',
              'Version': 'string',
              'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING',
              'CreationTime': datetime(2015, 1, 1),
              'DataRetentionInHours': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **StreamInfo** *(dict) --* 

        An object that describes the stream.

        
        

        - **DeviceName** *(string) --* 

          The name of the device that is associated with the stream.

          
        

        - **StreamName** *(string) --* 

          The name of the stream.

          
        

        - **StreamARN** *(string) --* 

          The Amazon Resource Name (ARN) of the stream.

          
        

        - **MediaType** *(string) --* 

          The ``MediaType`` of the stream.

          
        

        - **KmsKeyId** *(string) --* 

          The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

          
        

        - **Version** *(string) --* 

          The version of the stream.

          
        

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

          The status of the stream.

          
        

        - **CreationTime** *(datetime) --* 

          A time stamp that indicates when the stream was created.

          
        

        - **DataRetentionInHours** *(integer) --* 

          How long the stream retains data, in hours.

          
    
  
  **Exceptions**
  
  *   :py:class:`KinesisVideo.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`KinesisVideo.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`KinesisVideo.Client.exceptions.ClientLimitExceededException`

  
  *   :py:class:`KinesisVideo.Client.exceptions.NotAuthorizedException`

  