stop_data_collection_by_agent_ids

stop_data_collection_by_agent_ids(**kwargs)

Instructs the specified agents or connectors to stop collecting data.

See also: AWS API Documentation

Request Syntax

response = client.stop_data_collection_by_agent_ids(
    agentIds=[
        'string',
    ]
)

Parameters

agentIds (list) --

[REQUIRED]

The IDs of the agents or connectors from which to stop collecting data.

• (string) --

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --
  • agentsConfigurationStatus (list) --

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

    • (dict) --

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

      • agentId (string) --

        The agent/connector ID.

      • operationSucceeded (boolean) --

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

      • description (string) --

        A description of the operation performed.

Exceptions

• ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException
• ApplicationDiscoveryService.Client.exceptions.InvalidParameterException
• ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException
• ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException
• ApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetException