get_threat_entity_set ¶

get_threat_entity_set(
    detector_id: DetectorId,
    threat_entity_set_id: String,
    *,
    config_overrides: Optional[GuardDutyClientConfig] = None,
) -> GetThreatEntitySetResponse

Retrieves the threat entity set associated with the specified threatEntitySetId.

Parameters:

detector_id (DetectorId) –

The unique ID of the detector associated with the threat entity set resource.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
threat_entity_set_id (String) –

The unique ID that helps GuardDuty identify the threat entity set.

Raises:

BadRequestException –

A bad request exception object.
InternalServerErrorException –

An internal server error exception object.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_guardduty/_services/guard_duty.py

def get_threat_entity_set(
    self,
    detector_id: "capo_guardduty.types.detector_id.DetectorId",
    threat_entity_set_id: "capo_guardduty.types.string.String",
    *,
    config_overrides: Optional[GuardDutyClientConfig] = None,
) -> (
    "capo_guardduty.types.get_threat_entity_set_response.GetThreatEntitySetResponse"
):
    """<p>Retrieves the threat entity set associated with the specified <code>threatEntitySetId</code>.</p>

    Args:
        detector_id: <p>The unique ID of the detector associated with the threat entity set resource.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
        threat_entity_set_id: <p>The unique ID that helps GuardDuty identify the threat entity set.</p>

    Raises:
        capo_guardduty.errors.bad_request_exception.BadRequestException: <p>A bad request exception object.</p>
        capo_guardduty.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal server error exception object.</p>
        capo_guardduty.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_guardduty.types.get_threat_entity_set_request.GetThreatEntitySetRequest]",
    ) -> OperationResponse[
        "capo_guardduty.types.get_threat_entity_set_response.GetThreatEntitySetResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.get_threat_entity_set

        output, http_response = (
            capo_guardduty._operations.guard_duty_api_service.get_threat_entity_set.get_threat_entity_set(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetThreatEntitySet")
    )
    input_: capo_guardduty.types.get_threat_entity_set_request.GetThreatEntitySetRequest = {
        "detector_id": detector_id,
        "threat_entity_set_id": threat_entity_set_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output