:doc:`EndUserMessagingSocial <../../socialmessaging>` / Client / get_linked_whatsapp_business_account

************************************
get_linked_whatsapp_business_account
************************************



.. py:method:: EndUserMessagingSocial.Client.get_linked_whatsapp_business_account(**kwargs)

  

  Get the details of your linked WhatsApp Business Account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/GetLinkedWhatsAppBusinessAccount>`_  


  **Request Syntax**
  ::

    response = client.get_linked_whatsapp_business_account(
        id='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The unique identifier, from Amazon Web Services, of the linked WhatsApp Business Account. WABA identifiers are formatted as ``waba-01234567890123456789012345678901``. Use `ListLinkedWhatsAppBusinessAccounts <https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html>`__ to list all WABAs and their details.

    

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

    
    ::

      {
          'account': {
              'arn': 'string',
              'id': 'string',
              'wabaId': 'string',
              'registrationStatus': 'COMPLETE'|'INCOMPLETE',
              'linkDate': datetime(2015, 1, 1),
              'wabaName': 'string',
              'eventDestinations': [
                  {
                      'eventDestinationArn': 'string',
                      'roleArn': 'string'
                  },
              ],
              'phoneNumbers': [
                  {
                      'arn': 'string',
                      'phoneNumber': 'string',
                      'phoneNumberId': 'string',
                      'metaPhoneNumberId': 'string',
                      'displayPhoneNumberName': 'string',
                      'displayPhoneNumber': 'string',
                      'qualityRating': 'string',
                      'dataLocalizationRegion': 'string'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **account** *(dict) --* 

        The details of the linked WhatsApp Business Account.

        
        

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

          The ARN of the linked WhatsApp Business Account.

          
        

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

          The ID of the linked WhatsApp Business Account, formatted as ``waba-01234567890123456789012345678901``.

          
        

        - **wabaId** *(string) --* 

          The WhatsApp Business Account ID from meta.

          
        

        - **registrationStatus** *(string) --* 

          The registration status of the linked WhatsApp Business Account.

          
        

        - **linkDate** *(datetime) --* 

          The date the WhatsApp Business Account was linked.

          
        

        - **wabaName** *(string) --* 

          The name of the linked WhatsApp Business Account.

          
        

        - **eventDestinations** *(list) --* 

          The event destinations for the linked WhatsApp Business Account.

          
          

          - *(dict) --* 

            Contains information on the event destination.

            
            

            - **eventDestinationArn** *(string) --* 

              The ARN of the event destination.

              
            

            - **roleArn** *(string) --* 

              The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.

              
        
      
        

        - **phoneNumbers** *(list) --* 

          The phone numbers associated with the Linked WhatsApp Business Account.

          
          

          - *(dict) --* 

            The details of a linked phone number.

            
            

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

              The full Amazon Resource Name (ARN) for the phone number.

              
            

            - **phoneNumber** *(string) --* 

              The phone number associated with the Linked WhatsApp Business Account.

              
            

            - **phoneNumberId** *(string) --* 

              The phone number ID. Phone number identifiers are formatted as ``phone-number-id-01234567890123456789012345678901``.

              
            

            - **metaPhoneNumberId** *(string) --* 

              The phone number ID from Meta.

              
            

            - **displayPhoneNumberName** *(string) --* 

              The display name for this phone number.

              
            

            - **displayPhoneNumber** *(string) --* 

              The phone number that appears in the recipients display.

              
            

            - **qualityRating** *(string) --* 

              The quality rating of the phone number. This is from Meta.

              
            

            - **dataLocalizationRegion** *(string) --* 

              The geographic region where the WhatsApp phone number's data is stored and processed.

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

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

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.InvalidParametersException`

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

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.ThrottledRequestException`

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.InternalServiceException`

  
  *   :py:class:`EndUserMessagingSocial.Client.exceptions.DependencyException`

  