:doc:`ApplicationDiscoveryService <../../discovery>` / Client / start_data_collection_by_agent_ids

**********************************
start_data_collection_by_agent_ids
**********************************



.. py:method:: ApplicationDiscoveryService.Client.start_data_collection_by_agent_ids(**kwargs)

  

  Instructs the specified agents to start collecting data.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/discovery-2015-11-01/StartDataCollectionByAgentIds>`_  


  **Request Syntax**
  ::

    response = client.start_data_collection_by_agent_ids(
        agentIds=[
            'string',
        ]
    )
    
  :type agentIds: list
  :param agentIds: **[REQUIRED]** 

    The IDs of the agents from which to start collecting data. If you send a request to an agent ID that you do not have permission to contact, according to your Amazon Web Services account, the service does not throw an exception. Instead, it returns the error in the *Description* field. If you send a request to multiple agents and you do not have permission to contact some of those agents, the system does not throw an exception. Instead, the system shows ``Failed`` in the *Description* field.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'agentsConfigurationStatus': [
              {
                  'agentId': 'string',
                  'operationSucceeded': True|False,
                  'description': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **agentsConfigurationStatus** *(list) --* 

        Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation performed, and whether the agent configuration was updated.

        
        

        - *(dict) --* 

          Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation, and whether the agent configuration was updated.

          
          

          - **agentId** *(string) --* 

            The agent ID.

            
          

          - **operationSucceeded** *(boolean) --* 

            Information about the status of the ``StartDataCollection`` and ``StopDataCollection`` operations. The system has recorded the data collection operation. The agent receives this command the next time it polls for a new command.

            
          

          - **description** *(string) --* 

            A description of the operation performed.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException`

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

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetException`

  