:doc:`AppSync <../../appsync>` / Client / get_api_association

*******************
get_api_association
*******************



.. py:method:: AppSync.Client.get_api_association(**kwargs)

  

  Retrieves an ``ApiAssociation`` object.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetApiAssociation>`_  


  **Request Syntax**
  ::

    response = client.get_api_association(
        domainName='string'
    )
    
  :type domainName: string
  :param domainName: **[REQUIRED]** 

    The domain name.

    

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

    
    ::

      {
          'apiAssociation': {
              'domainName': 'string',
              'apiId': 'string',
              'associationStatus': 'PROCESSING'|'FAILED'|'SUCCESS',
              'deploymentDetail': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **apiAssociation** *(dict) --* 

        The ``ApiAssociation`` object.

        
        

        - **domainName** *(string) --* 

          The domain name.

          
        

        - **apiId** *(string) --* 

          The API ID.

          
        

        - **associationStatus** *(string) --* 

          Identifies the status of an association.

           

          
          * **PROCESSING**: The API association is being created. You cannot modify association requests during processing.
           
          * **SUCCESS**: The API association was successful. You can modify associations after success.
           
          * **FAILED**: The API association has failed. You can modify associations after failure.
          

          
        

        - **deploymentDetail** *(string) --* 

          Details about the last deployment status.

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

  
  *   :py:class:`AppSync.Client.exceptions.BadRequestException`

  
  *   :py:class:`AppSync.Client.exceptions.InternalFailureException`

  
  *   :py:class:`AppSync.Client.exceptions.NotFoundException`

  