Skip to content

get_code_security_scan_configuration

get_code_security_scan_configuration(
    scan_configuration_arn: ScanConfigurationArn,
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
) -> GetCodeSecurityScanConfigurationResponse

Retrieves information about a code security scan configuration.

Parameters:

  • scan_configuration_arn (ScanConfigurationArn) –

    The Amazon Resource Name (ARN) of the scan configuration to retrieve.

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.

  • InternalServerException –

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

  • ResourceNotFoundException –

    The operation tried to access an invalid resource. Make sure the resource is specified correctly.

  • 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.

Source code in docs_src/capo_inspector2/_services/inspector2.py
def get_code_security_scan_configuration(
    self,
    scan_configuration_arn: "capo_inspector2.types.scan_configuration_arn.ScanConfigurationArn",
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
) -> "capo_inspector2.types.get_code_security_scan_configuration_response.GetCodeSecurityScanConfigurationResponse":
    """<p>Retrieves information about a code security scan configuration.</p>

    Args:
        scan_configuration_arn: <p>The Amazon Resource Name (ARN) of the scan configuration to retrieve.</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.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
        capo_inspector2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access an invalid resource. Make sure the resource is specified correctly.</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.
    """

    def _handler(
        req: "OperationRequest[capo_inspector2.types.get_code_security_scan_configuration_request.GetCodeSecurityScanConfigurationRequest]",
    ) -> OperationResponse[
        "capo_inspector2.types.get_code_security_scan_configuration_response.GetCodeSecurityScanConfigurationResponse"
    ]:
        import capo_inspector2._operations.inspector2.get_code_security_scan_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetCodeSecurityScanConfiguration")
    )
    input_: capo_inspector2.types.get_code_security_scan_configuration_request.GetCodeSecurityScanConfigurationRequest = {
        "scan_configuration_arn": scan_configuration_arn
    }

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