:doc:`CustomerProfiles <../../customer-profiles>` / Client / get_event_stream

****************
get_event_stream
****************



.. py:method:: CustomerProfiles.Client.get_event_stream(**kwargs)

  

  Returns information about the specified event stream in a specific domain.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetEventStream>`_  


  **Request Syntax**
  ::

    response = client.get_event_stream(
        DomainName='string',
        EventStreamName='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique name of the domain.

    

  
  :type EventStreamName: string
  :param EventStreamName: **[REQUIRED]** 

    The name of the event stream provided during create operations.

    

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

    
    ::

      {
          'DomainName': 'string',
          'EventStreamArn': 'string',
          'CreatedAt': datetime(2015, 1, 1),
          'State': 'RUNNING'|'STOPPED',
          'StoppedSince': datetime(2015, 1, 1),
          'DestinationDetails': {
              'Uri': 'string',
              'Status': 'HEALTHY'|'UNHEALTHY',
              'UnhealthySince': datetime(2015, 1, 1),
              'Message': 'string'
          },
          'Tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **DomainName** *(string) --* 

        The unique name of the domain.

        
      

      - **EventStreamArn** *(string) --* 

        A unique identifier for the event stream.

        
      

      - **CreatedAt** *(datetime) --* 

        The timestamp of when the export was created.

        
      

      - **State** *(string) --* 

        The operational state of destination stream for export.

        
      

      - **StoppedSince** *(datetime) --* 

        The timestamp when the ``State`` changed to ``STOPPED``.

        
      

      - **DestinationDetails** *(dict) --* 

        Details regarding the Kinesis stream.

        
        

        - **Uri** *(string) --* 

          The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.

          
        

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

          The status of enabling the Kinesis stream as a destination for export.

          
        

        - **UnhealthySince** *(datetime) --* 

          The timestamp when the status last changed to ``UNHEALHY``.

          
        

        - **Message** *(string) --* 

          The human-readable string that corresponds to the error or success while enabling the streaming destination.

          
    
      

      - **Tags** *(dict) --* 

        The tags used to organize, track, or control access for this resource.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`CustomerProfiles.Client.exceptions.BadRequestException`

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

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

  
  *   :py:class:`CustomerProfiles.Client.exceptions.ThrottlingException`

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

  