:doc:`CloudWatchObservabilityAccessManager <../../oam>` / Client / get_sink

********
get_sink
********



.. py:method:: CloudWatchObservabilityAccessManager.Client.get_sink(**kwargs)

  

  Returns complete information about one monitoring account sink.

   

  To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use `ListSinks <https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetSink>`_  


  **Request Syntax**
  ::

    response = client.get_sink(
        Identifier='string',
        IncludeTags=True|False
    )
    
  :type Identifier: string
  :param Identifier: **[REQUIRED]** 

    The ARN of the sink to retrieve information for.

    

  
  :type IncludeTags: boolean
  :param IncludeTags: 

    Specifies whether to include the tags associated with the sink in the response. When ``IncludeTags`` is set to ``true`` and the caller has the required permission, ``oam:ListTagsForResource``, the API will return the tags for the specified resource. If the caller doesn't have the required permission, ``oam:ListTagsForResource``, the API will raise an exception.

     

    The default value is ``false``.

    

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

    
    ::

      {
          'Arn': 'string',
          'Id': 'string',
          'Name': 'string',
          'Tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Arn** *(string) --* 

        The ARN of the sink.

        
      

      - **Id** *(string) --* 

        The random ID string that Amazon Web Services generated as part of the sink ARN.

        
      

      - **Name** *(string) --* 

        The name of the sink.

        
      

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

        The tags assigned to the sink.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`CloudWatchObservabilityAccessManager.Client.exceptions.InternalServiceFault`

  
  *   :py:class:`CloudWatchObservabilityAccessManager.Client.exceptions.MissingRequiredParameterException`

  
  *   :py:class:`CloudWatchObservabilityAccessManager.Client.exceptions.InvalidParameterException`

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

  