stop_cis_session `async` ¶

stop_cis_session(
    scan_job_id: UUID,
    session_token: UUID,
    message: StopCisSessionMessage,
    *,
    config_overrides: Optional[AsyncInspector2ClientConfig] = None,
) -> StopCisSessionResponse

Stops 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 stop 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.
message (StopCisSessionMessage) –

The stop 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 StopCisSession Call

>>> await client.stop_cis_session(scan_job_id='624b746d-e080-44ae-8c1d-48e653365a38', session_token='624b746d-e080-44ae-8c1d-48e653365a31', message={'status': 'FAILED', 'reason': 'Failure Reason', 'progress': {'informationalChecks': 1, 'errorChecks': 1, 'successfulChecks': 5, 'notApplicableChecks': 0, 'totalChecks': 10, 'unknownChecks': 0, 'notEvaluatedChecks': 2, 'failedChecks': 0}, 'computePlatform': {'vendor': 'canonical', 'product': 'ubuntu', 'version': '20.04'}, 'benchmarkVersion': '2.0.0', 'benchmarkProfile': 'xccdf_org.cisecurity.benchmarks_profile_Level_1'})

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

async def stop_cis_session(
    self,
    scan_job_id: "capo_inspector2.types.uuid.UUID",
    session_token: "capo_inspector2.types.uuid.UUID",
    message: "capo_inspector2.types.stop_cis_session_message.StopCisSessionMessage",
    *,
    config_overrides: Optional[AsyncInspector2ClientConfig] = None,
) -> "capo_inspector2.types.stop_cis_session_response.StopCisSessionResponse":
    """<p> Stops 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 stop 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>
        message: <p>The stop 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 StopCisSession Call

        >>> await client.stop_cis_session(scan_job_id='624b746d-e080-44ae-8c1d-48e653365a38', session_token='624b746d-e080-44ae-8c1d-48e653365a31', message={'status': 'FAILED', 'reason': 'Failure Reason', 'progress': {'informationalChecks': 1, 'errorChecks': 1, 'successfulChecks': 5, 'notApplicableChecks': 0, 'totalChecks': 10, 'unknownChecks': 0, 'notEvaluatedChecks': 2, 'failedChecks': 0}, 'computePlatform': {'vendor': 'canonical', 'product': 'ubuntu', 'version': '20.04'}, 'benchmarkVersion': '2.0.0', 'benchmarkProfile': 'xccdf_org.cisecurity.benchmarks_profile_Level_1'})
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_inspector2.types.stop_cis_session_request.StopCisSessionRequest]",
    ) -> AsyncOperationResponse[
        "capo_inspector2.types.stop_cis_session_response.StopCisSessionResponse"
    ]:
        import capo_inspector2._operations.inspector2.stop_cis_session

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopCisSession")
    )
    input_: capo_inspector2.types.stop_cis_session_request.StopCisSessionRequest = {
        "scan_job_id": scan_job_id,
        "session_token": session_token,
        "message": message,
    }

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

stop_cis_session async ¶

stop_cis_session `async` ¶