:doc:`Synthetics <../../synthetics>` / Client / associate_resource

******************
associate_resource
******************



.. py:method:: Synthetics.Client.associate_resource(**kwargs)

  

  Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

   

  You must run this operation in the Region where the canary exists.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AssociateResource>`_  


  **Request Syntax**
  ::

    response = client.associate_resource(
        GroupIdentifier='string',
        ResourceArn='string'
    )
    
  :type GroupIdentifier: string
  :param GroupIdentifier: **[REQUIRED]** 

    Specifies the group. You can specify the group name, the ARN, or the group ID as the ``GroupIdentifier``.

    

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

    The ARN of the canary that you want to associate with the specified group.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`Synthetics.Client.exceptions.InternalServerException`

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

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

  
  *   :py:class:`Synthetics.Client.exceptions.ConflictException`

  
  *   :py:class:`Synthetics.Client.exceptions.ServiceQuotaExceededException`

  