Skip to content

stop_data_collection_by_agent_ids async

stop_data_collection_by_agent_ids(
    agent_ids: AgentIds,
    *,
    config_overrides: Optional[AsyncApplicationDiscoveryServiceClientConfig] = None,
) -> StopDataCollectionByAgentIdsResponse

Instructs the specified agents to stop collecting data.

Parameters:

  • agent_ids (AgentIds) –

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

Raises:

Source code in docs_src/capo_application_discovery_service/_services/async_application_discovery_service.py
async def stop_data_collection_by_agent_ids(
    self,
    agent_ids: "capo_application_discovery_service.types.agent_ids.AgentIds",
    *,
    config_overrides: Optional[AsyncApplicationDiscoveryServiceClientConfig] = None,
) -> "capo_application_discovery_service.types.stop_data_collection_by_agent_ids_response.StopDataCollectionByAgentIdsResponse":
    """<p>Instructs the specified agents to stop collecting data.</p>

    Args:
        agent_ids: <p>The IDs of the agents from which to stop collecting data.</p>

    Raises:
        capo_application_discovery_service.errors.authorization_error_exception.AuthorizationErrorException: <p>The user does not have permission to perform the action. Check the IAM policy associated with this user.</p>
        capo_application_discovery_service.errors.home_region_not_set_exception.HomeRegionNotSetException: <p>The home Region is not set. Set the home Region to continue.</p>
        capo_application_discovery_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid. Verify the parameters and try again.</p>
        capo_application_discovery_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.</p>
        capo_application_discovery_service.errors.server_internal_error_exception.ServerInternalErrorException: <p>The server experienced an internal error. Try again.</p>
        capo_application_discovery_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_application_discovery_service.types.stop_data_collection_by_agent_ids_request.StopDataCollectionByAgentIdsRequest]",
    ) -> AsyncOperationResponse[
        "capo_application_discovery_service.types.stop_data_collection_by_agent_ids_response.StopDataCollectionByAgentIdsResponse"
    ]:
        import capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.stop_data_collection_by_agent_ids

        (
            output,
            http_response,
        ) = await capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.stop_data_collection_by_agent_ids.async_stop_data_collection_by_agent_ids(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopDataCollectionByAgentIds")
    )
    input_: capo_application_discovery_service.types.stop_data_collection_by_agent_ids_request.StopDataCollectionByAgentIdsRequest = {
        "agent_ids": agent_ids
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output