start_cis_session ¶

start_cis_session(
    scan_job_id: UUID,
    message: StartCisSessionMessage,
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
) -> StartCisSessionResponse

Starts a CIS session. 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.
message (StartCisSessionMessage) –

The start CIS session message.

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 SendCisSessionHealth Call

>>> client.start_cis_session(scan_job_id='624b746d-e080-44ae-8c1d-48e653365a38', message={'sessionToken': '624b746d-e080-44ae-8c1d-48e653365a31'})

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

def start_cis_session(
    self,
    scan_job_id: "capo_inspector2.types.uuid.UUID",
    message: "capo_inspector2.types.start_cis_session_message.StartCisSessionMessage",
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
) -> "capo_inspector2.types.start_cis_session_response.StartCisSessionResponse":
    """<p> Starts a CIS session. 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>
        message: <p>The start CIS session message.</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 SendCisSessionHealth Call

        >>> client.start_cis_session(scan_job_id='624b746d-e080-44ae-8c1d-48e653365a38', message={'sessionToken': '624b746d-e080-44ae-8c1d-48e653365a31'})
    """

    def _handler(
        req: "OperationRequest[capo_inspector2.types.start_cis_session_request.StartCisSessionRequest]",
    ) -> OperationResponse[
        "capo_inspector2.types.start_cis_session_response.StartCisSessionResponse"
    ]:
        import capo_inspector2._operations.inspector2.start_cis_session

        output, http_response = (
            capo_inspector2._operations.inspector2.start_cis_session.start_cis_session(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartCisSession")
    )
    input_: capo_inspector2.types.start_cis_session_request.StartCisSessionRequest = {
        "scan_job_id": scan_job_id,
        "message": message,
    }

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