Inspector2 / Client / send_cis_session_telemetry

send_cis_session_telemetry#

Inspector2.Client.send_cis_session_telemetry(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.send_cis_session_telemetry(
    messages=[
        {
            'cisRuleDetails': b'bytes',
            'ruleId': 'string',
            'status': 'FAILED'|'PASSED'|'NOT_EVALUATED'|'INFORMATIONAL'|'UNKNOWN'|'NOT_APPLICABLE'|'ERROR'
        },
    ],
    scanJobId='string',
    sessionToken='string'
)
Parameters:
  • messages (list) –

    [REQUIRED]

    The CIS session telemetry messages.

    • (dict) –

      The CIS session message.

      • cisRuleDetails (bytes) – [REQUIRED]

        The CIS rule details for the CIS session message.

      • ruleId (string) – [REQUIRED]

        The rule ID for the CIS session message.

      • status (string) – [REQUIRED]

        The status of the CIS session message.

  • scanJobId (string) –

    [REQUIRED]

    A unique identifier for the scan job.

  • sessionToken (string) –

    [REQUIRED]

    The unique token that identifies the CIS session.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Inspector2.Client.exceptions.ConflictException

  • Inspector2.Client.exceptions.ValidationException

  • Inspector2.Client.exceptions.AccessDeniedException

  • Inspector2.Client.exceptions.ThrottlingException

  • Inspector2.Client.exceptions.InternalServerException