:doc:`SSMContacts <../../ssm-contacts>` / Client / get_contact_channel

*******************
get_contact_channel
*******************



.. py:method:: SSMContacts.Client.get_contact_channel(**kwargs)

  

  List details about a specific contact channel.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetContactChannel>`_  


  **Request Syntax**
  ::

    response = client.get_contact_channel(
        ContactChannelId='string'
    )
    
  :type ContactChannelId: string
  :param ContactChannelId: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the contact channel you want information about.

    

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

    
    ::

      {
          'ContactArn': 'string',
          'ContactChannelArn': 'string',
          'Name': 'string',
          'Type': 'SMS'|'VOICE'|'EMAIL',
          'DeliveryAddress': {
              'SimpleAddress': 'string'
          },
          'ActivationStatus': 'ACTIVATED'|'NOT_ACTIVATED'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ContactArn** *(string) --* 

        The ARN of the contact that the channel belongs to.

        
      

      - **ContactChannelArn** *(string) --* 

        The ARN of the contact channel.

        
      

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

        The name of the contact channel

        
      

      - **Type** *(string) --* 

        The type of contact channel. The type is ``SMS``, ``VOICE``, or ``EMAIL``.

        
      

      - **DeliveryAddress** *(dict) --* 

        The details that Incident Manager uses when trying to engage the contact channel.

        
        

        - **SimpleAddress** *(string) --* 

          The format is dependent on the type of the contact channel. The following are the expected formats:

           

          
          * SMS - '+' followed by the country code and phone number
           
          * VOICE - '+' followed by the country code and phone number
           
          * EMAIL - any standard email format
          

          
    
      

      - **ActivationStatus** *(string) --* 

        A Boolean value indicating if the contact channel has been activated or not.

        
  
  **Exceptions**
  
  *   :py:class:`SSMContacts.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SSMContacts.Client.exceptions.DataEncryptionException`

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

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

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

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

  

  **Examples**

  The following get-contact-channel example lists the details of a contact channel.
  ::

    response = client.get_contact_channel(
        ContactChannelId='arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'ActivationStatus': 'ACTIVATED',
        'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
        'ContactChannelArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
        'DeliveryAddress': {
            'SimpleAddress': '+15005550199',
        },
        'Name': 'akuas sms',
        'Type': 'SMS',
        'ResponseMetadata': {
            '...': '...',
        },
    }

  