send_cis_session_telemetry `async` ¶

send_cis_session_telemetry(
    scan_job_id: UUID,
    session_token: UUID,
    messages: CisSessionMessages,
    *,
    config_overrides: Optional[AsyncInspector2ClientConfig] = None,
) -> SendCisSessionTelemetryResponse

Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.

Parameters:

scan_job_id (UUID) –

A unique identifier for the scan job.
session_token (UUID) –

The unique token that identifies the CIS session.
messages (CisSessionMessages) –

The CIS session telemetry messages.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.
ConflictException –

A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.
InternalServerException –

The request has failed due to an internal failure of the Amazon Inspector service.
ThrottlingException –

The limit on the number of requests per second was exceeded.
ValidationException –

The request has failed validation due to missing required fields or having invalid inputs.
UnknownServiceError –

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

Examples:

Sample SendCisSessionTelemetry Call

>>> await client.send_cis_session_telemetry(scan_job_id='624b746d-e080-44ae-8c1d-48e653365a38', session_token='624b746d-e080-44ae-8c1d-48e653365a31', messages=[{'ruleId': '1.12.1', 'status': 'FAILED', 'cisRuleDetails': 'dGVzdCBleGFtcGxlCg=='}, {'ruleId': '1.2.1', 'status': 'PASSED', 'cisRuleDetails': 'dGVzdCBleGFtcGxlCg==dGVzdCBleGFtcGxlCg'}])

Source code in docs_src/capo_inspector2/_services/async_inspector2.py

async def send_cis_session_telemetry(
    self,
    scan_job_id: "capo_inspector2.types.uuid.UUID",
    session_token: "capo_inspector2.types.uuid.UUID",
    messages: "capo_inspector2.types.cis_session_messages.CisSessionMessages",
    *,
    config_overrides: Optional[AsyncInspector2ClientConfig] = None,
) -> "capo_inspector2.types.send_cis_session_telemetry_response.SendCisSessionTelemetryResponse":
    """<p> Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service. </p>

    Args:
        scan_job_id: <p>A unique identifier for the scan job.</p>
        session_token: <p>The unique token that identifies the CIS session.</p>
        messages: <p>The CIS session telemetry messages.</p>

    Raises:
        capo_inspector2.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p> For <code>Enable</code>, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region. </p>
        capo_inspector2.errors.conflict_exception.ConflictException: <p>A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.</p>
        capo_inspector2.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
        capo_inspector2.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_inspector2.errors.validation_exception.ValidationException: <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
        capo_inspector2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Sample SendCisSessionTelemetry Call

        >>> await client.send_cis_session_telemetry(scan_job_id='624b746d-e080-44ae-8c1d-48e653365a38', session_token='624b746d-e080-44ae-8c1d-48e653365a31', messages=[{'ruleId': '1.12.1', 'status': 'FAILED', 'cisRuleDetails': 'dGVzdCBleGFtcGxlCg=='}, {'ruleId': '1.2.1', 'status': 'PASSED', 'cisRuleDetails': 'dGVzdCBleGFtcGxlCg==dGVzdCBleGFtcGxlCg'}])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_inspector2.types.send_cis_session_telemetry_request.SendCisSessionTelemetryRequest]",
    ) -> AsyncOperationResponse[
        "capo_inspector2.types.send_cis_session_telemetry_response.SendCisSessionTelemetryResponse"
    ]:
        import capo_inspector2._operations.inspector2.send_cis_session_telemetry

        (
            output,
            http_response,
        ) = await capo_inspector2._operations.inspector2.send_cis_session_telemetry.async_send_cis_session_telemetry(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendCisSessionTelemetry")
    )
    input_: capo_inspector2.types.send_cis_session_telemetry_request.SendCisSessionTelemetryRequest = {
        "scan_job_id": scan_job_id,
        "session_token": session_token,
        "messages": messages,
    }

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

send_cis_session_telemetry async ¶

send_cis_session_telemetry `async` ¶