start_code_security_scan `async` ¶

start_code_security_scan(
    resource: CodeSecurityResource,
    *,
    config_overrides: Optional[AsyncInspector2ClientConfig] = None,
    client_token: Optional[CodeSecurityClientToken] = None,
) -> StartCodeSecurityScanResponse

Initiates a code security scan on a specified repository.

Parameters:

client_token (Optional[CodeSecurityClientToken], default: None ) –

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
resource (CodeSecurityResource) –

The resource identifier for the code repository to scan.

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.
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/async_inspector2.py

async def start_code_security_scan(
    self,
    resource: "capo_inspector2.types.code_security_resource.CodeSecurityResource",
    *,
    config_overrides: Optional[AsyncInspector2ClientConfig] = None,
    client_token: Optional[
        "capo_inspector2.types.code_security_client_token.CodeSecurityClientToken"
    ] = None,
) -> "capo_inspector2.types.start_code_security_scan_response.StartCodeSecurityScanResponse":
    """<p>Initiates a code security scan on a specified repository.</p>

    Args:
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
        resource: <p>The resource identifier for the code repository to scan.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_inspector2.types.start_code_security_scan_request.StartCodeSecurityScanRequest]",
    ) -> AsyncOperationResponse[
        "capo_inspector2.types.start_code_security_scan_response.StartCodeSecurityScanResponse"
    ]:
        import capo_inspector2._operations.inspector2.start_code_security_scan

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartCodeSecurityScan")
    )
    input_: capo_inspector2.types.start_code_security_scan_request.StartCodeSecurityScanRequest = {
        "resource": resource
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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

start_code_security_scan async ¶

start_code_security_scan `async` ¶